diff --git a/specification/ai/Azure.AI.Projects/client.tsp b/specification/ai/Azure.AI.Projects/client.tsp new file mode 100644 index 000000000000..f90a88b505a4 --- /dev/null +++ b/specification/ai/Azure.AI.Projects/client.tsp @@ -0,0 +1,39 @@ +import "@azure-tools/typespec-client-generator-core"; +import "./main.tsp"; + +using Azure.ClientGenerator.Core; + +@@clientName(Azure.AI.Projects, "AIProjectClient"); + +// Shorter method names for SDK datasets operations +@@clientName(Azure.AI.Projects.Datasets.listLatest, "list"); +@@clientName(Azure.AI.Projects.Datasets.getVersion, "get"); +@@clientName(Azure.AI.Projects.Datasets.deleteVersion, "delete"); +@@clientName(Azure.AI.Projects.Datasets.createOrUpdateVersion, + "createOrUpdate" +); +@@clientName(Azure.AI.Projects.Datasets.startPendingUploadVersion, + "pendingUpload" +); + +// Shorter method names for SDK Index operations +@@clientName(Azure.AI.Projects.Indexes.listLatest, "list"); +@@clientName(Azure.AI.Projects.Indexes.getVersion, "get"); +@@clientName(Azure.AI.Projects.Indexes.deleteVersion, "delete"); +@@clientName(Azure.AI.Projects.Indexes.createOrUpdateVersion, "createOrUpdate"); + +// In Python, the emitter changes "keys" to "keys_property", since there is already +// a "keys" method in the generated code due to usage of MutableMapping. Call it credential_keys instead. +@@clientName(Azure.AI.Projects.CustomCredential.keys, + "credential_keys", + "python" +); + +// Make these two internal, since all SDKs hand-write a single public method with boolean "includeCredentials" +// input parameter that calls either on these two. +@@access(Azure.AI.Projects.Connections.get, Access.internal); +@@access(Azure.AI.Projects.Connections.getWithCredentials, Access.internal); + +// For some reason for Python the emitter creates an empty ServicePatternsOperations operation +// class. Mark it as internal here. Apply to all languages just in case. +//@@access(Azure.AI.Projects.ServicePatterns, Access.internal); <== this did not work. It makes all methods internal. diff --git a/specification/ai/Azure.AI.Projects/common/models.tsp b/specification/ai/Azure.AI.Projects/common/models.tsp new file mode 100644 index 000000000000..4d615ca7fdf6 --- /dev/null +++ b/specification/ai/Azure.AI.Projects/common/models.tsp @@ -0,0 +1,117 @@ +import "@typespec/rest"; +import "@typespec/versioning"; +import "@azure-tools/typespec-azure-core"; +import "@azure-tools/typespec-azure-resource-manager"; + +namespace Azure.AI.Projects; + +alias AssetBase = { + @doc("Asset ID, a unique identifier for the asset") + @visibility(Lifecycle.Read) + id?: string; + + @doc("The name of the resource") + @visibility(Lifecycle.Read) + @key + name: string; + + @doc("The version of the resource") + @visibility(Lifecycle.Read) + version: string; + + @doc("The asset description text.") + @visibility(Lifecycle.Create, Lifecycle.Update) + description?: string; + + @doc("Tag dictionary. Tags can be added, removed, and updated.") + @visibility(Lifecycle.Create, Lifecycle.Update) + tags?: Record; +}; + +#suppress "@azure-tools/typespec-providerhub/no-inline-model" "Need to create responses correctly" +alias ResourceCreatedResponse = TypeSpec.Http.Response<201> & + T; + +#suppress "@azure-tools/typespec-providerhub/no-inline-model" "Need to create responses correctly" +alias OkResponse = TypeSpec.Http.Response<200> & + T; + +// Pending upload spec + +// Define a URI alias for clarity. +alias Uri = string; + +@doc("The type of pending upload.") +union PendingUploadType { + string, + + @doc("No pending upload.") + none: "None", + + @doc("Blob Reference is the only supported type.") + BlobReference: "BlobReference", +} + +@doc("The type of credential used to access the storage account.") +union PendingUploadCredentialType { + string, + + @doc("SAS credential type.") + sas: "SAS", +} + +@doc("Represents a request for a pending upload.") +model PendingUploadRequest { + @doc("If PendingUploadId is not provided, a random GUID will be used.") + pendingUploadId?: string; + + @doc("Azure Storage Account connection name to use for generating temporary SAS token") + connectionName?: string; + + @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.") + blobReference: BlobReference; + + @doc("ID for this upload request.") + pendingUploadId: string; + + @doc("Version of asset to be created if user did not specify version when initially creating upload") + version?: string; + + @doc("BlobReference is the only supported type") + pendingUploadType: PendingUploadType.BlobReference; +} + +@doc("SAS Credential definition") +model SasCredential { + @doc("SAS uri") + @visibility(Lifecycle.Read) + sasUri: string; + + @visibility(Lifecycle.Read) + @doc("Type of credential") + type: "SAS"; +} + +@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; + + @doc("ARM ID of the storage account to use.") + storageAccountArmId: string; + + @doc("Credential info to access the storage account.") + credential: SasCredential; +} + +@doc("Represents a reference to a blob for consumption") +model AssetCredentialResponse { + @doc("Credential info to access the storage account.") + blobReference: BlobReference; +} diff --git a/specification/ai/Azure.AI.Projects/connections/models.tsp b/specification/ai/Azure.AI.Projects/connections/models.tsp new file mode 100644 index 000000000000..31fc746544a6 --- /dev/null +++ b/specification/ai/Azure.AI.Projects/connections/models.tsp @@ -0,0 +1,157 @@ +import "@typespec/rest"; +import "@azure-tools/typespec-autorest"; +import "@typespec/versioning"; +import "@azure-tools/typespec-azure-core"; +import "@typespec/openapi"; +import "@typespec/versioning"; + +using TypeSpec.Rest; +using TypeSpec.Versioning; + +namespace Azure.AI.Projects; + +@doc("Response from the list and get connections operations") +@resource("connections") +@added(Versions.v2025_05_01) +model Connection { + @doc("The friendly name of the connection, provided by the user.") + @visibility(Lifecycle.Read) + @key("name") + name: string; + + @doc("A unique identifier for the connection, generated by the service") + @visibility(Lifecycle.Read) + id: string; + + @doc("Category of the connection") + @visibility(Lifecycle.Read) + type: ConnectionType; + + @doc("The connection URL to be used for this service") + @visibility(Lifecycle.Read) + target: string; + + @doc("Whether the connection is tagged as the default connection of its type") + @visibility(Lifecycle.Read) + isDefault: boolean; + + @doc("The credentials used by the connection") + @visibility(Lifecycle.Read) + credentials: BaseCredentials; + + @doc("Metadata of the connection") + @visibility(Lifecycle.Read) + metadata: Record; +} + +@doc("A base class for connection credentials") +@discriminator("type") +model BaseCredentials { + @doc("The type of credential used by the connection") + @visibility(Lifecycle.Read) + type: CredentialType; +} + +@doc("API Key Credential definition") +model ApiKeyCredentials extends BaseCredentials { + @doc("The credential type") + @visibility(Lifecycle.Read) + type: CredentialType.apiKey; + + @doc("API Key") + @visibility(Lifecycle.Read) + @encodedName("application/json", "key") + apiKey?: string; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" +@doc("Entra ID credential definition") +model EntraIDCredentials extends BaseCredentials { + @doc("The credential type") + @visibility(Lifecycle.Read) + type: CredentialType.entraId; +} + +@doc("Custom credential definition") +model CustomCredential extends BaseCredentials { + @doc("The credential type") + @visibility(Lifecycle.Read) + type: CredentialType.custom; + + @doc("The credential type") + @visibility(Lifecycle.Read) + keys: Record; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" +@doc("Shared Access Signature (SAS) credential definition") +model SASCredentials extends BaseCredentials { + @doc("The credential type") + @visibility(Lifecycle.Read) + type: CredentialType.SAS; + + @doc("SAS token") + @visibility(Lifecycle.Read) + @encodedName("application/json", "SAS") + sasToken?: string; +} + +@doc("Credentials that do not require authentication") +model NoAuthenticationCredentials extends BaseCredentials { + @doc("The credential type ") + @visibility(Lifecycle.Read) + type: CredentialType.None; +} + +// https://learn.microsoft.com/rest/api/azureml/workspace-connections/list-secrets?view=rest-azureml-2024-04-01&tabs=HTTP#ConnectionType +@doc("The Type (or category) of the connection") +union ConnectionType { + string, + + @doc("Azure OpenAI Service") + AzureOpenAI: "AzureOpenAI", //TODO: In Python this results in .AZURE_OPEN_AI. How do I make it .AZURE_OPENAI? + + @doc("Azure Blob Storage, with specified container") + AzureBlobStorage: "AzureBlob", + + @doc("Azure Blob Storage, with container not specified (used by Agents)") + AzureStorageAccount: "AzureStorageAccount", + + @doc("Azure AI Search") + AzureAISearch: "CognitiveSearch", + + @doc("CosmosDB") + CosmosDB: "CosmosDB", + + @doc("Generic connection that uses API Key authentication") + APIKey: "ApiKey", + + @doc("Application Configuration") + ApplicationConfiguration: "AppConfig", + + @doc("Application Insights") + ApplicationInsights: "AppInsights", + + @doc("Custom Keys") + Custom: "CustomKeys", +} + +@doc("The credential type used by the connection") +union CredentialType { + string, + + @doc("API Key credential") + apiKey: "ApiKey", + + @doc("Entra ID credential (formerly known as AAD)") + entraId: "AAD", + + @doc("Shared Access Signature (SAS) credential") + SAS: "SAS", + + @doc("Custom credential") + custom: "CustomKeys", + + @doc("No credential") + None: "None", +} diff --git a/specification/ai/Azure.AI.Projects/connections/routes.tsp b/specification/ai/Azure.AI.Projects/connections/routes.tsp new file mode 100644 index 000000000000..7038a2b92c07 --- /dev/null +++ b/specification/ai/Azure.AI.Projects/connections/routes.tsp @@ -0,0 +1,47 @@ +import "@typespec/rest"; +import "@azure-tools/typespec-autorest"; +import "@typespec/versioning"; +import "@azure-tools/typespec-azure-core"; +import "./models.tsp"; + +using TypeSpec.Http; +using Azure.Core.Traits; +using TypeSpec.Versioning; + +namespace Azure.AI.Projects; + +alias ConnectionServiceTraits = SupportsClientRequestId & + NoRepeatableRequests & + NoConditionalRequests; + +alias ConnectionOperations = Azure.Core.ResourceOperations; + +@added(Versions.v2025_05_01) +interface Connections { + @doc("Get a connection by name, without populating connection credentials") + get is ConnectionOperations.ResourceRead; + + @doc("Get a connection by name, with its connection credentials") + @TypeSpec.Http.post + @Rest.actionSeparator("/") + @Rest.action("getConnectionWithCredentials") + getWithCredentials is ConnectionOperations.ResourceAction< + Connection, + {}, + Connection + >; + + @doc("List all connections in the project, without populating connection credentials") + list is ConnectionOperations.ResourceList< + Connection, + ListQueryParametersTrait<{ + @doc("List connections of this specific type") + @query("connectionType") + connectionType?: ConnectionType; + + @doc("List connections that are default connections") + @query("defaultConnection") + defaultConnection?: boolean; + }> + >; +} diff --git a/specification/ai/Azure.AI.Projects/datasets/models.tsp b/specification/ai/Azure.AI.Projects/datasets/models.tsp new file mode 100644 index 000000000000..2d32aa18657b --- /dev/null +++ b/specification/ai/Azure.AI.Projects/datasets/models.tsp @@ -0,0 +1,63 @@ +import "@typespec/rest"; +import "@azure-tools/typespec-autorest"; +import "@typespec/versioning"; +import "@azure-tools/typespec-azure-core"; +import "../common/models.tsp"; +import "../main.tsp"; +import "@typespec/openapi"; +import "@typespec/versioning"; + +using TypeSpec.Versioning; + +namespace Azure.AI.Projects; + +@doc("Enum to determine the type of data.") +union DatasetType { + string, + + @doc("URI file.") + uri_file: "uri_file", + + @doc("URI folder.") + uri_folder: "uri_folder", +} + +#suppress "@azure-tools/typespec-azure-core/composition-over-inheritance" +@doc("DatasetVersion Definition") +@Rest.resource("datasets") +@discriminator("type") +@added(Versions.v2025_05_01) +model DatasetVersion { + @doc("URI of the data. Example: https://go.microsoft.com/fwlink/?linkid=2202330") + @visibility(Lifecycle.Read, Lifecycle.Create) + @minLength(1) + @pattern("[a-zA-Z0-9_]") + dataUri: string; + + @doc("Dataset type") + type: DatasetType; + + @doc("Indicates if the dataset holds a reference to the storage, or the dataset manages storage itself. If true, the underlying data will not be deleted when the dataset version is deleted") + @visibility(Lifecycle.Read) + isReference?: boolean; + + @doc("The Azure Storage Account connection name. Required if startPendingUploadVersion was not called before creating the Dataset") + @visibility(Lifecycle.Read, Lifecycle.Create) + connectionName?: string; + + ...AssetBase; +} + +@doc("FileDatasetVersion Definition") +@added(Versions.v2025_05_01) +model FileDatasetVersion extends DatasetVersion { + @doc("Dataset type") + type: DatasetType.uri_file; +} + +@doc("FileDatasetVersion Definition") +@added(Versions.v2025_05_01) +model FolderDatasetVersion extends DatasetVersion { + @doc("Dataset type") + type: DatasetType.uri_folder; +} diff --git a/specification/ai/Azure.AI.Projects/datasets/routes.tsp b/specification/ai/Azure.AI.Projects/datasets/routes.tsp new file mode 100644 index 000000000000..d899cfad1df5 --- /dev/null +++ b/specification/ai/Azure.AI.Projects/datasets/routes.tsp @@ -0,0 +1,55 @@ +import "@typespec/http"; +import "@typespec/rest"; +import "@azure-tools/typespec-autorest"; +import "@typespec/versioning"; +import "@azure-tools/typespec-azure-core"; +import "../common/models.tsp"; +import "./models.tsp"; +import "../servicepatterns.tsp"; + +using TypeSpec.Http; +using TypeSpec.Versioning; + +namespace Azure.AI.Projects; + +alias ListDatasetVersionsParameters = {}; + +#suppress "@azure-tools/typespec-azure-core/use-standard-operations" "We are using service specific operation templates" +@added(Versions.v2025_05_01) +interface Datasets + extends ServicePatterns.VersionedOperations< + DatasetVersion, + ListDatasetVersionsParameters, + ListDatasetVersionsParameters + > { + @doc("Start a new or get an existing pending upload of a dataset for a specific version.") + @Rest.action("startPendingUpload") + startPendingUploadVersion is ServicePatterns.VersionedResourceActionWithBody< + DatasetVersion, + PendingUploadRequest, + PendingUploadResponse + >; + + /* Reenable this once the service supports "unversioned" dataset operations + @doc("Start a new pending upload for a dataset. The version id will be generated by the service.") + @Rest.actionSeparator("/") + @Rest.action("startPendingUpload") + @Http.post + startPendingUpload is ServicePatterns.UnversionedResourceAction< + DatasetVersion, + PendingUploadRequest, + PendingUploadResponse + >; + */ + + #suppress "@azure-tools/typespec-azure-core/operation-missing-api-version" + #suppress "@azure-tools/typespec-azure-core/use-standard-operations" + @doc("Get the SAS credential to access the storage account associated with a Dataset version.") + @post + @Rest.action("credentials") + @Rest.actionSeparator("/") + getCredentials is ServicePatterns.VersionedResourceActionNoBody< + DatasetVersion, + AssetCredentialResponse + >; +} diff --git a/specification/ai/Azure.AI.Projects/deployments/models.tsp b/specification/ai/Azure.AI.Projects/deployments/models.tsp new file mode 100644 index 000000000000..2ae2d5923dba --- /dev/null +++ b/specification/ai/Azure.AI.Projects/deployments/models.tsp @@ -0,0 +1,84 @@ +import "@typespec/rest"; +import "@azure-tools/typespec-autorest"; +import "@typespec/versioning"; +import "@azure-tools/typespec-azure-core"; +import "../main.tsp"; +import "../common/models.tsp"; +import "@typespec/openapi"; + +using TypeSpec.Rest; +using TypeSpec.Versioning; + +namespace Azure.AI.Projects; + +@doc("Model Deployment Definition") +@resource("deployments") +@discriminator("type") +@added(Versions.v2025_05_01) +model Deployment { + @doc("The type of the deployment") + type: DeploymentType; + + @doc("Name of the deployment") + @visibility(Lifecycle.Read) + @key("name") + name: string; +} + +@doc("Model Deployment Definition") +@added(Versions.v2025_05_01) +model ModelDeployment extends Deployment { + @doc("The type of the deployment") + type: DeploymentType.ModelDeployment; + + @doc("Publisher-specific name of the deployed model") + @visibility(Lifecycle.Read) + modelName: string; + + @doc("Publisher-specific version of the deployed model") + @visibility(Lifecycle.Read) + modelVersion: string; + + @doc("Name of the deployed model's publisher") + @visibility(Lifecycle.Read) + modelPublisher: string; + + @doc("Capabilities of deployed model") + @visibility(Lifecycle.Read) + capabilities: Record; + + @doc("Sku of the model deployment") + @visibility(Lifecycle.Read) + sku: Sku; + + @doc("Name of the connection the deployment comes from") + @visibility(Lifecycle.Read) + connectionName?: string; +} + +@doc("Sku information") +@added(Versions.v2025_05_01) +model Sku { + @doc("Sku capacity") + capacity: int64; + + @doc("Sku family") + family: string; + + @doc("Sku name") + name: string; + + @doc("Sku size") + size: string; + + @doc("Sku tier") + tier: string; +} + +@added(Versions.v2025_05_01) +union DeploymentType { + string, + + @doc("Model deployment") + ModelDeployment: "ModelDeployment", +} diff --git a/specification/ai/Azure.AI.Projects/deployments/routes.tsp b/specification/ai/Azure.AI.Projects/deployments/routes.tsp new file mode 100644 index 000000000000..70782c6b7fb3 --- /dev/null +++ b/specification/ai/Azure.AI.Projects/deployments/routes.tsp @@ -0,0 +1,41 @@ +import "@typespec/rest"; +import "@azure-tools/typespec-autorest"; +import "@typespec/versioning"; +import "@azure-tools/typespec-azure-core"; +import "./models.tsp"; + +using TypeSpec.Http; +using Azure.Core.Traits; +using TypeSpec.Versioning; + +namespace Azure.AI.Projects; + +alias DeploymentServiceTraits = SupportsClientRequestId & + NoRepeatableRequests & + NoConditionalRequests; + +alias DeploymentOperations = Azure.Core.ResourceOperations; + +@added(Versions.v2025_05_01) +interface Deployments { + @doc("Get a deployed model.") + get is DeploymentOperations.ResourceRead; + + @doc("List all deployed models in the project") + list is DeploymentOperations.ResourceList< + Deployment, + ListQueryParametersTrait<{ + @doc("Model publisher to filter models by") + @query("modelPublisher") + modelPublisher?: string; + + @doc("Model name (the publisher specific name) to filter models by") + @query("modelName") + modelName?: string; + + @doc("Type of deployment to filter list by") + @query("deploymentType") + deploymentType?: DeploymentType; + }> + >; +} diff --git a/specification/ai/Azure.AI.Projects/evaluations/models.tsp b/specification/ai/Azure.AI.Projects/evaluations/models.tsp new file mode 100644 index 000000000000..1819c1b83bc0 --- /dev/null +++ b/specification/ai/Azure.AI.Projects/evaluations/models.tsp @@ -0,0 +1,178 @@ +import "@typespec/http"; +import "@typespec/rest"; +import "@azure-tools/typespec-autorest"; +import "@typespec/versioning"; +import "@azure-tools/typespec-azure-core"; +import "../common/models.tsp"; +import "../main.tsp"; +import "@typespec/openapi"; + +using TypeSpec.Rest; +using TypeSpec.Versioning; + +namespace Azure.AI.Projects; + +@doc("Evaluator Configuration") +@added(Versions.v2025_05_15_preview) +@removed(Versions.v1) +model EvaluatorConfiguration { + @doc("Identifier of the evaluator.") + id: string; + + @doc("Initialization parameters of the evaluator.") + initParams?: Record; + + @doc("Data parameters of the evaluator.") + dataMapping?: Record; +} + +#suppress "@azure-tools/typespec-azure-core/no-string-discriminator" +@doc("Abstract data class.") +@discriminator("type") +@added(Versions.v2025_05_15_preview) +@removed(Versions.v1) +model InputData { + @doc("Type of the data") + type: string; +} + +@doc("Dataset as source for evaluation.") +@added(Versions.v2025_05_15_preview) +@removed(Versions.v1) +model InputDataset extends InputData { + type: "dataset"; + + @doc("Evaluation input data") + id: string; +} + +@doc("Evaluation Definition") +@resource("runs") +@added(Versions.v2025_05_15_preview) +@removed(Versions.v1) +model Evaluation { + @doc("Identifier of the evaluation.") + @key("name") + @encodedName("application/json", "id") + @visibility(Lifecycle.Read) + name: string; + + @doc("Data for evaluation.") + data: InputData; + + @doc("Display Name for evaluation. It helps to find the evaluation easily in AI Foundry. It does not need to be unique.") + displayName?: string; + + @doc("Description of the evaluation. It can be used to store additional information about the evaluation and is mutable.") + description?: string; + + @doc("Status of the evaluation. It is set by service and is read-only.") + @visibility(Lifecycle.Read) + status?: string; + + @doc("Evaluation's tags. Unlike properties, tags are fully mutable.") + tags?: Record; + + @doc("Evaluation's properties. Unlike tags, properties are add-only. Once added, a property cannot be removed.") + properties?: Record; + + @doc("Evaluators to be used for the evaluation.") + evaluators: Record; +} + +@doc("Definition for sampling strategy.") +@added(Versions.v2025_05_15_preview) +@removed(Versions.v1) +model AgentEvaluationSamplingConfiguration { + @doc("Name of the sampling strategy.") + name: string; + + @doc("Percentage of sampling per hour (0-100).") + samplingPercent: float32; + + @doc("Maximum request rate per hour (0 to 1000).") + maxRequestRate: float32; +} + +@doc("The redaction configuration will allow the user to control what is redacted.") +@added(Versions.v2025_05_15_preview) +@removed(Versions.v1) +model AgentEvaluationRedactionConfiguration { + @doc("Redact score properties. If not specified, the default is to redact in production.") + redactScoreProperties?: boolean; +} + +@doc("Evaluation request for agent run.") +@added(Versions.v2025_05_15_preview) +@removed(Versions.v1) +model AgentEvaluationRequest { + @doc("Identifier of the agent run.") + runId: string; + + @doc("Identifier of the agent thread. This field is mandatory currently, but it will be optional in the future.") + threadId?: string; + + @doc("Evaluators to be used for the evaluation.") + evaluators: Record; + + @doc("Sampling configuration for the evaluation.") + samplingConfiguration?: AgentEvaluationSamplingConfiguration; + + @doc("Redaction configuration for the evaluation.") + redactionConfiguration?: AgentEvaluationRedactionConfiguration; + + @doc("Pass the AppInsights connection string to the agent evaluation for the evaluation results and the errors logs.") + appInsightsConnectionString: string; +} + +@doc("Result for the agent evaluation evaluator run.") +@added(Versions.v2025_05_15_preview) +@removed(Versions.v1) +model AgentEvaluationResult { + @doc("Evaluator's name. This is the name of the evaluator that was used to evaluate the agent's completion.") + evaluator: string; + + @doc("Identifier of the evaluator.") + evaluatorId: string; + + @doc("Score of the given evaluator. No restriction on range.") + score: float32; + + @doc("Status of the evaluator result. Options: Running, Completed, Failed, NotApplicable.") + status: string; + + @doc("Reasoning for the evaluation result.") + reason?: string; + + @doc("Version of the evaluator that was used to evaluate the agent's completion.") + version?: string; + + @doc("The unique identifier of the thread.") + threadId?: string; + + @doc("The unique identifier of the run.") + runId: string; + + @doc("A string explaining why there was an error, if applicable.") + error?: string; + + @doc("Additional properties relevant to the evaluator. These will differ between evaluators.") + additionalDetails?: Record; +} + +@doc("Evaluation response for agent evaluation run.") +@added(Versions.v2025_05_15_preview) +@removed(Versions.v1) +model AgentEvaluation { + @doc("Identifier of the agent evaluation run.") + id: string; + + @doc("Status of the agent evaluation. Options: Running, Completed, Failed.") + status: string; + + @doc("The reason of the request failure for the long running process, if applicable.") + error?: string; + + @doc("The agent evaluation result.") + result?: Array; +} diff --git a/specification/ai/Azure.AI.Projects/evaluations/routes.tsp b/specification/ai/Azure.AI.Projects/evaluations/routes.tsp new file mode 100644 index 000000000000..63b65ee97844 --- /dev/null +++ b/specification/ai/Azure.AI.Projects/evaluations/routes.tsp @@ -0,0 +1,54 @@ +import "@typespec/rest"; +import "@azure-tools/typespec-autorest"; +import "@typespec/versioning"; +import "@azure-tools/typespec-azure-core"; +import "./models.tsp"; + +using TypeSpec.Http; +using Azure.Core.Traits; +using TypeSpec.Versioning; + +namespace Azure.AI.Projects; + +alias ServiceTraits = SupportsClientRequestId & + NoRepeatableRequests & + NoConditionalRequests; + +alias EvaluationsOperations = Azure.Core.ResourceOperations; + +@route("evaluations") +@added(Versions.v2025_05_15_preview) +@removed(Versions.v1) +interface Evaluations { + @doc("Get an evaluation run by name.") + get is EvaluationsOperations.ResourceRead; + + @doc("List evaluation runs") + list is EvaluationsOperations.ResourceList; + + #suppress "@azure-tools/typespec-azure-core/use-standard-operations" + @doc("Creates an evaluation run.") + @route("runs:run") + @post + create is Azure.Core.Foundations.Operation< + { + @doc("Evaluation to be run") + @body + evaluation: Evaluation; + }, + ResourceCreatedResponse + >; + + #suppress "@azure-tools/typespec-azure-core/use-standard-operations" + @doc("Creates an agent evaluation run.") + @route("runs:runAgent") + @post + createAgentEvaluation is Azure.Core.Foundations.Operation< + { + @doc("Agent evaluation to be run") + @body + evaluation: AgentEvaluationRequest; + }, + ResourceCreatedResponse + >; +} diff --git a/specification/ai/Azure.AI.Projects/examples/2025-05-01/Connections_GetWithCredentials_MaximumSet_Gen.json b/specification/ai/Azure.AI.Projects/examples/2025-05-01/Connections_GetWithCredentials_MaximumSet_Gen.json new file mode 100644 index 000000000000..1d0d3182016d --- /dev/null +++ b/specification/ai/Azure.AI.Projects/examples/2025-05-01/Connections_GetWithCredentials_MaximumSet_Gen.json @@ -0,0 +1,26 @@ +{ + "title": "Connections_GetWithCredentials_MaximumSet", + "operationId": "Connections_GetWithCredentials", + "parameters": { + "api-version": "2025-05-01", + "name": "qbcgg", + "x-ms-client-request-id": "cf35b680-dc80-4815-ab83-9364acc3bce6" + }, + "responses": { + "200": { + "body": { + "name": "obsbzkgcpozwapujpylfjqwqpbeol", + "id": "unique-id", + "type": "AzureOpenAI", + "target": "rkznadqxuwnkbtb", + "isDefault": true, + "credentials": { + "type": "BaseCredentials" + }, + "metadata": { + "key8920": "utjp" + } + } + } + } +} diff --git a/specification/ai/Azure.AI.Projects/examples/2025-05-01/Connections_Get_MaximumSet_Gen.json b/specification/ai/Azure.AI.Projects/examples/2025-05-01/Connections_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..50b34ecfe931 --- /dev/null +++ b/specification/ai/Azure.AI.Projects/examples/2025-05-01/Connections_Get_MaximumSet_Gen.json @@ -0,0 +1,26 @@ +{ + "title": "Connections_Get_MaximumSet", + "operationId": "Connections_Get", + "parameters": { + "api-version": "2025-05-01", + "name": "dbxtef", + "x-ms-client-request-id": "cf35b680-dc80-4815-ab83-9364acc3bce6" + }, + "responses": { + "200": { + "body": { + "name": "obsbzkgcpozwapujpylfjqwqpbeol", + "id": "unique-id", + "type": "AzureOpenAI", + "target": "rkznadqxuwnkbtb", + "isDefault": true, + "credentials": { + "type": "BaseCredentials" + }, + "metadata": { + "key8920": "utjp" + } + } + } + } +} diff --git a/specification/ai/Azure.AI.Projects/examples/2025-05-01/Connections_List_MaximumSet_Gen.json b/specification/ai/Azure.AI.Projects/examples/2025-05-01/Connections_List_MaximumSet_Gen.json new file mode 100644 index 000000000000..0941fa337118 --- /dev/null +++ b/specification/ai/Azure.AI.Projects/examples/2025-05-01/Connections_List_MaximumSet_Gen.json @@ -0,0 +1,35 @@ +{ + "title": "Connections_List_MaximumSet", + "operationId": "Connections_List", + "parameters": { + "api-version": "2025-05-01", + "connectionType": "AzureOpenAI", + "defaultConnection": true, + "top": 29, + "skip": 27, + "maxpagesize": 25, + "x-ms-client-request-id": "cf35b680-dc80-4815-ab83-9364acc3bce6" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "obsbzkgcpozwapujpylfjqwqpbeol", + "id": "unique-id", + "type": "AzureOpenAI", + "target": "rkznadqxuwnkbtb", + "isDefault": true, + "credentials": { + "type": "BaseCredentials" + }, + "metadata": { + "key8920": "utjp" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/ai/Azure.AI.Projects/examples/2025-05-01/Datasets_CreateOrUpdateVersion_MaximumSet_Gen.json b/specification/ai/Azure.AI.Projects/examples/2025-05-01/Datasets_CreateOrUpdateVersion_MaximumSet_Gen.json new file mode 100644 index 000000000000..ac5689cf7bf9 --- /dev/null +++ b/specification/ai/Azure.AI.Projects/examples/2025-05-01/Datasets_CreateOrUpdateVersion_MaximumSet_Gen.json @@ -0,0 +1,39 @@ +{ + "title": "Datasets_CreateOrUpdateVersion_MaximumSet", + "operationId": "Datasets_CreateOrUpdateVersion", + "parameters": { + "api-version": "2025-05-01", + "name": "grpenjfobadxmsceuqwunwqn", + "version": "dfo", + "body": { + "dataUri": "Replace this value with a string matching RegExp [a-zA-Z0-9_]", + "type": "DatasetVersion", + "description": "zukluwbmoq", + "tags": { + "key8794": "ietydcqbwiebstkxrmqzsadlraapox" + } + } + }, + "responses": { + "200": { + "body": { + "dataUri": "Replace this value with a string matching RegExp [a-zA-Z0-9_]", + "type": "DatasetVersion", + "isReference": true, + "id": "nneuypway", + "name": "qnagvpitbcc", + "version": "vcdlshlzkzyuocakljbdjkaasc" + } + }, + "201": { + "body": { + "dataUri": "Replace this value with a string matching RegExp [a-zA-Z0-9_]", + "type": "DatasetVersion", + "isReference": true, + "id": "nneuypway", + "name": "qnagvpitbcc", + "version": "vcdlshlzkzyuocakljbdjkaasc" + } + } + } +} diff --git a/specification/ai/Azure.AI.Projects/examples/2025-05-01/Datasets_CreateOrUpdateVersion_MinimumSet_Gen.json b/specification/ai/Azure.AI.Projects/examples/2025-05-01/Datasets_CreateOrUpdateVersion_MinimumSet_Gen.json new file mode 100644 index 000000000000..b9dce746b790 --- /dev/null +++ b/specification/ai/Azure.AI.Projects/examples/2025-05-01/Datasets_CreateOrUpdateVersion_MinimumSet_Gen.json @@ -0,0 +1,31 @@ +{ + "title": "Datasets_CreateOrUpdateVersion_MinimumSet", + "operationId": "Datasets_CreateOrUpdateVersion", + "parameters": { + "api-version": "2025-05-01", + "name": "rpnyigsqddnpdmrboazyi", + "version": "iplgbfirylwervrnglnnbwwzodsm", + "body": { + "type": "DatasetVersion", + "dataUri": "Replace this value with a string matching RegExp [a-zA-Z0-9_]" + } + }, + "responses": { + "200": { + "body": { + "dataUri": "Replace this value with a string matching RegExp [a-zA-Z0-9_]", + "type": "DatasetVersion", + "name": "qnagvpitbcc", + "version": "vcdlshlzkzyuocakljbdjkaasc" + } + }, + "201": { + "body": { + "dataUri": "Replace this value with a string matching RegExp [a-zA-Z0-9_]", + "type": "DatasetVersion", + "name": "qnagvpitbcc", + "version": "vcdlshlzkzyuocakljbdjkaasc" + } + } + } +} diff --git a/specification/ai/Azure.AI.Projects/examples/2025-05-01/Datasets_DeleteVersion_MaximumSet_Gen.json b/specification/ai/Azure.AI.Projects/examples/2025-05-01/Datasets_DeleteVersion_MaximumSet_Gen.json new file mode 100644 index 000000000000..dd4eed294b2d --- /dev/null +++ b/specification/ai/Azure.AI.Projects/examples/2025-05-01/Datasets_DeleteVersion_MaximumSet_Gen.json @@ -0,0 +1,12 @@ +{ + "title": "Datasets_DeleteVersion_MaximumSet", + "operationId": "Datasets_DeleteVersion", + "parameters": { + "api-version": "2025-05-01", + "name": "ucurctiifkgnlmfsqjdqikngh", + "version": "ynxklccaehey" + }, + "responses": { + "204": {} + } +} diff --git a/specification/ai/Azure.AI.Projects/examples/2025-05-01/Datasets_DeleteVersion_MinimumSet_Gen.json b/specification/ai/Azure.AI.Projects/examples/2025-05-01/Datasets_DeleteVersion_MinimumSet_Gen.json new file mode 100644 index 000000000000..feddeb285bba --- /dev/null +++ b/specification/ai/Azure.AI.Projects/examples/2025-05-01/Datasets_DeleteVersion_MinimumSet_Gen.json @@ -0,0 +1,12 @@ +{ + "title": "Datasets_DeleteVersion_MinimumSet", + "operationId": "Datasets_DeleteVersion", + "parameters": { + "api-version": "2025-05-01", + "name": "mah", + "version": "cyvuzcdcozazi" + }, + "responses": { + "204": {} + } +} diff --git a/specification/ai/Azure.AI.Projects/examples/2025-05-01/Datasets_GetCredentials_MaximumSet_Gen.json b/specification/ai/Azure.AI.Projects/examples/2025-05-01/Datasets_GetCredentials_MaximumSet_Gen.json new file mode 100644 index 000000000000..7f1a1fc3d0a0 --- /dev/null +++ b/specification/ai/Azure.AI.Projects/examples/2025-05-01/Datasets_GetCredentials_MaximumSet_Gen.json @@ -0,0 +1,24 @@ +{ + "title": "Datasets_GetCredentials_MaximumSet", + "operationId": "Datasets_GetCredentials", + "parameters": { + "api-version": "2025-05-01", + "name": "ianzqjcpdiabrxkrbnstbpwlzavrmh", + "version": "nekh", + "body": {} + }, + "responses": { + "200": { + "body": { + "blobReference": { + "blobUri": "wvqzlobwdzstxryhnlqqtvp", + "storageAccountArmId": "br", + "credential": { + "sasUri": "qw", + "type": "SAS" + } + } + } + } + } +} diff --git a/specification/ai/Azure.AI.Projects/examples/2025-05-01/Datasets_GetCredentials_MinimumSet_Gen.json b/specification/ai/Azure.AI.Projects/examples/2025-05-01/Datasets_GetCredentials_MinimumSet_Gen.json new file mode 100644 index 000000000000..697c2a12a07f --- /dev/null +++ b/specification/ai/Azure.AI.Projects/examples/2025-05-01/Datasets_GetCredentials_MinimumSet_Gen.json @@ -0,0 +1,24 @@ +{ + "title": "Datasets_GetCredentials_MinimumSet", + "operationId": "Datasets_GetCredentials", + "parameters": { + "api-version": "2025-05-01", + "name": "nydfjjrnlgs", + "version": "wskb", + "body": {} + }, + "responses": { + "200": { + "body": { + "blobReference": { + "blobUri": "wvqzlobwdzstxryhnlqqtvp", + "storageAccountArmId": "br", + "credential": { + "sasUri": "qw", + "type": "SAS" + } + } + } + } + } +} diff --git a/specification/ai/Azure.AI.Projects/examples/2025-05-01/Datasets_GetVersion_MaximumSet_Gen.json b/specification/ai/Azure.AI.Projects/examples/2025-05-01/Datasets_GetVersion_MaximumSet_Gen.json new file mode 100644 index 000000000000..ae873e09f984 --- /dev/null +++ b/specification/ai/Azure.AI.Projects/examples/2025-05-01/Datasets_GetVersion_MaximumSet_Gen.json @@ -0,0 +1,21 @@ +{ + "title": "Datasets_GetVersion_MaximumSet", + "operationId": "Datasets_GetVersion", + "parameters": { + "api-version": "2025-05-01", + "name": "nynmsupycdzwlieanjigzvfcsxhghr", + "version": "efrsah" + }, + "responses": { + "200": { + "body": { + "dataUri": "Replace this value with a string matching RegExp [a-zA-Z0-9_]", + "type": "DatasetVersion", + "isReference": true, + "id": "nneuypway", + "name": "qnagvpitbcc", + "version": "vcdlshlzkzyuocakljbdjkaasc" + } + } + } +} diff --git a/specification/ai/Azure.AI.Projects/examples/2025-05-01/Datasets_GetVersion_MinimumSet_Gen.json b/specification/ai/Azure.AI.Projects/examples/2025-05-01/Datasets_GetVersion_MinimumSet_Gen.json new file mode 100644 index 000000000000..704b7791d6c5 --- /dev/null +++ b/specification/ai/Azure.AI.Projects/examples/2025-05-01/Datasets_GetVersion_MinimumSet_Gen.json @@ -0,0 +1,19 @@ +{ + "title": "Datasets_GetVersion_MinimumSet", + "operationId": "Datasets_GetVersion", + "parameters": { + "api-version": "2025-05-01", + "name": "nphjhqczjtdfwoxwuhcsnvfawmq", + "version": "itpmqdpptvnubbkihc" + }, + "responses": { + "200": { + "body": { + "dataUri": "Replace this value with a string matching RegExp [a-zA-Z0-9_]", + "type": "DatasetVersion", + "name": "qnagvpitbcc", + "version": "vcdlshlzkzyuocakljbdjkaasc" + } + } + } +} diff --git a/specification/ai/Azure.AI.Projects/examples/2025-05-01/Datasets_ListLatest_MaximumSet_Gen.json b/specification/ai/Azure.AI.Projects/examples/2025-05-01/Datasets_ListLatest_MaximumSet_Gen.json new file mode 100644 index 000000000000..85f841a8d488 --- /dev/null +++ b/specification/ai/Azure.AI.Projects/examples/2025-05-01/Datasets_ListLatest_MaximumSet_Gen.json @@ -0,0 +1,28 @@ +{ + "title": "Datasets_ListLatest_MaximumSet", + "operationId": "Datasets_ListLatest", + "parameters": { + "api-version": "2025-05-01", + "top": 21, + "skip": "eprtlgapqpuxmkqqbyqgatazgk", + "tags": "mvcivdyuolnhvpuqdp", + "listViewType": "ActiveOnly" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "dataUri": "Replace this value with a string matching RegExp [a-zA-Z0-9_]", + "type": "DatasetVersion", + "isReference": true, + "id": "nneuypway", + "name": "qnagvpitbcc", + "version": "vcdlshlzkzyuocakljbdjkaasc" + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/ai/Azure.AI.Projects/examples/2025-05-01/Datasets_ListLatest_MinimumSet_Gen.json b/specification/ai/Azure.AI.Projects/examples/2025-05-01/Datasets_ListLatest_MinimumSet_Gen.json new file mode 100644 index 000000000000..f76f06e31a8c --- /dev/null +++ b/specification/ai/Azure.AI.Projects/examples/2025-05-01/Datasets_ListLatest_MinimumSet_Gen.json @@ -0,0 +1,21 @@ +{ + "title": "Datasets_ListLatest_MinimumSet", + "operationId": "Datasets_ListLatest", + "parameters": { + "api-version": "2025-05-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "dataUri": "Replace this value with a string matching RegExp [a-zA-Z0-9_]", + "type": "DatasetVersion", + "name": "qnagvpitbcc", + "version": "vcdlshlzkzyuocakljbdjkaasc" + } + ] + } + } + } +} diff --git a/specification/ai/Azure.AI.Projects/examples/2025-05-01/Datasets_ListVersions_MaximumSet_Gen.json b/specification/ai/Azure.AI.Projects/examples/2025-05-01/Datasets_ListVersions_MaximumSet_Gen.json new file mode 100644 index 000000000000..dcfefdba5120 --- /dev/null +++ b/specification/ai/Azure.AI.Projects/examples/2025-05-01/Datasets_ListVersions_MaximumSet_Gen.json @@ -0,0 +1,29 @@ +{ + "title": "Datasets_ListVersions_MaximumSet", + "operationId": "Datasets_ListVersions", + "parameters": { + "api-version": "2025-05-01", + "name": "qjknijsjewu", + "top": 13, + "skip": "wwwo", + "tags": "nfxvn", + "listViewType": "ActiveOnly" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "dataUri": "Replace this value with a string matching RegExp [a-zA-Z0-9_]", + "type": "DatasetVersion", + "isReference": true, + "id": "nneuypway", + "name": "qnagvpitbcc", + "version": "vcdlshlzkzyuocakljbdjkaasc" + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/ai/Azure.AI.Projects/examples/2025-05-01/Datasets_ListVersions_MinimumSet_Gen.json b/specification/ai/Azure.AI.Projects/examples/2025-05-01/Datasets_ListVersions_MinimumSet_Gen.json new file mode 100644 index 000000000000..176b7e2e7237 --- /dev/null +++ b/specification/ai/Azure.AI.Projects/examples/2025-05-01/Datasets_ListVersions_MinimumSet_Gen.json @@ -0,0 +1,22 @@ +{ + "title": "Datasets_ListVersions_MinimumSet", + "operationId": "Datasets_ListVersions", + "parameters": { + "api-version": "2025-05-01", + "name": "qcoxe" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "dataUri": "Replace this value with a string matching RegExp [a-zA-Z0-9_]", + "type": "DatasetVersion", + "name": "qnagvpitbcc", + "version": "vcdlshlzkzyuocakljbdjkaasc" + } + ] + } + } + } +} diff --git a/specification/ai/Azure.AI.Projects/examples/2025-05-01/Datasets_StartPendingUploadVersion_MaximumSet_Gen.json b/specification/ai/Azure.AI.Projects/examples/2025-05-01/Datasets_StartPendingUploadVersion_MaximumSet_Gen.json new file mode 100644 index 000000000000..084b9473a76d --- /dev/null +++ b/specification/ai/Azure.AI.Projects/examples/2025-05-01/Datasets_StartPendingUploadVersion_MaximumSet_Gen.json @@ -0,0 +1,31 @@ +{ + "title": "Datasets_StartPendingUploadVersion_MaximumSet", + "operationId": "Datasets_StartPendingUploadVersion", + "parameters": { + "api-version": "2025-05-01", + "name": "hvusmygqjnkihfwprkw", + "version": "zcrxyums", + "body": { + "pendingUploadId": "cnvf", + "connectionName": "qepjjlfgjlcalfuhchnojqlzhzrtcj", + "pendingUploadType": "BlobReference" + } + }, + "responses": { + "200": { + "body": { + "blobReference": { + "blobUri": "wvqzlobwdzstxryhnlqqtvp", + "storageAccountArmId": "br", + "credential": { + "sasUri": "qw", + "type": "SAS" + } + }, + "pendingUploadId": "mdhrbpu", + "version": "qbbmljwtqwhbgdcajnywtky", + "pendingUploadType": "BlobReference" + } + } + } +} diff --git a/specification/ai/Azure.AI.Projects/examples/2025-05-01/Datasets_StartPendingUploadVersion_MinimumSet_Gen.json b/specification/ai/Azure.AI.Projects/examples/2025-05-01/Datasets_StartPendingUploadVersion_MinimumSet_Gen.json new file mode 100644 index 000000000000..d7100cf468ab --- /dev/null +++ b/specification/ai/Azure.AI.Projects/examples/2025-05-01/Datasets_StartPendingUploadVersion_MinimumSet_Gen.json @@ -0,0 +1,28 @@ +{ + "title": "Datasets_StartPendingUploadVersion_MinimumSet", + "operationId": "Datasets_StartPendingUploadVersion", + "parameters": { + "api-version": "2025-05-01", + "name": "esicohztsytnvxxqcpzsxnesug", + "version": "rrwerwxmkfuewptwsxeylxrcjkcp", + "body": { + "pendingUploadType": "BlobReference" + } + }, + "responses": { + "200": { + "body": { + "blobReference": { + "blobUri": "wvqzlobwdzstxryhnlqqtvp", + "storageAccountArmId": "br", + "credential": { + "sasUri": "qw", + "type": "SAS" + } + }, + "pendingUploadId": "mdhrbpu", + "pendingUploadType": "BlobReference" + } + } + } +} diff --git a/specification/ai/Azure.AI.Projects/examples/2025-05-01/Deployments_Get_MaximumSet_Gen.json b/specification/ai/Azure.AI.Projects/examples/2025-05-01/Deployments_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..e054205d8864 --- /dev/null +++ b/specification/ai/Azure.AI.Projects/examples/2025-05-01/Deployments_Get_MaximumSet_Gen.json @@ -0,0 +1,17 @@ +{ + "title": "Deployments_Get_MaximumSet", + "operationId": "Deployments_Get", + "parameters": { + "api-version": "2025-05-01", + "name": "asyfxhswpjdjtjjwrkhyxmoljgml", + "x-ms-client-request-id": "cf35b680-dc80-4815-ab83-9364acc3bce6" + }, + "responses": { + "200": { + "body": { + "type": "Deployment", + "name": "aof" + } + } + } +} diff --git a/specification/ai/Azure.AI.Projects/examples/2025-05-01/Deployments_List_MaximumSet_Gen.json b/specification/ai/Azure.AI.Projects/examples/2025-05-01/Deployments_List_MaximumSet_Gen.json new file mode 100644 index 000000000000..dfc8c3e12f85 --- /dev/null +++ b/specification/ai/Azure.AI.Projects/examples/2025-05-01/Deployments_List_MaximumSet_Gen.json @@ -0,0 +1,26 @@ +{ + "title": "Deployments_List_MaximumSet", + "operationId": "Deployments_List", + "parameters": { + "api-version": "2025-05-01", + "modelPublisher": "wpfjkjrmkxihi", + "modelName": "lxhwhobkjsyhnfvhfyqhymgosytke", + "top": 29, + "skip": 27, + "maxpagesize": 25, + "x-ms-client-request-id": "cf35b680-dc80-4815-ab83-9364acc3bce6" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "type": "Deployment", + "name": "aof" + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/ai/Azure.AI.Projects/examples/2025-05-01/Indexes_CreateOrUpdateVersion_MaximumSet_Gen.json b/specification/ai/Azure.AI.Projects/examples/2025-05-01/Indexes_CreateOrUpdateVersion_MaximumSet_Gen.json new file mode 100644 index 000000000000..35dc866fade1 --- /dev/null +++ b/specification/ai/Azure.AI.Projects/examples/2025-05-01/Indexes_CreateOrUpdateVersion_MaximumSet_Gen.json @@ -0,0 +1,34 @@ +{ + "title": "Indexes_CreateOrUpdateVersion_MaximumSet", + "operationId": "Indexes_CreateOrUpdateVersion", + "parameters": { + "api-version": "2025-05-01", + "name": "qlslwpztrobxh", + "version": "lvwrjftywgtfixhxoxbmcs", + "body": { + "type": "Index", + "description": "fvbkomalkxkj", + "tags": { + "key8738": "gmejegbwwrkawbdxuv" + } + } + }, + "responses": { + "200": { + "body": { + "type": "Index", + "id": "ivqkxhapawoqvjiksau", + "name": "mfyjvkkukqfgrzlqtzfbtuldr", + "version": "qrygnibzlcruksqvwa" + } + }, + "201": { + "body": { + "type": "Index", + "id": "ivqkxhapawoqvjiksau", + "name": "mfyjvkkukqfgrzlqtzfbtuldr", + "version": "qrygnibzlcruksqvwa" + } + } + } +} diff --git a/specification/ai/Azure.AI.Projects/examples/2025-05-01/Indexes_CreateOrUpdateVersion_MinimumSet_Gen.json b/specification/ai/Azure.AI.Projects/examples/2025-05-01/Indexes_CreateOrUpdateVersion_MinimumSet_Gen.json new file mode 100644 index 000000000000..96d3b1f77ded --- /dev/null +++ b/specification/ai/Azure.AI.Projects/examples/2025-05-01/Indexes_CreateOrUpdateVersion_MinimumSet_Gen.json @@ -0,0 +1,28 @@ +{ + "title": "Indexes_CreateOrUpdateVersion_MinimumSet", + "operationId": "Indexes_CreateOrUpdateVersion", + "parameters": { + "api-version": "2025-05-01", + "name": "ypkrjjvche", + "version": "gmorfjnfnwawvkwsjsodunylq", + "body": { + "type": "Index" + } + }, + "responses": { + "200": { + "body": { + "type": "Index", + "name": "mfyjvkkukqfgrzlqtzfbtuldr", + "version": "qrygnibzlcruksqvwa" + } + }, + "201": { + "body": { + "type": "Index", + "name": "mfyjvkkukqfgrzlqtzfbtuldr", + "version": "qrygnibzlcruksqvwa" + } + } + } +} diff --git a/specification/ai/Azure.AI.Projects/examples/2025-05-01/Indexes_DeleteVersion_MaximumSet_Gen.json b/specification/ai/Azure.AI.Projects/examples/2025-05-01/Indexes_DeleteVersion_MaximumSet_Gen.json new file mode 100644 index 000000000000..f2cb9986c7ab --- /dev/null +++ b/specification/ai/Azure.AI.Projects/examples/2025-05-01/Indexes_DeleteVersion_MaximumSet_Gen.json @@ -0,0 +1,12 @@ +{ + "title": "Indexes_DeleteVersion_MaximumSet", + "operationId": "Indexes_DeleteVersion", + "parameters": { + "api-version": "2025-05-01", + "name": "djofiby", + "version": "wjcqszxbshmfcspufpvusvijabosg" + }, + "responses": { + "204": {} + } +} diff --git a/specification/ai/Azure.AI.Projects/examples/2025-05-01/Indexes_DeleteVersion_MinimumSet_Gen.json b/specification/ai/Azure.AI.Projects/examples/2025-05-01/Indexes_DeleteVersion_MinimumSet_Gen.json new file mode 100644 index 000000000000..a2aad4e2cffe --- /dev/null +++ b/specification/ai/Azure.AI.Projects/examples/2025-05-01/Indexes_DeleteVersion_MinimumSet_Gen.json @@ -0,0 +1,12 @@ +{ + "title": "Indexes_DeleteVersion_MinimumSet", + "operationId": "Indexes_DeleteVersion", + "parameters": { + "api-version": "2025-05-01", + "name": "bhjawuegimffqwlhrxtbbeohdplmw", + "version": "o" + }, + "responses": { + "204": {} + } +} diff --git a/specification/ai/Azure.AI.Projects/examples/2025-05-01/Indexes_GetVersion_MaximumSet_Gen.json b/specification/ai/Azure.AI.Projects/examples/2025-05-01/Indexes_GetVersion_MaximumSet_Gen.json new file mode 100644 index 000000000000..641bb03093fa --- /dev/null +++ b/specification/ai/Azure.AI.Projects/examples/2025-05-01/Indexes_GetVersion_MaximumSet_Gen.json @@ -0,0 +1,19 @@ +{ + "title": "Indexes_GetVersion_MaximumSet", + "operationId": "Indexes_GetVersion", + "parameters": { + "api-version": "2025-05-01", + "name": "nsgckjrartmxxbuc", + "version": "zplpqeeluwtxx" + }, + "responses": { + "200": { + "body": { + "type": "Index", + "id": "ivqkxhapawoqvjiksau", + "name": "mfyjvkkukqfgrzlqtzfbtuldr", + "version": "qrygnibzlcruksqvwa" + } + } + } +} diff --git a/specification/ai/Azure.AI.Projects/examples/2025-05-01/Indexes_GetVersion_MinimumSet_Gen.json b/specification/ai/Azure.AI.Projects/examples/2025-05-01/Indexes_GetVersion_MinimumSet_Gen.json new file mode 100644 index 000000000000..e1d022748151 --- /dev/null +++ b/specification/ai/Azure.AI.Projects/examples/2025-05-01/Indexes_GetVersion_MinimumSet_Gen.json @@ -0,0 +1,18 @@ +{ + "title": "Indexes_GetVersion_MinimumSet", + "operationId": "Indexes_GetVersion", + "parameters": { + "api-version": "2025-05-01", + "name": "ssadrgeajxmatjfcakqfxm", + "version": "ckqhgdasokotj" + }, + "responses": { + "200": { + "body": { + "type": "Index", + "name": "mfyjvkkukqfgrzlqtzfbtuldr", + "version": "qrygnibzlcruksqvwa" + } + } + } +} diff --git a/specification/ai/Azure.AI.Projects/examples/2025-05-01/Indexes_ListLatest_MaximumSet_Gen.json b/specification/ai/Azure.AI.Projects/examples/2025-05-01/Indexes_ListLatest_MaximumSet_Gen.json new file mode 100644 index 000000000000..1e185187835c --- /dev/null +++ b/specification/ai/Azure.AI.Projects/examples/2025-05-01/Indexes_ListLatest_MaximumSet_Gen.json @@ -0,0 +1,26 @@ +{ + "title": "Indexes_ListLatest_MaximumSet", + "operationId": "Indexes_ListLatest", + "parameters": { + "api-version": "2025-05-01", + "top": 27, + "skip": "pjv", + "tags": "v", + "listViewType": "ActiveOnly" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "type": "Index", + "id": "ivqkxhapawoqvjiksau", + "name": "mfyjvkkukqfgrzlqtzfbtuldr", + "version": "qrygnibzlcruksqvwa" + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/ai/Azure.AI.Projects/examples/2025-05-01/Indexes_ListLatest_MinimumSet_Gen.json b/specification/ai/Azure.AI.Projects/examples/2025-05-01/Indexes_ListLatest_MinimumSet_Gen.json new file mode 100644 index 000000000000..5b993cdaa80f --- /dev/null +++ b/specification/ai/Azure.AI.Projects/examples/2025-05-01/Indexes_ListLatest_MinimumSet_Gen.json @@ -0,0 +1,20 @@ +{ + "title": "Indexes_ListLatest_MinimumSet", + "operationId": "Indexes_ListLatest", + "parameters": { + "api-version": "2025-05-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "type": "Index", + "name": "mfyjvkkukqfgrzlqtzfbtuldr", + "version": "qrygnibzlcruksqvwa" + } + ] + } + } + } +} diff --git a/specification/ai/Azure.AI.Projects/examples/2025-05-01/Indexes_ListVersions_MaximumSet_Gen.json b/specification/ai/Azure.AI.Projects/examples/2025-05-01/Indexes_ListVersions_MaximumSet_Gen.json new file mode 100644 index 000000000000..c2d1bda61ccf --- /dev/null +++ b/specification/ai/Azure.AI.Projects/examples/2025-05-01/Indexes_ListVersions_MaximumSet_Gen.json @@ -0,0 +1,27 @@ +{ + "title": "Indexes_ListVersions_MaximumSet", + "operationId": "Indexes_ListVersions", + "parameters": { + "api-version": "2025-05-01", + "name": "ympfyjkrpvirlqqfcwbrrmebc", + "top": 1, + "skip": "emybimaziwnaxdvk", + "tags": "bhuogyiydomalwcj", + "listViewType": "ActiveOnly" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "type": "Index", + "id": "ivqkxhapawoqvjiksau", + "name": "mfyjvkkukqfgrzlqtzfbtuldr", + "version": "qrygnibzlcruksqvwa" + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/ai/Azure.AI.Projects/examples/2025-05-01/Indexes_ListVersions_MinimumSet_Gen.json b/specification/ai/Azure.AI.Projects/examples/2025-05-01/Indexes_ListVersions_MinimumSet_Gen.json new file mode 100644 index 000000000000..767f7c24591e --- /dev/null +++ b/specification/ai/Azure.AI.Projects/examples/2025-05-01/Indexes_ListVersions_MinimumSet_Gen.json @@ -0,0 +1,21 @@ +{ + "title": "Indexes_ListVersions_MinimumSet", + "operationId": "Indexes_ListVersions", + "parameters": { + "api-version": "2025-05-01", + "name": "sgpbxddgmugf" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "type": "Index", + "name": "mfyjvkkukqfgrzlqtzfbtuldr", + "version": "qrygnibzlcruksqvwa" + } + ] + } + } + } +} diff --git a/specification/ai/Azure.AI.Projects/examples/2025-05-15-preview/Connections_GetWithCredentials_MaximumSet_Gen.json b/specification/ai/Azure.AI.Projects/examples/2025-05-15-preview/Connections_GetWithCredentials_MaximumSet_Gen.json new file mode 100644 index 000000000000..18e95663b43e --- /dev/null +++ b/specification/ai/Azure.AI.Projects/examples/2025-05-15-preview/Connections_GetWithCredentials_MaximumSet_Gen.json @@ -0,0 +1,26 @@ +{ + "title": "Connections_GetWithCredentials_MaximumSet", + "operationId": "Connections_GetWithCredentials", + "parameters": { + "api-version": "2025-05-15-preview", + "name": "bblabqcnrjcbxlyjsejqiyixfoil", + "x-ms-client-request-id": "cf35b680-dc80-4815-ab83-9364acc3bce6" + }, + "responses": { + "200": { + "body": { + "name": "cpezssfnwhl", + "id": "unique-id", + "type": "AzureOpenAI", + "target": "gxrgfvtt", + "isDefault": true, + "credentials": { + "type": "BaseCredentials" + }, + "metadata": { + "key2930": "uovt" + } + } + } + } +} diff --git a/specification/ai/Azure.AI.Projects/examples/2025-05-15-preview/Connections_Get_MaximumSet_Gen.json b/specification/ai/Azure.AI.Projects/examples/2025-05-15-preview/Connections_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..9cb4ecf222bb --- /dev/null +++ b/specification/ai/Azure.AI.Projects/examples/2025-05-15-preview/Connections_Get_MaximumSet_Gen.json @@ -0,0 +1,26 @@ +{ + "title": "Connections_Get_MaximumSet", + "operationId": "Connections_Get", + "parameters": { + "api-version": "2025-05-15-preview", + "name": "ijxjmv", + "x-ms-client-request-id": "cf35b680-dc80-4815-ab83-9364acc3bce6" + }, + "responses": { + "200": { + "body": { + "name": "cpezssfnwhl", + "id": "unique-id", + "type": "AzureOpenAI", + "target": "gxrgfvtt", + "isDefault": true, + "credentials": { + "type": "BaseCredentials" + }, + "metadata": { + "key2930": "uovt" + } + } + } + } +} diff --git a/specification/ai/Azure.AI.Projects/examples/2025-05-15-preview/Connections_List_MaximumSet_Gen.json b/specification/ai/Azure.AI.Projects/examples/2025-05-15-preview/Connections_List_MaximumSet_Gen.json new file mode 100644 index 000000000000..564378be28f9 --- /dev/null +++ b/specification/ai/Azure.AI.Projects/examples/2025-05-15-preview/Connections_List_MaximumSet_Gen.json @@ -0,0 +1,35 @@ +{ + "title": "Connections_List_MaximumSet", + "operationId": "Connections_List", + "parameters": { + "api-version": "2025-05-15-preview", + "connectionType": "AzureOpenAI", + "defaultConnection": true, + "top": 28, + "skip": 8, + "maxpagesize": 21, + "x-ms-client-request-id": "cf35b680-dc80-4815-ab83-9364acc3bce6" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "cpezssfnwhl", + "id": "unique-id", + "type": "AzureOpenAI", + "target": "gxrgfvtt", + "isDefault": true, + "credentials": { + "type": "BaseCredentials" + }, + "metadata": { + "key2930": "uovt" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/ai/Azure.AI.Projects/examples/2025-05-15-preview/Datasets_CreateOrUpdateVersion_MaximumSet_Gen.json b/specification/ai/Azure.AI.Projects/examples/2025-05-15-preview/Datasets_CreateOrUpdateVersion_MaximumSet_Gen.json new file mode 100644 index 000000000000..412da74f51ba --- /dev/null +++ b/specification/ai/Azure.AI.Projects/examples/2025-05-15-preview/Datasets_CreateOrUpdateVersion_MaximumSet_Gen.json @@ -0,0 +1,39 @@ +{ + "title": "Datasets_CreateOrUpdateVersion_MaximumSet", + "operationId": "Datasets_CreateOrUpdateVersion", + "parameters": { + "api-version": "2025-05-15-preview", + "name": "vfupg", + "version": "ecacrnqtmggfqsocagocpf", + "body": { + "dataUri": "Replace this value with a string matching RegExp [a-zA-Z0-9_]", + "type": "DatasetVersion", + "description": "u", + "tags": { + "key7559": "ybrhnrxopsvmxqxibvysedlsy" + } + } + }, + "responses": { + "200": { + "body": { + "dataUri": "Replace this value with a string matching RegExp [a-zA-Z0-9_]", + "type": "DatasetVersion", + "isReference": true, + "id": "hvpdyfpeoqcl", + "name": "xtdmvwhhobloqqsovgpynsnow", + "version": "eaixzft" + } + }, + "201": { + "body": { + "dataUri": "Replace this value with a string matching RegExp [a-zA-Z0-9_]", + "type": "DatasetVersion", + "isReference": true, + "id": "hvpdyfpeoqcl", + "name": "xtdmvwhhobloqqsovgpynsnow", + "version": "eaixzft" + } + } + } +} diff --git a/specification/ai/Azure.AI.Projects/examples/2025-05-15-preview/Datasets_CreateOrUpdateVersion_MinimumSet_Gen.json b/specification/ai/Azure.AI.Projects/examples/2025-05-15-preview/Datasets_CreateOrUpdateVersion_MinimumSet_Gen.json new file mode 100644 index 000000000000..ce5e5dbe9e0b --- /dev/null +++ b/specification/ai/Azure.AI.Projects/examples/2025-05-15-preview/Datasets_CreateOrUpdateVersion_MinimumSet_Gen.json @@ -0,0 +1,31 @@ +{ + "title": "Datasets_CreateOrUpdateVersion_MinimumSet", + "operationId": "Datasets_CreateOrUpdateVersion", + "parameters": { + "api-version": "2025-05-15-preview", + "name": "ryqozexodzklgkffokixpftfkcy", + "version": "vldbiveryfmysxuzw", + "body": { + "dataUri": "Replace this value with a string matching RegExp [a-zA-Z0-9_]", + "type": "DatasetVersion" + } + }, + "responses": { + "200": { + "body": { + "dataUri": "Replace this value with a string matching RegExp [a-zA-Z0-9_]", + "type": "DatasetVersion", + "name": "xtdmvwhhobloqqsovgpynsnow", + "version": "eaixzft" + } + }, + "201": { + "body": { + "dataUri": "Replace this value with a string matching RegExp [a-zA-Z0-9_]", + "type": "DatasetVersion", + "name": "xtdmvwhhobloqqsovgpynsnow", + "version": "eaixzft" + } + } + } +} diff --git a/specification/ai/Azure.AI.Projects/examples/2025-05-15-preview/Datasets_DeleteVersion_MaximumSet_Gen.json b/specification/ai/Azure.AI.Projects/examples/2025-05-15-preview/Datasets_DeleteVersion_MaximumSet_Gen.json new file mode 100644 index 000000000000..76dd33d1cd39 --- /dev/null +++ b/specification/ai/Azure.AI.Projects/examples/2025-05-15-preview/Datasets_DeleteVersion_MaximumSet_Gen.json @@ -0,0 +1,12 @@ +{ + "title": "Datasets_DeleteVersion_MaximumSet", + "operationId": "Datasets_DeleteVersion", + "parameters": { + "api-version": "2025-05-15-preview", + "name": "alpqwogwzatcyot", + "version": "zrkxodsgcd" + }, + "responses": { + "204": {} + } +} diff --git a/specification/ai/Azure.AI.Projects/examples/2025-05-15-preview/Datasets_DeleteVersion_MinimumSet_Gen.json b/specification/ai/Azure.AI.Projects/examples/2025-05-15-preview/Datasets_DeleteVersion_MinimumSet_Gen.json new file mode 100644 index 000000000000..224647378aa1 --- /dev/null +++ b/specification/ai/Azure.AI.Projects/examples/2025-05-15-preview/Datasets_DeleteVersion_MinimumSet_Gen.json @@ -0,0 +1,12 @@ +{ + "title": "Datasets_DeleteVersion_MinimumSet", + "operationId": "Datasets_DeleteVersion", + "parameters": { + "api-version": "2025-05-15-preview", + "name": "wllolxqbymlz", + "version": "ch" + }, + "responses": { + "204": {} + } +} diff --git a/specification/ai/Azure.AI.Projects/examples/2025-05-15-preview/Datasets_GetCredentials_MaximumSet_Gen.json b/specification/ai/Azure.AI.Projects/examples/2025-05-15-preview/Datasets_GetCredentials_MaximumSet_Gen.json new file mode 100644 index 000000000000..45b5ee7ea754 --- /dev/null +++ b/specification/ai/Azure.AI.Projects/examples/2025-05-15-preview/Datasets_GetCredentials_MaximumSet_Gen.json @@ -0,0 +1,24 @@ +{ + "title": "Datasets_GetCredentials_MaximumSet", + "operationId": "Datasets_GetCredentials", + "parameters": { + "api-version": "2025-05-15-preview", + "name": "vzqmzhfdzfqegdk", + "version": "cuiflnznlzybcrc", + "body": {} + }, + "responses": { + "200": { + "body": { + "blobReference": { + "blobUri": "azqrjzvwamspuuvtqvvzfaxiasf", + "storageAccountArmId": "deqizonopmijpxsmmzugiwnyy", + "credential": { + "sasUri": "agojbnipwrhupvervcdiffxes", + "type": "SAS" + } + } + } + } + } +} diff --git a/specification/ai/Azure.AI.Projects/examples/2025-05-15-preview/Datasets_GetCredentials_MinimumSet_Gen.json b/specification/ai/Azure.AI.Projects/examples/2025-05-15-preview/Datasets_GetCredentials_MinimumSet_Gen.json new file mode 100644 index 000000000000..9edf4191722b --- /dev/null +++ b/specification/ai/Azure.AI.Projects/examples/2025-05-15-preview/Datasets_GetCredentials_MinimumSet_Gen.json @@ -0,0 +1,24 @@ +{ + "title": "Datasets_GetCredentials_MinimumSet", + "operationId": "Datasets_GetCredentials", + "parameters": { + "api-version": "2025-05-15-preview", + "name": "sbblxkyqnfvdiqacezyygvts", + "version": "ikak", + "body": {} + }, + "responses": { + "200": { + "body": { + "blobReference": { + "blobUri": "azqrjzvwamspuuvtqvvzfaxiasf", + "storageAccountArmId": "deqizonopmijpxsmmzugiwnyy", + "credential": { + "sasUri": "agojbnipwrhupvervcdiffxes", + "type": "SAS" + } + } + } + } + } +} diff --git a/specification/ai/Azure.AI.Projects/examples/2025-05-15-preview/Datasets_GetVersion_MaximumSet_Gen.json b/specification/ai/Azure.AI.Projects/examples/2025-05-15-preview/Datasets_GetVersion_MaximumSet_Gen.json new file mode 100644 index 000000000000..0e6641b1292e --- /dev/null +++ b/specification/ai/Azure.AI.Projects/examples/2025-05-15-preview/Datasets_GetVersion_MaximumSet_Gen.json @@ -0,0 +1,21 @@ +{ + "title": "Datasets_GetVersion_MaximumSet", + "operationId": "Datasets_GetVersion", + "parameters": { + "api-version": "2025-05-15-preview", + "name": "temeurpoaslnnu", + "version": "icrcjdmwkggtdogifuoolnrg" + }, + "responses": { + "200": { + "body": { + "dataUri": "Replace this value with a string matching RegExp [a-zA-Z0-9_]", + "type": "DatasetVersion", + "isReference": true, + "id": "hvpdyfpeoqcl", + "name": "xtdmvwhhobloqqsovgpynsnow", + "version": "eaixzft" + } + } + } +} diff --git a/specification/ai/Azure.AI.Projects/examples/2025-05-15-preview/Datasets_GetVersion_MinimumSet_Gen.json b/specification/ai/Azure.AI.Projects/examples/2025-05-15-preview/Datasets_GetVersion_MinimumSet_Gen.json new file mode 100644 index 000000000000..2d7eff038cd2 --- /dev/null +++ b/specification/ai/Azure.AI.Projects/examples/2025-05-15-preview/Datasets_GetVersion_MinimumSet_Gen.json @@ -0,0 +1,19 @@ +{ + "title": "Datasets_GetVersion_MinimumSet", + "operationId": "Datasets_GetVersion", + "parameters": { + "api-version": "2025-05-15-preview", + "name": "xikgeqethuxytuseiawhklaapj", + "version": "hxksxrkgmtucfrbbnxyzwl" + }, + "responses": { + "200": { + "body": { + "dataUri": "Replace this value with a string matching RegExp [a-zA-Z0-9_]", + "type": "DatasetVersion", + "name": "xtdmvwhhobloqqsovgpynsnow", + "version": "eaixzft" + } + } + } +} diff --git a/specification/ai/Azure.AI.Projects/examples/2025-05-15-preview/Datasets_ListLatest_MaximumSet_Gen.json b/specification/ai/Azure.AI.Projects/examples/2025-05-15-preview/Datasets_ListLatest_MaximumSet_Gen.json new file mode 100644 index 000000000000..c3d33fdcbe7c --- /dev/null +++ b/specification/ai/Azure.AI.Projects/examples/2025-05-15-preview/Datasets_ListLatest_MaximumSet_Gen.json @@ -0,0 +1,28 @@ +{ + "title": "Datasets_ListLatest_MaximumSet", + "operationId": "Datasets_ListLatest", + "parameters": { + "api-version": "2025-05-15-preview", + "top": 26, + "skip": "lbra", + "tags": "pp", + "listViewType": "ActiveOnly" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "dataUri": "Replace this value with a string matching RegExp [a-zA-Z0-9_]", + "type": "DatasetVersion", + "isReference": true, + "id": "hvpdyfpeoqcl", + "name": "xtdmvwhhobloqqsovgpynsnow", + "version": "eaixzft" + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/ai/Azure.AI.Projects/examples/2025-05-15-preview/Datasets_ListLatest_MinimumSet_Gen.json b/specification/ai/Azure.AI.Projects/examples/2025-05-15-preview/Datasets_ListLatest_MinimumSet_Gen.json new file mode 100644 index 000000000000..9ec0c6d4ca45 --- /dev/null +++ b/specification/ai/Azure.AI.Projects/examples/2025-05-15-preview/Datasets_ListLatest_MinimumSet_Gen.json @@ -0,0 +1,21 @@ +{ + "title": "Datasets_ListLatest_MinimumSet", + "operationId": "Datasets_ListLatest", + "parameters": { + "api-version": "2025-05-15-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "dataUri": "Replace this value with a string matching RegExp [a-zA-Z0-9_]", + "type": "DatasetVersion", + "name": "xtdmvwhhobloqqsovgpynsnow", + "version": "eaixzft" + } + ] + } + } + } +} diff --git a/specification/ai/Azure.AI.Projects/examples/2025-05-15-preview/Datasets_ListVersions_MaximumSet_Gen.json b/specification/ai/Azure.AI.Projects/examples/2025-05-15-preview/Datasets_ListVersions_MaximumSet_Gen.json new file mode 100644 index 000000000000..3ec8c8a774c7 --- /dev/null +++ b/specification/ai/Azure.AI.Projects/examples/2025-05-15-preview/Datasets_ListVersions_MaximumSet_Gen.json @@ -0,0 +1,29 @@ +{ + "title": "Datasets_ListVersions_MaximumSet", + "operationId": "Datasets_ListVersions", + "parameters": { + "api-version": "2025-05-15-preview", + "name": "xogklfj", + "top": 18, + "skip": "qtdfikprjdlsosjaa", + "tags": "amyob", + "listViewType": "ActiveOnly" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "dataUri": "Replace this value with a string matching RegExp [a-zA-Z0-9_]", + "type": "DatasetVersion", + "isReference": true, + "id": "hvpdyfpeoqcl", + "name": "xtdmvwhhobloqqsovgpynsnow", + "version": "eaixzft" + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/ai/Azure.AI.Projects/examples/2025-05-15-preview/Datasets_ListVersions_MinimumSet_Gen.json b/specification/ai/Azure.AI.Projects/examples/2025-05-15-preview/Datasets_ListVersions_MinimumSet_Gen.json new file mode 100644 index 000000000000..ebdfaedd1954 --- /dev/null +++ b/specification/ai/Azure.AI.Projects/examples/2025-05-15-preview/Datasets_ListVersions_MinimumSet_Gen.json @@ -0,0 +1,22 @@ +{ + "title": "Datasets_ListVersions_MinimumSet", + "operationId": "Datasets_ListVersions", + "parameters": { + "api-version": "2025-05-15-preview", + "name": "hxemlflfomh" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "dataUri": "Replace this value with a string matching RegExp [a-zA-Z0-9_]", + "type": "DatasetVersion", + "name": "xtdmvwhhobloqqsovgpynsnow", + "version": "eaixzft" + } + ] + } + } + } +} diff --git a/specification/ai/Azure.AI.Projects/examples/2025-05-15-preview/Datasets_StartPendingUploadVersion_MaximumSet_Gen.json b/specification/ai/Azure.AI.Projects/examples/2025-05-15-preview/Datasets_StartPendingUploadVersion_MaximumSet_Gen.json new file mode 100644 index 000000000000..d3713678fa88 --- /dev/null +++ b/specification/ai/Azure.AI.Projects/examples/2025-05-15-preview/Datasets_StartPendingUploadVersion_MaximumSet_Gen.json @@ -0,0 +1,31 @@ +{ + "title": "Datasets_StartPendingUploadVersion_MaximumSet", + "operationId": "Datasets_StartPendingUploadVersion", + "parameters": { + "api-version": "2025-05-15-preview", + "name": "sgrzyrpltz", + "version": "ozdqisviavgqgfbtnzk", + "body": { + "pendingUploadId": "mxjahcghabuplfwtlopiqgxtcyw", + "connectionName": "bknvpmlisrqxaphkf", + "pendingUploadType": "BlobReference" + } + }, + "responses": { + "200": { + "body": { + "blobReference": { + "blobUri": "azqrjzvwamspuuvtqvvzfaxiasf", + "storageAccountArmId": "deqizonopmijpxsmmzugiwnyy", + "credential": { + "sasUri": "agojbnipwrhupvervcdiffxes", + "type": "SAS" + } + }, + "pendingUploadId": "qgizwomhljzn", + "version": "tegswajurquatmuhfde", + "pendingUploadType": "BlobReference" + } + } + } +} diff --git a/specification/ai/Azure.AI.Projects/examples/2025-05-15-preview/Datasets_StartPendingUploadVersion_MinimumSet_Gen.json b/specification/ai/Azure.AI.Projects/examples/2025-05-15-preview/Datasets_StartPendingUploadVersion_MinimumSet_Gen.json new file mode 100644 index 000000000000..e1df69a932f5 --- /dev/null +++ b/specification/ai/Azure.AI.Projects/examples/2025-05-15-preview/Datasets_StartPendingUploadVersion_MinimumSet_Gen.json @@ -0,0 +1,28 @@ +{ + "title": "Datasets_StartPendingUploadVersion_MinimumSet", + "operationId": "Datasets_StartPendingUploadVersion", + "parameters": { + "api-version": "2025-05-15-preview", + "name": "duxoiaywfik", + "version": "yzzzt", + "body": { + "pendingUploadType": "BlobReference" + } + }, + "responses": { + "200": { + "body": { + "blobReference": { + "blobUri": "azqrjzvwamspuuvtqvvzfaxiasf", + "storageAccountArmId": "deqizonopmijpxsmmzugiwnyy", + "credential": { + "sasUri": "agojbnipwrhupvervcdiffxes", + "type": "SAS" + } + }, + "pendingUploadId": "qgizwomhljzn", + "pendingUploadType": "BlobReference" + } + } + } +} diff --git a/specification/ai/Azure.AI.Projects/examples/2025-05-15-preview/Deployments_Get_MaximumSet_Gen.json b/specification/ai/Azure.AI.Projects/examples/2025-05-15-preview/Deployments_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..795394509e35 --- /dev/null +++ b/specification/ai/Azure.AI.Projects/examples/2025-05-15-preview/Deployments_Get_MaximumSet_Gen.json @@ -0,0 +1,17 @@ +{ + "title": "Deployments_Get_MaximumSet", + "operationId": "Deployments_Get", + "parameters": { + "api-version": "2025-05-15-preview", + "name": "qqvacpzjfk", + "x-ms-client-request-id": "cf35b680-dc80-4815-ab83-9364acc3bce6" + }, + "responses": { + "200": { + "body": { + "type": "Deployment", + "name": "pjnkbctjpshoeunqedinagotrj" + } + } + } +} diff --git a/specification/ai/Azure.AI.Projects/examples/2025-05-15-preview/Deployments_List_MaximumSet_Gen.json b/specification/ai/Azure.AI.Projects/examples/2025-05-15-preview/Deployments_List_MaximumSet_Gen.json new file mode 100644 index 000000000000..8bd1e3061529 --- /dev/null +++ b/specification/ai/Azure.AI.Projects/examples/2025-05-15-preview/Deployments_List_MaximumSet_Gen.json @@ -0,0 +1,26 @@ +{ + "title": "Deployments_List_MaximumSet", + "operationId": "Deployments_List", + "parameters": { + "api-version": "2025-05-15-preview", + "modelPublisher": "kznreojrvlwdq", + "modelName": "gplerszsuyisseeksnyvkaqperxox", + "top": 28, + "skip": 8, + "maxpagesize": 21, + "x-ms-client-request-id": "cf35b680-dc80-4815-ab83-9364acc3bce6" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "type": "Deployment", + "name": "pjnkbctjpshoeunqedinagotrj" + } + ], + "nextLink": "https://microsoft.com/ahpgda" + } + } + } +} diff --git a/specification/ai/Azure.AI.Projects/examples/2025-05-15-preview/Evaluations_CreateAgentEvaluation_MaximumSet_Gen.json b/specification/ai/Azure.AI.Projects/examples/2025-05-15-preview/Evaluations_CreateAgentEvaluation_MaximumSet_Gen.json new file mode 100644 index 000000000000..e3b597027cfb --- /dev/null +++ b/specification/ai/Azure.AI.Projects/examples/2025-05-15-preview/Evaluations_CreateAgentEvaluation_MaximumSet_Gen.json @@ -0,0 +1,54 @@ +{ + "title": "Evaluations_CreateAgentEvaluation_MaximumSet", + "operationId": "Evaluations_CreateAgentEvaluation", + "parameters": { + "api-version": "2025-05-15-preview", + "evaluation": { + "runId": "ecfcffqsrdhpecocrufffiqz", + "threadId": "cxjjsyhkeezgnaqqyerrdrbbth", + "evaluators": { + "key2653": { + "id": "gujwtvhptykq", + "initParams": {}, + "dataMapping": { + "key7400": "ijkjfvoswni" + } + } + }, + "samplingConfiguration": { + "name": "tj", + "samplingPercent": 7, + "maxRequestRate": 8 + }, + "redactionConfiguration": { + "redactScoreProperties": true + }, + "appInsightsConnectionString": "dvcnrcwar" + } + }, + "responses": { + "201": { + "body": { + "id": "gji", + "status": "ozywrhiasll", + "error": "stcjbhxgmqvjqwzmbvaa", + "result": [ + { + "evaluator": "upnt", + "evaluatorId": "upnt", + "score": 13, + "status": "eoxw", + "reason": "kfrjetziuketgioobeydlugonzfxo", + "version": "lfqwtzuktnbmcxxwkghmlpdtuu", + "threadId": "sldwqklyuxeayfmxpbl", + "runId": "lauehlf", + "error": "lrutmshl", + "additionalDetails": { + "key3590": "vhhneubavtiklsjcdexij" + } + } + ] + } + } + } +} diff --git a/specification/ai/Azure.AI.Projects/examples/2025-05-15-preview/Evaluations_CreateAgentEvaluation_MinimumSet_Gen.json b/specification/ai/Azure.AI.Projects/examples/2025-05-15-preview/Evaluations_CreateAgentEvaluation_MinimumSet_Gen.json new file mode 100644 index 000000000000..ea7133304b73 --- /dev/null +++ b/specification/ai/Azure.AI.Projects/examples/2025-05-15-preview/Evaluations_CreateAgentEvaluation_MinimumSet_Gen.json @@ -0,0 +1,20 @@ +{ + "title": "Evaluations_CreateAgentEvaluation_MinimumSet", + "operationId": "Evaluations_CreateAgentEvaluation", + "parameters": { + "api-version": "2025-05-15-preview", + "evaluation": { + "runId": "ecfcffqsrdhpecocrufffiqz", + "evaluators": {}, + "appInsightsConnectionString": "dvcnrcwar" + } + }, + "responses": { + "201": { + "body": { + "id": "gji", + "status": "ozywrhiasll" + } + } + } +} diff --git a/specification/ai/Azure.AI.Projects/examples/2025-05-15-preview/Evaluations_Create_MaximumSet_Gen.json b/specification/ai/Azure.AI.Projects/examples/2025-05-15-preview/Evaluations_Create_MaximumSet_Gen.json new file mode 100644 index 000000000000..0315a2c4007b --- /dev/null +++ b/specification/ai/Azure.AI.Projects/examples/2025-05-15-preview/Evaluations_Create_MaximumSet_Gen.json @@ -0,0 +1,57 @@ +{ + "title": "Evaluations_Create_MaximumSet", + "operationId": "Evaluations_Create", + "parameters": { + "api-version": "2025-05-15-preview", + "evaluation": { + "data": { + "type": "InputData" + }, + "displayName": "ymjxkodggqrhjnmusta", + "description": "cuviaxytqckkybxwc", + "tags": { + "key30": "nqrdpedyhkjzgrbtqhxbmkdmlpdf" + }, + "properties": { + "key9192": "e" + }, + "evaluators": { + "key2735": { + "id": "gujwtvhptykq", + "initParams": {}, + "dataMapping": { + "key7400": "ijkjfvoswni" + } + } + } + } + }, + "responses": { + "201": { + "body": { + "id": "aarhggbojnh", + "data": { + "type": "InputData" + }, + "displayName": "ymjxkodggqrhjnmusta", + "description": "cuviaxytqckkybxwc", + "status": "uhejnohmiiogajkx", + "tags": { + "key30": "nqrdpedyhkjzgrbtqhxbmkdmlpdf" + }, + "properties": { + "key9192": "e" + }, + "evaluators": { + "key2735": { + "id": "gujwtvhptykq", + "initParams": {}, + "dataMapping": { + "key7400": "ijkjfvoswni" + } + } + } + } + } + } +} diff --git a/specification/ai/Azure.AI.Projects/examples/2025-05-15-preview/Evaluations_Create_MinimumSet_Gen.json b/specification/ai/Azure.AI.Projects/examples/2025-05-15-preview/Evaluations_Create_MinimumSet_Gen.json new file mode 100644 index 000000000000..6739c8eab994 --- /dev/null +++ b/specification/ai/Azure.AI.Projects/examples/2025-05-15-preview/Evaluations_Create_MinimumSet_Gen.json @@ -0,0 +1,24 @@ +{ + "title": "Evaluations_Create_MinimumSet", + "operationId": "Evaluations_Create", + "parameters": { + "api-version": "2025-05-15-preview", + "evaluation": { + "data": { + "type": "InputData" + }, + "evaluators": {} + } + }, + "responses": { + "201": { + "body": { + "id": "aarhggbojnh", + "data": { + "type": "InputData" + }, + "evaluators": {} + } + } + } +} diff --git a/specification/ai/Azure.AI.Projects/examples/2025-05-15-preview/Evaluations_Get_MaximumSet_Gen.json b/specification/ai/Azure.AI.Projects/examples/2025-05-15-preview/Evaluations_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..834d486f6071 --- /dev/null +++ b/specification/ai/Azure.AI.Projects/examples/2025-05-15-preview/Evaluations_Get_MaximumSet_Gen.json @@ -0,0 +1,37 @@ +{ + "title": "Evaluations_Get_MaximumSet", + "operationId": "Evaluations_Get", + "parameters": { + "api-version": "2025-05-15-preview", + "name": "so", + "x-ms-client-request-id": "cf35b680-dc80-4815-ab83-9364acc3bce6" + }, + "responses": { + "200": { + "body": { + "id": "aarhggbojnh", + "data": { + "type": "InputData" + }, + "displayName": "ymjxkodggqrhjnmusta", + "description": "cuviaxytqckkybxwc", + "status": "uhejnohmiiogajkx", + "tags": { + "key30": "nqrdpedyhkjzgrbtqhxbmkdmlpdf" + }, + "properties": { + "key9192": "e" + }, + "evaluators": { + "key2735": { + "id": "gujwtvhptykq", + "initParams": {}, + "dataMapping": { + "key7400": "ijkjfvoswni" + } + } + } + } + } + } +} diff --git a/specification/ai/Azure.AI.Projects/examples/2025-05-15-preview/Evaluations_List_MaximumSet_Gen.json b/specification/ai/Azure.AI.Projects/examples/2025-05-15-preview/Evaluations_List_MaximumSet_Gen.json new file mode 100644 index 000000000000..2c8d83bdf062 --- /dev/null +++ b/specification/ai/Azure.AI.Projects/examples/2025-05-15-preview/Evaluations_List_MaximumSet_Gen.json @@ -0,0 +1,44 @@ +{ + "title": "Evaluations_List_MaximumSet", + "operationId": "Evaluations_List", + "parameters": { + "api-version": "2025-05-15-preview", + "top": 28, + "skip": 8, + "maxpagesize": 21, + "x-ms-client-request-id": "cf35b680-dc80-4815-ab83-9364acc3bce6" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "aarhggbojnh", + "data": { + "type": "InputData" + }, + "displayName": "ymjxkodggqrhjnmusta", + "description": "cuviaxytqckkybxwc", + "status": "uhejnohmiiogajkx", + "tags": { + "key30": "nqrdpedyhkjzgrbtqhxbmkdmlpdf" + }, + "properties": { + "key9192": "e" + }, + "evaluators": { + "key2735": { + "id": "gujwtvhptykq", + "initParams": {}, + "dataMapping": { + "key7400": "ijkjfvoswni" + } + } + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/ai/Azure.AI.Projects/examples/2025-05-15-preview/Indexes_CreateOrUpdateVersion_MaximumSet_Gen.json b/specification/ai/Azure.AI.Projects/examples/2025-05-15-preview/Indexes_CreateOrUpdateVersion_MaximumSet_Gen.json new file mode 100644 index 000000000000..3b6ac40c5f1d --- /dev/null +++ b/specification/ai/Azure.AI.Projects/examples/2025-05-15-preview/Indexes_CreateOrUpdateVersion_MaximumSet_Gen.json @@ -0,0 +1,34 @@ +{ + "title": "Indexes_CreateOrUpdateVersion_MaximumSet", + "operationId": "Indexes_CreateOrUpdateVersion", + "parameters": { + "api-version": "2025-05-15-preview", + "name": "tv", + "version": "emphgqdq", + "body": { + "type": "Index", + "description": "vdwtgaudopguto", + "tags": { + "key8846": "serbpbugykgbwuwvh" + } + } + }, + "responses": { + "200": { + "body": { + "type": "Index", + "id": "fxdrmhqrfmclzkjmfldnszfnztla", + "name": "fiwkavutgfan", + "version": "iqupugmfgctoxzdubrcdnzx" + } + }, + "201": { + "body": { + "type": "Index", + "id": "fxdrmhqrfmclzkjmfldnszfnztla", + "name": "fiwkavutgfan", + "version": "iqupugmfgctoxzdubrcdnzx" + } + } + } +} diff --git a/specification/ai/Azure.AI.Projects/examples/2025-05-15-preview/Indexes_CreateOrUpdateVersion_MinimumSet_Gen.json b/specification/ai/Azure.AI.Projects/examples/2025-05-15-preview/Indexes_CreateOrUpdateVersion_MinimumSet_Gen.json new file mode 100644 index 000000000000..8b570a419db2 --- /dev/null +++ b/specification/ai/Azure.AI.Projects/examples/2025-05-15-preview/Indexes_CreateOrUpdateVersion_MinimumSet_Gen.json @@ -0,0 +1,28 @@ +{ + "title": "Indexes_CreateOrUpdateVersion_MinimumSet", + "operationId": "Indexes_CreateOrUpdateVersion", + "parameters": { + "api-version": "2025-05-15-preview", + "name": "lvlygvkgvkbzutknlnretfvivdgkb", + "version": "ct", + "body": { + "type": "Index" + } + }, + "responses": { + "200": { + "body": { + "type": "Index", + "name": "fiwkavutgfan", + "version": "iqupugmfgctoxzdubrcdnzx" + } + }, + "201": { + "body": { + "type": "Index", + "name": "fiwkavutgfan", + "version": "iqupugmfgctoxzdubrcdnzx" + } + } + } +} diff --git a/specification/ai/Azure.AI.Projects/examples/2025-05-15-preview/Indexes_DeleteVersion_MaximumSet_Gen.json b/specification/ai/Azure.AI.Projects/examples/2025-05-15-preview/Indexes_DeleteVersion_MaximumSet_Gen.json new file mode 100644 index 000000000000..a31c3f6e7e24 --- /dev/null +++ b/specification/ai/Azure.AI.Projects/examples/2025-05-15-preview/Indexes_DeleteVersion_MaximumSet_Gen.json @@ -0,0 +1,12 @@ +{ + "title": "Indexes_DeleteVersion_MaximumSet", + "operationId": "Indexes_DeleteVersion", + "parameters": { + "api-version": "2025-05-15-preview", + "name": "uxzepyytxjtpjkdrpxicavot", + "version": "vyihcshjrfglzhj" + }, + "responses": { + "204": {} + } +} diff --git a/specification/ai/Azure.AI.Projects/examples/2025-05-15-preview/Indexes_DeleteVersion_MinimumSet_Gen.json b/specification/ai/Azure.AI.Projects/examples/2025-05-15-preview/Indexes_DeleteVersion_MinimumSet_Gen.json new file mode 100644 index 000000000000..7fec5d942612 --- /dev/null +++ b/specification/ai/Azure.AI.Projects/examples/2025-05-15-preview/Indexes_DeleteVersion_MinimumSet_Gen.json @@ -0,0 +1,12 @@ +{ + "title": "Indexes_DeleteVersion_MinimumSet", + "operationId": "Indexes_DeleteVersion", + "parameters": { + "api-version": "2025-05-15-preview", + "name": "mzshhabnrpuocgtyxkzftkr", + "version": "orbdovkdebzfwluronkmsoty" + }, + "responses": { + "204": {} + } +} diff --git a/specification/ai/Azure.AI.Projects/examples/2025-05-15-preview/Indexes_GetVersion_MaximumSet_Gen.json b/specification/ai/Azure.AI.Projects/examples/2025-05-15-preview/Indexes_GetVersion_MaximumSet_Gen.json new file mode 100644 index 000000000000..5324a2883934 --- /dev/null +++ b/specification/ai/Azure.AI.Projects/examples/2025-05-15-preview/Indexes_GetVersion_MaximumSet_Gen.json @@ -0,0 +1,19 @@ +{ + "title": "Indexes_GetVersion_MaximumSet", + "operationId": "Indexes_GetVersion", + "parameters": { + "api-version": "2025-05-15-preview", + "name": "nnhahjajcarruliib", + "version": "njynfwrxvujbklgxnibzafvcm" + }, + "responses": { + "200": { + "body": { + "type": "Index", + "id": "fxdrmhqrfmclzkjmfldnszfnztla", + "name": "fiwkavutgfan", + "version": "iqupugmfgctoxzdubrcdnzx" + } + } + } +} diff --git a/specification/ai/Azure.AI.Projects/examples/2025-05-15-preview/Indexes_GetVersion_MinimumSet_Gen.json b/specification/ai/Azure.AI.Projects/examples/2025-05-15-preview/Indexes_GetVersion_MinimumSet_Gen.json new file mode 100644 index 000000000000..3d7ccc6498e6 --- /dev/null +++ b/specification/ai/Azure.AI.Projects/examples/2025-05-15-preview/Indexes_GetVersion_MinimumSet_Gen.json @@ -0,0 +1,18 @@ +{ + "title": "Indexes_GetVersion_MinimumSet", + "operationId": "Indexes_GetVersion", + "parameters": { + "api-version": "2025-05-15-preview", + "name": "kbfueisvpmwlmmgqrylbgcwabum", + "version": "qtzhdugby" + }, + "responses": { + "200": { + "body": { + "type": "Index", + "name": "fiwkavutgfan", + "version": "iqupugmfgctoxzdubrcdnzx" + } + } + } +} diff --git a/specification/ai/Azure.AI.Projects/examples/2025-05-15-preview/Indexes_ListLatest_MaximumSet_Gen.json b/specification/ai/Azure.AI.Projects/examples/2025-05-15-preview/Indexes_ListLatest_MaximumSet_Gen.json new file mode 100644 index 000000000000..67ebe012f8e9 --- /dev/null +++ b/specification/ai/Azure.AI.Projects/examples/2025-05-15-preview/Indexes_ListLatest_MaximumSet_Gen.json @@ -0,0 +1,26 @@ +{ + "title": "Indexes_ListLatest_MaximumSet", + "operationId": "Indexes_ListLatest", + "parameters": { + "api-version": "2025-05-15-preview", + "top": 11, + "skip": "qijkobbksrqhgvwzmujd", + "tags": "lmpvvr", + "listViewType": "ActiveOnly" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "type": "Index", + "id": "fxdrmhqrfmclzkjmfldnszfnztla", + "name": "fiwkavutgfan", + "version": "iqupugmfgctoxzdubrcdnzx" + } + ], + "nextLink": "https://microsoft.com/ayyakes" + } + } + } +} diff --git a/specification/ai/Azure.AI.Projects/examples/2025-05-15-preview/Indexes_ListLatest_MinimumSet_Gen.json b/specification/ai/Azure.AI.Projects/examples/2025-05-15-preview/Indexes_ListLatest_MinimumSet_Gen.json new file mode 100644 index 000000000000..2c147c3ed85e --- /dev/null +++ b/specification/ai/Azure.AI.Projects/examples/2025-05-15-preview/Indexes_ListLatest_MinimumSet_Gen.json @@ -0,0 +1,20 @@ +{ + "title": "Indexes_ListLatest_MinimumSet", + "operationId": "Indexes_ListLatest", + "parameters": { + "api-version": "2025-05-15-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "type": "Index", + "name": "fiwkavutgfan", + "version": "iqupugmfgctoxzdubrcdnzx" + } + ] + } + } + } +} diff --git a/specification/ai/Azure.AI.Projects/examples/2025-05-15-preview/Indexes_ListVersions_MaximumSet_Gen.json b/specification/ai/Azure.AI.Projects/examples/2025-05-15-preview/Indexes_ListVersions_MaximumSet_Gen.json new file mode 100644 index 000000000000..f776245cff56 --- /dev/null +++ b/specification/ai/Azure.AI.Projects/examples/2025-05-15-preview/Indexes_ListVersions_MaximumSet_Gen.json @@ -0,0 +1,27 @@ +{ + "title": "Indexes_ListVersions_MaximumSet", + "operationId": "Indexes_ListVersions", + "parameters": { + "api-version": "2025-05-15-preview", + "name": "tvabzvonlomkdvglaubvvqmzwdaiz", + "top": 2, + "skip": "fgwrnkksjofetmtfyizikbyv", + "tags": "hymlvxullwef", + "listViewType": "ActiveOnly" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "type": "Index", + "id": "fxdrmhqrfmclzkjmfldnszfnztla", + "name": "fiwkavutgfan", + "version": "iqupugmfgctoxzdubrcdnzx" + } + ], + "nextLink": "https://microsoft.com/ayyakes" + } + } + } +} diff --git a/specification/ai/Azure.AI.Projects/examples/2025-05-15-preview/Indexes_ListVersions_MinimumSet_Gen.json b/specification/ai/Azure.AI.Projects/examples/2025-05-15-preview/Indexes_ListVersions_MinimumSet_Gen.json new file mode 100644 index 000000000000..6e11477a0190 --- /dev/null +++ b/specification/ai/Azure.AI.Projects/examples/2025-05-15-preview/Indexes_ListVersions_MinimumSet_Gen.json @@ -0,0 +1,21 @@ +{ + "title": "Indexes_ListVersions_MinimumSet", + "operationId": "Indexes_ListVersions", + "parameters": { + "api-version": "2025-05-15-preview", + "name": "opimayfinqlkarudm" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "type": "Index", + "name": "fiwkavutgfan", + "version": "iqupugmfgctoxzdubrcdnzx" + } + ] + } + } + } +} diff --git a/specification/ai/Azure.AI.Projects/examples/2025-05-15-preview/RedTeams_Create_MaximumSet_Gen.json b/specification/ai/Azure.AI.Projects/examples/2025-05-15-preview/RedTeams_Create_MaximumSet_Gen.json new file mode 100644 index 000000000000..60c36a639864 --- /dev/null +++ b/specification/ai/Azure.AI.Projects/examples/2025-05-15-preview/RedTeams_Create_MaximumSet_Gen.json @@ -0,0 +1,53 @@ +{ + "title": "RedTeams_Create_MaximumSet", + "operationId": "RedTeams_Create", + "parameters": { + "api-version": "2025-05-15-preview", + "RedTeam": { + "numTurns": 10, + "attackStrategies": [ + "easy" + ], + "simulationOnly": true, + "riskCategories": [ + "HateUnfairness" + ], + "applicationScenario": "qaxxxhjp", + "tags": { + "key1287": "gbklekkgmxkfbhehgh" + }, + "properties": { + "key9280": "fwzjtipl" + }, + "target": { + "type": "TargetConfig" + } + } + }, + "responses": { + "201": { + "body": { + "id": "tztegmf", + "numTurns": 10, + "attackStrategies": [ + "easy" + ], + "simulationOnly": true, + "riskCategories": [ + "HateUnfairness" + ], + "applicationScenario": "qaxxxhjp", + "tags": { + "key1287": "gbklekkgmxkfbhehgh" + }, + "properties": { + "key9280": "fwzjtipl" + }, + "status": "owgxaiudnkkeqwlnhtmihvhdkbgd", + "target": { + "type": "TargetConfig" + } + } + } + } +} diff --git a/specification/ai/Azure.AI.Projects/examples/2025-05-15-preview/RedTeams_Create_MinimumSet_Gen.json b/specification/ai/Azure.AI.Projects/examples/2025-05-15-preview/RedTeams_Create_MinimumSet_Gen.json new file mode 100644 index 000000000000..0bca24700a8c --- /dev/null +++ b/specification/ai/Azure.AI.Projects/examples/2025-05-15-preview/RedTeams_Create_MinimumSet_Gen.json @@ -0,0 +1,38 @@ +{ + "title": "RedTeams_Create_MinimumSet", + "operationId": "RedTeams_Create", + "parameters": { + "api-version": "2025-05-15-preview", + "RedTeam": { + "numTurns": 10, + "attackStrategies": [ + "easy" + ], + "simulationOnly": true, + "riskCategories": [ + "HateUnfairness" + ], + "target": { + "type": "TargetConfig" + } + } + }, + "responses": { + "201": { + "body": { + "id": "tztegmf", + "numTurns": 10, + "attackStrategies": [ + "easy" + ], + "simulationOnly": true, + "riskCategories": [ + "HateUnfairness" + ], + "target": { + "type": "TargetConfig" + } + } + } + } +} diff --git a/specification/ai/Azure.AI.Projects/examples/2025-05-15-preview/RedTeams_Get_MaximumSet_Gen.json b/specification/ai/Azure.AI.Projects/examples/2025-05-15-preview/RedTeams_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..59fd9f26b81c --- /dev/null +++ b/specification/ai/Azure.AI.Projects/examples/2025-05-15-preview/RedTeams_Get_MaximumSet_Gen.json @@ -0,0 +1,35 @@ +{ + "title": "RedTeams_Get_MaximumSet", + "operationId": "RedTeams_Get", + "parameters": { + "api-version": "2025-05-15-preview", + "name": "apwpcf", + "x-ms-client-request-id": "cf35b680-dc80-4815-ab83-9364acc3bce6" + }, + "responses": { + "200": { + "body": { + "id": "tztegmf", + "numTurns": 10, + "attackStrategies": [ + "easy" + ], + "simulationOnly": true, + "riskCategories": [ + "HateUnfairness" + ], + "applicationScenario": "qaxxxhjp", + "tags": { + "key1287": "gbklekkgmxkfbhehgh" + }, + "properties": { + "key9280": "fwzjtipl" + }, + "status": "owgxaiudnkkeqwlnhtmihvhdkbgd", + "target": { + "type": "TargetConfig" + } + } + } + } +} diff --git a/specification/ai/Azure.AI.Projects/examples/2025-05-15-preview/RedTeams_List_MaximumSet_Gen.json b/specification/ai/Azure.AI.Projects/examples/2025-05-15-preview/RedTeams_List_MaximumSet_Gen.json new file mode 100644 index 000000000000..10bb9532ff47 --- /dev/null +++ b/specification/ai/Azure.AI.Projects/examples/2025-05-15-preview/RedTeams_List_MaximumSet_Gen.json @@ -0,0 +1,42 @@ +{ + "title": "RedTeams_List_MaximumSet", + "operationId": "RedTeams_List", + "parameters": { + "api-version": "2025-05-15-preview", + "top": 28, + "skip": 8, + "maxpagesize": 21, + "x-ms-client-request-id": "cf35b680-dc80-4815-ab83-9364acc3bce6" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "tztegmf", + "numTurns": 10, + "attackStrategies": [ + "easy" + ], + "simulationOnly": true, + "riskCategories": [ + "HateUnfairness" + ], + "applicationScenario": "qaxxxhjp", + "tags": { + "key1287": "gbklekkgmxkfbhehgh" + }, + "properties": { + "key9280": "fwzjtipl" + }, + "status": "owgxaiudnkkeqwlnhtmihvhdkbgd", + "target": { + "type": "TargetConfig" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/ai/Azure.AI.Projects/examples/v1/Connections_GetWithCredentials_MaximumSet_Gen.json b/specification/ai/Azure.AI.Projects/examples/v1/Connections_GetWithCredentials_MaximumSet_Gen.json new file mode 100644 index 000000000000..fbb3f544c752 --- /dev/null +++ b/specification/ai/Azure.AI.Projects/examples/v1/Connections_GetWithCredentials_MaximumSet_Gen.json @@ -0,0 +1,26 @@ +{ + "title": "Connections_GetWithCredentials_MaximumSet", + "operationId": "Connections_GetWithCredentials", + "parameters": { + "api-version": "v1", + "name": "jqgcfdexf", + "x-ms-client-request-id": "cf35b680-dc80-4815-ab83-9364acc3bce6" + }, + "responses": { + "200": { + "body": { + "name": "we", + "id": "unique-id", + "type": "AzureOpenAI", + "target": "bbzo", + "isDefault": true, + "credentials": { + "type": "BaseCredentials" + }, + "metadata": { + "key9765": "voknfqanbxnseqg" + } + } + } + } +} diff --git a/specification/ai/Azure.AI.Projects/examples/v1/Connections_Get_MaximumSet_Gen.json b/specification/ai/Azure.AI.Projects/examples/v1/Connections_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..1e695083b491 --- /dev/null +++ b/specification/ai/Azure.AI.Projects/examples/v1/Connections_Get_MaximumSet_Gen.json @@ -0,0 +1,26 @@ +{ + "title": "Connections_Get_MaximumSet", + "operationId": "Connections_Get", + "parameters": { + "api-version": "v1", + "name": "gvwpqdivyfaiftzdfcjoj", + "x-ms-client-request-id": "cf35b680-dc80-4815-ab83-9364acc3bce6" + }, + "responses": { + "200": { + "body": { + "name": "we", + "id": "unique-id", + "type": "AzureOpenAI", + "target": "bbzo", + "isDefault": true, + "credentials": { + "type": "BaseCredentials" + }, + "metadata": { + "key9765": "voknfqanbxnseqg" + } + } + } + } +} diff --git a/specification/ai/Azure.AI.Projects/examples/v1/Connections_List_MaximumSet_Gen.json b/specification/ai/Azure.AI.Projects/examples/v1/Connections_List_MaximumSet_Gen.json new file mode 100644 index 000000000000..d4a34496485e --- /dev/null +++ b/specification/ai/Azure.AI.Projects/examples/v1/Connections_List_MaximumSet_Gen.json @@ -0,0 +1,35 @@ +{ + "title": "Connections_List_MaximumSet", + "operationId": "Connections_List", + "parameters": { + "api-version": "v1", + "connectionType": "AzureOpenAI", + "defaultConnection": true, + "top": 6, + "skip": 12, + "maxpagesize": 11, + "x-ms-client-request-id": "cf35b680-dc80-4815-ab83-9364acc3bce6" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "we", + "id": "unique-id", + "type": "AzureOpenAI", + "target": "bbzo", + "isDefault": true, + "credentials": { + "type": "BaseCredentials" + }, + "metadata": { + "key9765": "voknfqanbxnseqg" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/ai/Azure.AI.Projects/examples/v1/Datasets_CreateOrUpdateVersion_MaximumSet_Gen.json b/specification/ai/Azure.AI.Projects/examples/v1/Datasets_CreateOrUpdateVersion_MaximumSet_Gen.json new file mode 100644 index 000000000000..8c9bc28da150 --- /dev/null +++ b/specification/ai/Azure.AI.Projects/examples/v1/Datasets_CreateOrUpdateVersion_MaximumSet_Gen.json @@ -0,0 +1,39 @@ +{ + "title": "Datasets_CreateOrUpdateVersion_MaximumSet", + "operationId": "Datasets_CreateOrUpdateVersion", + "parameters": { + "api-version": "v1", + "name": "nsvugzcnsvqodrxiojanhtdymgglnx", + "version": "utbfmfka", + "body": { + "dataUri": "Replace this value with a string matching RegExp [a-zA-Z0-9_]", + "type": "DatasetVersion", + "description": "grthjigklkewz", + "tags": { + "key868": "yjmiiufnnccqfiljtndr" + } + } + }, + "responses": { + "200": { + "body": { + "dataUri": "Replace this value with a string matching RegExp [a-zA-Z0-9_]", + "type": "DatasetVersion", + "isReference": true, + "id": "cfgncrzpcpqbpxefd", + "name": "zoskzytcqmndtyqwugy", + "version": "joegai" + } + }, + "201": { + "body": { + "dataUri": "Replace this value with a string matching RegExp [a-zA-Z0-9_]", + "type": "DatasetVersion", + "isReference": true, + "id": "cfgncrzpcpqbpxefd", + "name": "zoskzytcqmndtyqwugy", + "version": "joegai" + } + } + } +} diff --git a/specification/ai/Azure.AI.Projects/examples/v1/Datasets_CreateOrUpdateVersion_MinimumSet_Gen.json b/specification/ai/Azure.AI.Projects/examples/v1/Datasets_CreateOrUpdateVersion_MinimumSet_Gen.json new file mode 100644 index 000000000000..907ad46f02a2 --- /dev/null +++ b/specification/ai/Azure.AI.Projects/examples/v1/Datasets_CreateOrUpdateVersion_MinimumSet_Gen.json @@ -0,0 +1,31 @@ +{ + "title": "Datasets_CreateOrUpdateVersion_MinimumSet", + "operationId": "Datasets_CreateOrUpdateVersion", + "parameters": { + "api-version": "v1", + "name": "pluvp", + "version": "playwidjgezovivciosnkerrdwe", + "body": { + "dataUri": "Replace this value with a string matching RegExp [a-zA-Z0-9_]", + "type": "DatasetVersion" + } + }, + "responses": { + "200": { + "body": { + "dataUri": "Replace this value with a string matching RegExp [a-zA-Z0-9_]", + "type": "DatasetVersion", + "name": "zoskzytcqmndtyqwugy", + "version": "joegai" + } + }, + "201": { + "body": { + "dataUri": "Replace this value with a string matching RegExp [a-zA-Z0-9_]", + "type": "DatasetVersion", + "name": "zoskzytcqmndtyqwugy", + "version": "joegai" + } + } + } +} diff --git a/specification/ai/Azure.AI.Projects/examples/v1/Datasets_DeleteVersion_MaximumSet_Gen.json b/specification/ai/Azure.AI.Projects/examples/v1/Datasets_DeleteVersion_MaximumSet_Gen.json new file mode 100644 index 000000000000..6d32c7b8bd30 --- /dev/null +++ b/specification/ai/Azure.AI.Projects/examples/v1/Datasets_DeleteVersion_MaximumSet_Gen.json @@ -0,0 +1,12 @@ +{ + "title": "Datasets_DeleteVersion_MaximumSet", + "operationId": "Datasets_DeleteVersion", + "parameters": { + "api-version": "v1", + "name": "dfmimccx", + "version": "mukc" + }, + "responses": { + "204": {} + } +} diff --git a/specification/ai/Azure.AI.Projects/examples/v1/Datasets_DeleteVersion_MinimumSet_Gen.json b/specification/ai/Azure.AI.Projects/examples/v1/Datasets_DeleteVersion_MinimumSet_Gen.json new file mode 100644 index 000000000000..7c629dd22c35 --- /dev/null +++ b/specification/ai/Azure.AI.Projects/examples/v1/Datasets_DeleteVersion_MinimumSet_Gen.json @@ -0,0 +1,12 @@ +{ + "title": "Datasets_DeleteVersion_MinimumSet", + "operationId": "Datasets_DeleteVersion", + "parameters": { + "api-version": "v1", + "name": "nkaivxoayhkrxavagybliogwwgvbk", + "version": "pmavzwbusicqau" + }, + "responses": { + "204": {} + } +} diff --git a/specification/ai/Azure.AI.Projects/examples/v1/Datasets_GetCredentials_MaximumSet_Gen.json b/specification/ai/Azure.AI.Projects/examples/v1/Datasets_GetCredentials_MaximumSet_Gen.json new file mode 100644 index 000000000000..3a94a266ebd4 --- /dev/null +++ b/specification/ai/Azure.AI.Projects/examples/v1/Datasets_GetCredentials_MaximumSet_Gen.json @@ -0,0 +1,24 @@ +{ + "title": "Datasets_GetCredentials_MaximumSet", + "operationId": "Datasets_GetCredentials", + "parameters": { + "api-version": "v1", + "name": "hpvjnkljsuospxwrypot", + "version": "rlf", + "body": {} + }, + "responses": { + "200": { + "body": { + "blobReference": { + "blobUri": "kbodccbnhdznekrtu", + "storageAccountArmId": "gcsdeid", + "credential": { + "sasUri": "mzmtfelripgmz", + "type": "SAS" + } + } + } + } + } +} diff --git a/specification/ai/Azure.AI.Projects/examples/v1/Datasets_GetCredentials_MinimumSet_Gen.json b/specification/ai/Azure.AI.Projects/examples/v1/Datasets_GetCredentials_MinimumSet_Gen.json new file mode 100644 index 000000000000..acaebdaeb748 --- /dev/null +++ b/specification/ai/Azure.AI.Projects/examples/v1/Datasets_GetCredentials_MinimumSet_Gen.json @@ -0,0 +1,24 @@ +{ + "title": "Datasets_GetCredentials_MinimumSet", + "operationId": "Datasets_GetCredentials", + "parameters": { + "api-version": "v1", + "name": "udrhdaxbjptksqqwztnfswzku", + "version": "ytogupzn", + "body": {} + }, + "responses": { + "200": { + "body": { + "blobReference": { + "blobUri": "kbodccbnhdznekrtu", + "storageAccountArmId": "gcsdeid", + "credential": { + "sasUri": "mzmtfelripgmz", + "type": "SAS" + } + } + } + } + } +} diff --git a/specification/ai/Azure.AI.Projects/examples/v1/Datasets_GetVersion_MaximumSet_Gen.json b/specification/ai/Azure.AI.Projects/examples/v1/Datasets_GetVersion_MaximumSet_Gen.json new file mode 100644 index 000000000000..5e8855d2e79b --- /dev/null +++ b/specification/ai/Azure.AI.Projects/examples/v1/Datasets_GetVersion_MaximumSet_Gen.json @@ -0,0 +1,21 @@ +{ + "title": "Datasets_GetVersion_MaximumSet", + "operationId": "Datasets_GetVersion", + "parameters": { + "api-version": "v1", + "name": "ppdba", + "version": "ttetev" + }, + "responses": { + "200": { + "body": { + "dataUri": "Replace this value with a string matching RegExp [a-zA-Z0-9_]", + "type": "DatasetVersion", + "isReference": true, + "id": "cfgncrzpcpqbpxefd", + "name": "zoskzytcqmndtyqwugy", + "version": "joegai" + } + } + } +} diff --git a/specification/ai/Azure.AI.Projects/examples/v1/Datasets_GetVersion_MinimumSet_Gen.json b/specification/ai/Azure.AI.Projects/examples/v1/Datasets_GetVersion_MinimumSet_Gen.json new file mode 100644 index 000000000000..f3295b63731b --- /dev/null +++ b/specification/ai/Azure.AI.Projects/examples/v1/Datasets_GetVersion_MinimumSet_Gen.json @@ -0,0 +1,19 @@ +{ + "title": "Datasets_GetVersion_MinimumSet", + "operationId": "Datasets_GetVersion", + "parameters": { + "api-version": "v1", + "name": "ivkedy", + "version": "vxufccznqvuctabcyagbczidvr" + }, + "responses": { + "200": { + "body": { + "dataUri": "Replace this value with a string matching RegExp [a-zA-Z0-9_]", + "type": "DatasetVersion", + "name": "zoskzytcqmndtyqwugy", + "version": "joegai" + } + } + } +} diff --git a/specification/ai/Azure.AI.Projects/examples/v1/Datasets_ListLatest_MaximumSet_Gen.json b/specification/ai/Azure.AI.Projects/examples/v1/Datasets_ListLatest_MaximumSet_Gen.json new file mode 100644 index 000000000000..9f3ef0ba4438 --- /dev/null +++ b/specification/ai/Azure.AI.Projects/examples/v1/Datasets_ListLatest_MaximumSet_Gen.json @@ -0,0 +1,28 @@ +{ + "title": "Datasets_ListLatest_MaximumSet", + "operationId": "Datasets_ListLatest", + "parameters": { + "api-version": "v1", + "top": 16, + "skip": "wbilbzmgugbikcwaguhtq", + "tags": "azsufezp", + "listViewType": "ActiveOnly" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "dataUri": "Replace this value with a string matching RegExp [a-zA-Z0-9_]", + "type": "DatasetVersion", + "isReference": true, + "id": "cfgncrzpcpqbpxefd", + "name": "zoskzytcqmndtyqwugy", + "version": "joegai" + } + ], + "nextLink": "https://microsoft.com/al" + } + } + } +} diff --git a/specification/ai/Azure.AI.Projects/examples/v1/Datasets_ListLatest_MinimumSet_Gen.json b/specification/ai/Azure.AI.Projects/examples/v1/Datasets_ListLatest_MinimumSet_Gen.json new file mode 100644 index 000000000000..31fc6a22a0fb --- /dev/null +++ b/specification/ai/Azure.AI.Projects/examples/v1/Datasets_ListLatest_MinimumSet_Gen.json @@ -0,0 +1,21 @@ +{ + "title": "Datasets_ListLatest_MinimumSet", + "operationId": "Datasets_ListLatest", + "parameters": { + "api-version": "v1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "dataUri": "Replace this value with a string matching RegExp [a-zA-Z0-9_]", + "type": "DatasetVersion", + "name": "zoskzytcqmndtyqwugy", + "version": "joegai" + } + ] + } + } + } +} diff --git a/specification/ai/Azure.AI.Projects/examples/v1/Datasets_ListVersions_MaximumSet_Gen.json b/specification/ai/Azure.AI.Projects/examples/v1/Datasets_ListVersions_MaximumSet_Gen.json new file mode 100644 index 000000000000..eea8f66948db --- /dev/null +++ b/specification/ai/Azure.AI.Projects/examples/v1/Datasets_ListVersions_MaximumSet_Gen.json @@ -0,0 +1,29 @@ +{ + "title": "Datasets_ListVersions_MaximumSet", + "operationId": "Datasets_ListVersions", + "parameters": { + "api-version": "v1", + "name": "ojjzgfffyyyr", + "top": 4, + "skip": "bafjlmqcftwnjlofuwnxoc", + "tags": "taynswmfxqo", + "listViewType": "ActiveOnly" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "dataUri": "Replace this value with a string matching RegExp [a-zA-Z0-9_]", + "type": "DatasetVersion", + "isReference": true, + "id": "cfgncrzpcpqbpxefd", + "name": "zoskzytcqmndtyqwugy", + "version": "joegai" + } + ], + "nextLink": "https://microsoft.com/al" + } + } + } +} diff --git a/specification/ai/Azure.AI.Projects/examples/v1/Datasets_ListVersions_MinimumSet_Gen.json b/specification/ai/Azure.AI.Projects/examples/v1/Datasets_ListVersions_MinimumSet_Gen.json new file mode 100644 index 000000000000..eb947adf9e1c --- /dev/null +++ b/specification/ai/Azure.AI.Projects/examples/v1/Datasets_ListVersions_MinimumSet_Gen.json @@ -0,0 +1,22 @@ +{ + "title": "Datasets_ListVersions_MinimumSet", + "operationId": "Datasets_ListVersions", + "parameters": { + "api-version": "v1", + "name": "fauawvl" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "dataUri": "Replace this value with a string matching RegExp [a-zA-Z0-9_]", + "type": "DatasetVersion", + "name": "zoskzytcqmndtyqwugy", + "version": "joegai" + } + ] + } + } + } +} diff --git a/specification/ai/Azure.AI.Projects/examples/v1/Datasets_StartPendingUploadVersion_MaximumSet_Gen.json b/specification/ai/Azure.AI.Projects/examples/v1/Datasets_StartPendingUploadVersion_MaximumSet_Gen.json new file mode 100644 index 000000000000..dec49019bfd6 --- /dev/null +++ b/specification/ai/Azure.AI.Projects/examples/v1/Datasets_StartPendingUploadVersion_MaximumSet_Gen.json @@ -0,0 +1,31 @@ +{ + "title": "Datasets_StartPendingUploadVersion_MaximumSet", + "operationId": "Datasets_StartPendingUploadVersion", + "parameters": { + "api-version": "v1", + "name": "cncrcmiaksswirlujwcptxeaef", + "version": "jkqqzmj", + "body": { + "pendingUploadId": "gxuutkdhlygsmsbtszqzx", + "connectionName": "hsgskbhwucytwglwlm", + "pendingUploadType": "BlobReference" + } + }, + "responses": { + "200": { + "body": { + "blobReference": { + "blobUri": "kbodccbnhdznekrtu", + "storageAccountArmId": "gcsdeid", + "credential": { + "sasUri": "mzmtfelripgmz", + "type": "SAS" + } + }, + "pendingUploadId": "qdxymiww", + "version": "bofnujdjvnnhjtzzu", + "pendingUploadType": "BlobReference" + } + } + } +} diff --git a/specification/ai/Azure.AI.Projects/examples/v1/Datasets_StartPendingUploadVersion_MinimumSet_Gen.json b/specification/ai/Azure.AI.Projects/examples/v1/Datasets_StartPendingUploadVersion_MinimumSet_Gen.json new file mode 100644 index 000000000000..8df70d95ceab --- /dev/null +++ b/specification/ai/Azure.AI.Projects/examples/v1/Datasets_StartPendingUploadVersion_MinimumSet_Gen.json @@ -0,0 +1,28 @@ +{ + "title": "Datasets_StartPendingUploadVersion_MinimumSet", + "operationId": "Datasets_StartPendingUploadVersion", + "parameters": { + "api-version": "v1", + "name": "atopkjwxsjtforndczju", + "version": "yftpnjxwjylhixypopcytxd", + "body": { + "pendingUploadType": "BlobReference" + } + }, + "responses": { + "200": { + "body": { + "blobReference": { + "blobUri": "kbodccbnhdznekrtu", + "storageAccountArmId": "gcsdeid", + "credential": { + "sasUri": "mzmtfelripgmz", + "type": "SAS" + } + }, + "pendingUploadId": "qdxymiww", + "pendingUploadType": "BlobReference" + } + } + } +} diff --git a/specification/ai/Azure.AI.Projects/examples/v1/Deployments_Get_MaximumSet_Gen.json b/specification/ai/Azure.AI.Projects/examples/v1/Deployments_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..8023d41a5e89 --- /dev/null +++ b/specification/ai/Azure.AI.Projects/examples/v1/Deployments_Get_MaximumSet_Gen.json @@ -0,0 +1,17 @@ +{ + "title": "Deployments_Get_MaximumSet", + "operationId": "Deployments_Get", + "parameters": { + "api-version": "v1", + "name": "ft", + "x-ms-client-request-id": "cf35b680-dc80-4815-ab83-9364acc3bce6" + }, + "responses": { + "200": { + "body": { + "type": "Deployment", + "name": "yfnhkglimmtfavwsetvoopcuyewygg" + } + } + } +} diff --git a/specification/ai/Azure.AI.Projects/examples/v1/Deployments_List_MaximumSet_Gen.json b/specification/ai/Azure.AI.Projects/examples/v1/Deployments_List_MaximumSet_Gen.json new file mode 100644 index 000000000000..5e6110856a4b --- /dev/null +++ b/specification/ai/Azure.AI.Projects/examples/v1/Deployments_List_MaximumSet_Gen.json @@ -0,0 +1,26 @@ +{ + "title": "Deployments_List_MaximumSet", + "operationId": "Deployments_List", + "parameters": { + "api-version": "v1", + "modelPublisher": "tb", + "modelName": "xdlvjxymsmdnebesolv", + "top": 6, + "skip": 12, + "maxpagesize": 11, + "x-ms-client-request-id": "cf35b680-dc80-4815-ab83-9364acc3bce6" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "type": "Deployment", + "name": "yfnhkglimmtfavwsetvoopcuyewygg" + } + ], + "nextLink": "https://microsoft.com/aoecpoh" + } + } + } +} diff --git a/specification/ai/Azure.AI.Projects/examples/v1/Indexes_CreateOrUpdateVersion_MaximumSet_Gen.json b/specification/ai/Azure.AI.Projects/examples/v1/Indexes_CreateOrUpdateVersion_MaximumSet_Gen.json new file mode 100644 index 000000000000..b43bd4b291f1 --- /dev/null +++ b/specification/ai/Azure.AI.Projects/examples/v1/Indexes_CreateOrUpdateVersion_MaximumSet_Gen.json @@ -0,0 +1,34 @@ +{ + "title": "Indexes_CreateOrUpdateVersion_MaximumSet", + "operationId": "Indexes_CreateOrUpdateVersion", + "parameters": { + "api-version": "v1", + "name": "kptgsnpfjcunvvdgzfjdmnurq", + "version": "hxutytnzwioiijfinpdojrnrqhqb", + "body": { + "type": "Index", + "description": "wtjqhnlwihffw", + "tags": { + "key1654": "aqtywrvy" + } + } + }, + "responses": { + "200": { + "body": { + "type": "Index", + "id": "xtjevbrwrwuwkbujuwpq", + "name": "wwikvkcdcobt", + "version": "swnonkxmjl" + } + }, + "201": { + "body": { + "type": "Index", + "id": "xtjevbrwrwuwkbujuwpq", + "name": "wwikvkcdcobt", + "version": "swnonkxmjl" + } + } + } +} diff --git a/specification/ai/Azure.AI.Projects/examples/v1/Indexes_CreateOrUpdateVersion_MinimumSet_Gen.json b/specification/ai/Azure.AI.Projects/examples/v1/Indexes_CreateOrUpdateVersion_MinimumSet_Gen.json new file mode 100644 index 000000000000..bf495cf8c9d5 --- /dev/null +++ b/specification/ai/Azure.AI.Projects/examples/v1/Indexes_CreateOrUpdateVersion_MinimumSet_Gen.json @@ -0,0 +1,28 @@ +{ + "title": "Indexes_CreateOrUpdateVersion_MinimumSet", + "operationId": "Indexes_CreateOrUpdateVersion", + "parameters": { + "api-version": "v1", + "name": "dpfjghwaowffzhoyuwrnmws", + "version": "priaizsqiwxrwnhhyk", + "body": { + "type": "Index" + } + }, + "responses": { + "200": { + "body": { + "type": "Index", + "name": "wwikvkcdcobt", + "version": "swnonkxmjl" + } + }, + "201": { + "body": { + "type": "Index", + "name": "wwikvkcdcobt", + "version": "swnonkxmjl" + } + } + } +} diff --git a/specification/ai/Azure.AI.Projects/examples/v1/Indexes_DeleteVersion_MaximumSet_Gen.json b/specification/ai/Azure.AI.Projects/examples/v1/Indexes_DeleteVersion_MaximumSet_Gen.json new file mode 100644 index 000000000000..abca9b51ee02 --- /dev/null +++ b/specification/ai/Azure.AI.Projects/examples/v1/Indexes_DeleteVersion_MaximumSet_Gen.json @@ -0,0 +1,12 @@ +{ + "title": "Indexes_DeleteVersion_MaximumSet", + "operationId": "Indexes_DeleteVersion", + "parameters": { + "api-version": "v1", + "name": "fb", + "version": "ajbuwvsxobvnynpcliqcylqdp" + }, + "responses": { + "204": {} + } +} diff --git a/specification/ai/Azure.AI.Projects/examples/v1/Indexes_DeleteVersion_MinimumSet_Gen.json b/specification/ai/Azure.AI.Projects/examples/v1/Indexes_DeleteVersion_MinimumSet_Gen.json new file mode 100644 index 000000000000..b8742995962a --- /dev/null +++ b/specification/ai/Azure.AI.Projects/examples/v1/Indexes_DeleteVersion_MinimumSet_Gen.json @@ -0,0 +1,12 @@ +{ + "title": "Indexes_DeleteVersion_MinimumSet", + "operationId": "Indexes_DeleteVersion", + "parameters": { + "api-version": "v1", + "name": "zoxequ", + "version": "akulwzwrfeqxh" + }, + "responses": { + "204": {} + } +} diff --git a/specification/ai/Azure.AI.Projects/examples/v1/Indexes_GetVersion_MaximumSet_Gen.json b/specification/ai/Azure.AI.Projects/examples/v1/Indexes_GetVersion_MaximumSet_Gen.json new file mode 100644 index 000000000000..22119a544952 --- /dev/null +++ b/specification/ai/Azure.AI.Projects/examples/v1/Indexes_GetVersion_MaximumSet_Gen.json @@ -0,0 +1,19 @@ +{ + "title": "Indexes_GetVersion_MaximumSet", + "operationId": "Indexes_GetVersion", + "parameters": { + "api-version": "v1", + "name": "ascwgkgwpqxeinbp", + "version": "bqhzitucneeoxurvf" + }, + "responses": { + "200": { + "body": { + "type": "Index", + "id": "xtjevbrwrwuwkbujuwpq", + "name": "wwikvkcdcobt", + "version": "swnonkxmjl" + } + } + } +} diff --git a/specification/ai/Azure.AI.Projects/examples/v1/Indexes_GetVersion_MinimumSet_Gen.json b/specification/ai/Azure.AI.Projects/examples/v1/Indexes_GetVersion_MinimumSet_Gen.json new file mode 100644 index 000000000000..f3918ab409a3 --- /dev/null +++ b/specification/ai/Azure.AI.Projects/examples/v1/Indexes_GetVersion_MinimumSet_Gen.json @@ -0,0 +1,18 @@ +{ + "title": "Indexes_GetVersion_MinimumSet", + "operationId": "Indexes_GetVersion", + "parameters": { + "api-version": "v1", + "name": "sflsamumttlwccuxveocgozlkmdme", + "version": "txg" + }, + "responses": { + "200": { + "body": { + "type": "Index", + "name": "wwikvkcdcobt", + "version": "swnonkxmjl" + } + } + } +} diff --git a/specification/ai/Azure.AI.Projects/examples/v1/Indexes_ListLatest_MaximumSet_Gen.json b/specification/ai/Azure.AI.Projects/examples/v1/Indexes_ListLatest_MaximumSet_Gen.json new file mode 100644 index 000000000000..5a34d862b95c --- /dev/null +++ b/specification/ai/Azure.AI.Projects/examples/v1/Indexes_ListLatest_MaximumSet_Gen.json @@ -0,0 +1,26 @@ +{ + "title": "Indexes_ListLatest_MaximumSet", + "operationId": "Indexes_ListLatest", + "parameters": { + "api-version": "v1", + "top": 16, + "skip": "cbeuhxuzaucwgqj", + "tags": "ecxlvszgcepwunik", + "listViewType": "ActiveOnly" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "type": "Index", + "id": "xtjevbrwrwuwkbujuwpq", + "name": "wwikvkcdcobt", + "version": "swnonkxmjl" + } + ], + "nextLink": "https://microsoft.com/av" + } + } + } +} diff --git a/specification/ai/Azure.AI.Projects/examples/v1/Indexes_ListLatest_MinimumSet_Gen.json b/specification/ai/Azure.AI.Projects/examples/v1/Indexes_ListLatest_MinimumSet_Gen.json new file mode 100644 index 000000000000..9ee9e1422b9c --- /dev/null +++ b/specification/ai/Azure.AI.Projects/examples/v1/Indexes_ListLatest_MinimumSet_Gen.json @@ -0,0 +1,20 @@ +{ + "title": "Indexes_ListLatest_MinimumSet", + "operationId": "Indexes_ListLatest", + "parameters": { + "api-version": "v1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "type": "Index", + "name": "wwikvkcdcobt", + "version": "swnonkxmjl" + } + ] + } + } + } +} diff --git a/specification/ai/Azure.AI.Projects/examples/v1/Indexes_ListVersions_MaximumSet_Gen.json b/specification/ai/Azure.AI.Projects/examples/v1/Indexes_ListVersions_MaximumSet_Gen.json new file mode 100644 index 000000000000..63e20b44b11a --- /dev/null +++ b/specification/ai/Azure.AI.Projects/examples/v1/Indexes_ListVersions_MaximumSet_Gen.json @@ -0,0 +1,27 @@ +{ + "title": "Indexes_ListVersions_MaximumSet", + "operationId": "Indexes_ListVersions", + "parameters": { + "api-version": "v1", + "name": "ugobcytrjfdfu", + "top": 12, + "skip": "vspvqu", + "tags": "fwbwsyszezlzabrudeswnvoqoq", + "listViewType": "ActiveOnly" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "type": "Index", + "id": "xtjevbrwrwuwkbujuwpq", + "name": "wwikvkcdcobt", + "version": "swnonkxmjl" + } + ], + "nextLink": "https://microsoft.com/av" + } + } + } +} diff --git a/specification/ai/Azure.AI.Projects/examples/v1/Indexes_ListVersions_MinimumSet_Gen.json b/specification/ai/Azure.AI.Projects/examples/v1/Indexes_ListVersions_MinimumSet_Gen.json new file mode 100644 index 000000000000..ba599e422489 --- /dev/null +++ b/specification/ai/Azure.AI.Projects/examples/v1/Indexes_ListVersions_MinimumSet_Gen.json @@ -0,0 +1,21 @@ +{ + "title": "Indexes_ListVersions_MinimumSet", + "operationId": "Indexes_ListVersions", + "parameters": { + "api-version": "v1", + "name": "lenbliqxnfqi" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "type": "Index", + "name": "wwikvkcdcobt", + "version": "swnonkxmjl" + } + ] + } + } + } +} diff --git a/specification/ai/Azure.AI.Projects/indexes/models.tsp b/specification/ai/Azure.AI.Projects/indexes/models.tsp new file mode 100644 index 000000000000..4bdce439118b --- /dev/null +++ b/specification/ai/Azure.AI.Projects/indexes/models.tsp @@ -0,0 +1,132 @@ +import "@typespec/rest"; +import "@azure-tools/typespec-autorest"; +import "@typespec/versioning"; +import "@azure-tools/typespec-azure-core"; +import "../common/models.tsp"; +import "../main.tsp"; + +using TypeSpec.Versioning; + +namespace Azure.AI.Projects; + +@doc("Index resource Definition") +@discriminator("type") +@Rest.resource("indexes") +@added(Versions.v2025_05_01) +model Index { + @doc("Type of index") + type: IndexType; + + ...AssetBase; +} + +@doc("Azure AI Search Index Definition") +@added(Versions.v2025_05_01) +model AzureAISearchIndex extends Index { + @doc("Type of index") + type: IndexType.azureSearch; + + @doc("Name of connection to Azure AI Search") + @visibility(Lifecycle.Create) + connectionName: string; + + @doc("Name of index in Azure AI Search resource to attach") + @visibility(Lifecycle.Create) + indexName: string; + + @doc("Field mapping configuration") + @visibility(Lifecycle.Create) + fieldMapping?: FieldMapping; +} + +@doc("Managed Azure AI Search Index Definition") +@added(Versions.v2025_05_01) +model ManagedAzureAISearchIndex extends Index { + @doc("Type of index") + type: IndexType.managedAzureSearch; + + @doc("Vector store id of managed index") + @visibility(Lifecycle.Create) + vectorStoreId: string; +} + +@doc("CosmosDB Vector Store Index Definition") +@added(Versions.v2025_05_01) +model CosmosDBIndex extends Index { + @doc("Type of index") + type: IndexType.cosmosDB; + + @doc("Name of connection to CosmosDB") + @visibility(Lifecycle.Create) + connectionName: string; + + @doc("Name of the CosmosDB Database") + @visibility(Lifecycle.Create) + databaseName: string; + + @doc("Name of CosmosDB Container") + @visibility(Lifecycle.Create) + containerName: string; + + @doc("Embedding model configuration") + @visibility(Lifecycle.Create) + embeddingConfiguration: EmbeddingConfiguration; + + @doc("Field mapping configuration") + @visibility(Lifecycle.Create) + fieldMapping: FieldMapping; +} + +@doc("Embedding configuration class") +@added(Versions.v2025_05_01) +model EmbeddingConfiguration { + @doc("Deployment name of embedding model. It can point to a model deployment either in the parent AIServices or a connection.") + @visibility(Lifecycle.Create) + modelDeploymentName: string; + + @doc("Embedding field") + @visibility(Lifecycle.Create) + embeddingField: string; +} + +@doc("Field mapping configuration class") +@added(Versions.v2025_05_01) +model FieldMapping { + @doc("List of fields with text content") + @visibility(Lifecycle.Create) + contentFields: string[]; + + @doc("Path of file to be used as a source of text content") + @visibility(Lifecycle.Create) + filepathField?: string; + + @doc("Field containing the title of the document") + @visibility(Lifecycle.Create) + titleField?: string; + + @doc("Field containing the url of the document") + @visibility(Lifecycle.Create) + urlField?: string; + + @doc("List of fields with vector content") + @visibility(Lifecycle.Create) + vectorFields?: string[]; + + @doc("List of fields with metadata content") + @visibility(Lifecycle.Create) + metadataFields?: string[]; +} + +@added(Versions.v2025_05_01) +union IndexType { + string, + + @doc("Azure search") + azureSearch: "AzureSearch", + + @doc("CosmosDB") + cosmosDB: "CosmosDBNoSqlVectorStore", + + @doc("Managed Azure Search") + managedAzureSearch: "ManagedAzureSearch", +} diff --git a/specification/ai/Azure.AI.Projects/indexes/routes.tsp b/specification/ai/Azure.AI.Projects/indexes/routes.tsp new file mode 100644 index 000000000000..0ff537f47c20 --- /dev/null +++ b/specification/ai/Azure.AI.Projects/indexes/routes.tsp @@ -0,0 +1,22 @@ +import "@typespec/rest"; +import "@azure-tools/typespec-autorest"; +import "@typespec/versioning"; +import "@azure-tools/typespec-azure-core"; +import "./models.tsp"; +import "../servicepatterns.tsp"; +import "../common/models.tsp"; + +using TypeSpec.Versioning; + +namespace Azure.AI.Projects; + +alias ListIndexVersionParameters = {}; + +#suppress "@azure-tools/typespec-azure-core/use-standard-operations" "We are using service specific operation templates" +@added(Versions.v2025_05_01) +interface Indexes + extends ServicePatterns.VersionedOperations< + Index, + ListIndexVersionParameters, + ListIndexVersionParameters + > {} diff --git a/specification/ai/Azure.AI.Projects/main.tsp b/specification/ai/Azure.AI.Projects/main.tsp new file mode 100644 index 000000000000..eb7edfc0664c --- /dev/null +++ b/specification/ai/Azure.AI.Projects/main.tsp @@ -0,0 +1,61 @@ +import "@typespec/http"; +import "@typespec/rest"; +import "@typespec/versioning"; +import "@azure-tools/typespec-azure-core"; +import "@azure-tools/typespec-azure-resource-manager"; +import "./connections/routes.tsp"; +import "./evaluations/routes.tsp"; +import "./datasets/routes.tsp"; +import "./indexes/routes.tsp"; +import "./deployments/routes.tsp"; +import "./red-teams/routes.tsp"; + +using TypeSpec.Http; +using TypeSpec.Versioning; + +#suppress "@azure-tools/typespec-azure-core/casing-style" +namespace Azure.AI { + +} + +#suppress "@azure-tools/typespec-autorest/unsupported-http-auth-scheme" +@useAuth( + OAuth2Auth<[ + { + type: OAuth2FlowType.implicit, + authorizationUrl: "https://login.microsoftonline.com/common/oauth2/v2.0/authorize", + scopes: ["https://ai.azure.com/.default"], + } + ]> +) +@service(#{ title: "Azure AI" }) +@server( + "{endpoint}", + "Azure AI", + { + @doc(""" + Project endpoint. In the form "https://.services.ai.azure.com/api/projects/_project" + if your Foundry Hub has only one Project, or to use the default Project in your Hub. Or in the form + "https://.services.ai.azure.com/api/projects/" if you want to explicitly + specify the Foundry Project name. + """) + endpoint: url, + } +) +@versioned(Versions) +namespace Azure.AI.Projects { + @doc("Azure AI Projects API versions") + enum Versions { + @doc("Azure AI API version 2025-05-01.") + @useDependency(Azure.Core.Versions.v1_0_Preview_2) + v2025_05_01: "2025-05-01", + + @doc("Azure AI API version 2025-05-15-preview.") + @useDependency(Azure.Core.Versions.v1_0_Preview_2) + v2025_05_15_preview: "2025-05-15-preview", + + @doc("Azure AI API version v1.") + @useDependency(Azure.Core.Versions.v1_0_Preview_2) + v1: "v1", + } +} diff --git a/specification/ai/Azure.AI.Projects/red-teams/models.tsp b/specification/ai/Azure.AI.Projects/red-teams/models.tsp new file mode 100644 index 000000000000..b6ec4eb4dc58 --- /dev/null +++ b/specification/ai/Azure.AI.Projects/red-teams/models.tsp @@ -0,0 +1,173 @@ +import "@typespec/http"; +import "@typespec/rest"; +import "@azure-tools/typespec-autorest"; +import "@typespec/versioning"; +import "@azure-tools/typespec-azure-core"; +import "@typespec/openapi"; +import "../common/models.tsp"; + +using TypeSpec.Rest; +using TypeSpec.Versioning; + +namespace Azure.AI.Projects; + +@doc("Strategies for attacks.") +@added(Versions.v2025_05_15_preview) +@removed(Versions.v1) +union AttackStrategy { + string, + + @doc("Represents a default set of easy complexity attacks. Easy complexity attacks require less effort, such as translation of a prompt into some encoding, and does not require any Large Language Model to convert or orchestrate.") + Easy: "easy", + + @doc("Represents a default set of moderate complexity attacks. Moderate complexity attacks require having access to resources such as another generative AI model.") + Moderate: "moderate", + + @doc("Represents a default set of difficult complexity attacks. Difficult complexity attacks include attacks that require access to significant resources and effort to execute an attack such as knowledge of search-based algorithms in addition to a generative AI model.") + Difficult: "difficult", + + @doc("Generates visual art using ASCII characters, often used for creative or obfuscation purposes.") + AsciiArt: "ascii_art", + + @doc("Conceals data within ASCII characters, making it harder to detect.") + AsciiSmuggler: "ascii_smuggler", + + @doc("Implements the Atbash cipher, a simple substitution cipher where each letter is mapped to its reverse.") + Atbash: "atbash", + + @doc("Encodes binary data into a text format using Base64, commonly used for data transmission.") + Base64: "base64", + + @doc("Converts text into binary code, representing data in a series of 0s and 1s.") + Binary: "binary", + + @doc("Applies the Caesar cipher, a substitution cipher that shifts characters by a fixed number of positions.") + Caesar: "caesar", + + @doc("Alters text by adding spaces between characters, often used for obfuscation.") + CharacterSpace: "character_space", + + @doc("Injects specially crafted prompts to bypass AI safeguards, known as User Injected Prompt Attacks (UPIA).") + Jailbreak: "jailbreak", + + @doc("Utilizes ANSI escape sequences to manipulate text appearance and behavior.") + AnsiiAttack: "ansii_attack", + + @doc("Swaps characters within text to create variations or obfuscate the original content.") + CharacterSwap: "character_swap", + + @doc("Appends an adversarial suffix to the prompt.") + SuffixAppend: "suffix_append", + + @doc("Joins multiple strings together, often used for concatenation or obfuscation.") + StringJoin: "string_join", + + @doc("Uses Unicode characters that look similar to standard characters, creating visual confusion.") + UnicodeConfusable: "unicode_confusable", + + @doc("Substitutes standard characters with Unicode equivalents, often for obfuscation.") + UnicodeSubstitution: "unicode_substitution", + + @doc("Adds diacritical marks to characters, changing their appearance and sometimes their meaning.") + Diacritic: "diacritic", + + @doc("Flips characters from front to back, creating a mirrored effect.") + Flip: "flip", + + @doc("Transforms text into Leetspeak, a form of encoding that replaces letters with similar-looking numbers or symbols.") + Leetspeak: "leetspeak", + + @doc("Applies the ROT13 cipher, a simple substitution cipher that shifts characters by 13 positions.") + ROT13: "rot13", + + @doc("Encodes text into Morse code, using dots and dashes to represent characters.") + Morse: "morse", + + @doc("Encodes text into URL format.") + Url: "url", + + @doc("Represents the baseline direct adversarial probing, which is used by attack strategies as the attack objective.") + Baseline: "baseline", +} + +@doc("Risk category for the attack objective.") +@added(Versions.v2025_05_15_preview) +@removed(Versions.v1) +union RiskCategory { + string, + + @doc("Represents content related to hate or unfairness.") + HateUnfairness: "HateUnfairness", + + @doc("Represents content related to violence.") + Violence: "Violence", + + @doc("Represents content of a sexual nature.") + Sexual: "Sexual", + + @doc("Represents content related to self-harm.") + SelfHarm: "SelfHarm", +} + +@doc("Azure OpenAI model configuration. The API version would be selected by the service for querying the model.") +@added(Versions.v2025_05_15_preview) +@removed(Versions.v1) +model AzureOpenAIModelConfiguration extends TargetConfig { + @visibility(Lifecycle.Read) + type: "AzureOpenAIModel"; + + @doc("Deployment name for AOAI model. Example: gpt-4o if in AIServices or connection based `connection_name/deployment_name` (i.e. `my-aoai-connection/gpt-4o`.") + modelDeploymentName: string; +} + +@doc("Abstract class for target configuration.") +@added(Versions.v2025_05_15_preview) +@removed(Versions.v1) +@discriminator("type") +model TargetConfig { + @doc("Type of the model configuration.") + type: string; +} + +@doc("Red team details.") +@resource("runs") +@added(Versions.v2025_05_15_preview) +@removed(Versions.v1) +model RedTeam { + @doc("Identifier of the red team run.") + @key("name") + @encodedName("application/json", "id") + @visibility(Lifecycle.Read) + name: string; + + @doc("Name of the red-team run.") + displayName?: string; + + @doc("Number of simulation rounds.") + numTurns?: int32; + + @doc("List of attack strategies or nested lists of attack strategies.") + attackStrategies?: AttackStrategy[]; + + @doc("Simulation-only or Simulation + Evaluation. Default false, if true the scan outputs conversation not evaluation result.") + simulationOnly?: boolean = false; + + @doc("List of risk categories to generate attack objectives for.") + riskCategories?: RiskCategory[]; + + @doc("Application scenario for the red team operation, to generate scenario specific attacks.") + applicationScenario?: string; + + @doc("Red team's tags. Unlike properties, tags are fully mutable.") + tags?: Record; + + @doc("Red team's properties. Unlike tags, properties are add-only. Once added, a property cannot be removed.") + properties?: Record; + + @doc("Status of the red-team. It is set by service and is read-only.") + @visibility(Lifecycle.Read) + status?: string; + + @doc("Target configuration for the red-team run.") + target: TargetConfig; +} diff --git a/specification/ai/Azure.AI.Projects/red-teams/routes.tsp b/specification/ai/Azure.AI.Projects/red-teams/routes.tsp new file mode 100644 index 000000000000..9fcdf116796d --- /dev/null +++ b/specification/ai/Azure.AI.Projects/red-teams/routes.tsp @@ -0,0 +1,41 @@ +import "@typespec/rest"; +import "@azure-tools/typespec-autorest"; +import "@typespec/versioning"; +import "@azure-tools/typespec-azure-core"; +import "./models.tsp"; + +using TypeSpec.Http; +using TypeSpec.Versioning; +using Azure.Core.Traits; + +namespace Azure.AI.Projects; + +alias RedTeamServiceTraits = SupportsClientRequestId & + NoRepeatableRequests & + NoConditionalRequests; // NoRetryRequests suppresses @azure-tools/typespec-azure-core/conditional-requests-trait-missing + +alias RedTeamOperations = Azure.Core.ResourceOperations; + +@route("redTeams") +@added(Versions.v2025_05_15_preview) +@removed(Versions.v1) +interface RedTeams { + @doc("Get a redteam by name.") + get is RedTeamOperations.ResourceRead; + + @doc("List a redteam by name.") + list is RedTeamOperations.ResourceList; + + #suppress "@azure-tools/typespec-azure-core/use-standard-operations" + @doc("Creates a redteam run.") + @route("runs:run") + @post + create is Azure.Core.Foundations.Operation< + { + @doc("Redteam to be run") + @body + RedTeam: RedTeam; + }, + ResourceCreatedResponse + >; +} diff --git a/specification/ai/Azure.AI.Projects/servicepatterns.tsp b/specification/ai/Azure.AI.Projects/servicepatterns.tsp new file mode 100644 index 000000000000..2dd4c36f9910 --- /dev/null +++ b/specification/ai/Azure.AI.Projects/servicepatterns.tsp @@ -0,0 +1,163 @@ +import "@typespec/http"; +import "@typespec/rest"; +import "@azure-tools/typespec-azure-core"; + +namespace Azure.AI.Projects.ServicePatterns { + @Rest.autoRoute + interface VersionedOperations< + TEntityType extends Reflection.Model, + TListLatestParameters extends Reflection.Model = {}, + TListVersionsParameters extends Reflection.Model = {} + > { + #suppress "@azure-tools/typespec-azure-core/verb-conflict" "We are using the resource action as a building block." + @doc("List all versions of the given {name}", TEntityType) + @Rest.action("versions") + @Rest.actionSeparator("/") + @Http.get + listVersions is BuildingBlocks.CoreOps.ResourceAction< + TEntityType, + TListVersionsParameters, + Azure.Core.Page + >; + + @doc("List the latest version of each {name}", TEntityType) + @Rest.listsResource(TEntityType) + listLatest is Azure.Core.Foundations.ResourceList< + TEntityType, + TListLatestParameters, + Azure.Core.Page + >; + + @doc("Get the specific version of the {name}", TEntityType) + getVersion is Azure.Core.Foundations.ResourceOperation< + TEntityType, + { + @doc("The specific version id of the {name} to retrieve.", TEntityType) + @Rest.segment("versions") + @Http.path + version: string; + }, + Azure.Core.Foundations.ResourceOkResponse + >; + + @doc("Delete the specific version of the {name}", TEntityType) + @Http.delete + deleteVersion is Azure.Core.Foundations.ResourceOperation< + TEntityType, + { + @doc("The version of the {name} to delete.", TEntityType) + @Rest.segment("versions") + @Http.path + version: string; + }, + Http.NoContentResponse + >; + + /* Reenable this once the service supports "unversioned" operations + @doc( + "Create a new {name}. The version id will be generated by the service.", + TEntityType + ) + @Rest.actionSeparator("/") + @Rest.action("versions") + @Http.post + create is BuildingBlocks.RepeatableCoreOps.ResourceAction< + TEntityType, + { + @doc("The definition of the {name} to create", TEntityType) + @Http.bodyRoot + body: TEntityType; + }, + TEntityType + >; + */ + + @doc( + "Create a new or update an existing {name} with the given version id", + TEntityType + ) + @Http.patch + createOrUpdateVersion is Azure.Core.Foundations.ResourceOperation< + TEntityType, + { + @doc("The definition of the {name} to create or update", TEntityType) + @Http.bodyRoot + body: TEntityType; + + @doc("Content type for patch") + @Http.header("Content-Type") + contentType: "application/merge-patch+json"; + + @doc( + "The specific version id of the {name} to create or replace.", + TEntityType + ) + @Rest.segment("versions") + @Http.path + version: string; + }, + Azure.Core.Foundations.ResourceCreatedOrOkResponse + >; + } + + @Rest.action + op VersionedResourceActionWithBody< + TEntityType extends Reflection.Model, + TParams, + TResponse + > is Azure.Core.Foundations.ResourceOperation< + TEntityType, + { + @doc("Parameters for the action") + @Http.bodyRoot + body: TParams; + + @doc("The specific version id of the {name} to operate on.", TEntityType) + @Rest.segment("versions") + @Http.path + version: string; + }, + TResponse + >; + + @Rest.action + op VersionedResourceActionNoBody< + TEntityType extends Reflection.Model, + TResponse + > is Azure.Core.Foundations.ResourceOperation< + TEntityType, + { + @doc("The specific version id of the {name} to operate on.", TEntityType) + @Rest.segment("versions") + @Http.path + version: string; + }, + TResponse + >; + + /* Reenable this once the service supports "unversioned" operations + @Rest.action + op UnversionedResourceAction< + TEntityType extends Reflection.Model, + TParams, + TResponse + > is Azure.Core.Foundations.ResourceOperation< + TEntityType, + { + @doc("Parameters for the action") + @Http.bodyRoot + body: TParams; + }, + TResponse + >; + */ + + namespace BuildingBlocks { + alias CoreOps = Azure.Core.StandardResourceOperations; + /* + alias RepeatableCoreOps = Azure.Core.ResourceOperations; + */ + } +} diff --git a/specification/ai/Azure.AI.Projects/suppressions.yaml b/specification/ai/Azure.AI.Projects/suppressions.yaml new file mode 100644 index 000000000000..0c482b38e9ad --- /dev/null +++ b/specification/ai/Azure.AI.Projects/suppressions.yaml @@ -0,0 +1,17 @@ +- tool: TypeSpecValidation + paths: + - tspconfig.yaml + rules: + - SdkTspConfigValidation + sub-rules: + # Suppress validation for a Go emitter options + - options.@azure-tools/typespec-go.generate-fakes + - options.@azure-tools/typespec-go.inject-spans + - options.@azure-tools/typespec-go.service-dir + - options.@azure-tools/typespec-go.package-dir + # Suppress JS package & dir names related to RLC, which require "rest" in the name. We do not use RLC. + - options.@azure-tools/typespec-ts.package-dir + - options.@azure-tools/typespec-ts.package-details.name + # Do not force me to generate Python samples + - options.@azure-tools/typespec-python.generate-sample + reason: 'See above comments for details' diff --git a/specification/ai/Azure.AI.Projects/tspconfig.yaml b/specification/ai/Azure.AI.Projects/tspconfig.yaml new file mode 100644 index 000000000000..3b38feb962b2 --- /dev/null +++ b/specification/ai/Azure.AI.Projects/tspconfig.yaml @@ -0,0 +1,56 @@ +parameters: + "service-dir": + default: "sdk/ai" +emit: + - "@azure-tools/typespec-autorest" +options: + "@azure-tools/typespec-autorest": + emitter-output-dir: "{project-root}/.." + azure-resource-provider-folder: "data-plane" + emit-lro-options: "none" + output-file: "{azure-resource-provider-folder}/{service-name}/{version-status}/{version}/azure-ai-projects.json" + "@azure-tools/typespec-python": + package-mode: "dataplane" + package-dir: "azure-ai-projects" + package-name: "{package-dir}" + namespace: "azure.ai.projects" + api-version: "2025-05-15-preview" + flavor: azure + generate-test: true + generate-sample: false + "@azure-tools/typespec-csharp": + package-mode: "dataplane" + package-dir: "Azure.AI.Projects" + namespace: "{package-dir}" + package-name: "{package-dir}" + api-version: "2025-05-15-preview" + model-namespace: false + flavor: azure + generate-test: false + generate-sample: false + clear-output-folder: true + "@azure-tools/typespec-ts": + package-dir: "ai-projects" + api-version: "2025-05-15-preview" + is-modular-library: true + generate-test: true + generate-metadata: false + package-details: + name: "@azure/ai-projects" + description: "Azure AI Projects Client" + flavor: azure + "@azure-tools/typespec-java": + package-dir: "azure-ai-projects" + namespace: com.azure.ai.projects + partial-update: true + enable-sync-stack: true + generate-tests: false + flavor: azure +linter: + extends: + - "@azure-tools/typespec-azure-rulesets/data-plane" + disable: + "@azure-tools/typespec-azure-core/casing-style": "Since we have many names in the form XxxxAIXxxx" + "@azure-tools/typespec-azure-core/no-string-discriminator": "Use an extensible union instead of a plain string" + "@azure-tools/typespec-azure-core/bad-record-type": "We do want to use Record, and not Record. But this needs further investigation" + "@azure-tools/typespec-azure-core/use-standard-names": "PUT operations that return 200 should start with 'replace' or 'createOrReplace'" diff --git a/specification/ai/cspell.yaml b/specification/ai/cspell.yaml index 2f9086f3bcc3..33cb982b79c7 100644 --- a/specification/ai/cspell.yaml +++ b/specification/ai/cspell.yaml @@ -38,9 +38,17 @@ words: - tyrer - ubinary - umls + - unversioned - upca - upce - wordprocessingml + - azureai + - atbash + - onedp + - ansii + - upia + - aoai + - azaiprojects overrides: - filename: >- **/specification/ai/data-plane/DocumentIntelligence/**/DocumentIntelligence.json diff --git a/specification/ai/data-plane/Azure.AI.Projects/preview/2025-05-15-preview/azure-ai-projects.json b/specification/ai/data-plane/Azure.AI.Projects/preview/2025-05-15-preview/azure-ai-projects.json new file mode 100644 index 000000000000..c9ee48da4370 --- /dev/null +++ b/specification/ai/data-plane/Azure.AI.Projects/preview/2025-05-15-preview/azure-ai-projects.json @@ -0,0 +1,3128 @@ +{ + "swagger": "2.0", + "info": { + "title": "Azure AI", + "version": "2025-05-15-preview", + "x-typespec-generated": [ + { + "emitter": "@azure-tools/typespec-autorest" + } + ] + }, + "schemes": [ + "https" + ], + "x-ms-parameterized-host": { + "hostTemplate": "{endpoint}", + "useSchemePrefix": false, + "parameters": [ + { + "name": "endpoint", + "in": "path", + "description": "Project endpoint. In the form \"https://.services.ai.azure.com/api/projects/_project\"\nif your Foundry Hub has only one Project, or to use the default Project in your Hub. Or in the form \n\"https://.services.ai.azure.com/api/projects/\" if you want to explicitly\nspecify the Foundry Project name.", + "required": true, + "type": "string", + "format": "uri", + "x-ms-skip-url-encoding": true + } + ] + }, + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ], + "security": [ + { + "OAuth2Auth": [ + "https://ai.azure.com/.default" + ] + } + ], + "securityDefinitions": { + "OAuth2Auth": { + "type": "oauth2", + "flow": "implicit", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/v2.0/authorize", + "scopes": { + "https://ai.azure.com/.default": "" + } + } + }, + "tags": [], + "paths": { + "/connections": { + "get": { + "operationId": "Connections_List", + "description": "List all connections in the project, without populating connection credentials", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "connectionType", + "in": "query", + "description": "List connections of this specific type", + "required": false, + "type": "string", + "enum": [ + "AzureOpenAI", + "AzureBlob", + "AzureStorageAccount", + "CognitiveSearch", + "CosmosDB", + "ApiKey", + "AppConfig", + "AppInsights", + "CustomKeys" + ], + "x-ms-enum": { + "name": "ConnectionType", + "modelAsString": true, + "values": [ + { + "name": "AzureOpenAI", + "value": "AzureOpenAI", + "description": "Azure OpenAI Service" + }, + { + "name": "AzureBlobStorage", + "value": "AzureBlob", + "description": "Azure Blob Storage, with specified container" + }, + { + "name": "AzureStorageAccount", + "value": "AzureStorageAccount", + "description": "Azure Blob Storage, with container not specified (used by Agents)" + }, + { + "name": "AzureAISearch", + "value": "CognitiveSearch", + "description": "Azure AI Search" + }, + { + "name": "CosmosDB", + "value": "CosmosDB", + "description": "CosmosDB" + }, + { + "name": "APIKey", + "value": "ApiKey", + "description": "Generic connection that uses API Key authentication" + }, + { + "name": "ApplicationConfiguration", + "value": "AppConfig", + "description": "Application Configuration" + }, + { + "name": "ApplicationInsights", + "value": "AppInsights", + "description": "Application Insights" + }, + { + "name": "Custom", + "value": "CustomKeys", + "description": "Custom Keys" + } + ] + } + }, + { + "name": "defaultConnection", + "in": "query", + "description": "List connections that are default connections", + "required": false, + "type": "boolean" + }, + { + "$ref": "#/parameters/Azure.Core.ClientRequestIdHeader" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/PagedConnection" + }, + "headers": { + "x-ms-client-request-id": { + "type": "string", + "format": "uuid", + "description": "An opaque, globally-unique, client-generated string identifier for the request." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Connections_List_MaximumSet": { + "$ref": "./examples/Connections_List_MaximumSet_Gen.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/connections/{name}": { + "get": { + "operationId": "Connections_Get", + "description": "Get a connection by name, without populating connection credentials", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "name", + "in": "path", + "description": "The friendly name of the connection, provided by the user.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/Azure.Core.ClientRequestIdHeader" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/Connection" + }, + "headers": { + "x-ms-client-request-id": { + "type": "string", + "format": "uuid", + "description": "An opaque, globally-unique, client-generated string identifier for the request." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Connections_Get_MaximumSet": { + "$ref": "./examples/Connections_Get_MaximumSet_Gen.json" + } + } + } + }, + "/connections/{name}/getConnectionWithCredentials": { + "post": { + "operationId": "Connections_GetWithCredentials", + "description": "Get a connection by name, with its connection credentials", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "name", + "in": "path", + "description": "The friendly name of the connection, provided by the user.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/Azure.Core.ClientRequestIdHeader" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/Connection" + }, + "headers": { + "x-ms-client-request-id": { + "type": "string", + "format": "uuid", + "description": "An opaque, globally-unique, client-generated string identifier for the request." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Connections_GetWithCredentials_MaximumSet": { + "$ref": "./examples/Connections_GetWithCredentials_MaximumSet_Gen.json" + } + } + } + }, + "/datasets": { + "get": { + "operationId": "Datasets_ListLatest", + "description": "List the latest version of each DatasetVersion", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/PagedDatasetVersion" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Datasets_ListLatest_MaximumSet": { + "$ref": "./examples/Datasets_ListLatest_MaximumSet_Gen.json" + }, + "Datasets_ListLatest_MinimumSet": { + "$ref": "./examples/Datasets_ListLatest_MinimumSet_Gen.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/datasets/{name}/versions": { + "get": { + "operationId": "Datasets_ListVersions", + "description": "List all versions of the given DatasetVersion", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "name", + "in": "path", + "description": "The name of the resource", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/PagedDatasetVersion" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Datasets_ListVersions_MaximumSet": { + "$ref": "./examples/Datasets_ListVersions_MaximumSet_Gen.json" + }, + "Datasets_ListVersions_MinimumSet": { + "$ref": "./examples/Datasets_ListVersions_MinimumSet_Gen.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/datasets/{name}/versions/{version}": { + "get": { + "operationId": "Datasets_GetVersion", + "description": "Get the specific version of the DatasetVersion", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "name", + "in": "path", + "description": "The name of the resource", + "required": true, + "type": "string" + }, + { + "name": "version", + "in": "path", + "description": "The specific version id of the DatasetVersion to retrieve.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/DatasetVersion" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Datasets_GetVersion_MaximumSet": { + "$ref": "./examples/Datasets_GetVersion_MaximumSet_Gen.json" + }, + "Datasets_GetVersion_MinimumSet": { + "$ref": "./examples/Datasets_GetVersion_MinimumSet_Gen.json" + } + } + }, + "patch": { + "operationId": "Datasets_CreateOrUpdateVersion", + "description": "Create a new or update an existing DatasetVersion with the given version id", + "consumes": [ + "application/merge-patch+json" + ], + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "name", + "in": "path", + "description": "The name of the resource", + "required": true, + "type": "string" + }, + { + "name": "version", + "in": "path", + "description": "The specific version id of the DatasetVersion to create or replace.", + "required": true, + "type": "string" + }, + { + "name": "body", + "in": "body", + "description": "The definition of the DatasetVersion to create or update", + "required": true, + "schema": { + "$ref": "#/definitions/DatasetVersion" + } + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/DatasetVersion" + } + }, + "201": { + "description": "The request has succeeded and a new resource has been created as a result.", + "schema": { + "$ref": "#/definitions/DatasetVersion" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Datasets_CreateOrUpdateVersion_MaximumSet": { + "$ref": "./examples/Datasets_CreateOrUpdateVersion_MaximumSet_Gen.json" + }, + "Datasets_CreateOrUpdateVersion_MinimumSet": { + "$ref": "./examples/Datasets_CreateOrUpdateVersion_MinimumSet_Gen.json" + } + } + }, + "delete": { + "operationId": "Datasets_DeleteVersion", + "description": "Delete the specific version of the DatasetVersion", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "name", + "in": "path", + "description": "The name of the resource", + "required": true, + "type": "string" + }, + { + "name": "version", + "in": "path", + "description": "The version of the DatasetVersion to delete.", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "There is no content to send for this request, but the headers may be useful." + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Datasets_DeleteVersion_MaximumSet": { + "$ref": "./examples/Datasets_DeleteVersion_MaximumSet_Gen.json" + }, + "Datasets_DeleteVersion_MinimumSet": { + "$ref": "./examples/Datasets_DeleteVersion_MinimumSet_Gen.json" + } + } + } + }, + "/datasets/{name}/versions/{version}/credentials": { + "post": { + "operationId": "Datasets_GetCredentials", + "description": "Get the SAS credential to access the storage account associated with a Dataset version.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "name", + "in": "path", + "description": "The name of the resource", + "required": true, + "type": "string" + }, + { + "name": "version", + "in": "path", + "description": "The specific version id of the DatasetVersion to operate on.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/AssetCredentialResponse" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Datasets_GetCredentials_MaximumSet": { + "$ref": "./examples/Datasets_GetCredentials_MaximumSet_Gen.json" + }, + "Datasets_GetCredentials_MinimumSet": { + "$ref": "./examples/Datasets_GetCredentials_MinimumSet_Gen.json" + } + } + } + }, + "/datasets/{name}/versions/{version}/startPendingUpload": { + "post": { + "operationId": "Datasets_StartPendingUploadVersion", + "description": "Start a new or get an existing pending upload of a dataset for a specific version.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "name", + "in": "path", + "description": "The name of the resource", + "required": true, + "type": "string" + }, + { + "name": "version", + "in": "path", + "description": "The specific version id of the DatasetVersion to operate on.", + "required": true, + "type": "string" + }, + { + "name": "body", + "in": "body", + "description": "Parameters for the action", + "required": true, + "schema": { + "$ref": "#/definitions/PendingUploadRequest" + } + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/PendingUploadResponse" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Datasets_StartPendingUploadVersion_MaximumSet": { + "$ref": "./examples/Datasets_StartPendingUploadVersion_MaximumSet_Gen.json" + }, + "Datasets_StartPendingUploadVersion_MinimumSet": { + "$ref": "./examples/Datasets_StartPendingUploadVersion_MinimumSet_Gen.json" + } + } + } + }, + "/deployments": { + "get": { + "operationId": "Deployments_List", + "description": "List all deployed models in the project", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "modelPublisher", + "in": "query", + "description": "Model publisher to filter models by", + "required": false, + "type": "string" + }, + { + "name": "modelName", + "in": "query", + "description": "Model name (the publisher specific name) to filter models by", + "required": false, + "type": "string" + }, + { + "name": "deploymentType", + "in": "query", + "description": "Type of deployment to filter list by", + "required": false, + "type": "string", + "enum": [ + "ModelDeployment" + ], + "x-ms-enum": { + "name": "DeploymentType", + "modelAsString": true, + "values": [ + { + "name": "ModelDeployment", + "value": "ModelDeployment", + "description": "Model deployment" + } + ] + } + }, + { + "$ref": "#/parameters/Azure.Core.ClientRequestIdHeader" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/PagedDeployment" + }, + "headers": { + "x-ms-client-request-id": { + "type": "string", + "format": "uuid", + "description": "An opaque, globally-unique, client-generated string identifier for the request." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Deployments_List_MaximumSet": { + "$ref": "./examples/Deployments_List_MaximumSet_Gen.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/deployments/{name}": { + "get": { + "operationId": "Deployments_Get", + "description": "Get a deployed model.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the deployment", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/Azure.Core.ClientRequestIdHeader" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/Deployment" + }, + "headers": { + "x-ms-client-request-id": { + "type": "string", + "format": "uuid", + "description": "An opaque, globally-unique, client-generated string identifier for the request." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Deployments_Get_MaximumSet": { + "$ref": "./examples/Deployments_Get_MaximumSet_Gen.json" + } + } + } + }, + "/evaluations/runs": { + "get": { + "operationId": "Evaluations_List", + "description": "List evaluation runs", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "$ref": "#/parameters/Azure.Core.ClientRequestIdHeader" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/PagedEvaluation" + }, + "headers": { + "x-ms-client-request-id": { + "type": "string", + "format": "uuid", + "description": "An opaque, globally-unique, client-generated string identifier for the request." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Evaluations_List_MaximumSet": { + "$ref": "./examples/Evaluations_List_MaximumSet_Gen.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/evaluations/runs/{name}": { + "get": { + "operationId": "Evaluations_Get", + "description": "Get an evaluation run by name.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "name", + "in": "path", + "description": "Identifier of the evaluation.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/Azure.Core.ClientRequestIdHeader" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/Evaluation" + }, + "headers": { + "x-ms-client-request-id": { + "type": "string", + "format": "uuid", + "description": "An opaque, globally-unique, client-generated string identifier for the request." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Evaluations_Get_MaximumSet": { + "$ref": "./examples/Evaluations_Get_MaximumSet_Gen.json" + } + } + } + }, + "/evaluations/runs:run": { + "post": { + "operationId": "Evaluations_Create", + "description": "Creates an evaluation run.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "evaluation", + "in": "body", + "description": "Evaluation to be run", + "required": true, + "schema": { + "$ref": "#/definitions/Evaluation" + } + } + ], + "responses": { + "201": { + "description": "The request has succeeded and a new resource has been created as a result.", + "schema": { + "$ref": "#/definitions/Evaluation" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Evaluations_Create_MaximumSet": { + "$ref": "./examples/Evaluations_Create_MaximumSet_Gen.json" + }, + "Evaluations_Create_MinimumSet": { + "$ref": "./examples/Evaluations_Create_MinimumSet_Gen.json" + } + } + } + }, + "/evaluations/runs:runAgent": { + "post": { + "operationId": "Evaluations_CreateAgentEvaluation", + "description": "Creates an agent evaluation run.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "evaluation", + "in": "body", + "description": "Agent evaluation to be run", + "required": true, + "schema": { + "$ref": "#/definitions/AgentEvaluationRequest" + } + } + ], + "responses": { + "201": { + "description": "The request has succeeded and a new resource has been created as a result.", + "schema": { + "$ref": "#/definitions/AgentEvaluation" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Evaluations_CreateAgentEvaluation_MaximumSet": { + "$ref": "./examples/Evaluations_CreateAgentEvaluation_MaximumSet_Gen.json" + }, + "Evaluations_CreateAgentEvaluation_MinimumSet": { + "$ref": "./examples/Evaluations_CreateAgentEvaluation_MinimumSet_Gen.json" + } + } + } + }, + "/indexes": { + "get": { + "operationId": "Indexes_ListLatest", + "description": "List the latest version of each Index", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/PagedIndex" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Indexes_ListLatest_MaximumSet": { + "$ref": "./examples/Indexes_ListLatest_MaximumSet_Gen.json" + }, + "Indexes_ListLatest_MinimumSet": { + "$ref": "./examples/Indexes_ListLatest_MinimumSet_Gen.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/indexes/{name}/versions": { + "get": { + "operationId": "Indexes_ListVersions", + "description": "List all versions of the given Index", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "name", + "in": "path", + "description": "The name of the resource", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/PagedIndex" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Indexes_ListVersions_MaximumSet": { + "$ref": "./examples/Indexes_ListVersions_MaximumSet_Gen.json" + }, + "Indexes_ListVersions_MinimumSet": { + "$ref": "./examples/Indexes_ListVersions_MinimumSet_Gen.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/indexes/{name}/versions/{version}": { + "get": { + "operationId": "Indexes_GetVersion", + "description": "Get the specific version of the Index", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "name", + "in": "path", + "description": "The name of the resource", + "required": true, + "type": "string" + }, + { + "name": "version", + "in": "path", + "description": "The specific version id of the Index to retrieve.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/Index" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Indexes_GetVersion_MaximumSet": { + "$ref": "./examples/Indexes_GetVersion_MaximumSet_Gen.json" + }, + "Indexes_GetVersion_MinimumSet": { + "$ref": "./examples/Indexes_GetVersion_MinimumSet_Gen.json" + } + } + }, + "patch": { + "operationId": "Indexes_CreateOrUpdateVersion", + "description": "Create a new or update an existing Index with the given version id", + "consumes": [ + "application/merge-patch+json" + ], + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "name", + "in": "path", + "description": "The name of the resource", + "required": true, + "type": "string" + }, + { + "name": "version", + "in": "path", + "description": "The specific version id of the Index to create or replace.", + "required": true, + "type": "string" + }, + { + "name": "body", + "in": "body", + "description": "The definition of the Index to create or update", + "required": true, + "schema": { + "$ref": "#/definitions/Index" + } + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/Index" + } + }, + "201": { + "description": "The request has succeeded and a new resource has been created as a result.", + "schema": { + "$ref": "#/definitions/Index" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Indexes_CreateOrUpdateVersion_MaximumSet": { + "$ref": "./examples/Indexes_CreateOrUpdateVersion_MaximumSet_Gen.json" + }, + "Indexes_CreateOrUpdateVersion_MinimumSet": { + "$ref": "./examples/Indexes_CreateOrUpdateVersion_MinimumSet_Gen.json" + } + } + }, + "delete": { + "operationId": "Indexes_DeleteVersion", + "description": "Delete the specific version of the Index", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "name", + "in": "path", + "description": "The name of the resource", + "required": true, + "type": "string" + }, + { + "name": "version", + "in": "path", + "description": "The version of the Index to delete.", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "There is no content to send for this request, but the headers may be useful." + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Indexes_DeleteVersion_MaximumSet": { + "$ref": "./examples/Indexes_DeleteVersion_MaximumSet_Gen.json" + }, + "Indexes_DeleteVersion_MinimumSet": { + "$ref": "./examples/Indexes_DeleteVersion_MinimumSet_Gen.json" + } + } + } + }, + "/redTeams/runs": { + "get": { + "operationId": "RedTeams_List", + "description": "List a redteam by name.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "$ref": "#/parameters/Azure.Core.ClientRequestIdHeader" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/PagedRedTeam" + }, + "headers": { + "x-ms-client-request-id": { + "type": "string", + "format": "uuid", + "description": "An opaque, globally-unique, client-generated string identifier for the request." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "RedTeams_List_MaximumSet": { + "$ref": "./examples/RedTeams_List_MaximumSet_Gen.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/redTeams/runs/{name}": { + "get": { + "operationId": "RedTeams_Get", + "description": "Get a redteam by name.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "name", + "in": "path", + "description": "Identifier of the red team run.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/Azure.Core.ClientRequestIdHeader" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/RedTeam" + }, + "headers": { + "x-ms-client-request-id": { + "type": "string", + "format": "uuid", + "description": "An opaque, globally-unique, client-generated string identifier for the request." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "RedTeams_Get_MaximumSet": { + "$ref": "./examples/RedTeams_Get_MaximumSet_Gen.json" + } + } + } + }, + "/redTeams/runs:run": { + "post": { + "operationId": "RedTeams_Create", + "description": "Creates a redteam run.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "RedTeam", + "in": "body", + "description": "Redteam to be run", + "required": true, + "schema": { + "$ref": "#/definitions/RedTeam" + } + } + ], + "responses": { + "201": { + "description": "The request has succeeded and a new resource has been created as a result.", + "schema": { + "$ref": "#/definitions/RedTeam" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "RedTeams_Create_MaximumSet": { + "$ref": "./examples/RedTeams_Create_MaximumSet_Gen.json" + }, + "RedTeams_Create_MinimumSet": { + "$ref": "./examples/RedTeams_Create_MinimumSet_Gen.json" + } + } + } + } + }, + "definitions": { + "AgentEvaluation": { + "type": "object", + "description": "Evaluation response for agent evaluation run.", + "properties": { + "id": { + "type": "string", + "description": "Identifier of the agent evaluation run." + }, + "status": { + "type": "string", + "description": "Status of the agent evaluation. Options: Running, Completed, Failed." + }, + "error": { + "type": "string", + "description": "The reason of the request failure for the long running process, if applicable." + }, + "result": { + "type": "array", + "description": "The agent evaluation result.", + "items": { + "$ref": "#/definitions/AgentEvaluationResult" + }, + "x-ms-identifiers": [] + } + }, + "required": [ + "id", + "status" + ] + }, + "AgentEvaluationRedactionConfiguration": { + "type": "object", + "description": "The redaction configuration will allow the user to control what is redacted.", + "properties": { + "redactScoreProperties": { + "type": "boolean", + "description": "Redact score properties. If not specified, the default is to redact in production." + } + } + }, + "AgentEvaluationRequest": { + "type": "object", + "description": "Evaluation request for agent run.", + "properties": { + "runId": { + "type": "string", + "description": "Identifier of the agent run." + }, + "threadId": { + "type": "string", + "description": "Identifier of the agent thread. This field is mandatory currently, but it will be optional in the future." + }, + "evaluators": { + "type": "object", + "description": "Evaluators to be used for the evaluation.", + "additionalProperties": { + "$ref": "#/definitions/EvaluatorConfiguration" + } + }, + "samplingConfiguration": { + "$ref": "#/definitions/AgentEvaluationSamplingConfiguration", + "description": "Sampling configuration for the evaluation." + }, + "redactionConfiguration": { + "$ref": "#/definitions/AgentEvaluationRedactionConfiguration", + "description": "Redaction configuration for the evaluation." + }, + "appInsightsConnectionString": { + "type": "string", + "description": "Pass the AppInsights connection string to the agent evaluation for the evaluation results and the errors logs." + } + }, + "required": [ + "runId", + "evaluators", + "appInsightsConnectionString" + ] + }, + "AgentEvaluationResult": { + "type": "object", + "description": "Result for the agent evaluation evaluator run.", + "properties": { + "evaluator": { + "type": "string", + "description": "Evaluator's name. This is the name of the evaluator that was used to evaluate the agent's completion." + }, + "evaluatorId": { + "type": "string", + "description": "Identifier of the evaluator." + }, + "score": { + "type": "number", + "format": "float", + "description": "Score of the given evaluator. No restriction on range." + }, + "status": { + "type": "string", + "description": "Status of the evaluator result. Options: Running, Completed, Failed, NotApplicable." + }, + "reason": { + "type": "string", + "description": "Reasoning for the evaluation result." + }, + "version": { + "type": "string", + "description": "Version of the evaluator that was used to evaluate the agent's completion." + }, + "threadId": { + "type": "string", + "description": "The unique identifier of the thread." + }, + "runId": { + "type": "string", + "description": "The unique identifier of the run." + }, + "error": { + "type": "string", + "description": "A string explaining why there was an error, if applicable." + }, + "additionalDetails": { + "type": "object", + "description": "Additional properties relevant to the evaluator. These will differ between evaluators.", + "additionalProperties": { + "type": "string" + } + } + }, + "required": [ + "evaluator", + "evaluatorId", + "score", + "status", + "runId" + ] + }, + "AgentEvaluationSamplingConfiguration": { + "type": "object", + "description": "Definition for sampling strategy.", + "properties": { + "name": { + "type": "string", + "description": "Name of the sampling strategy." + }, + "samplingPercent": { + "type": "number", + "format": "float", + "description": "Percentage of sampling per hour (0-100)." + }, + "maxRequestRate": { + "type": "number", + "format": "float", + "description": "Maximum request rate per hour (0 to 1000)." + } + }, + "required": [ + "name", + "samplingPercent", + "maxRequestRate" + ] + }, + "ApiKeyCredentials": { + "type": "object", + "description": "API Key Credential definition", + "properties": { + "key": { + "type": "string", + "description": "API Key", + "readOnly": true, + "x-ms-client-name": "apiKey" + } + }, + "allOf": [ + { + "$ref": "#/definitions/BaseCredentials" + } + ], + "x-ms-discriminator-value": "ApiKey" + }, + "AssetCredentialResponse": { + "type": "object", + "description": "Represents a reference to a blob for consumption", + "properties": { + "blobReference": { + "$ref": "#/definitions/BlobReference", + "description": "Credential info to access the storage account." + } + }, + "required": [ + "blobReference" + ] + }, + "AttackStrategy": { + "type": "string", + "description": "Strategies for attacks.", + "enum": [ + "easy", + "moderate", + "difficult", + "ascii_art", + "ascii_smuggler", + "atbash", + "base64", + "binary", + "caesar", + "character_space", + "jailbreak", + "ansii_attack", + "character_swap", + "suffix_append", + "string_join", + "unicode_confusable", + "unicode_substitution", + "diacritic", + "flip", + "leetspeak", + "rot13", + "morse", + "url", + "baseline" + ], + "x-ms-enum": { + "name": "AttackStrategy", + "modelAsString": true, + "values": [ + { + "name": "Easy", + "value": "easy", + "description": "Represents a default set of easy complexity attacks. Easy complexity attacks require less effort, such as translation of a prompt into some encoding, and does not require any Large Language Model to convert or orchestrate." + }, + { + "name": "Moderate", + "value": "moderate", + "description": "Represents a default set of moderate complexity attacks. Moderate complexity attacks require having access to resources such as another generative AI model." + }, + { + "name": "Difficult", + "value": "difficult", + "description": "Represents a default set of difficult complexity attacks. Difficult complexity attacks include attacks that require access to significant resources and effort to execute an attack such as knowledge of search-based algorithms in addition to a generative AI model." + }, + { + "name": "AsciiArt", + "value": "ascii_art", + "description": "Generates visual art using ASCII characters, often used for creative or obfuscation purposes." + }, + { + "name": "AsciiSmuggler", + "value": "ascii_smuggler", + "description": "Conceals data within ASCII characters, making it harder to detect." + }, + { + "name": "Atbash", + "value": "atbash", + "description": "Implements the Atbash cipher, a simple substitution cipher where each letter is mapped to its reverse." + }, + { + "name": "Base64", + "value": "base64", + "description": "Encodes binary data into a text format using Base64, commonly used for data transmission." + }, + { + "name": "Binary", + "value": "binary", + "description": "Converts text into binary code, representing data in a series of 0s and 1s." + }, + { + "name": "Caesar", + "value": "caesar", + "description": "Applies the Caesar cipher, a substitution cipher that shifts characters by a fixed number of positions." + }, + { + "name": "CharacterSpace", + "value": "character_space", + "description": "Alters text by adding spaces between characters, often used for obfuscation." + }, + { + "name": "Jailbreak", + "value": "jailbreak", + "description": "Injects specially crafted prompts to bypass AI safeguards, known as User Injected Prompt Attacks (UPIA)." + }, + { + "name": "AnsiiAttack", + "value": "ansii_attack", + "description": "Utilizes ANSI escape sequences to manipulate text appearance and behavior." + }, + { + "name": "CharacterSwap", + "value": "character_swap", + "description": "Swaps characters within text to create variations or obfuscate the original content." + }, + { + "name": "SuffixAppend", + "value": "suffix_append", + "description": "Appends an adversarial suffix to the prompt." + }, + { + "name": "StringJoin", + "value": "string_join", + "description": "Joins multiple strings together, often used for concatenation or obfuscation." + }, + { + "name": "UnicodeConfusable", + "value": "unicode_confusable", + "description": "Uses Unicode characters that look similar to standard characters, creating visual confusion." + }, + { + "name": "UnicodeSubstitution", + "value": "unicode_substitution", + "description": "Substitutes standard characters with Unicode equivalents, often for obfuscation." + }, + { + "name": "Diacritic", + "value": "diacritic", + "description": "Adds diacritical marks to characters, changing their appearance and sometimes their meaning." + }, + { + "name": "Flip", + "value": "flip", + "description": "Flips characters from front to back, creating a mirrored effect." + }, + { + "name": "Leetspeak", + "value": "leetspeak", + "description": "Transforms text into Leetspeak, a form of encoding that replaces letters with similar-looking numbers or symbols." + }, + { + "name": "ROT13", + "value": "rot13", + "description": "Applies the ROT13 cipher, a simple substitution cipher that shifts characters by 13 positions." + }, + { + "name": "Morse", + "value": "morse", + "description": "Encodes text into Morse code, using dots and dashes to represent characters." + }, + { + "name": "Url", + "value": "url", + "description": "Encodes text into URL format." + }, + { + "name": "Baseline", + "value": "baseline", + "description": "Represents the baseline direct adversarial probing, which is used by attack strategies as the attack objective." + } + ] + } + }, + "Azure.Core.Foundations.Error": { + "type": "object", + "description": "The error object.", + "properties": { + "code": { + "type": "string", + "description": "One of a server-defined set of error codes." + }, + "message": { + "type": "string", + "description": "A human-readable representation of the error." + }, + "target": { + "type": "string", + "description": "The target of the error." + }, + "details": { + "type": "array", + "description": "An array of details about specific errors that led to this reported error.", + "items": { + "$ref": "#/definitions/Azure.Core.Foundations.Error" + }, + "x-ms-identifiers": [] + }, + "innererror": { + "$ref": "#/definitions/Azure.Core.Foundations.InnerError", + "description": "An object containing more specific information than the current object about the error." + } + }, + "required": [ + "code", + "message" + ] + }, + "Azure.Core.Foundations.ErrorResponse": { + "type": "object", + "description": "A response containing error details.", + "properties": { + "error": { + "$ref": "#/definitions/Azure.Core.Foundations.Error", + "description": "The error object." + } + }, + "required": [ + "error" + ] + }, + "Azure.Core.Foundations.InnerError": { + "type": "object", + "description": "An object containing more specific information about the error. As per Microsoft One API guidelines - https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors.", + "properties": { + "code": { + "type": "string", + "description": "One of a server-defined set of error codes." + }, + "innererror": { + "$ref": "#/definitions/Azure.Core.Foundations.InnerError", + "description": "Inner error." + } + } + }, + "AzureAISearchIndex": { + "type": "object", + "description": "Azure AI Search Index Definition", + "properties": { + "connectionName": { + "type": "string", + "description": "Name of connection to Azure AI Search", + "x-ms-mutability": [ + "create" + ] + }, + "indexName": { + "type": "string", + "description": "Name of index in Azure AI Search resource to attach", + "x-ms-mutability": [ + "create" + ] + }, + "fieldMapping": { + "$ref": "#/definitions/FieldMapping", + "description": "Field mapping configuration", + "x-ms-mutability": [ + "create" + ] + } + }, + "required": [ + "connectionName", + "indexName" + ], + "allOf": [ + { + "$ref": "#/definitions/Index" + } + ], + "x-ms-discriminator-value": "AzureSearch" + }, + "AzureOpenAIModelConfiguration": { + "type": "object", + "description": "Azure OpenAI model configuration. The API version would be selected by the service for querying the model.", + "properties": { + "modelDeploymentName": { + "type": "string", + "description": "Deployment name for AOAI model. Example: gpt-4o if in AIServices or connection based `connection_name/deployment_name` (i.e. `my-aoai-connection/gpt-4o`." + } + }, + "required": [ + "modelDeploymentName" + ], + "allOf": [ + { + "$ref": "#/definitions/TargetConfig" + } + ], + "x-ms-discriminator-value": "AzureOpenAIModel" + }, + "BaseCredentials": { + "type": "object", + "description": "A base class for connection credentials", + "properties": { + "type": { + "$ref": "#/definitions/CredentialType", + "description": "The type of credential used by the connection", + "readOnly": true + } + }, + "discriminator": "type", + "required": [ + "type" + ] + }, + "BlobReference": { + "type": "object", + "description": "Blob reference details.", + "properties": { + "blobUri": { + "type": "string", + "description": "Blob URI path for client to upload data. Example: https://blob.windows.core.net/Container/Path" + }, + "storageAccountArmId": { + "type": "string", + "description": "ARM ID of the storage account to use." + }, + "credential": { + "$ref": "#/definitions/SasCredential", + "description": "Credential info to access the storage account." + } + }, + "required": [ + "blobUri", + "storageAccountArmId", + "credential" + ] + }, + "Connection": { + "type": "object", + "description": "Response from the list and get connections operations", + "properties": { + "name": { + "type": "string", + "description": "The friendly name of the connection, provided by the user.", + "readOnly": true + }, + "id": { + "type": "string", + "description": "A unique identifier for the connection, generated by the service", + "readOnly": true + }, + "type": { + "$ref": "#/definitions/ConnectionType", + "description": "Category of the connection", + "readOnly": true + }, + "target": { + "type": "string", + "description": "The connection URL to be used for this service", + "readOnly": true + }, + "isDefault": { + "type": "boolean", + "description": "Whether the connection is tagged as the default connection of its type", + "readOnly": true + }, + "credentials": { + "$ref": "#/definitions/BaseCredentials", + "description": "The credentials used by the connection", + "readOnly": true + }, + "metadata": { + "type": "object", + "description": "Metadata of the connection", + "additionalProperties": { + "type": "string" + }, + "readOnly": true + } + }, + "required": [ + "name", + "id", + "type", + "target", + "isDefault", + "credentials", + "metadata" + ] + }, + "ConnectionType": { + "type": "string", + "description": "The Type (or category) of the connection", + "enum": [ + "AzureOpenAI", + "AzureBlob", + "AzureStorageAccount", + "CognitiveSearch", + "CosmosDB", + "ApiKey", + "AppConfig", + "AppInsights", + "CustomKeys" + ], + "x-ms-enum": { + "name": "ConnectionType", + "modelAsString": true, + "values": [ + { + "name": "AzureOpenAI", + "value": "AzureOpenAI", + "description": "Azure OpenAI Service" + }, + { + "name": "AzureBlobStorage", + "value": "AzureBlob", + "description": "Azure Blob Storage, with specified container" + }, + { + "name": "AzureStorageAccount", + "value": "AzureStorageAccount", + "description": "Azure Blob Storage, with container not specified (used by Agents)" + }, + { + "name": "AzureAISearch", + "value": "CognitiveSearch", + "description": "Azure AI Search" + }, + { + "name": "CosmosDB", + "value": "CosmosDB", + "description": "CosmosDB" + }, + { + "name": "APIKey", + "value": "ApiKey", + "description": "Generic connection that uses API Key authentication" + }, + { + "name": "ApplicationConfiguration", + "value": "AppConfig", + "description": "Application Configuration" + }, + { + "name": "ApplicationInsights", + "value": "AppInsights", + "description": "Application Insights" + }, + { + "name": "Custom", + "value": "CustomKeys", + "description": "Custom Keys" + } + ] + } + }, + "CosmosDBIndex": { + "type": "object", + "description": "CosmosDB Vector Store Index Definition", + "properties": { + "connectionName": { + "type": "string", + "description": "Name of connection to CosmosDB", + "x-ms-mutability": [ + "create" + ] + }, + "databaseName": { + "type": "string", + "description": "Name of the CosmosDB Database", + "x-ms-mutability": [ + "create" + ] + }, + "containerName": { + "type": "string", + "description": "Name of CosmosDB Container", + "x-ms-mutability": [ + "create" + ] + }, + "embeddingConfiguration": { + "$ref": "#/definitions/EmbeddingConfiguration", + "description": "Embedding model configuration", + "x-ms-mutability": [ + "create" + ] + }, + "fieldMapping": { + "$ref": "#/definitions/FieldMapping", + "description": "Field mapping configuration", + "x-ms-mutability": [ + "create" + ] + } + }, + "required": [ + "connectionName", + "databaseName", + "containerName", + "embeddingConfiguration", + "fieldMapping" + ], + "allOf": [ + { + "$ref": "#/definitions/Index" + } + ], + "x-ms-discriminator-value": "CosmosDBNoSqlVectorStore" + }, + "CredentialType": { + "type": "string", + "description": "The credential type used by the connection", + "enum": [ + "ApiKey", + "AAD", + "SAS", + "CustomKeys", + "None" + ], + "x-ms-enum": { + "name": "CredentialType", + "modelAsString": true, + "values": [ + { + "name": "apiKey", + "value": "ApiKey", + "description": "API Key credential" + }, + { + "name": "entraId", + "value": "AAD", + "description": "Entra ID credential (formerly known as AAD)" + }, + { + "name": "SAS", + "value": "SAS", + "description": "Shared Access Signature (SAS) credential" + }, + { + "name": "custom", + "value": "CustomKeys", + "description": "Custom credential" + }, + { + "name": "None", + "value": "None", + "description": "No credential" + } + ] + } + }, + "CustomCredential": { + "type": "object", + "description": "Custom credential definition", + "properties": { + "keys": { + "type": "object", + "description": "The credential type", + "additionalProperties": { + "type": "string" + }, + "readOnly": true + } + }, + "required": [ + "keys" + ], + "allOf": [ + { + "$ref": "#/definitions/BaseCredentials" + } + ], + "x-ms-discriminator-value": "CustomKeys" + }, + "DatasetType": { + "type": "string", + "description": "Enum to determine the type of data.", + "enum": [ + "uri_file", + "uri_folder" + ], + "x-ms-enum": { + "name": "DatasetType", + "modelAsString": true, + "values": [ + { + "name": "uri_file", + "value": "uri_file", + "description": "URI file." + }, + { + "name": "uri_folder", + "value": "uri_folder", + "description": "URI folder." + } + ] + } + }, + "DatasetVersion": { + "type": "object", + "description": "DatasetVersion Definition", + "properties": { + "dataUri": { + "type": "string", + "description": "URI of the data. Example: https://go.microsoft.com/fwlink/?linkid=2202330", + "minLength": 1, + "pattern": "[a-zA-Z0-9_]", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "type": { + "$ref": "#/definitions/DatasetType", + "description": "Dataset type" + }, + "isReference": { + "type": "boolean", + "description": "Indicates if the dataset holds a reference to the storage, or the dataset manages storage itself. If true, the underlying data will not be deleted when the dataset version is deleted", + "readOnly": true + }, + "connectionName": { + "type": "string", + "description": "The Azure Storage Account connection name. Required if startPendingUploadVersion was not called before creating the Dataset", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "id": { + "type": "string", + "description": "Asset ID, a unique identifier for the asset", + "readOnly": true + }, + "name": { + "type": "string", + "description": "The name of the resource", + "readOnly": true + }, + "version": { + "type": "string", + "description": "The version of the resource", + "readOnly": true + }, + "description": { + "type": "string", + "description": "The asset description text.", + "x-ms-mutability": [ + "update", + "create" + ] + }, + "tags": { + "type": "object", + "description": "Tag dictionary. Tags can be added, removed, and updated.", + "additionalProperties": { + "type": "string" + }, + "x-ms-mutability": [ + "update", + "create" + ] + } + }, + "discriminator": "type", + "required": [ + "dataUri", + "type", + "name", + "version" + ] + }, + "Deployment": { + "type": "object", + "description": "Model Deployment Definition", + "properties": { + "type": { + "$ref": "#/definitions/DeploymentType", + "description": "The type of the deployment" + }, + "name": { + "type": "string", + "description": "Name of the deployment", + "readOnly": true + } + }, + "discriminator": "type", + "required": [ + "type", + "name" + ] + }, + "DeploymentType": { + "type": "string", + "enum": [ + "ModelDeployment" + ], + "x-ms-enum": { + "name": "DeploymentType", + "modelAsString": true, + "values": [ + { + "name": "ModelDeployment", + "value": "ModelDeployment", + "description": "Model deployment" + } + ] + } + }, + "EmbeddingConfiguration": { + "type": "object", + "description": "Embedding configuration class", + "properties": { + "modelDeploymentName": { + "type": "string", + "description": "Deployment name of embedding model. It can point to a model deployment either in the parent AIServices or a connection.", + "x-ms-mutability": [ + "create" + ] + }, + "embeddingField": { + "type": "string", + "description": "Embedding field", + "x-ms-mutability": [ + "create" + ] + } + }, + "required": [ + "modelDeploymentName", + "embeddingField" + ] + }, + "EntraIDCredentials": { + "type": "object", + "description": "Entra ID credential definition", + "allOf": [ + { + "$ref": "#/definitions/BaseCredentials" + } + ], + "x-ms-discriminator-value": "AAD" + }, + "Evaluation": { + "type": "object", + "description": "Evaluation Definition", + "properties": { + "id": { + "type": "string", + "description": "Identifier of the evaluation.", + "readOnly": true, + "x-ms-client-name": "name" + }, + "data": { + "$ref": "#/definitions/InputData", + "description": "Data for evaluation." + }, + "displayName": { + "type": "string", + "description": "Display Name for evaluation. It helps to find the evaluation easily in AI Foundry. It does not need to be unique." + }, + "description": { + "type": "string", + "description": "Description of the evaluation. It can be used to store additional information about the evaluation and is mutable." + }, + "status": { + "type": "string", + "description": "Status of the evaluation. It is set by service and is read-only.", + "readOnly": true + }, + "tags": { + "type": "object", + "description": "Evaluation's tags. Unlike properties, tags are fully mutable.", + "additionalProperties": { + "type": "string" + } + }, + "properties": { + "type": "object", + "description": "Evaluation's properties. Unlike tags, properties are add-only. Once added, a property cannot be removed.", + "additionalProperties": { + "type": "string" + } + }, + "evaluators": { + "type": "object", + "description": "Evaluators to be used for the evaluation.", + "additionalProperties": { + "$ref": "#/definitions/EvaluatorConfiguration" + } + } + }, + "required": [ + "id", + "data", + "evaluators" + ] + }, + "EvaluatorConfiguration": { + "type": "object", + "description": "Evaluator Configuration", + "properties": { + "id": { + "type": "string", + "description": "Identifier of the evaluator." + }, + "initParams": { + "type": "object", + "description": "Initialization parameters of the evaluator.", + "additionalProperties": {} + }, + "dataMapping": { + "type": "object", + "description": "Data parameters of the evaluator.", + "additionalProperties": { + "type": "string" + } + } + }, + "required": [ + "id" + ] + }, + "FieldMapping": { + "type": "object", + "description": "Field mapping configuration class", + "properties": { + "contentFields": { + "type": "array", + "description": "List of fields with text content", + "items": { + "type": "string" + }, + "x-ms-mutability": [ + "create" + ] + }, + "filepathField": { + "type": "string", + "description": "Path of file to be used as a source of text content", + "x-ms-mutability": [ + "create" + ] + }, + "titleField": { + "type": "string", + "description": "Field containing the title of the document", + "x-ms-mutability": [ + "create" + ] + }, + "urlField": { + "type": "string", + "description": "Field containing the url of the document", + "x-ms-mutability": [ + "create" + ] + }, + "vectorFields": { + "type": "array", + "description": "List of fields with vector content", + "items": { + "type": "string" + }, + "x-ms-mutability": [ + "create" + ] + }, + "metadataFields": { + "type": "array", + "description": "List of fields with metadata content", + "items": { + "type": "string" + }, + "x-ms-mutability": [ + "create" + ] + } + }, + "required": [ + "contentFields" + ] + }, + "FileDatasetVersion": { + "type": "object", + "description": "FileDatasetVersion Definition", + "allOf": [ + { + "$ref": "#/definitions/DatasetVersion" + } + ], + "x-ms-discriminator-value": "uri_file" + }, + "FolderDatasetVersion": { + "type": "object", + "description": "FileDatasetVersion Definition", + "allOf": [ + { + "$ref": "#/definitions/DatasetVersion" + } + ], + "x-ms-discriminator-value": "uri_folder" + }, + "Index": { + "type": "object", + "description": "Index resource Definition", + "properties": { + "type": { + "$ref": "#/definitions/IndexType", + "description": "Type of index" + }, + "id": { + "type": "string", + "description": "Asset ID, a unique identifier for the asset", + "readOnly": true + }, + "name": { + "type": "string", + "description": "The name of the resource", + "readOnly": true + }, + "version": { + "type": "string", + "description": "The version of the resource", + "readOnly": true + }, + "description": { + "type": "string", + "description": "The asset description text.", + "x-ms-mutability": [ + "update", + "create" + ] + }, + "tags": { + "type": "object", + "description": "Tag dictionary. Tags can be added, removed, and updated.", + "additionalProperties": { + "type": "string" + }, + "x-ms-mutability": [ + "update", + "create" + ] + } + }, + "discriminator": "type", + "required": [ + "type", + "name", + "version" + ] + }, + "IndexType": { + "type": "string", + "enum": [ + "AzureSearch", + "CosmosDBNoSqlVectorStore", + "ManagedAzureSearch" + ], + "x-ms-enum": { + "name": "IndexType", + "modelAsString": true, + "values": [ + { + "name": "azureSearch", + "value": "AzureSearch", + "description": "Azure search" + }, + { + "name": "cosmosDB", + "value": "CosmosDBNoSqlVectorStore", + "description": "CosmosDB" + }, + { + "name": "managedAzureSearch", + "value": "ManagedAzureSearch", + "description": "Managed Azure Search" + } + ] + } + }, + "InputData": { + "type": "object", + "description": "Abstract data class.", + "properties": { + "type": { + "type": "string", + "description": "Type of the data" + } + }, + "discriminator": "type", + "required": [ + "type" + ] + }, + "InputDataset": { + "type": "object", + "description": "Dataset as source for evaluation.", + "properties": { + "id": { + "type": "string", + "description": "Evaluation input data" + } + }, + "required": [ + "id" + ], + "allOf": [ + { + "$ref": "#/definitions/InputData" + } + ], + "x-ms-discriminator-value": "dataset" + }, + "ManagedAzureAISearchIndex": { + "type": "object", + "description": "Managed Azure AI Search Index Definition", + "properties": { + "vectorStoreId": { + "type": "string", + "description": "Vector store id of managed index", + "x-ms-mutability": [ + "create" + ] + } + }, + "required": [ + "vectorStoreId" + ], + "allOf": [ + { + "$ref": "#/definitions/Index" + } + ], + "x-ms-discriminator-value": "ManagedAzureSearch" + }, + "ModelDeployment": { + "type": "object", + "description": "Model Deployment Definition", + "properties": { + "modelName": { + "type": "string", + "description": "Publisher-specific name of the deployed model", + "readOnly": true + }, + "modelVersion": { + "type": "string", + "description": "Publisher-specific version of the deployed model", + "readOnly": true + }, + "modelPublisher": { + "type": "string", + "description": "Name of the deployed model's publisher", + "readOnly": true + }, + "capabilities": { + "type": "object", + "description": "Capabilities of deployed model", + "additionalProperties": { + "type": "string" + }, + "readOnly": true + }, + "sku": { + "$ref": "#/definitions/Sku", + "description": "Sku of the model deployment", + "readOnly": true + }, + "connectionName": { + "type": "string", + "description": "Name of the connection the deployment comes from", + "readOnly": true + } + }, + "required": [ + "modelName", + "modelVersion", + "modelPublisher", + "capabilities", + "sku" + ], + "allOf": [ + { + "$ref": "#/definitions/Deployment" + } + ], + "x-ms-discriminator-value": "ModelDeployment" + }, + "NoAuthenticationCredentials": { + "type": "object", + "description": "Credentials that do not require authentication", + "allOf": [ + { + "$ref": "#/definitions/BaseCredentials" + } + ], + "x-ms-discriminator-value": "None" + }, + "PagedConnection": { + "type": "object", + "description": "Paged collection of Connection items", + "properties": { + "value": { + "type": "array", + "description": "The Connection items on this page", + "items": { + "$ref": "#/definitions/Connection" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "PagedDatasetVersion": { + "type": "object", + "description": "Paged collection of DatasetVersion items", + "properties": { + "value": { + "type": "array", + "description": "The DatasetVersion items on this page", + "items": { + "$ref": "#/definitions/DatasetVersion" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "PagedDeployment": { + "type": "object", + "description": "Paged collection of Deployment items", + "properties": { + "value": { + "type": "array", + "description": "The Deployment items on this page", + "items": { + "$ref": "#/definitions/Deployment" + }, + "x-ms-identifiers": [] + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "PagedEvaluation": { + "type": "object", + "description": "Paged collection of Evaluation items", + "properties": { + "value": { + "type": "array", + "description": "The Evaluation items on this page", + "items": { + "$ref": "#/definitions/Evaluation" + }, + "x-ms-identifiers": [] + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "PagedIndex": { + "type": "object", + "description": "Paged collection of Index items", + "properties": { + "value": { + "type": "array", + "description": "The Index items on this page", + "items": { + "$ref": "#/definitions/Index" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "PagedRedTeam": { + "type": "object", + "description": "Paged collection of RedTeam items", + "properties": { + "value": { + "type": "array", + "description": "The RedTeam items on this page", + "items": { + "$ref": "#/definitions/RedTeam" + }, + "x-ms-identifiers": [] + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "PendingUploadCredentialType": { + "type": "string", + "description": "The type of credential used to access the storage account.", + "enum": [ + "SAS" + ], + "x-ms-enum": { + "name": "PendingUploadCredentialType", + "modelAsString": true, + "values": [ + { + "name": "sas", + "value": "SAS", + "description": "SAS credential type." + } + ] + } + }, + "PendingUploadRequest": { + "type": "object", + "description": "Represents a request for a pending upload.", + "properties": { + "pendingUploadId": { + "type": "string", + "description": "If PendingUploadId is not provided, a random GUID will be used." + }, + "connectionName": { + "type": "string", + "description": "Azure Storage Account connection name to use for generating temporary SAS token" + }, + "pendingUploadType": { + "type": "string", + "description": "BlobReference is the only supported type.", + "enum": [ + "BlobReference" + ], + "x-ms-enum": { + "modelAsString": false + } + } + }, + "required": [ + "pendingUploadType" + ] + }, + "PendingUploadResponse": { + "type": "object", + "description": "Represents the response for a pending upload request", + "properties": { + "blobReference": { + "$ref": "#/definitions/BlobReference", + "description": "Container-level read, write, list SAS." + }, + "pendingUploadId": { + "type": "string", + "description": "ID for this upload request." + }, + "version": { + "type": "string", + "description": "Version of asset to be created if user did not specify version when initially creating upload" + }, + "pendingUploadType": { + "type": "string", + "description": "BlobReference is the only supported type", + "enum": [ + "BlobReference" + ], + "x-ms-enum": { + "modelAsString": false + } + } + }, + "required": [ + "blobReference", + "pendingUploadId", + "pendingUploadType" + ] + }, + "PendingUploadType": { + "type": "string", + "description": "The type of pending upload.", + "enum": [ + "None", + "BlobReference" + ], + "x-ms-enum": { + "name": "PendingUploadType", + "modelAsString": true, + "values": [ + { + "name": "none", + "value": "None", + "description": "No pending upload." + }, + { + "name": "BlobReference", + "value": "BlobReference", + "description": "Blob Reference is the only supported type." + } + ] + } + }, + "RedTeam": { + "type": "object", + "description": "Red team details.", + "properties": { + "id": { + "type": "string", + "description": "Identifier of the red team run.", + "readOnly": true, + "x-ms-client-name": "name" + }, + "displayName": { + "type": "string", + "description": "Name of the red-team run." + }, + "numTurns": { + "type": "integer", + "format": "int32", + "description": "Number of simulation rounds." + }, + "attackStrategies": { + "type": "array", + "description": "List of attack strategies or nested lists of attack strategies.", + "items": { + "$ref": "#/definitions/AttackStrategy" + } + }, + "simulationOnly": { + "type": "boolean", + "description": "Simulation-only or Simulation + Evaluation. Default false, if true the scan outputs conversation not evaluation result.", + "default": false + }, + "riskCategories": { + "type": "array", + "description": "List of risk categories to generate attack objectives for.", + "items": { + "$ref": "#/definitions/RiskCategory" + } + }, + "applicationScenario": { + "type": "string", + "description": "Application scenario for the red team operation, to generate scenario specific attacks." + }, + "tags": { + "type": "object", + "description": "Red team's tags. Unlike properties, tags are fully mutable.", + "additionalProperties": { + "type": "string" + } + }, + "properties": { + "type": "object", + "description": "Red team's properties. Unlike tags, properties are add-only. Once added, a property cannot be removed.", + "additionalProperties": { + "type": "string" + } + }, + "status": { + "type": "string", + "description": "Status of the red-team. It is set by service and is read-only.", + "readOnly": true + }, + "target": { + "$ref": "#/definitions/TargetConfig", + "description": "Target configuration for the red-team run." + } + }, + "required": [ + "id", + "target" + ] + }, + "RiskCategory": { + "type": "string", + "description": "Risk category for the attack objective.", + "enum": [ + "HateUnfairness", + "Violence", + "Sexual", + "SelfHarm" + ], + "x-ms-enum": { + "name": "RiskCategory", + "modelAsString": true, + "values": [ + { + "name": "HateUnfairness", + "value": "HateUnfairness", + "description": "Represents content related to hate or unfairness." + }, + { + "name": "Violence", + "value": "Violence", + "description": "Represents content related to violence." + }, + { + "name": "Sexual", + "value": "Sexual", + "description": "Represents content of a sexual nature." + }, + { + "name": "SelfHarm", + "value": "SelfHarm", + "description": "Represents content related to self-harm." + } + ] + } + }, + "SASCredentials": { + "type": "object", + "description": "Shared Access Signature (SAS) credential definition", + "properties": { + "SAS": { + "type": "string", + "description": "SAS token", + "readOnly": true, + "x-ms-client-name": "sasToken" + } + }, + "allOf": [ + { + "$ref": "#/definitions/BaseCredentials" + } + ], + "x-ms-discriminator-value": "SAS" + }, + "SasCredential": { + "type": "object", + "description": "SAS Credential definition", + "properties": { + "sasUri": { + "type": "string", + "description": "SAS uri", + "readOnly": true + }, + "type": { + "type": "string", + "description": "Type of credential", + "enum": [ + "SAS" + ], + "x-ms-enum": { + "modelAsString": false + }, + "readOnly": true + } + }, + "required": [ + "sasUri", + "type" + ] + }, + "Sku": { + "type": "object", + "description": "Sku information", + "properties": { + "capacity": { + "type": "integer", + "format": "int64", + "description": "Sku capacity" + }, + "family": { + "type": "string", + "description": "Sku family" + }, + "name": { + "type": "string", + "description": "Sku name" + }, + "size": { + "type": "string", + "description": "Sku size" + }, + "tier": { + "type": "string", + "description": "Sku tier" + } + }, + "required": [ + "capacity", + "family", + "name", + "size", + "tier" + ] + }, + "TargetConfig": { + "type": "object", + "description": "Abstract class for target configuration.", + "properties": { + "type": { + "type": "string", + "description": "Type of the model configuration." + } + }, + "discriminator": "type", + "required": [ + "type" + ] + } + }, + "parameters": { + "Azure.Core.ClientRequestIdHeader": { + "name": "x-ms-client-request-id", + "in": "header", + "description": "An opaque, globally-unique, client-generated string identifier for the request.", + "required": false, + "type": "string", + "format": "uuid", + "x-ms-parameter-location": "method", + "x-ms-client-name": "clientRequestId" + }, + "Azure.Core.Foundations.ApiVersionParameter": { + "name": "api-version", + "in": "query", + "description": "The API version to use for this operation.", + "required": true, + "type": "string", + "minLength": 1, + "x-ms-parameter-location": "method", + "x-ms-client-name": "apiVersion" + } + } +} diff --git a/specification/ai/data-plane/Azure.AI.Projects/preview/2025-05-15-preview/examples/Connections_GetWithCredentials_MaximumSet_Gen.json b/specification/ai/data-plane/Azure.AI.Projects/preview/2025-05-15-preview/examples/Connections_GetWithCredentials_MaximumSet_Gen.json new file mode 100644 index 000000000000..18e95663b43e --- /dev/null +++ b/specification/ai/data-plane/Azure.AI.Projects/preview/2025-05-15-preview/examples/Connections_GetWithCredentials_MaximumSet_Gen.json @@ -0,0 +1,26 @@ +{ + "title": "Connections_GetWithCredentials_MaximumSet", + "operationId": "Connections_GetWithCredentials", + "parameters": { + "api-version": "2025-05-15-preview", + "name": "bblabqcnrjcbxlyjsejqiyixfoil", + "x-ms-client-request-id": "cf35b680-dc80-4815-ab83-9364acc3bce6" + }, + "responses": { + "200": { + "body": { + "name": "cpezssfnwhl", + "id": "unique-id", + "type": "AzureOpenAI", + "target": "gxrgfvtt", + "isDefault": true, + "credentials": { + "type": "BaseCredentials" + }, + "metadata": { + "key2930": "uovt" + } + } + } + } +} diff --git a/specification/ai/data-plane/Azure.AI.Projects/preview/2025-05-15-preview/examples/Connections_Get_MaximumSet_Gen.json b/specification/ai/data-plane/Azure.AI.Projects/preview/2025-05-15-preview/examples/Connections_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..9cb4ecf222bb --- /dev/null +++ b/specification/ai/data-plane/Azure.AI.Projects/preview/2025-05-15-preview/examples/Connections_Get_MaximumSet_Gen.json @@ -0,0 +1,26 @@ +{ + "title": "Connections_Get_MaximumSet", + "operationId": "Connections_Get", + "parameters": { + "api-version": "2025-05-15-preview", + "name": "ijxjmv", + "x-ms-client-request-id": "cf35b680-dc80-4815-ab83-9364acc3bce6" + }, + "responses": { + "200": { + "body": { + "name": "cpezssfnwhl", + "id": "unique-id", + "type": "AzureOpenAI", + "target": "gxrgfvtt", + "isDefault": true, + "credentials": { + "type": "BaseCredentials" + }, + "metadata": { + "key2930": "uovt" + } + } + } + } +} diff --git a/specification/ai/data-plane/Azure.AI.Projects/preview/2025-05-15-preview/examples/Connections_List_MaximumSet_Gen.json b/specification/ai/data-plane/Azure.AI.Projects/preview/2025-05-15-preview/examples/Connections_List_MaximumSet_Gen.json new file mode 100644 index 000000000000..564378be28f9 --- /dev/null +++ b/specification/ai/data-plane/Azure.AI.Projects/preview/2025-05-15-preview/examples/Connections_List_MaximumSet_Gen.json @@ -0,0 +1,35 @@ +{ + "title": "Connections_List_MaximumSet", + "operationId": "Connections_List", + "parameters": { + "api-version": "2025-05-15-preview", + "connectionType": "AzureOpenAI", + "defaultConnection": true, + "top": 28, + "skip": 8, + "maxpagesize": 21, + "x-ms-client-request-id": "cf35b680-dc80-4815-ab83-9364acc3bce6" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "cpezssfnwhl", + "id": "unique-id", + "type": "AzureOpenAI", + "target": "gxrgfvtt", + "isDefault": true, + "credentials": { + "type": "BaseCredentials" + }, + "metadata": { + "key2930": "uovt" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/ai/data-plane/Azure.AI.Projects/preview/2025-05-15-preview/examples/Datasets_CreateOrUpdateVersion_MaximumSet_Gen.json b/specification/ai/data-plane/Azure.AI.Projects/preview/2025-05-15-preview/examples/Datasets_CreateOrUpdateVersion_MaximumSet_Gen.json new file mode 100644 index 000000000000..412da74f51ba --- /dev/null +++ b/specification/ai/data-plane/Azure.AI.Projects/preview/2025-05-15-preview/examples/Datasets_CreateOrUpdateVersion_MaximumSet_Gen.json @@ -0,0 +1,39 @@ +{ + "title": "Datasets_CreateOrUpdateVersion_MaximumSet", + "operationId": "Datasets_CreateOrUpdateVersion", + "parameters": { + "api-version": "2025-05-15-preview", + "name": "vfupg", + "version": "ecacrnqtmggfqsocagocpf", + "body": { + "dataUri": "Replace this value with a string matching RegExp [a-zA-Z0-9_]", + "type": "DatasetVersion", + "description": "u", + "tags": { + "key7559": "ybrhnrxopsvmxqxibvysedlsy" + } + } + }, + "responses": { + "200": { + "body": { + "dataUri": "Replace this value with a string matching RegExp [a-zA-Z0-9_]", + "type": "DatasetVersion", + "isReference": true, + "id": "hvpdyfpeoqcl", + "name": "xtdmvwhhobloqqsovgpynsnow", + "version": "eaixzft" + } + }, + "201": { + "body": { + "dataUri": "Replace this value with a string matching RegExp [a-zA-Z0-9_]", + "type": "DatasetVersion", + "isReference": true, + "id": "hvpdyfpeoqcl", + "name": "xtdmvwhhobloqqsovgpynsnow", + "version": "eaixzft" + } + } + } +} diff --git a/specification/ai/data-plane/Azure.AI.Projects/preview/2025-05-15-preview/examples/Datasets_CreateOrUpdateVersion_MinimumSet_Gen.json b/specification/ai/data-plane/Azure.AI.Projects/preview/2025-05-15-preview/examples/Datasets_CreateOrUpdateVersion_MinimumSet_Gen.json new file mode 100644 index 000000000000..ce5e5dbe9e0b --- /dev/null +++ b/specification/ai/data-plane/Azure.AI.Projects/preview/2025-05-15-preview/examples/Datasets_CreateOrUpdateVersion_MinimumSet_Gen.json @@ -0,0 +1,31 @@ +{ + "title": "Datasets_CreateOrUpdateVersion_MinimumSet", + "operationId": "Datasets_CreateOrUpdateVersion", + "parameters": { + "api-version": "2025-05-15-preview", + "name": "ryqozexodzklgkffokixpftfkcy", + "version": "vldbiveryfmysxuzw", + "body": { + "dataUri": "Replace this value with a string matching RegExp [a-zA-Z0-9_]", + "type": "DatasetVersion" + } + }, + "responses": { + "200": { + "body": { + "dataUri": "Replace this value with a string matching RegExp [a-zA-Z0-9_]", + "type": "DatasetVersion", + "name": "xtdmvwhhobloqqsovgpynsnow", + "version": "eaixzft" + } + }, + "201": { + "body": { + "dataUri": "Replace this value with a string matching RegExp [a-zA-Z0-9_]", + "type": "DatasetVersion", + "name": "xtdmvwhhobloqqsovgpynsnow", + "version": "eaixzft" + } + } + } +} diff --git a/specification/ai/data-plane/Azure.AI.Projects/preview/2025-05-15-preview/examples/Datasets_DeleteVersion_MaximumSet_Gen.json b/specification/ai/data-plane/Azure.AI.Projects/preview/2025-05-15-preview/examples/Datasets_DeleteVersion_MaximumSet_Gen.json new file mode 100644 index 000000000000..76dd33d1cd39 --- /dev/null +++ b/specification/ai/data-plane/Azure.AI.Projects/preview/2025-05-15-preview/examples/Datasets_DeleteVersion_MaximumSet_Gen.json @@ -0,0 +1,12 @@ +{ + "title": "Datasets_DeleteVersion_MaximumSet", + "operationId": "Datasets_DeleteVersion", + "parameters": { + "api-version": "2025-05-15-preview", + "name": "alpqwogwzatcyot", + "version": "zrkxodsgcd" + }, + "responses": { + "204": {} + } +} diff --git a/specification/ai/data-plane/Azure.AI.Projects/preview/2025-05-15-preview/examples/Datasets_DeleteVersion_MinimumSet_Gen.json b/specification/ai/data-plane/Azure.AI.Projects/preview/2025-05-15-preview/examples/Datasets_DeleteVersion_MinimumSet_Gen.json new file mode 100644 index 000000000000..224647378aa1 --- /dev/null +++ b/specification/ai/data-plane/Azure.AI.Projects/preview/2025-05-15-preview/examples/Datasets_DeleteVersion_MinimumSet_Gen.json @@ -0,0 +1,12 @@ +{ + "title": "Datasets_DeleteVersion_MinimumSet", + "operationId": "Datasets_DeleteVersion", + "parameters": { + "api-version": "2025-05-15-preview", + "name": "wllolxqbymlz", + "version": "ch" + }, + "responses": { + "204": {} + } +} diff --git a/specification/ai/data-plane/Azure.AI.Projects/preview/2025-05-15-preview/examples/Datasets_GetCredentials_MaximumSet_Gen.json b/specification/ai/data-plane/Azure.AI.Projects/preview/2025-05-15-preview/examples/Datasets_GetCredentials_MaximumSet_Gen.json new file mode 100644 index 000000000000..45b5ee7ea754 --- /dev/null +++ b/specification/ai/data-plane/Azure.AI.Projects/preview/2025-05-15-preview/examples/Datasets_GetCredentials_MaximumSet_Gen.json @@ -0,0 +1,24 @@ +{ + "title": "Datasets_GetCredentials_MaximumSet", + "operationId": "Datasets_GetCredentials", + "parameters": { + "api-version": "2025-05-15-preview", + "name": "vzqmzhfdzfqegdk", + "version": "cuiflnznlzybcrc", + "body": {} + }, + "responses": { + "200": { + "body": { + "blobReference": { + "blobUri": "azqrjzvwamspuuvtqvvzfaxiasf", + "storageAccountArmId": "deqizonopmijpxsmmzugiwnyy", + "credential": { + "sasUri": "agojbnipwrhupvervcdiffxes", + "type": "SAS" + } + } + } + } + } +} diff --git a/specification/ai/data-plane/Azure.AI.Projects/preview/2025-05-15-preview/examples/Datasets_GetCredentials_MinimumSet_Gen.json b/specification/ai/data-plane/Azure.AI.Projects/preview/2025-05-15-preview/examples/Datasets_GetCredentials_MinimumSet_Gen.json new file mode 100644 index 000000000000..9edf4191722b --- /dev/null +++ b/specification/ai/data-plane/Azure.AI.Projects/preview/2025-05-15-preview/examples/Datasets_GetCredentials_MinimumSet_Gen.json @@ -0,0 +1,24 @@ +{ + "title": "Datasets_GetCredentials_MinimumSet", + "operationId": "Datasets_GetCredentials", + "parameters": { + "api-version": "2025-05-15-preview", + "name": "sbblxkyqnfvdiqacezyygvts", + "version": "ikak", + "body": {} + }, + "responses": { + "200": { + "body": { + "blobReference": { + "blobUri": "azqrjzvwamspuuvtqvvzfaxiasf", + "storageAccountArmId": "deqizonopmijpxsmmzugiwnyy", + "credential": { + "sasUri": "agojbnipwrhupvervcdiffxes", + "type": "SAS" + } + } + } + } + } +} diff --git a/specification/ai/data-plane/Azure.AI.Projects/preview/2025-05-15-preview/examples/Datasets_GetVersion_MaximumSet_Gen.json b/specification/ai/data-plane/Azure.AI.Projects/preview/2025-05-15-preview/examples/Datasets_GetVersion_MaximumSet_Gen.json new file mode 100644 index 000000000000..0e6641b1292e --- /dev/null +++ b/specification/ai/data-plane/Azure.AI.Projects/preview/2025-05-15-preview/examples/Datasets_GetVersion_MaximumSet_Gen.json @@ -0,0 +1,21 @@ +{ + "title": "Datasets_GetVersion_MaximumSet", + "operationId": "Datasets_GetVersion", + "parameters": { + "api-version": "2025-05-15-preview", + "name": "temeurpoaslnnu", + "version": "icrcjdmwkggtdogifuoolnrg" + }, + "responses": { + "200": { + "body": { + "dataUri": "Replace this value with a string matching RegExp [a-zA-Z0-9_]", + "type": "DatasetVersion", + "isReference": true, + "id": "hvpdyfpeoqcl", + "name": "xtdmvwhhobloqqsovgpynsnow", + "version": "eaixzft" + } + } + } +} diff --git a/specification/ai/data-plane/Azure.AI.Projects/preview/2025-05-15-preview/examples/Datasets_GetVersion_MinimumSet_Gen.json b/specification/ai/data-plane/Azure.AI.Projects/preview/2025-05-15-preview/examples/Datasets_GetVersion_MinimumSet_Gen.json new file mode 100644 index 000000000000..2d7eff038cd2 --- /dev/null +++ b/specification/ai/data-plane/Azure.AI.Projects/preview/2025-05-15-preview/examples/Datasets_GetVersion_MinimumSet_Gen.json @@ -0,0 +1,19 @@ +{ + "title": "Datasets_GetVersion_MinimumSet", + "operationId": "Datasets_GetVersion", + "parameters": { + "api-version": "2025-05-15-preview", + "name": "xikgeqethuxytuseiawhklaapj", + "version": "hxksxrkgmtucfrbbnxyzwl" + }, + "responses": { + "200": { + "body": { + "dataUri": "Replace this value with a string matching RegExp [a-zA-Z0-9_]", + "type": "DatasetVersion", + "name": "xtdmvwhhobloqqsovgpynsnow", + "version": "eaixzft" + } + } + } +} diff --git a/specification/ai/data-plane/Azure.AI.Projects/preview/2025-05-15-preview/examples/Datasets_ListLatest_MaximumSet_Gen.json b/specification/ai/data-plane/Azure.AI.Projects/preview/2025-05-15-preview/examples/Datasets_ListLatest_MaximumSet_Gen.json new file mode 100644 index 000000000000..c3d33fdcbe7c --- /dev/null +++ b/specification/ai/data-plane/Azure.AI.Projects/preview/2025-05-15-preview/examples/Datasets_ListLatest_MaximumSet_Gen.json @@ -0,0 +1,28 @@ +{ + "title": "Datasets_ListLatest_MaximumSet", + "operationId": "Datasets_ListLatest", + "parameters": { + "api-version": "2025-05-15-preview", + "top": 26, + "skip": "lbra", + "tags": "pp", + "listViewType": "ActiveOnly" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "dataUri": "Replace this value with a string matching RegExp [a-zA-Z0-9_]", + "type": "DatasetVersion", + "isReference": true, + "id": "hvpdyfpeoqcl", + "name": "xtdmvwhhobloqqsovgpynsnow", + "version": "eaixzft" + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/ai/data-plane/Azure.AI.Projects/preview/2025-05-15-preview/examples/Datasets_ListLatest_MinimumSet_Gen.json b/specification/ai/data-plane/Azure.AI.Projects/preview/2025-05-15-preview/examples/Datasets_ListLatest_MinimumSet_Gen.json new file mode 100644 index 000000000000..9ec0c6d4ca45 --- /dev/null +++ b/specification/ai/data-plane/Azure.AI.Projects/preview/2025-05-15-preview/examples/Datasets_ListLatest_MinimumSet_Gen.json @@ -0,0 +1,21 @@ +{ + "title": "Datasets_ListLatest_MinimumSet", + "operationId": "Datasets_ListLatest", + "parameters": { + "api-version": "2025-05-15-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "dataUri": "Replace this value with a string matching RegExp [a-zA-Z0-9_]", + "type": "DatasetVersion", + "name": "xtdmvwhhobloqqsovgpynsnow", + "version": "eaixzft" + } + ] + } + } + } +} diff --git a/specification/ai/data-plane/Azure.AI.Projects/preview/2025-05-15-preview/examples/Datasets_ListVersions_MaximumSet_Gen.json b/specification/ai/data-plane/Azure.AI.Projects/preview/2025-05-15-preview/examples/Datasets_ListVersions_MaximumSet_Gen.json new file mode 100644 index 000000000000..3ec8c8a774c7 --- /dev/null +++ b/specification/ai/data-plane/Azure.AI.Projects/preview/2025-05-15-preview/examples/Datasets_ListVersions_MaximumSet_Gen.json @@ -0,0 +1,29 @@ +{ + "title": "Datasets_ListVersions_MaximumSet", + "operationId": "Datasets_ListVersions", + "parameters": { + "api-version": "2025-05-15-preview", + "name": "xogklfj", + "top": 18, + "skip": "qtdfikprjdlsosjaa", + "tags": "amyob", + "listViewType": "ActiveOnly" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "dataUri": "Replace this value with a string matching RegExp [a-zA-Z0-9_]", + "type": "DatasetVersion", + "isReference": true, + "id": "hvpdyfpeoqcl", + "name": "xtdmvwhhobloqqsovgpynsnow", + "version": "eaixzft" + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/ai/data-plane/Azure.AI.Projects/preview/2025-05-15-preview/examples/Datasets_ListVersions_MinimumSet_Gen.json b/specification/ai/data-plane/Azure.AI.Projects/preview/2025-05-15-preview/examples/Datasets_ListVersions_MinimumSet_Gen.json new file mode 100644 index 000000000000..ebdfaedd1954 --- /dev/null +++ b/specification/ai/data-plane/Azure.AI.Projects/preview/2025-05-15-preview/examples/Datasets_ListVersions_MinimumSet_Gen.json @@ -0,0 +1,22 @@ +{ + "title": "Datasets_ListVersions_MinimumSet", + "operationId": "Datasets_ListVersions", + "parameters": { + "api-version": "2025-05-15-preview", + "name": "hxemlflfomh" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "dataUri": "Replace this value with a string matching RegExp [a-zA-Z0-9_]", + "type": "DatasetVersion", + "name": "xtdmvwhhobloqqsovgpynsnow", + "version": "eaixzft" + } + ] + } + } + } +} diff --git a/specification/ai/data-plane/Azure.AI.Projects/preview/2025-05-15-preview/examples/Datasets_StartPendingUploadVersion_MaximumSet_Gen.json b/specification/ai/data-plane/Azure.AI.Projects/preview/2025-05-15-preview/examples/Datasets_StartPendingUploadVersion_MaximumSet_Gen.json new file mode 100644 index 000000000000..d3713678fa88 --- /dev/null +++ b/specification/ai/data-plane/Azure.AI.Projects/preview/2025-05-15-preview/examples/Datasets_StartPendingUploadVersion_MaximumSet_Gen.json @@ -0,0 +1,31 @@ +{ + "title": "Datasets_StartPendingUploadVersion_MaximumSet", + "operationId": "Datasets_StartPendingUploadVersion", + "parameters": { + "api-version": "2025-05-15-preview", + "name": "sgrzyrpltz", + "version": "ozdqisviavgqgfbtnzk", + "body": { + "pendingUploadId": "mxjahcghabuplfwtlopiqgxtcyw", + "connectionName": "bknvpmlisrqxaphkf", + "pendingUploadType": "BlobReference" + } + }, + "responses": { + "200": { + "body": { + "blobReference": { + "blobUri": "azqrjzvwamspuuvtqvvzfaxiasf", + "storageAccountArmId": "deqizonopmijpxsmmzugiwnyy", + "credential": { + "sasUri": "agojbnipwrhupvervcdiffxes", + "type": "SAS" + } + }, + "pendingUploadId": "qgizwomhljzn", + "version": "tegswajurquatmuhfde", + "pendingUploadType": "BlobReference" + } + } + } +} diff --git a/specification/ai/data-plane/Azure.AI.Projects/preview/2025-05-15-preview/examples/Datasets_StartPendingUploadVersion_MinimumSet_Gen.json b/specification/ai/data-plane/Azure.AI.Projects/preview/2025-05-15-preview/examples/Datasets_StartPendingUploadVersion_MinimumSet_Gen.json new file mode 100644 index 000000000000..e1df69a932f5 --- /dev/null +++ b/specification/ai/data-plane/Azure.AI.Projects/preview/2025-05-15-preview/examples/Datasets_StartPendingUploadVersion_MinimumSet_Gen.json @@ -0,0 +1,28 @@ +{ + "title": "Datasets_StartPendingUploadVersion_MinimumSet", + "operationId": "Datasets_StartPendingUploadVersion", + "parameters": { + "api-version": "2025-05-15-preview", + "name": "duxoiaywfik", + "version": "yzzzt", + "body": { + "pendingUploadType": "BlobReference" + } + }, + "responses": { + "200": { + "body": { + "blobReference": { + "blobUri": "azqrjzvwamspuuvtqvvzfaxiasf", + "storageAccountArmId": "deqizonopmijpxsmmzugiwnyy", + "credential": { + "sasUri": "agojbnipwrhupvervcdiffxes", + "type": "SAS" + } + }, + "pendingUploadId": "qgizwomhljzn", + "pendingUploadType": "BlobReference" + } + } + } +} diff --git a/specification/ai/data-plane/Azure.AI.Projects/preview/2025-05-15-preview/examples/Deployments_Get_MaximumSet_Gen.json b/specification/ai/data-plane/Azure.AI.Projects/preview/2025-05-15-preview/examples/Deployments_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..795394509e35 --- /dev/null +++ b/specification/ai/data-plane/Azure.AI.Projects/preview/2025-05-15-preview/examples/Deployments_Get_MaximumSet_Gen.json @@ -0,0 +1,17 @@ +{ + "title": "Deployments_Get_MaximumSet", + "operationId": "Deployments_Get", + "parameters": { + "api-version": "2025-05-15-preview", + "name": "qqvacpzjfk", + "x-ms-client-request-id": "cf35b680-dc80-4815-ab83-9364acc3bce6" + }, + "responses": { + "200": { + "body": { + "type": "Deployment", + "name": "pjnkbctjpshoeunqedinagotrj" + } + } + } +} diff --git a/specification/ai/data-plane/Azure.AI.Projects/preview/2025-05-15-preview/examples/Deployments_List_MaximumSet_Gen.json b/specification/ai/data-plane/Azure.AI.Projects/preview/2025-05-15-preview/examples/Deployments_List_MaximumSet_Gen.json new file mode 100644 index 000000000000..8bd1e3061529 --- /dev/null +++ b/specification/ai/data-plane/Azure.AI.Projects/preview/2025-05-15-preview/examples/Deployments_List_MaximumSet_Gen.json @@ -0,0 +1,26 @@ +{ + "title": "Deployments_List_MaximumSet", + "operationId": "Deployments_List", + "parameters": { + "api-version": "2025-05-15-preview", + "modelPublisher": "kznreojrvlwdq", + "modelName": "gplerszsuyisseeksnyvkaqperxox", + "top": 28, + "skip": 8, + "maxpagesize": 21, + "x-ms-client-request-id": "cf35b680-dc80-4815-ab83-9364acc3bce6" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "type": "Deployment", + "name": "pjnkbctjpshoeunqedinagotrj" + } + ], + "nextLink": "https://microsoft.com/ahpgda" + } + } + } +} diff --git a/specification/ai/data-plane/Azure.AI.Projects/preview/2025-05-15-preview/examples/Evaluations_CreateAgentEvaluation_MaximumSet_Gen.json b/specification/ai/data-plane/Azure.AI.Projects/preview/2025-05-15-preview/examples/Evaluations_CreateAgentEvaluation_MaximumSet_Gen.json new file mode 100644 index 000000000000..e3b597027cfb --- /dev/null +++ b/specification/ai/data-plane/Azure.AI.Projects/preview/2025-05-15-preview/examples/Evaluations_CreateAgentEvaluation_MaximumSet_Gen.json @@ -0,0 +1,54 @@ +{ + "title": "Evaluations_CreateAgentEvaluation_MaximumSet", + "operationId": "Evaluations_CreateAgentEvaluation", + "parameters": { + "api-version": "2025-05-15-preview", + "evaluation": { + "runId": "ecfcffqsrdhpecocrufffiqz", + "threadId": "cxjjsyhkeezgnaqqyerrdrbbth", + "evaluators": { + "key2653": { + "id": "gujwtvhptykq", + "initParams": {}, + "dataMapping": { + "key7400": "ijkjfvoswni" + } + } + }, + "samplingConfiguration": { + "name": "tj", + "samplingPercent": 7, + "maxRequestRate": 8 + }, + "redactionConfiguration": { + "redactScoreProperties": true + }, + "appInsightsConnectionString": "dvcnrcwar" + } + }, + "responses": { + "201": { + "body": { + "id": "gji", + "status": "ozywrhiasll", + "error": "stcjbhxgmqvjqwzmbvaa", + "result": [ + { + "evaluator": "upnt", + "evaluatorId": "upnt", + "score": 13, + "status": "eoxw", + "reason": "kfrjetziuketgioobeydlugonzfxo", + "version": "lfqwtzuktnbmcxxwkghmlpdtuu", + "threadId": "sldwqklyuxeayfmxpbl", + "runId": "lauehlf", + "error": "lrutmshl", + "additionalDetails": { + "key3590": "vhhneubavtiklsjcdexij" + } + } + ] + } + } + } +} diff --git a/specification/ai/data-plane/Azure.AI.Projects/preview/2025-05-15-preview/examples/Evaluations_CreateAgentEvaluation_MinimumSet_Gen.json b/specification/ai/data-plane/Azure.AI.Projects/preview/2025-05-15-preview/examples/Evaluations_CreateAgentEvaluation_MinimumSet_Gen.json new file mode 100644 index 000000000000..ea7133304b73 --- /dev/null +++ b/specification/ai/data-plane/Azure.AI.Projects/preview/2025-05-15-preview/examples/Evaluations_CreateAgentEvaluation_MinimumSet_Gen.json @@ -0,0 +1,20 @@ +{ + "title": "Evaluations_CreateAgentEvaluation_MinimumSet", + "operationId": "Evaluations_CreateAgentEvaluation", + "parameters": { + "api-version": "2025-05-15-preview", + "evaluation": { + "runId": "ecfcffqsrdhpecocrufffiqz", + "evaluators": {}, + "appInsightsConnectionString": "dvcnrcwar" + } + }, + "responses": { + "201": { + "body": { + "id": "gji", + "status": "ozywrhiasll" + } + } + } +} diff --git a/specification/ai/data-plane/Azure.AI.Projects/preview/2025-05-15-preview/examples/Evaluations_Create_MaximumSet_Gen.json b/specification/ai/data-plane/Azure.AI.Projects/preview/2025-05-15-preview/examples/Evaluations_Create_MaximumSet_Gen.json new file mode 100644 index 000000000000..0315a2c4007b --- /dev/null +++ b/specification/ai/data-plane/Azure.AI.Projects/preview/2025-05-15-preview/examples/Evaluations_Create_MaximumSet_Gen.json @@ -0,0 +1,57 @@ +{ + "title": "Evaluations_Create_MaximumSet", + "operationId": "Evaluations_Create", + "parameters": { + "api-version": "2025-05-15-preview", + "evaluation": { + "data": { + "type": "InputData" + }, + "displayName": "ymjxkodggqrhjnmusta", + "description": "cuviaxytqckkybxwc", + "tags": { + "key30": "nqrdpedyhkjzgrbtqhxbmkdmlpdf" + }, + "properties": { + "key9192": "e" + }, + "evaluators": { + "key2735": { + "id": "gujwtvhptykq", + "initParams": {}, + "dataMapping": { + "key7400": "ijkjfvoswni" + } + } + } + } + }, + "responses": { + "201": { + "body": { + "id": "aarhggbojnh", + "data": { + "type": "InputData" + }, + "displayName": "ymjxkodggqrhjnmusta", + "description": "cuviaxytqckkybxwc", + "status": "uhejnohmiiogajkx", + "tags": { + "key30": "nqrdpedyhkjzgrbtqhxbmkdmlpdf" + }, + "properties": { + "key9192": "e" + }, + "evaluators": { + "key2735": { + "id": "gujwtvhptykq", + "initParams": {}, + "dataMapping": { + "key7400": "ijkjfvoswni" + } + } + } + } + } + } +} diff --git a/specification/ai/data-plane/Azure.AI.Projects/preview/2025-05-15-preview/examples/Evaluations_Create_MinimumSet_Gen.json b/specification/ai/data-plane/Azure.AI.Projects/preview/2025-05-15-preview/examples/Evaluations_Create_MinimumSet_Gen.json new file mode 100644 index 000000000000..6739c8eab994 --- /dev/null +++ b/specification/ai/data-plane/Azure.AI.Projects/preview/2025-05-15-preview/examples/Evaluations_Create_MinimumSet_Gen.json @@ -0,0 +1,24 @@ +{ + "title": "Evaluations_Create_MinimumSet", + "operationId": "Evaluations_Create", + "parameters": { + "api-version": "2025-05-15-preview", + "evaluation": { + "data": { + "type": "InputData" + }, + "evaluators": {} + } + }, + "responses": { + "201": { + "body": { + "id": "aarhggbojnh", + "data": { + "type": "InputData" + }, + "evaluators": {} + } + } + } +} diff --git a/specification/ai/data-plane/Azure.AI.Projects/preview/2025-05-15-preview/examples/Evaluations_Get_MaximumSet_Gen.json b/specification/ai/data-plane/Azure.AI.Projects/preview/2025-05-15-preview/examples/Evaluations_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..834d486f6071 --- /dev/null +++ b/specification/ai/data-plane/Azure.AI.Projects/preview/2025-05-15-preview/examples/Evaluations_Get_MaximumSet_Gen.json @@ -0,0 +1,37 @@ +{ + "title": "Evaluations_Get_MaximumSet", + "operationId": "Evaluations_Get", + "parameters": { + "api-version": "2025-05-15-preview", + "name": "so", + "x-ms-client-request-id": "cf35b680-dc80-4815-ab83-9364acc3bce6" + }, + "responses": { + "200": { + "body": { + "id": "aarhggbojnh", + "data": { + "type": "InputData" + }, + "displayName": "ymjxkodggqrhjnmusta", + "description": "cuviaxytqckkybxwc", + "status": "uhejnohmiiogajkx", + "tags": { + "key30": "nqrdpedyhkjzgrbtqhxbmkdmlpdf" + }, + "properties": { + "key9192": "e" + }, + "evaluators": { + "key2735": { + "id": "gujwtvhptykq", + "initParams": {}, + "dataMapping": { + "key7400": "ijkjfvoswni" + } + } + } + } + } + } +} diff --git a/specification/ai/data-plane/Azure.AI.Projects/preview/2025-05-15-preview/examples/Evaluations_List_MaximumSet_Gen.json b/specification/ai/data-plane/Azure.AI.Projects/preview/2025-05-15-preview/examples/Evaluations_List_MaximumSet_Gen.json new file mode 100644 index 000000000000..2c8d83bdf062 --- /dev/null +++ b/specification/ai/data-plane/Azure.AI.Projects/preview/2025-05-15-preview/examples/Evaluations_List_MaximumSet_Gen.json @@ -0,0 +1,44 @@ +{ + "title": "Evaluations_List_MaximumSet", + "operationId": "Evaluations_List", + "parameters": { + "api-version": "2025-05-15-preview", + "top": 28, + "skip": 8, + "maxpagesize": 21, + "x-ms-client-request-id": "cf35b680-dc80-4815-ab83-9364acc3bce6" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "aarhggbojnh", + "data": { + "type": "InputData" + }, + "displayName": "ymjxkodggqrhjnmusta", + "description": "cuviaxytqckkybxwc", + "status": "uhejnohmiiogajkx", + "tags": { + "key30": "nqrdpedyhkjzgrbtqhxbmkdmlpdf" + }, + "properties": { + "key9192": "e" + }, + "evaluators": { + "key2735": { + "id": "gujwtvhptykq", + "initParams": {}, + "dataMapping": { + "key7400": "ijkjfvoswni" + } + } + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/ai/data-plane/Azure.AI.Projects/preview/2025-05-15-preview/examples/Indexes_CreateOrUpdateVersion_MaximumSet_Gen.json b/specification/ai/data-plane/Azure.AI.Projects/preview/2025-05-15-preview/examples/Indexes_CreateOrUpdateVersion_MaximumSet_Gen.json new file mode 100644 index 000000000000..3b6ac40c5f1d --- /dev/null +++ b/specification/ai/data-plane/Azure.AI.Projects/preview/2025-05-15-preview/examples/Indexes_CreateOrUpdateVersion_MaximumSet_Gen.json @@ -0,0 +1,34 @@ +{ + "title": "Indexes_CreateOrUpdateVersion_MaximumSet", + "operationId": "Indexes_CreateOrUpdateVersion", + "parameters": { + "api-version": "2025-05-15-preview", + "name": "tv", + "version": "emphgqdq", + "body": { + "type": "Index", + "description": "vdwtgaudopguto", + "tags": { + "key8846": "serbpbugykgbwuwvh" + } + } + }, + "responses": { + "200": { + "body": { + "type": "Index", + "id": "fxdrmhqrfmclzkjmfldnszfnztla", + "name": "fiwkavutgfan", + "version": "iqupugmfgctoxzdubrcdnzx" + } + }, + "201": { + "body": { + "type": "Index", + "id": "fxdrmhqrfmclzkjmfldnszfnztla", + "name": "fiwkavutgfan", + "version": "iqupugmfgctoxzdubrcdnzx" + } + } + } +} diff --git a/specification/ai/data-plane/Azure.AI.Projects/preview/2025-05-15-preview/examples/Indexes_CreateOrUpdateVersion_MinimumSet_Gen.json b/specification/ai/data-plane/Azure.AI.Projects/preview/2025-05-15-preview/examples/Indexes_CreateOrUpdateVersion_MinimumSet_Gen.json new file mode 100644 index 000000000000..8b570a419db2 --- /dev/null +++ b/specification/ai/data-plane/Azure.AI.Projects/preview/2025-05-15-preview/examples/Indexes_CreateOrUpdateVersion_MinimumSet_Gen.json @@ -0,0 +1,28 @@ +{ + "title": "Indexes_CreateOrUpdateVersion_MinimumSet", + "operationId": "Indexes_CreateOrUpdateVersion", + "parameters": { + "api-version": "2025-05-15-preview", + "name": "lvlygvkgvkbzutknlnretfvivdgkb", + "version": "ct", + "body": { + "type": "Index" + } + }, + "responses": { + "200": { + "body": { + "type": "Index", + "name": "fiwkavutgfan", + "version": "iqupugmfgctoxzdubrcdnzx" + } + }, + "201": { + "body": { + "type": "Index", + "name": "fiwkavutgfan", + "version": "iqupugmfgctoxzdubrcdnzx" + } + } + } +} diff --git a/specification/ai/data-plane/Azure.AI.Projects/preview/2025-05-15-preview/examples/Indexes_DeleteVersion_MaximumSet_Gen.json b/specification/ai/data-plane/Azure.AI.Projects/preview/2025-05-15-preview/examples/Indexes_DeleteVersion_MaximumSet_Gen.json new file mode 100644 index 000000000000..a31c3f6e7e24 --- /dev/null +++ b/specification/ai/data-plane/Azure.AI.Projects/preview/2025-05-15-preview/examples/Indexes_DeleteVersion_MaximumSet_Gen.json @@ -0,0 +1,12 @@ +{ + "title": "Indexes_DeleteVersion_MaximumSet", + "operationId": "Indexes_DeleteVersion", + "parameters": { + "api-version": "2025-05-15-preview", + "name": "uxzepyytxjtpjkdrpxicavot", + "version": "vyihcshjrfglzhj" + }, + "responses": { + "204": {} + } +} diff --git a/specification/ai/data-plane/Azure.AI.Projects/preview/2025-05-15-preview/examples/Indexes_DeleteVersion_MinimumSet_Gen.json b/specification/ai/data-plane/Azure.AI.Projects/preview/2025-05-15-preview/examples/Indexes_DeleteVersion_MinimumSet_Gen.json new file mode 100644 index 000000000000..7fec5d942612 --- /dev/null +++ b/specification/ai/data-plane/Azure.AI.Projects/preview/2025-05-15-preview/examples/Indexes_DeleteVersion_MinimumSet_Gen.json @@ -0,0 +1,12 @@ +{ + "title": "Indexes_DeleteVersion_MinimumSet", + "operationId": "Indexes_DeleteVersion", + "parameters": { + "api-version": "2025-05-15-preview", + "name": "mzshhabnrpuocgtyxkzftkr", + "version": "orbdovkdebzfwluronkmsoty" + }, + "responses": { + "204": {} + } +} diff --git a/specification/ai/data-plane/Azure.AI.Projects/preview/2025-05-15-preview/examples/Indexes_GetVersion_MaximumSet_Gen.json b/specification/ai/data-plane/Azure.AI.Projects/preview/2025-05-15-preview/examples/Indexes_GetVersion_MaximumSet_Gen.json new file mode 100644 index 000000000000..5324a2883934 --- /dev/null +++ b/specification/ai/data-plane/Azure.AI.Projects/preview/2025-05-15-preview/examples/Indexes_GetVersion_MaximumSet_Gen.json @@ -0,0 +1,19 @@ +{ + "title": "Indexes_GetVersion_MaximumSet", + "operationId": "Indexes_GetVersion", + "parameters": { + "api-version": "2025-05-15-preview", + "name": "nnhahjajcarruliib", + "version": "njynfwrxvujbklgxnibzafvcm" + }, + "responses": { + "200": { + "body": { + "type": "Index", + "id": "fxdrmhqrfmclzkjmfldnszfnztla", + "name": "fiwkavutgfan", + "version": "iqupugmfgctoxzdubrcdnzx" + } + } + } +} diff --git a/specification/ai/data-plane/Azure.AI.Projects/preview/2025-05-15-preview/examples/Indexes_GetVersion_MinimumSet_Gen.json b/specification/ai/data-plane/Azure.AI.Projects/preview/2025-05-15-preview/examples/Indexes_GetVersion_MinimumSet_Gen.json new file mode 100644 index 000000000000..3d7ccc6498e6 --- /dev/null +++ b/specification/ai/data-plane/Azure.AI.Projects/preview/2025-05-15-preview/examples/Indexes_GetVersion_MinimumSet_Gen.json @@ -0,0 +1,18 @@ +{ + "title": "Indexes_GetVersion_MinimumSet", + "operationId": "Indexes_GetVersion", + "parameters": { + "api-version": "2025-05-15-preview", + "name": "kbfueisvpmwlmmgqrylbgcwabum", + "version": "qtzhdugby" + }, + "responses": { + "200": { + "body": { + "type": "Index", + "name": "fiwkavutgfan", + "version": "iqupugmfgctoxzdubrcdnzx" + } + } + } +} diff --git a/specification/ai/data-plane/Azure.AI.Projects/preview/2025-05-15-preview/examples/Indexes_ListLatest_MaximumSet_Gen.json b/specification/ai/data-plane/Azure.AI.Projects/preview/2025-05-15-preview/examples/Indexes_ListLatest_MaximumSet_Gen.json new file mode 100644 index 000000000000..67ebe012f8e9 --- /dev/null +++ b/specification/ai/data-plane/Azure.AI.Projects/preview/2025-05-15-preview/examples/Indexes_ListLatest_MaximumSet_Gen.json @@ -0,0 +1,26 @@ +{ + "title": "Indexes_ListLatest_MaximumSet", + "operationId": "Indexes_ListLatest", + "parameters": { + "api-version": "2025-05-15-preview", + "top": 11, + "skip": "qijkobbksrqhgvwzmujd", + "tags": "lmpvvr", + "listViewType": "ActiveOnly" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "type": "Index", + "id": "fxdrmhqrfmclzkjmfldnszfnztla", + "name": "fiwkavutgfan", + "version": "iqupugmfgctoxzdubrcdnzx" + } + ], + "nextLink": "https://microsoft.com/ayyakes" + } + } + } +} diff --git a/specification/ai/data-plane/Azure.AI.Projects/preview/2025-05-15-preview/examples/Indexes_ListLatest_MinimumSet_Gen.json b/specification/ai/data-plane/Azure.AI.Projects/preview/2025-05-15-preview/examples/Indexes_ListLatest_MinimumSet_Gen.json new file mode 100644 index 000000000000..2c147c3ed85e --- /dev/null +++ b/specification/ai/data-plane/Azure.AI.Projects/preview/2025-05-15-preview/examples/Indexes_ListLatest_MinimumSet_Gen.json @@ -0,0 +1,20 @@ +{ + "title": "Indexes_ListLatest_MinimumSet", + "operationId": "Indexes_ListLatest", + "parameters": { + "api-version": "2025-05-15-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "type": "Index", + "name": "fiwkavutgfan", + "version": "iqupugmfgctoxzdubrcdnzx" + } + ] + } + } + } +} diff --git a/specification/ai/data-plane/Azure.AI.Projects/preview/2025-05-15-preview/examples/Indexes_ListVersions_MaximumSet_Gen.json b/specification/ai/data-plane/Azure.AI.Projects/preview/2025-05-15-preview/examples/Indexes_ListVersions_MaximumSet_Gen.json new file mode 100644 index 000000000000..f776245cff56 --- /dev/null +++ b/specification/ai/data-plane/Azure.AI.Projects/preview/2025-05-15-preview/examples/Indexes_ListVersions_MaximumSet_Gen.json @@ -0,0 +1,27 @@ +{ + "title": "Indexes_ListVersions_MaximumSet", + "operationId": "Indexes_ListVersions", + "parameters": { + "api-version": "2025-05-15-preview", + "name": "tvabzvonlomkdvglaubvvqmzwdaiz", + "top": 2, + "skip": "fgwrnkksjofetmtfyizikbyv", + "tags": "hymlvxullwef", + "listViewType": "ActiveOnly" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "type": "Index", + "id": "fxdrmhqrfmclzkjmfldnszfnztla", + "name": "fiwkavutgfan", + "version": "iqupugmfgctoxzdubrcdnzx" + } + ], + "nextLink": "https://microsoft.com/ayyakes" + } + } + } +} diff --git a/specification/ai/data-plane/Azure.AI.Projects/preview/2025-05-15-preview/examples/Indexes_ListVersions_MinimumSet_Gen.json b/specification/ai/data-plane/Azure.AI.Projects/preview/2025-05-15-preview/examples/Indexes_ListVersions_MinimumSet_Gen.json new file mode 100644 index 000000000000..6e11477a0190 --- /dev/null +++ b/specification/ai/data-plane/Azure.AI.Projects/preview/2025-05-15-preview/examples/Indexes_ListVersions_MinimumSet_Gen.json @@ -0,0 +1,21 @@ +{ + "title": "Indexes_ListVersions_MinimumSet", + "operationId": "Indexes_ListVersions", + "parameters": { + "api-version": "2025-05-15-preview", + "name": "opimayfinqlkarudm" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "type": "Index", + "name": "fiwkavutgfan", + "version": "iqupugmfgctoxzdubrcdnzx" + } + ] + } + } + } +} diff --git a/specification/ai/data-plane/Azure.AI.Projects/preview/2025-05-15-preview/examples/RedTeams_Create_MaximumSet_Gen.json b/specification/ai/data-plane/Azure.AI.Projects/preview/2025-05-15-preview/examples/RedTeams_Create_MaximumSet_Gen.json new file mode 100644 index 000000000000..60c36a639864 --- /dev/null +++ b/specification/ai/data-plane/Azure.AI.Projects/preview/2025-05-15-preview/examples/RedTeams_Create_MaximumSet_Gen.json @@ -0,0 +1,53 @@ +{ + "title": "RedTeams_Create_MaximumSet", + "operationId": "RedTeams_Create", + "parameters": { + "api-version": "2025-05-15-preview", + "RedTeam": { + "numTurns": 10, + "attackStrategies": [ + "easy" + ], + "simulationOnly": true, + "riskCategories": [ + "HateUnfairness" + ], + "applicationScenario": "qaxxxhjp", + "tags": { + "key1287": "gbklekkgmxkfbhehgh" + }, + "properties": { + "key9280": "fwzjtipl" + }, + "target": { + "type": "TargetConfig" + } + } + }, + "responses": { + "201": { + "body": { + "id": "tztegmf", + "numTurns": 10, + "attackStrategies": [ + "easy" + ], + "simulationOnly": true, + "riskCategories": [ + "HateUnfairness" + ], + "applicationScenario": "qaxxxhjp", + "tags": { + "key1287": "gbklekkgmxkfbhehgh" + }, + "properties": { + "key9280": "fwzjtipl" + }, + "status": "owgxaiudnkkeqwlnhtmihvhdkbgd", + "target": { + "type": "TargetConfig" + } + } + } + } +} diff --git a/specification/ai/data-plane/Azure.AI.Projects/preview/2025-05-15-preview/examples/RedTeams_Create_MinimumSet_Gen.json b/specification/ai/data-plane/Azure.AI.Projects/preview/2025-05-15-preview/examples/RedTeams_Create_MinimumSet_Gen.json new file mode 100644 index 000000000000..0bca24700a8c --- /dev/null +++ b/specification/ai/data-plane/Azure.AI.Projects/preview/2025-05-15-preview/examples/RedTeams_Create_MinimumSet_Gen.json @@ -0,0 +1,38 @@ +{ + "title": "RedTeams_Create_MinimumSet", + "operationId": "RedTeams_Create", + "parameters": { + "api-version": "2025-05-15-preview", + "RedTeam": { + "numTurns": 10, + "attackStrategies": [ + "easy" + ], + "simulationOnly": true, + "riskCategories": [ + "HateUnfairness" + ], + "target": { + "type": "TargetConfig" + } + } + }, + "responses": { + "201": { + "body": { + "id": "tztegmf", + "numTurns": 10, + "attackStrategies": [ + "easy" + ], + "simulationOnly": true, + "riskCategories": [ + "HateUnfairness" + ], + "target": { + "type": "TargetConfig" + } + } + } + } +} diff --git a/specification/ai/data-plane/Azure.AI.Projects/preview/2025-05-15-preview/examples/RedTeams_Get_MaximumSet_Gen.json b/specification/ai/data-plane/Azure.AI.Projects/preview/2025-05-15-preview/examples/RedTeams_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..59fd9f26b81c --- /dev/null +++ b/specification/ai/data-plane/Azure.AI.Projects/preview/2025-05-15-preview/examples/RedTeams_Get_MaximumSet_Gen.json @@ -0,0 +1,35 @@ +{ + "title": "RedTeams_Get_MaximumSet", + "operationId": "RedTeams_Get", + "parameters": { + "api-version": "2025-05-15-preview", + "name": "apwpcf", + "x-ms-client-request-id": "cf35b680-dc80-4815-ab83-9364acc3bce6" + }, + "responses": { + "200": { + "body": { + "id": "tztegmf", + "numTurns": 10, + "attackStrategies": [ + "easy" + ], + "simulationOnly": true, + "riskCategories": [ + "HateUnfairness" + ], + "applicationScenario": "qaxxxhjp", + "tags": { + "key1287": "gbklekkgmxkfbhehgh" + }, + "properties": { + "key9280": "fwzjtipl" + }, + "status": "owgxaiudnkkeqwlnhtmihvhdkbgd", + "target": { + "type": "TargetConfig" + } + } + } + } +} diff --git a/specification/ai/data-plane/Azure.AI.Projects/preview/2025-05-15-preview/examples/RedTeams_List_MaximumSet_Gen.json b/specification/ai/data-plane/Azure.AI.Projects/preview/2025-05-15-preview/examples/RedTeams_List_MaximumSet_Gen.json new file mode 100644 index 000000000000..10bb9532ff47 --- /dev/null +++ b/specification/ai/data-plane/Azure.AI.Projects/preview/2025-05-15-preview/examples/RedTeams_List_MaximumSet_Gen.json @@ -0,0 +1,42 @@ +{ + "title": "RedTeams_List_MaximumSet", + "operationId": "RedTeams_List", + "parameters": { + "api-version": "2025-05-15-preview", + "top": 28, + "skip": 8, + "maxpagesize": 21, + "x-ms-client-request-id": "cf35b680-dc80-4815-ab83-9364acc3bce6" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "tztegmf", + "numTurns": 10, + "attackStrategies": [ + "easy" + ], + "simulationOnly": true, + "riskCategories": [ + "HateUnfairness" + ], + "applicationScenario": "qaxxxhjp", + "tags": { + "key1287": "gbklekkgmxkfbhehgh" + }, + "properties": { + "key9280": "fwzjtipl" + }, + "status": "owgxaiudnkkeqwlnhtmihvhdkbgd", + "target": { + "type": "TargetConfig" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/ai/data-plane/Azure.AI.Projects/readme.md b/specification/ai/data-plane/Azure.AI.Projects/readme.md new file mode 100644 index 000000000000..1f090a5ed13f --- /dev/null +++ b/specification/ai/data-plane/Azure.AI.Projects/readme.md @@ -0,0 +1,46 @@ +# Azure AI Projects SDK + +> see https://aka.ms/autorest + +Configuration for generating Azure AI Projects SDK. + +The current release is `latest`. + +``` yaml + +tag: latest +add-credentials: true +openapi-type: data-plane +``` + +# Releases + +### Release v1 +These settings apply only when `--tag=v1` is specified on the command line. +``` yaml $(tag) == 'latest' +input-file: + - stable/v1/azure-ai-projects.json +``` + +### Release v2025-05-01 +These settings apply only when `--tag=v025-05-01` is specified on the command line. +``` yaml $(tag) == '2025-05-01' +input-file: + - stable/2025-05-01/azure-ai-projects.json +``` + +### Release v2025-05-15-preview +These settings apply only when `--tag=2025-05-15-preview` is specified on the command line. +``` yaml $(tag) == '2025-05-15-preview' +input-file: + - preview/2025-05-15-preview/azure-ai-projects.json +``` + +# Suppressions +``` yaml +suppressions: + - code: OperationIdNounVerb + from: azure-ai-projects.json + where: $.paths["/evaluations/runs:runAgent"].post.operationId + reason: False alert. Evaluation should appear after underscore for clarity's sake. +``` diff --git a/specification/ai/data-plane/Azure.AI.Projects/stable/2025-05-01/azure-ai-projects.json b/specification/ai/data-plane/Azure.AI.Projects/stable/2025-05-01/azure-ai-projects.json new file mode 100644 index 000000000000..3f1dd6a8941b --- /dev/null +++ b/specification/ai/data-plane/Azure.AI.Projects/stable/2025-05-01/azure-ai-projects.json @@ -0,0 +1,2167 @@ +{ + "swagger": "2.0", + "info": { + "title": "Azure AI", + "version": "2025-05-01", + "x-typespec-generated": [ + { + "emitter": "@azure-tools/typespec-autorest" + } + ] + }, + "schemes": [ + "https" + ], + "x-ms-parameterized-host": { + "hostTemplate": "{endpoint}", + "useSchemePrefix": false, + "parameters": [ + { + "name": "endpoint", + "in": "path", + "description": "Project endpoint. In the form \"https://.services.ai.azure.com/api/projects/_project\"\nif your Foundry Hub has only one Project, or to use the default Project in your Hub. Or in the form \n\"https://.services.ai.azure.com/api/projects/\" if you want to explicitly\nspecify the Foundry Project name.", + "required": true, + "type": "string", + "format": "uri", + "x-ms-skip-url-encoding": true + } + ] + }, + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ], + "security": [ + { + "OAuth2Auth": [ + "https://ai.azure.com/.default" + ] + } + ], + "securityDefinitions": { + "OAuth2Auth": { + "type": "oauth2", + "flow": "implicit", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/v2.0/authorize", + "scopes": { + "https://ai.azure.com/.default": "" + } + } + }, + "tags": [], + "paths": { + "/connections": { + "get": { + "operationId": "Connections_List", + "description": "List all connections in the project, without populating connection credentials", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "connectionType", + "in": "query", + "description": "List connections of this specific type", + "required": false, + "type": "string", + "enum": [ + "AzureOpenAI", + "AzureBlob", + "AzureStorageAccount", + "CognitiveSearch", + "CosmosDB", + "ApiKey", + "AppConfig", + "AppInsights", + "CustomKeys" + ], + "x-ms-enum": { + "name": "ConnectionType", + "modelAsString": true, + "values": [ + { + "name": "AzureOpenAI", + "value": "AzureOpenAI", + "description": "Azure OpenAI Service" + }, + { + "name": "AzureBlobStorage", + "value": "AzureBlob", + "description": "Azure Blob Storage, with specified container" + }, + { + "name": "AzureStorageAccount", + "value": "AzureStorageAccount", + "description": "Azure Blob Storage, with container not specified (used by Agents)" + }, + { + "name": "AzureAISearch", + "value": "CognitiveSearch", + "description": "Azure AI Search" + }, + { + "name": "CosmosDB", + "value": "CosmosDB", + "description": "CosmosDB" + }, + { + "name": "APIKey", + "value": "ApiKey", + "description": "Generic connection that uses API Key authentication" + }, + { + "name": "ApplicationConfiguration", + "value": "AppConfig", + "description": "Application Configuration" + }, + { + "name": "ApplicationInsights", + "value": "AppInsights", + "description": "Application Insights" + }, + { + "name": "Custom", + "value": "CustomKeys", + "description": "Custom Keys" + } + ] + } + }, + { + "name": "defaultConnection", + "in": "query", + "description": "List connections that are default connections", + "required": false, + "type": "boolean" + }, + { + "$ref": "#/parameters/Azure.Core.ClientRequestIdHeader" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/PagedConnection" + }, + "headers": { + "x-ms-client-request-id": { + "type": "string", + "format": "uuid", + "description": "An opaque, globally-unique, client-generated string identifier for the request." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Connections_List_MaximumSet": { + "$ref": "./examples/Connections_List_MaximumSet_Gen.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/connections/{name}": { + "get": { + "operationId": "Connections_Get", + "description": "Get a connection by name, without populating connection credentials", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "name", + "in": "path", + "description": "The friendly name of the connection, provided by the user.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/Azure.Core.ClientRequestIdHeader" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/Connection" + }, + "headers": { + "x-ms-client-request-id": { + "type": "string", + "format": "uuid", + "description": "An opaque, globally-unique, client-generated string identifier for the request." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Connections_Get_MaximumSet": { + "$ref": "./examples/Connections_Get_MaximumSet_Gen.json" + } + } + } + }, + "/connections/{name}/getConnectionWithCredentials": { + "post": { + "operationId": "Connections_GetWithCredentials", + "description": "Get a connection by name, with its connection credentials", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "name", + "in": "path", + "description": "The friendly name of the connection, provided by the user.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/Azure.Core.ClientRequestIdHeader" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/Connection" + }, + "headers": { + "x-ms-client-request-id": { + "type": "string", + "format": "uuid", + "description": "An opaque, globally-unique, client-generated string identifier for the request." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Connections_GetWithCredentials_MaximumSet": { + "$ref": "./examples/Connections_GetWithCredentials_MaximumSet_Gen.json" + } + } + } + }, + "/datasets": { + "get": { + "operationId": "Datasets_ListLatest", + "description": "List the latest version of each DatasetVersion", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/PagedDatasetVersion" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Datasets_ListLatest_MaximumSet": { + "$ref": "./examples/Datasets_ListLatest_MaximumSet_Gen.json" + }, + "Datasets_ListLatest_MinimumSet": { + "$ref": "./examples/Datasets_ListLatest_MinimumSet_Gen.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/datasets/{name}/versions": { + "get": { + "operationId": "Datasets_ListVersions", + "description": "List all versions of the given DatasetVersion", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "name", + "in": "path", + "description": "The name of the resource", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/PagedDatasetVersion" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Datasets_ListVersions_MaximumSet": { + "$ref": "./examples/Datasets_ListVersions_MaximumSet_Gen.json" + }, + "Datasets_ListVersions_MinimumSet": { + "$ref": "./examples/Datasets_ListVersions_MinimumSet_Gen.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/datasets/{name}/versions/{version}": { + "get": { + "operationId": "Datasets_GetVersion", + "description": "Get the specific version of the DatasetVersion", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "name", + "in": "path", + "description": "The name of the resource", + "required": true, + "type": "string" + }, + { + "name": "version", + "in": "path", + "description": "The specific version id of the DatasetVersion to retrieve.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/DatasetVersion" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Datasets_GetVersion_MaximumSet": { + "$ref": "./examples/Datasets_GetVersion_MaximumSet_Gen.json" + }, + "Datasets_GetVersion_MinimumSet": { + "$ref": "./examples/Datasets_GetVersion_MinimumSet_Gen.json" + } + } + }, + "patch": { + "operationId": "Datasets_CreateOrUpdateVersion", + "description": "Create a new or update an existing DatasetVersion with the given version id", + "consumes": [ + "application/merge-patch+json" + ], + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "name", + "in": "path", + "description": "The name of the resource", + "required": true, + "type": "string" + }, + { + "name": "version", + "in": "path", + "description": "The specific version id of the DatasetVersion to create or replace.", + "required": true, + "type": "string" + }, + { + "name": "body", + "in": "body", + "description": "The definition of the DatasetVersion to create or update", + "required": true, + "schema": { + "$ref": "#/definitions/DatasetVersion" + } + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/DatasetVersion" + } + }, + "201": { + "description": "The request has succeeded and a new resource has been created as a result.", + "schema": { + "$ref": "#/definitions/DatasetVersion" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Datasets_CreateOrUpdateVersion_MaximumSet": { + "$ref": "./examples/Datasets_CreateOrUpdateVersion_MaximumSet_Gen.json" + }, + "Datasets_CreateOrUpdateVersion_MinimumSet": { + "$ref": "./examples/Datasets_CreateOrUpdateVersion_MinimumSet_Gen.json" + } + } + }, + "delete": { + "operationId": "Datasets_DeleteVersion", + "description": "Delete the specific version of the DatasetVersion", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "name", + "in": "path", + "description": "The name of the resource", + "required": true, + "type": "string" + }, + { + "name": "version", + "in": "path", + "description": "The version of the DatasetVersion to delete.", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "There is no content to send for this request, but the headers may be useful." + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Datasets_DeleteVersion_MaximumSet": { + "$ref": "./examples/Datasets_DeleteVersion_MaximumSet_Gen.json" + }, + "Datasets_DeleteVersion_MinimumSet": { + "$ref": "./examples/Datasets_DeleteVersion_MinimumSet_Gen.json" + } + } + } + }, + "/datasets/{name}/versions/{version}/credentials": { + "post": { + "operationId": "Datasets_GetCredentials", + "description": "Get the SAS credential to access the storage account associated with a Dataset version.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "name", + "in": "path", + "description": "The name of the resource", + "required": true, + "type": "string" + }, + { + "name": "version", + "in": "path", + "description": "The specific version id of the DatasetVersion to operate on.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/AssetCredentialResponse" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Datasets_GetCredentials_MaximumSet": { + "$ref": "./examples/Datasets_GetCredentials_MaximumSet_Gen.json" + }, + "Datasets_GetCredentials_MinimumSet": { + "$ref": "./examples/Datasets_GetCredentials_MinimumSet_Gen.json" + } + } + } + }, + "/datasets/{name}/versions/{version}/startPendingUpload": { + "post": { + "operationId": "Datasets_StartPendingUploadVersion", + "description": "Start a new or get an existing pending upload of a dataset for a specific version.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "name", + "in": "path", + "description": "The name of the resource", + "required": true, + "type": "string" + }, + { + "name": "version", + "in": "path", + "description": "The specific version id of the DatasetVersion to operate on.", + "required": true, + "type": "string" + }, + { + "name": "body", + "in": "body", + "description": "Parameters for the action", + "required": true, + "schema": { + "$ref": "#/definitions/PendingUploadRequest" + } + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/PendingUploadResponse" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Datasets_StartPendingUploadVersion_MaximumSet": { + "$ref": "./examples/Datasets_StartPendingUploadVersion_MaximumSet_Gen.json" + }, + "Datasets_StartPendingUploadVersion_MinimumSet": { + "$ref": "./examples/Datasets_StartPendingUploadVersion_MinimumSet_Gen.json" + } + } + } + }, + "/deployments": { + "get": { + "operationId": "Deployments_List", + "description": "List all deployed models in the project", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "modelPublisher", + "in": "query", + "description": "Model publisher to filter models by", + "required": false, + "type": "string" + }, + { + "name": "modelName", + "in": "query", + "description": "Model name (the publisher specific name) to filter models by", + "required": false, + "type": "string" + }, + { + "name": "deploymentType", + "in": "query", + "description": "Type of deployment to filter list by", + "required": false, + "type": "string", + "enum": [ + "ModelDeployment" + ], + "x-ms-enum": { + "name": "DeploymentType", + "modelAsString": true, + "values": [ + { + "name": "ModelDeployment", + "value": "ModelDeployment", + "description": "Model deployment" + } + ] + } + }, + { + "$ref": "#/parameters/Azure.Core.ClientRequestIdHeader" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/PagedDeployment" + }, + "headers": { + "x-ms-client-request-id": { + "type": "string", + "format": "uuid", + "description": "An opaque, globally-unique, client-generated string identifier for the request." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Deployments_List_MaximumSet": { + "$ref": "./examples/Deployments_List_MaximumSet_Gen.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/deployments/{name}": { + "get": { + "operationId": "Deployments_Get", + "description": "Get a deployed model.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the deployment", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/Azure.Core.ClientRequestIdHeader" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/Deployment" + }, + "headers": { + "x-ms-client-request-id": { + "type": "string", + "format": "uuid", + "description": "An opaque, globally-unique, client-generated string identifier for the request." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Deployments_Get_MaximumSet": { + "$ref": "./examples/Deployments_Get_MaximumSet_Gen.json" + } + } + } + }, + "/indexes": { + "get": { + "operationId": "Indexes_ListLatest", + "description": "List the latest version of each Index", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/PagedIndex" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Indexes_ListLatest_MaximumSet": { + "$ref": "./examples/Indexes_ListLatest_MaximumSet_Gen.json" + }, + "Indexes_ListLatest_MinimumSet": { + "$ref": "./examples/Indexes_ListLatest_MinimumSet_Gen.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/indexes/{name}/versions": { + "get": { + "operationId": "Indexes_ListVersions", + "description": "List all versions of the given Index", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "name", + "in": "path", + "description": "The name of the resource", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/PagedIndex" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Indexes_ListVersions_MaximumSet": { + "$ref": "./examples/Indexes_ListVersions_MaximumSet_Gen.json" + }, + "Indexes_ListVersions_MinimumSet": { + "$ref": "./examples/Indexes_ListVersions_MinimumSet_Gen.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/indexes/{name}/versions/{version}": { + "get": { + "operationId": "Indexes_GetVersion", + "description": "Get the specific version of the Index", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "name", + "in": "path", + "description": "The name of the resource", + "required": true, + "type": "string" + }, + { + "name": "version", + "in": "path", + "description": "The specific version id of the Index to retrieve.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/Index" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Indexes_GetVersion_MaximumSet": { + "$ref": "./examples/Indexes_GetVersion_MaximumSet_Gen.json" + }, + "Indexes_GetVersion_MinimumSet": { + "$ref": "./examples/Indexes_GetVersion_MinimumSet_Gen.json" + } + } + }, + "patch": { + "operationId": "Indexes_CreateOrUpdateVersion", + "description": "Create a new or update an existing Index with the given version id", + "consumes": [ + "application/merge-patch+json" + ], + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "name", + "in": "path", + "description": "The name of the resource", + "required": true, + "type": "string" + }, + { + "name": "version", + "in": "path", + "description": "The specific version id of the Index to create or replace.", + "required": true, + "type": "string" + }, + { + "name": "body", + "in": "body", + "description": "The definition of the Index to create or update", + "required": true, + "schema": { + "$ref": "#/definitions/Index" + } + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/Index" + } + }, + "201": { + "description": "The request has succeeded and a new resource has been created as a result.", + "schema": { + "$ref": "#/definitions/Index" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Indexes_CreateOrUpdateVersion_MaximumSet": { + "$ref": "./examples/Indexes_CreateOrUpdateVersion_MaximumSet_Gen.json" + }, + "Indexes_CreateOrUpdateVersion_MinimumSet": { + "$ref": "./examples/Indexes_CreateOrUpdateVersion_MinimumSet_Gen.json" + } + } + }, + "delete": { + "operationId": "Indexes_DeleteVersion", + "description": "Delete the specific version of the Index", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "name", + "in": "path", + "description": "The name of the resource", + "required": true, + "type": "string" + }, + { + "name": "version", + "in": "path", + "description": "The version of the Index to delete.", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "There is no content to send for this request, but the headers may be useful." + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Indexes_DeleteVersion_MaximumSet": { + "$ref": "./examples/Indexes_DeleteVersion_MaximumSet_Gen.json" + }, + "Indexes_DeleteVersion_MinimumSet": { + "$ref": "./examples/Indexes_DeleteVersion_MinimumSet_Gen.json" + } + } + } + } + }, + "definitions": { + "ApiKeyCredentials": { + "type": "object", + "description": "API Key Credential definition", + "properties": { + "key": { + "type": "string", + "description": "API Key", + "readOnly": true, + "x-ms-client-name": "apiKey" + } + }, + "allOf": [ + { + "$ref": "#/definitions/BaseCredentials" + } + ], + "x-ms-discriminator-value": "ApiKey" + }, + "AssetCredentialResponse": { + "type": "object", + "description": "Represents a reference to a blob for consumption", + "properties": { + "blobReference": { + "$ref": "#/definitions/BlobReference", + "description": "Credential info to access the storage account." + } + }, + "required": [ + "blobReference" + ] + }, + "Azure.Core.Foundations.Error": { + "type": "object", + "description": "The error object.", + "properties": { + "code": { + "type": "string", + "description": "One of a server-defined set of error codes." + }, + "message": { + "type": "string", + "description": "A human-readable representation of the error." + }, + "target": { + "type": "string", + "description": "The target of the error." + }, + "details": { + "type": "array", + "description": "An array of details about specific errors that led to this reported error.", + "items": { + "$ref": "#/definitions/Azure.Core.Foundations.Error" + }, + "x-ms-identifiers": [] + }, + "innererror": { + "$ref": "#/definitions/Azure.Core.Foundations.InnerError", + "description": "An object containing more specific information than the current object about the error." + } + }, + "required": [ + "code", + "message" + ] + }, + "Azure.Core.Foundations.ErrorResponse": { + "type": "object", + "description": "A response containing error details.", + "properties": { + "error": { + "$ref": "#/definitions/Azure.Core.Foundations.Error", + "description": "The error object." + } + }, + "required": [ + "error" + ] + }, + "Azure.Core.Foundations.InnerError": { + "type": "object", + "description": "An object containing more specific information about the error. As per Microsoft One API guidelines - https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors.", + "properties": { + "code": { + "type": "string", + "description": "One of a server-defined set of error codes." + }, + "innererror": { + "$ref": "#/definitions/Azure.Core.Foundations.InnerError", + "description": "Inner error." + } + } + }, + "AzureAISearchIndex": { + "type": "object", + "description": "Azure AI Search Index Definition", + "properties": { + "connectionName": { + "type": "string", + "description": "Name of connection to Azure AI Search", + "x-ms-mutability": [ + "create" + ] + }, + "indexName": { + "type": "string", + "description": "Name of index in Azure AI Search resource to attach", + "x-ms-mutability": [ + "create" + ] + }, + "fieldMapping": { + "$ref": "#/definitions/FieldMapping", + "description": "Field mapping configuration", + "x-ms-mutability": [ + "create" + ] + } + }, + "required": [ + "connectionName", + "indexName" + ], + "allOf": [ + { + "$ref": "#/definitions/Index" + } + ], + "x-ms-discriminator-value": "AzureSearch" + }, + "BaseCredentials": { + "type": "object", + "description": "A base class for connection credentials", + "properties": { + "type": { + "$ref": "#/definitions/CredentialType", + "description": "The type of credential used by the connection", + "readOnly": true + } + }, + "discriminator": "type", + "required": [ + "type" + ] + }, + "BlobReference": { + "type": "object", + "description": "Blob reference details.", + "properties": { + "blobUri": { + "type": "string", + "description": "Blob URI path for client to upload data. Example: https://blob.windows.core.net/Container/Path" + }, + "storageAccountArmId": { + "type": "string", + "description": "ARM ID of the storage account to use." + }, + "credential": { + "$ref": "#/definitions/SasCredential", + "description": "Credential info to access the storage account." + } + }, + "required": [ + "blobUri", + "storageAccountArmId", + "credential" + ] + }, + "Connection": { + "type": "object", + "description": "Response from the list and get connections operations", + "properties": { + "name": { + "type": "string", + "description": "The friendly name of the connection, provided by the user.", + "readOnly": true + }, + "id": { + "type": "string", + "description": "A unique identifier for the connection, generated by the service", + "readOnly": true + }, + "type": { + "$ref": "#/definitions/ConnectionType", + "description": "Category of the connection", + "readOnly": true + }, + "target": { + "type": "string", + "description": "The connection URL to be used for this service", + "readOnly": true + }, + "isDefault": { + "type": "boolean", + "description": "Whether the connection is tagged as the default connection of its type", + "readOnly": true + }, + "credentials": { + "$ref": "#/definitions/BaseCredentials", + "description": "The credentials used by the connection", + "readOnly": true + }, + "metadata": { + "type": "object", + "description": "Metadata of the connection", + "additionalProperties": { + "type": "string" + }, + "readOnly": true + } + }, + "required": [ + "name", + "id", + "type", + "target", + "isDefault", + "credentials", + "metadata" + ] + }, + "ConnectionType": { + "type": "string", + "description": "The Type (or category) of the connection", + "enum": [ + "AzureOpenAI", + "AzureBlob", + "AzureStorageAccount", + "CognitiveSearch", + "CosmosDB", + "ApiKey", + "AppConfig", + "AppInsights", + "CustomKeys" + ], + "x-ms-enum": { + "name": "ConnectionType", + "modelAsString": true, + "values": [ + { + "name": "AzureOpenAI", + "value": "AzureOpenAI", + "description": "Azure OpenAI Service" + }, + { + "name": "AzureBlobStorage", + "value": "AzureBlob", + "description": "Azure Blob Storage, with specified container" + }, + { + "name": "AzureStorageAccount", + "value": "AzureStorageAccount", + "description": "Azure Blob Storage, with container not specified (used by Agents)" + }, + { + "name": "AzureAISearch", + "value": "CognitiveSearch", + "description": "Azure AI Search" + }, + { + "name": "CosmosDB", + "value": "CosmosDB", + "description": "CosmosDB" + }, + { + "name": "APIKey", + "value": "ApiKey", + "description": "Generic connection that uses API Key authentication" + }, + { + "name": "ApplicationConfiguration", + "value": "AppConfig", + "description": "Application Configuration" + }, + { + "name": "ApplicationInsights", + "value": "AppInsights", + "description": "Application Insights" + }, + { + "name": "Custom", + "value": "CustomKeys", + "description": "Custom Keys" + } + ] + } + }, + "CosmosDBIndex": { + "type": "object", + "description": "CosmosDB Vector Store Index Definition", + "properties": { + "connectionName": { + "type": "string", + "description": "Name of connection to CosmosDB", + "x-ms-mutability": [ + "create" + ] + }, + "databaseName": { + "type": "string", + "description": "Name of the CosmosDB Database", + "x-ms-mutability": [ + "create" + ] + }, + "containerName": { + "type": "string", + "description": "Name of CosmosDB Container", + "x-ms-mutability": [ + "create" + ] + }, + "embeddingConfiguration": { + "$ref": "#/definitions/EmbeddingConfiguration", + "description": "Embedding model configuration", + "x-ms-mutability": [ + "create" + ] + }, + "fieldMapping": { + "$ref": "#/definitions/FieldMapping", + "description": "Field mapping configuration", + "x-ms-mutability": [ + "create" + ] + } + }, + "required": [ + "connectionName", + "databaseName", + "containerName", + "embeddingConfiguration", + "fieldMapping" + ], + "allOf": [ + { + "$ref": "#/definitions/Index" + } + ], + "x-ms-discriminator-value": "CosmosDBNoSqlVectorStore" + }, + "CredentialType": { + "type": "string", + "description": "The credential type used by the connection", + "enum": [ + "ApiKey", + "AAD", + "SAS", + "CustomKeys", + "None" + ], + "x-ms-enum": { + "name": "CredentialType", + "modelAsString": true, + "values": [ + { + "name": "apiKey", + "value": "ApiKey", + "description": "API Key credential" + }, + { + "name": "entraId", + "value": "AAD", + "description": "Entra ID credential (formerly known as AAD)" + }, + { + "name": "SAS", + "value": "SAS", + "description": "Shared Access Signature (SAS) credential" + }, + { + "name": "custom", + "value": "CustomKeys", + "description": "Custom credential" + }, + { + "name": "None", + "value": "None", + "description": "No credential" + } + ] + } + }, + "CustomCredential": { + "type": "object", + "description": "Custom credential definition", + "properties": { + "keys": { + "type": "object", + "description": "The credential type", + "additionalProperties": { + "type": "string" + }, + "readOnly": true + } + }, + "required": [ + "keys" + ], + "allOf": [ + { + "$ref": "#/definitions/BaseCredentials" + } + ], + "x-ms-discriminator-value": "CustomKeys" + }, + "DatasetType": { + "type": "string", + "description": "Enum to determine the type of data.", + "enum": [ + "uri_file", + "uri_folder" + ], + "x-ms-enum": { + "name": "DatasetType", + "modelAsString": true, + "values": [ + { + "name": "uri_file", + "value": "uri_file", + "description": "URI file." + }, + { + "name": "uri_folder", + "value": "uri_folder", + "description": "URI folder." + } + ] + } + }, + "DatasetVersion": { + "type": "object", + "description": "DatasetVersion Definition", + "properties": { + "dataUri": { + "type": "string", + "description": "URI of the data. Example: https://go.microsoft.com/fwlink/?linkid=2202330", + "minLength": 1, + "pattern": "[a-zA-Z0-9_]", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "type": { + "$ref": "#/definitions/DatasetType", + "description": "Dataset type" + }, + "isReference": { + "type": "boolean", + "description": "Indicates if the dataset holds a reference to the storage, or the dataset manages storage itself. If true, the underlying data will not be deleted when the dataset version is deleted", + "readOnly": true + }, + "connectionName": { + "type": "string", + "description": "The Azure Storage Account connection name. Required if startPendingUploadVersion was not called before creating the Dataset", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "id": { + "type": "string", + "description": "Asset ID, a unique identifier for the asset", + "readOnly": true + }, + "name": { + "type": "string", + "description": "The name of the resource", + "readOnly": true + }, + "version": { + "type": "string", + "description": "The version of the resource", + "readOnly": true + }, + "description": { + "type": "string", + "description": "The asset description text.", + "x-ms-mutability": [ + "update", + "create" + ] + }, + "tags": { + "type": "object", + "description": "Tag dictionary. Tags can be added, removed, and updated.", + "additionalProperties": { + "type": "string" + }, + "x-ms-mutability": [ + "update", + "create" + ] + } + }, + "discriminator": "type", + "required": [ + "dataUri", + "type", + "name", + "version" + ] + }, + "Deployment": { + "type": "object", + "description": "Model Deployment Definition", + "properties": { + "type": { + "$ref": "#/definitions/DeploymentType", + "description": "The type of the deployment" + }, + "name": { + "type": "string", + "description": "Name of the deployment", + "readOnly": true + } + }, + "discriminator": "type", + "required": [ + "type", + "name" + ] + }, + "DeploymentType": { + "type": "string", + "enum": [ + "ModelDeployment" + ], + "x-ms-enum": { + "name": "DeploymentType", + "modelAsString": true, + "values": [ + { + "name": "ModelDeployment", + "value": "ModelDeployment", + "description": "Model deployment" + } + ] + } + }, + "EmbeddingConfiguration": { + "type": "object", + "description": "Embedding configuration class", + "properties": { + "modelDeploymentName": { + "type": "string", + "description": "Deployment name of embedding model. It can point to a model deployment either in the parent AIServices or a connection.", + "x-ms-mutability": [ + "create" + ] + }, + "embeddingField": { + "type": "string", + "description": "Embedding field", + "x-ms-mutability": [ + "create" + ] + } + }, + "required": [ + "modelDeploymentName", + "embeddingField" + ] + }, + "EntraIDCredentials": { + "type": "object", + "description": "Entra ID credential definition", + "allOf": [ + { + "$ref": "#/definitions/BaseCredentials" + } + ], + "x-ms-discriminator-value": "AAD" + }, + "FieldMapping": { + "type": "object", + "description": "Field mapping configuration class", + "properties": { + "contentFields": { + "type": "array", + "description": "List of fields with text content", + "items": { + "type": "string" + }, + "x-ms-mutability": [ + "create" + ] + }, + "filepathField": { + "type": "string", + "description": "Path of file to be used as a source of text content", + "x-ms-mutability": [ + "create" + ] + }, + "titleField": { + "type": "string", + "description": "Field containing the title of the document", + "x-ms-mutability": [ + "create" + ] + }, + "urlField": { + "type": "string", + "description": "Field containing the url of the document", + "x-ms-mutability": [ + "create" + ] + }, + "vectorFields": { + "type": "array", + "description": "List of fields with vector content", + "items": { + "type": "string" + }, + "x-ms-mutability": [ + "create" + ] + }, + "metadataFields": { + "type": "array", + "description": "List of fields with metadata content", + "items": { + "type": "string" + }, + "x-ms-mutability": [ + "create" + ] + } + }, + "required": [ + "contentFields" + ] + }, + "FileDatasetVersion": { + "type": "object", + "description": "FileDatasetVersion Definition", + "allOf": [ + { + "$ref": "#/definitions/DatasetVersion" + } + ], + "x-ms-discriminator-value": "uri_file" + }, + "FolderDatasetVersion": { + "type": "object", + "description": "FileDatasetVersion Definition", + "allOf": [ + { + "$ref": "#/definitions/DatasetVersion" + } + ], + "x-ms-discriminator-value": "uri_folder" + }, + "Index": { + "type": "object", + "description": "Index resource Definition", + "properties": { + "type": { + "$ref": "#/definitions/IndexType", + "description": "Type of index" + }, + "id": { + "type": "string", + "description": "Asset ID, a unique identifier for the asset", + "readOnly": true + }, + "name": { + "type": "string", + "description": "The name of the resource", + "readOnly": true + }, + "version": { + "type": "string", + "description": "The version of the resource", + "readOnly": true + }, + "description": { + "type": "string", + "description": "The asset description text.", + "x-ms-mutability": [ + "update", + "create" + ] + }, + "tags": { + "type": "object", + "description": "Tag dictionary. Tags can be added, removed, and updated.", + "additionalProperties": { + "type": "string" + }, + "x-ms-mutability": [ + "update", + "create" + ] + } + }, + "discriminator": "type", + "required": [ + "type", + "name", + "version" + ] + }, + "IndexType": { + "type": "string", + "enum": [ + "AzureSearch", + "CosmosDBNoSqlVectorStore", + "ManagedAzureSearch" + ], + "x-ms-enum": { + "name": "IndexType", + "modelAsString": true, + "values": [ + { + "name": "azureSearch", + "value": "AzureSearch", + "description": "Azure search" + }, + { + "name": "cosmosDB", + "value": "CosmosDBNoSqlVectorStore", + "description": "CosmosDB" + }, + { + "name": "managedAzureSearch", + "value": "ManagedAzureSearch", + "description": "Managed Azure Search" + } + ] + } + }, + "ManagedAzureAISearchIndex": { + "type": "object", + "description": "Managed Azure AI Search Index Definition", + "properties": { + "vectorStoreId": { + "type": "string", + "description": "Vector store id of managed index", + "x-ms-mutability": [ + "create" + ] + } + }, + "required": [ + "vectorStoreId" + ], + "allOf": [ + { + "$ref": "#/definitions/Index" + } + ], + "x-ms-discriminator-value": "ManagedAzureSearch" + }, + "ModelDeployment": { + "type": "object", + "description": "Model Deployment Definition", + "properties": { + "modelName": { + "type": "string", + "description": "Publisher-specific name of the deployed model", + "readOnly": true + }, + "modelVersion": { + "type": "string", + "description": "Publisher-specific version of the deployed model", + "readOnly": true + }, + "modelPublisher": { + "type": "string", + "description": "Name of the deployed model's publisher", + "readOnly": true + }, + "capabilities": { + "type": "object", + "description": "Capabilities of deployed model", + "additionalProperties": { + "type": "string" + }, + "readOnly": true + }, + "sku": { + "$ref": "#/definitions/Sku", + "description": "Sku of the model deployment", + "readOnly": true + }, + "connectionName": { + "type": "string", + "description": "Name of the connection the deployment comes from", + "readOnly": true + } + }, + "required": [ + "modelName", + "modelVersion", + "modelPublisher", + "capabilities", + "sku" + ], + "allOf": [ + { + "$ref": "#/definitions/Deployment" + } + ], + "x-ms-discriminator-value": "ModelDeployment" + }, + "NoAuthenticationCredentials": { + "type": "object", + "description": "Credentials that do not require authentication", + "allOf": [ + { + "$ref": "#/definitions/BaseCredentials" + } + ], + "x-ms-discriminator-value": "None" + }, + "PagedConnection": { + "type": "object", + "description": "Paged collection of Connection items", + "properties": { + "value": { + "type": "array", + "description": "The Connection items on this page", + "items": { + "$ref": "#/definitions/Connection" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "PagedDatasetVersion": { + "type": "object", + "description": "Paged collection of DatasetVersion items", + "properties": { + "value": { + "type": "array", + "description": "The DatasetVersion items on this page", + "items": { + "$ref": "#/definitions/DatasetVersion" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "PagedDeployment": { + "type": "object", + "description": "Paged collection of Deployment items", + "properties": { + "value": { + "type": "array", + "description": "The Deployment items on this page", + "items": { + "$ref": "#/definitions/Deployment" + }, + "x-ms-identifiers": [] + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "PagedIndex": { + "type": "object", + "description": "Paged collection of Index items", + "properties": { + "value": { + "type": "array", + "description": "The Index items on this page", + "items": { + "$ref": "#/definitions/Index" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "PendingUploadCredentialType": { + "type": "string", + "description": "The type of credential used to access the storage account.", + "enum": [ + "SAS" + ], + "x-ms-enum": { + "name": "PendingUploadCredentialType", + "modelAsString": true, + "values": [ + { + "name": "sas", + "value": "SAS", + "description": "SAS credential type." + } + ] + } + }, + "PendingUploadRequest": { + "type": "object", + "description": "Represents a request for a pending upload.", + "properties": { + "pendingUploadId": { + "type": "string", + "description": "If PendingUploadId is not provided, a random GUID will be used." + }, + "connectionName": { + "type": "string", + "description": "Azure Storage Account connection name to use for generating temporary SAS token" + }, + "pendingUploadType": { + "type": "string", + "description": "BlobReference is the only supported type.", + "enum": [ + "BlobReference" + ], + "x-ms-enum": { + "modelAsString": false + } + } + }, + "required": [ + "pendingUploadType" + ] + }, + "PendingUploadResponse": { + "type": "object", + "description": "Represents the response for a pending upload request", + "properties": { + "blobReference": { + "$ref": "#/definitions/BlobReference", + "description": "Container-level read, write, list SAS." + }, + "pendingUploadId": { + "type": "string", + "description": "ID for this upload request." + }, + "version": { + "type": "string", + "description": "Version of asset to be created if user did not specify version when initially creating upload" + }, + "pendingUploadType": { + "type": "string", + "description": "BlobReference is the only supported type", + "enum": [ + "BlobReference" + ], + "x-ms-enum": { + "modelAsString": false + } + } + }, + "required": [ + "blobReference", + "pendingUploadId", + "pendingUploadType" + ] + }, + "PendingUploadType": { + "type": "string", + "description": "The type of pending upload.", + "enum": [ + "None", + "BlobReference" + ], + "x-ms-enum": { + "name": "PendingUploadType", + "modelAsString": true, + "values": [ + { + "name": "none", + "value": "None", + "description": "No pending upload." + }, + { + "name": "BlobReference", + "value": "BlobReference", + "description": "Blob Reference is the only supported type." + } + ] + } + }, + "SASCredentials": { + "type": "object", + "description": "Shared Access Signature (SAS) credential definition", + "properties": { + "SAS": { + "type": "string", + "description": "SAS token", + "readOnly": true, + "x-ms-client-name": "sasToken" + } + }, + "allOf": [ + { + "$ref": "#/definitions/BaseCredentials" + } + ], + "x-ms-discriminator-value": "SAS" + }, + "SasCredential": { + "type": "object", + "description": "SAS Credential definition", + "properties": { + "sasUri": { + "type": "string", + "description": "SAS uri", + "readOnly": true + }, + "type": { + "type": "string", + "description": "Type of credential", + "enum": [ + "SAS" + ], + "x-ms-enum": { + "modelAsString": false + }, + "readOnly": true + } + }, + "required": [ + "sasUri", + "type" + ] + }, + "Sku": { + "type": "object", + "description": "Sku information", + "properties": { + "capacity": { + "type": "integer", + "format": "int64", + "description": "Sku capacity" + }, + "family": { + "type": "string", + "description": "Sku family" + }, + "name": { + "type": "string", + "description": "Sku name" + }, + "size": { + "type": "string", + "description": "Sku size" + }, + "tier": { + "type": "string", + "description": "Sku tier" + } + }, + "required": [ + "capacity", + "family", + "name", + "size", + "tier" + ] + } + }, + "parameters": { + "Azure.Core.ClientRequestIdHeader": { + "name": "x-ms-client-request-id", + "in": "header", + "description": "An opaque, globally-unique, client-generated string identifier for the request.", + "required": false, + "type": "string", + "format": "uuid", + "x-ms-parameter-location": "method", + "x-ms-client-name": "clientRequestId" + }, + "Azure.Core.Foundations.ApiVersionParameter": { + "name": "api-version", + "in": "query", + "description": "The API version to use for this operation.", + "required": true, + "type": "string", + "minLength": 1, + "x-ms-parameter-location": "method", + "x-ms-client-name": "apiVersion" + } + } +} diff --git a/specification/ai/data-plane/Azure.AI.Projects/stable/2025-05-01/examples/Connections_GetWithCredentials_MaximumSet_Gen.json b/specification/ai/data-plane/Azure.AI.Projects/stable/2025-05-01/examples/Connections_GetWithCredentials_MaximumSet_Gen.json new file mode 100644 index 000000000000..1d0d3182016d --- /dev/null +++ b/specification/ai/data-plane/Azure.AI.Projects/stable/2025-05-01/examples/Connections_GetWithCredentials_MaximumSet_Gen.json @@ -0,0 +1,26 @@ +{ + "title": "Connections_GetWithCredentials_MaximumSet", + "operationId": "Connections_GetWithCredentials", + "parameters": { + "api-version": "2025-05-01", + "name": "qbcgg", + "x-ms-client-request-id": "cf35b680-dc80-4815-ab83-9364acc3bce6" + }, + "responses": { + "200": { + "body": { + "name": "obsbzkgcpozwapujpylfjqwqpbeol", + "id": "unique-id", + "type": "AzureOpenAI", + "target": "rkznadqxuwnkbtb", + "isDefault": true, + "credentials": { + "type": "BaseCredentials" + }, + "metadata": { + "key8920": "utjp" + } + } + } + } +} diff --git a/specification/ai/data-plane/Azure.AI.Projects/stable/2025-05-01/examples/Connections_Get_MaximumSet_Gen.json b/specification/ai/data-plane/Azure.AI.Projects/stable/2025-05-01/examples/Connections_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..50b34ecfe931 --- /dev/null +++ b/specification/ai/data-plane/Azure.AI.Projects/stable/2025-05-01/examples/Connections_Get_MaximumSet_Gen.json @@ -0,0 +1,26 @@ +{ + "title": "Connections_Get_MaximumSet", + "operationId": "Connections_Get", + "parameters": { + "api-version": "2025-05-01", + "name": "dbxtef", + "x-ms-client-request-id": "cf35b680-dc80-4815-ab83-9364acc3bce6" + }, + "responses": { + "200": { + "body": { + "name": "obsbzkgcpozwapujpylfjqwqpbeol", + "id": "unique-id", + "type": "AzureOpenAI", + "target": "rkznadqxuwnkbtb", + "isDefault": true, + "credentials": { + "type": "BaseCredentials" + }, + "metadata": { + "key8920": "utjp" + } + } + } + } +} diff --git a/specification/ai/data-plane/Azure.AI.Projects/stable/2025-05-01/examples/Connections_List_MaximumSet_Gen.json b/specification/ai/data-plane/Azure.AI.Projects/stable/2025-05-01/examples/Connections_List_MaximumSet_Gen.json new file mode 100644 index 000000000000..0941fa337118 --- /dev/null +++ b/specification/ai/data-plane/Azure.AI.Projects/stable/2025-05-01/examples/Connections_List_MaximumSet_Gen.json @@ -0,0 +1,35 @@ +{ + "title": "Connections_List_MaximumSet", + "operationId": "Connections_List", + "parameters": { + "api-version": "2025-05-01", + "connectionType": "AzureOpenAI", + "defaultConnection": true, + "top": 29, + "skip": 27, + "maxpagesize": 25, + "x-ms-client-request-id": "cf35b680-dc80-4815-ab83-9364acc3bce6" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "obsbzkgcpozwapujpylfjqwqpbeol", + "id": "unique-id", + "type": "AzureOpenAI", + "target": "rkznadqxuwnkbtb", + "isDefault": true, + "credentials": { + "type": "BaseCredentials" + }, + "metadata": { + "key8920": "utjp" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/ai/data-plane/Azure.AI.Projects/stable/2025-05-01/examples/Datasets_CreateOrUpdateVersion_MaximumSet_Gen.json b/specification/ai/data-plane/Azure.AI.Projects/stable/2025-05-01/examples/Datasets_CreateOrUpdateVersion_MaximumSet_Gen.json new file mode 100644 index 000000000000..ac5689cf7bf9 --- /dev/null +++ b/specification/ai/data-plane/Azure.AI.Projects/stable/2025-05-01/examples/Datasets_CreateOrUpdateVersion_MaximumSet_Gen.json @@ -0,0 +1,39 @@ +{ + "title": "Datasets_CreateOrUpdateVersion_MaximumSet", + "operationId": "Datasets_CreateOrUpdateVersion", + "parameters": { + "api-version": "2025-05-01", + "name": "grpenjfobadxmsceuqwunwqn", + "version": "dfo", + "body": { + "dataUri": "Replace this value with a string matching RegExp [a-zA-Z0-9_]", + "type": "DatasetVersion", + "description": "zukluwbmoq", + "tags": { + "key8794": "ietydcqbwiebstkxrmqzsadlraapox" + } + } + }, + "responses": { + "200": { + "body": { + "dataUri": "Replace this value with a string matching RegExp [a-zA-Z0-9_]", + "type": "DatasetVersion", + "isReference": true, + "id": "nneuypway", + "name": "qnagvpitbcc", + "version": "vcdlshlzkzyuocakljbdjkaasc" + } + }, + "201": { + "body": { + "dataUri": "Replace this value with a string matching RegExp [a-zA-Z0-9_]", + "type": "DatasetVersion", + "isReference": true, + "id": "nneuypway", + "name": "qnagvpitbcc", + "version": "vcdlshlzkzyuocakljbdjkaasc" + } + } + } +} diff --git a/specification/ai/data-plane/Azure.AI.Projects/stable/2025-05-01/examples/Datasets_CreateOrUpdateVersion_MinimumSet_Gen.json b/specification/ai/data-plane/Azure.AI.Projects/stable/2025-05-01/examples/Datasets_CreateOrUpdateVersion_MinimumSet_Gen.json new file mode 100644 index 000000000000..b9dce746b790 --- /dev/null +++ b/specification/ai/data-plane/Azure.AI.Projects/stable/2025-05-01/examples/Datasets_CreateOrUpdateVersion_MinimumSet_Gen.json @@ -0,0 +1,31 @@ +{ + "title": "Datasets_CreateOrUpdateVersion_MinimumSet", + "operationId": "Datasets_CreateOrUpdateVersion", + "parameters": { + "api-version": "2025-05-01", + "name": "rpnyigsqddnpdmrboazyi", + "version": "iplgbfirylwervrnglnnbwwzodsm", + "body": { + "type": "DatasetVersion", + "dataUri": "Replace this value with a string matching RegExp [a-zA-Z0-9_]" + } + }, + "responses": { + "200": { + "body": { + "dataUri": "Replace this value with a string matching RegExp [a-zA-Z0-9_]", + "type": "DatasetVersion", + "name": "qnagvpitbcc", + "version": "vcdlshlzkzyuocakljbdjkaasc" + } + }, + "201": { + "body": { + "dataUri": "Replace this value with a string matching RegExp [a-zA-Z0-9_]", + "type": "DatasetVersion", + "name": "qnagvpitbcc", + "version": "vcdlshlzkzyuocakljbdjkaasc" + } + } + } +} diff --git a/specification/ai/data-plane/Azure.AI.Projects/stable/2025-05-01/examples/Datasets_DeleteVersion_MaximumSet_Gen.json b/specification/ai/data-plane/Azure.AI.Projects/stable/2025-05-01/examples/Datasets_DeleteVersion_MaximumSet_Gen.json new file mode 100644 index 000000000000..dd4eed294b2d --- /dev/null +++ b/specification/ai/data-plane/Azure.AI.Projects/stable/2025-05-01/examples/Datasets_DeleteVersion_MaximumSet_Gen.json @@ -0,0 +1,12 @@ +{ + "title": "Datasets_DeleteVersion_MaximumSet", + "operationId": "Datasets_DeleteVersion", + "parameters": { + "api-version": "2025-05-01", + "name": "ucurctiifkgnlmfsqjdqikngh", + "version": "ynxklccaehey" + }, + "responses": { + "204": {} + } +} diff --git a/specification/ai/data-plane/Azure.AI.Projects/stable/2025-05-01/examples/Datasets_DeleteVersion_MinimumSet_Gen.json b/specification/ai/data-plane/Azure.AI.Projects/stable/2025-05-01/examples/Datasets_DeleteVersion_MinimumSet_Gen.json new file mode 100644 index 000000000000..feddeb285bba --- /dev/null +++ b/specification/ai/data-plane/Azure.AI.Projects/stable/2025-05-01/examples/Datasets_DeleteVersion_MinimumSet_Gen.json @@ -0,0 +1,12 @@ +{ + "title": "Datasets_DeleteVersion_MinimumSet", + "operationId": "Datasets_DeleteVersion", + "parameters": { + "api-version": "2025-05-01", + "name": "mah", + "version": "cyvuzcdcozazi" + }, + "responses": { + "204": {} + } +} diff --git a/specification/ai/data-plane/Azure.AI.Projects/stable/2025-05-01/examples/Datasets_GetCredentials_MaximumSet_Gen.json b/specification/ai/data-plane/Azure.AI.Projects/stable/2025-05-01/examples/Datasets_GetCredentials_MaximumSet_Gen.json new file mode 100644 index 000000000000..7f1a1fc3d0a0 --- /dev/null +++ b/specification/ai/data-plane/Azure.AI.Projects/stable/2025-05-01/examples/Datasets_GetCredentials_MaximumSet_Gen.json @@ -0,0 +1,24 @@ +{ + "title": "Datasets_GetCredentials_MaximumSet", + "operationId": "Datasets_GetCredentials", + "parameters": { + "api-version": "2025-05-01", + "name": "ianzqjcpdiabrxkrbnstbpwlzavrmh", + "version": "nekh", + "body": {} + }, + "responses": { + "200": { + "body": { + "blobReference": { + "blobUri": "wvqzlobwdzstxryhnlqqtvp", + "storageAccountArmId": "br", + "credential": { + "sasUri": "qw", + "type": "SAS" + } + } + } + } + } +} diff --git a/specification/ai/data-plane/Azure.AI.Projects/stable/2025-05-01/examples/Datasets_GetCredentials_MinimumSet_Gen.json b/specification/ai/data-plane/Azure.AI.Projects/stable/2025-05-01/examples/Datasets_GetCredentials_MinimumSet_Gen.json new file mode 100644 index 000000000000..697c2a12a07f --- /dev/null +++ b/specification/ai/data-plane/Azure.AI.Projects/stable/2025-05-01/examples/Datasets_GetCredentials_MinimumSet_Gen.json @@ -0,0 +1,24 @@ +{ + "title": "Datasets_GetCredentials_MinimumSet", + "operationId": "Datasets_GetCredentials", + "parameters": { + "api-version": "2025-05-01", + "name": "nydfjjrnlgs", + "version": "wskb", + "body": {} + }, + "responses": { + "200": { + "body": { + "blobReference": { + "blobUri": "wvqzlobwdzstxryhnlqqtvp", + "storageAccountArmId": "br", + "credential": { + "sasUri": "qw", + "type": "SAS" + } + } + } + } + } +} diff --git a/specification/ai/data-plane/Azure.AI.Projects/stable/2025-05-01/examples/Datasets_GetVersion_MaximumSet_Gen.json b/specification/ai/data-plane/Azure.AI.Projects/stable/2025-05-01/examples/Datasets_GetVersion_MaximumSet_Gen.json new file mode 100644 index 000000000000..ae873e09f984 --- /dev/null +++ b/specification/ai/data-plane/Azure.AI.Projects/stable/2025-05-01/examples/Datasets_GetVersion_MaximumSet_Gen.json @@ -0,0 +1,21 @@ +{ + "title": "Datasets_GetVersion_MaximumSet", + "operationId": "Datasets_GetVersion", + "parameters": { + "api-version": "2025-05-01", + "name": "nynmsupycdzwlieanjigzvfcsxhghr", + "version": "efrsah" + }, + "responses": { + "200": { + "body": { + "dataUri": "Replace this value with a string matching RegExp [a-zA-Z0-9_]", + "type": "DatasetVersion", + "isReference": true, + "id": "nneuypway", + "name": "qnagvpitbcc", + "version": "vcdlshlzkzyuocakljbdjkaasc" + } + } + } +} diff --git a/specification/ai/data-plane/Azure.AI.Projects/stable/2025-05-01/examples/Datasets_GetVersion_MinimumSet_Gen.json b/specification/ai/data-plane/Azure.AI.Projects/stable/2025-05-01/examples/Datasets_GetVersion_MinimumSet_Gen.json new file mode 100644 index 000000000000..704b7791d6c5 --- /dev/null +++ b/specification/ai/data-plane/Azure.AI.Projects/stable/2025-05-01/examples/Datasets_GetVersion_MinimumSet_Gen.json @@ -0,0 +1,19 @@ +{ + "title": "Datasets_GetVersion_MinimumSet", + "operationId": "Datasets_GetVersion", + "parameters": { + "api-version": "2025-05-01", + "name": "nphjhqczjtdfwoxwuhcsnvfawmq", + "version": "itpmqdpptvnubbkihc" + }, + "responses": { + "200": { + "body": { + "dataUri": "Replace this value with a string matching RegExp [a-zA-Z0-9_]", + "type": "DatasetVersion", + "name": "qnagvpitbcc", + "version": "vcdlshlzkzyuocakljbdjkaasc" + } + } + } +} diff --git a/specification/ai/data-plane/Azure.AI.Projects/stable/2025-05-01/examples/Datasets_ListLatest_MaximumSet_Gen.json b/specification/ai/data-plane/Azure.AI.Projects/stable/2025-05-01/examples/Datasets_ListLatest_MaximumSet_Gen.json new file mode 100644 index 000000000000..85f841a8d488 --- /dev/null +++ b/specification/ai/data-plane/Azure.AI.Projects/stable/2025-05-01/examples/Datasets_ListLatest_MaximumSet_Gen.json @@ -0,0 +1,28 @@ +{ + "title": "Datasets_ListLatest_MaximumSet", + "operationId": "Datasets_ListLatest", + "parameters": { + "api-version": "2025-05-01", + "top": 21, + "skip": "eprtlgapqpuxmkqqbyqgatazgk", + "tags": "mvcivdyuolnhvpuqdp", + "listViewType": "ActiveOnly" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "dataUri": "Replace this value with a string matching RegExp [a-zA-Z0-9_]", + "type": "DatasetVersion", + "isReference": true, + "id": "nneuypway", + "name": "qnagvpitbcc", + "version": "vcdlshlzkzyuocakljbdjkaasc" + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/ai/data-plane/Azure.AI.Projects/stable/2025-05-01/examples/Datasets_ListLatest_MinimumSet_Gen.json b/specification/ai/data-plane/Azure.AI.Projects/stable/2025-05-01/examples/Datasets_ListLatest_MinimumSet_Gen.json new file mode 100644 index 000000000000..f76f06e31a8c --- /dev/null +++ b/specification/ai/data-plane/Azure.AI.Projects/stable/2025-05-01/examples/Datasets_ListLatest_MinimumSet_Gen.json @@ -0,0 +1,21 @@ +{ + "title": "Datasets_ListLatest_MinimumSet", + "operationId": "Datasets_ListLatest", + "parameters": { + "api-version": "2025-05-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "dataUri": "Replace this value with a string matching RegExp [a-zA-Z0-9_]", + "type": "DatasetVersion", + "name": "qnagvpitbcc", + "version": "vcdlshlzkzyuocakljbdjkaasc" + } + ] + } + } + } +} diff --git a/specification/ai/data-plane/Azure.AI.Projects/stable/2025-05-01/examples/Datasets_ListVersions_MaximumSet_Gen.json b/specification/ai/data-plane/Azure.AI.Projects/stable/2025-05-01/examples/Datasets_ListVersions_MaximumSet_Gen.json new file mode 100644 index 000000000000..dcfefdba5120 --- /dev/null +++ b/specification/ai/data-plane/Azure.AI.Projects/stable/2025-05-01/examples/Datasets_ListVersions_MaximumSet_Gen.json @@ -0,0 +1,29 @@ +{ + "title": "Datasets_ListVersions_MaximumSet", + "operationId": "Datasets_ListVersions", + "parameters": { + "api-version": "2025-05-01", + "name": "qjknijsjewu", + "top": 13, + "skip": "wwwo", + "tags": "nfxvn", + "listViewType": "ActiveOnly" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "dataUri": "Replace this value with a string matching RegExp [a-zA-Z0-9_]", + "type": "DatasetVersion", + "isReference": true, + "id": "nneuypway", + "name": "qnagvpitbcc", + "version": "vcdlshlzkzyuocakljbdjkaasc" + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/ai/data-plane/Azure.AI.Projects/stable/2025-05-01/examples/Datasets_ListVersions_MinimumSet_Gen.json b/specification/ai/data-plane/Azure.AI.Projects/stable/2025-05-01/examples/Datasets_ListVersions_MinimumSet_Gen.json new file mode 100644 index 000000000000..176b7e2e7237 --- /dev/null +++ b/specification/ai/data-plane/Azure.AI.Projects/stable/2025-05-01/examples/Datasets_ListVersions_MinimumSet_Gen.json @@ -0,0 +1,22 @@ +{ + "title": "Datasets_ListVersions_MinimumSet", + "operationId": "Datasets_ListVersions", + "parameters": { + "api-version": "2025-05-01", + "name": "qcoxe" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "dataUri": "Replace this value with a string matching RegExp [a-zA-Z0-9_]", + "type": "DatasetVersion", + "name": "qnagvpitbcc", + "version": "vcdlshlzkzyuocakljbdjkaasc" + } + ] + } + } + } +} diff --git a/specification/ai/data-plane/Azure.AI.Projects/stable/2025-05-01/examples/Datasets_StartPendingUploadVersion_MaximumSet_Gen.json b/specification/ai/data-plane/Azure.AI.Projects/stable/2025-05-01/examples/Datasets_StartPendingUploadVersion_MaximumSet_Gen.json new file mode 100644 index 000000000000..084b9473a76d --- /dev/null +++ b/specification/ai/data-plane/Azure.AI.Projects/stable/2025-05-01/examples/Datasets_StartPendingUploadVersion_MaximumSet_Gen.json @@ -0,0 +1,31 @@ +{ + "title": "Datasets_StartPendingUploadVersion_MaximumSet", + "operationId": "Datasets_StartPendingUploadVersion", + "parameters": { + "api-version": "2025-05-01", + "name": "hvusmygqjnkihfwprkw", + "version": "zcrxyums", + "body": { + "pendingUploadId": "cnvf", + "connectionName": "qepjjlfgjlcalfuhchnojqlzhzrtcj", + "pendingUploadType": "BlobReference" + } + }, + "responses": { + "200": { + "body": { + "blobReference": { + "blobUri": "wvqzlobwdzstxryhnlqqtvp", + "storageAccountArmId": "br", + "credential": { + "sasUri": "qw", + "type": "SAS" + } + }, + "pendingUploadId": "mdhrbpu", + "version": "qbbmljwtqwhbgdcajnywtky", + "pendingUploadType": "BlobReference" + } + } + } +} diff --git a/specification/ai/data-plane/Azure.AI.Projects/stable/2025-05-01/examples/Datasets_StartPendingUploadVersion_MinimumSet_Gen.json b/specification/ai/data-plane/Azure.AI.Projects/stable/2025-05-01/examples/Datasets_StartPendingUploadVersion_MinimumSet_Gen.json new file mode 100644 index 000000000000..d7100cf468ab --- /dev/null +++ b/specification/ai/data-plane/Azure.AI.Projects/stable/2025-05-01/examples/Datasets_StartPendingUploadVersion_MinimumSet_Gen.json @@ -0,0 +1,28 @@ +{ + "title": "Datasets_StartPendingUploadVersion_MinimumSet", + "operationId": "Datasets_StartPendingUploadVersion", + "parameters": { + "api-version": "2025-05-01", + "name": "esicohztsytnvxxqcpzsxnesug", + "version": "rrwerwxmkfuewptwsxeylxrcjkcp", + "body": { + "pendingUploadType": "BlobReference" + } + }, + "responses": { + "200": { + "body": { + "blobReference": { + "blobUri": "wvqzlobwdzstxryhnlqqtvp", + "storageAccountArmId": "br", + "credential": { + "sasUri": "qw", + "type": "SAS" + } + }, + "pendingUploadId": "mdhrbpu", + "pendingUploadType": "BlobReference" + } + } + } +} diff --git a/specification/ai/data-plane/Azure.AI.Projects/stable/2025-05-01/examples/Deployments_Get_MaximumSet_Gen.json b/specification/ai/data-plane/Azure.AI.Projects/stable/2025-05-01/examples/Deployments_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..e054205d8864 --- /dev/null +++ b/specification/ai/data-plane/Azure.AI.Projects/stable/2025-05-01/examples/Deployments_Get_MaximumSet_Gen.json @@ -0,0 +1,17 @@ +{ + "title": "Deployments_Get_MaximumSet", + "operationId": "Deployments_Get", + "parameters": { + "api-version": "2025-05-01", + "name": "asyfxhswpjdjtjjwrkhyxmoljgml", + "x-ms-client-request-id": "cf35b680-dc80-4815-ab83-9364acc3bce6" + }, + "responses": { + "200": { + "body": { + "type": "Deployment", + "name": "aof" + } + } + } +} diff --git a/specification/ai/data-plane/Azure.AI.Projects/stable/2025-05-01/examples/Deployments_List_MaximumSet_Gen.json b/specification/ai/data-plane/Azure.AI.Projects/stable/2025-05-01/examples/Deployments_List_MaximumSet_Gen.json new file mode 100644 index 000000000000..dfc8c3e12f85 --- /dev/null +++ b/specification/ai/data-plane/Azure.AI.Projects/stable/2025-05-01/examples/Deployments_List_MaximumSet_Gen.json @@ -0,0 +1,26 @@ +{ + "title": "Deployments_List_MaximumSet", + "operationId": "Deployments_List", + "parameters": { + "api-version": "2025-05-01", + "modelPublisher": "wpfjkjrmkxihi", + "modelName": "lxhwhobkjsyhnfvhfyqhymgosytke", + "top": 29, + "skip": 27, + "maxpagesize": 25, + "x-ms-client-request-id": "cf35b680-dc80-4815-ab83-9364acc3bce6" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "type": "Deployment", + "name": "aof" + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/ai/data-plane/Azure.AI.Projects/stable/2025-05-01/examples/Indexes_CreateOrUpdateVersion_MaximumSet_Gen.json b/specification/ai/data-plane/Azure.AI.Projects/stable/2025-05-01/examples/Indexes_CreateOrUpdateVersion_MaximumSet_Gen.json new file mode 100644 index 000000000000..35dc866fade1 --- /dev/null +++ b/specification/ai/data-plane/Azure.AI.Projects/stable/2025-05-01/examples/Indexes_CreateOrUpdateVersion_MaximumSet_Gen.json @@ -0,0 +1,34 @@ +{ + "title": "Indexes_CreateOrUpdateVersion_MaximumSet", + "operationId": "Indexes_CreateOrUpdateVersion", + "parameters": { + "api-version": "2025-05-01", + "name": "qlslwpztrobxh", + "version": "lvwrjftywgtfixhxoxbmcs", + "body": { + "type": "Index", + "description": "fvbkomalkxkj", + "tags": { + "key8738": "gmejegbwwrkawbdxuv" + } + } + }, + "responses": { + "200": { + "body": { + "type": "Index", + "id": "ivqkxhapawoqvjiksau", + "name": "mfyjvkkukqfgrzlqtzfbtuldr", + "version": "qrygnibzlcruksqvwa" + } + }, + "201": { + "body": { + "type": "Index", + "id": "ivqkxhapawoqvjiksau", + "name": "mfyjvkkukqfgrzlqtzfbtuldr", + "version": "qrygnibzlcruksqvwa" + } + } + } +} diff --git a/specification/ai/data-plane/Azure.AI.Projects/stable/2025-05-01/examples/Indexes_CreateOrUpdateVersion_MinimumSet_Gen.json b/specification/ai/data-plane/Azure.AI.Projects/stable/2025-05-01/examples/Indexes_CreateOrUpdateVersion_MinimumSet_Gen.json new file mode 100644 index 000000000000..96d3b1f77ded --- /dev/null +++ b/specification/ai/data-plane/Azure.AI.Projects/stable/2025-05-01/examples/Indexes_CreateOrUpdateVersion_MinimumSet_Gen.json @@ -0,0 +1,28 @@ +{ + "title": "Indexes_CreateOrUpdateVersion_MinimumSet", + "operationId": "Indexes_CreateOrUpdateVersion", + "parameters": { + "api-version": "2025-05-01", + "name": "ypkrjjvche", + "version": "gmorfjnfnwawvkwsjsodunylq", + "body": { + "type": "Index" + } + }, + "responses": { + "200": { + "body": { + "type": "Index", + "name": "mfyjvkkukqfgrzlqtzfbtuldr", + "version": "qrygnibzlcruksqvwa" + } + }, + "201": { + "body": { + "type": "Index", + "name": "mfyjvkkukqfgrzlqtzfbtuldr", + "version": "qrygnibzlcruksqvwa" + } + } + } +} diff --git a/specification/ai/data-plane/Azure.AI.Projects/stable/2025-05-01/examples/Indexes_DeleteVersion_MaximumSet_Gen.json b/specification/ai/data-plane/Azure.AI.Projects/stable/2025-05-01/examples/Indexes_DeleteVersion_MaximumSet_Gen.json new file mode 100644 index 000000000000..f2cb9986c7ab --- /dev/null +++ b/specification/ai/data-plane/Azure.AI.Projects/stable/2025-05-01/examples/Indexes_DeleteVersion_MaximumSet_Gen.json @@ -0,0 +1,12 @@ +{ + "title": "Indexes_DeleteVersion_MaximumSet", + "operationId": "Indexes_DeleteVersion", + "parameters": { + "api-version": "2025-05-01", + "name": "djofiby", + "version": "wjcqszxbshmfcspufpvusvijabosg" + }, + "responses": { + "204": {} + } +} diff --git a/specification/ai/data-plane/Azure.AI.Projects/stable/2025-05-01/examples/Indexes_DeleteVersion_MinimumSet_Gen.json b/specification/ai/data-plane/Azure.AI.Projects/stable/2025-05-01/examples/Indexes_DeleteVersion_MinimumSet_Gen.json new file mode 100644 index 000000000000..a2aad4e2cffe --- /dev/null +++ b/specification/ai/data-plane/Azure.AI.Projects/stable/2025-05-01/examples/Indexes_DeleteVersion_MinimumSet_Gen.json @@ -0,0 +1,12 @@ +{ + "title": "Indexes_DeleteVersion_MinimumSet", + "operationId": "Indexes_DeleteVersion", + "parameters": { + "api-version": "2025-05-01", + "name": "bhjawuegimffqwlhrxtbbeohdplmw", + "version": "o" + }, + "responses": { + "204": {} + } +} diff --git a/specification/ai/data-plane/Azure.AI.Projects/stable/2025-05-01/examples/Indexes_GetVersion_MaximumSet_Gen.json b/specification/ai/data-plane/Azure.AI.Projects/stable/2025-05-01/examples/Indexes_GetVersion_MaximumSet_Gen.json new file mode 100644 index 000000000000..641bb03093fa --- /dev/null +++ b/specification/ai/data-plane/Azure.AI.Projects/stable/2025-05-01/examples/Indexes_GetVersion_MaximumSet_Gen.json @@ -0,0 +1,19 @@ +{ + "title": "Indexes_GetVersion_MaximumSet", + "operationId": "Indexes_GetVersion", + "parameters": { + "api-version": "2025-05-01", + "name": "nsgckjrartmxxbuc", + "version": "zplpqeeluwtxx" + }, + "responses": { + "200": { + "body": { + "type": "Index", + "id": "ivqkxhapawoqvjiksau", + "name": "mfyjvkkukqfgrzlqtzfbtuldr", + "version": "qrygnibzlcruksqvwa" + } + } + } +} diff --git a/specification/ai/data-plane/Azure.AI.Projects/stable/2025-05-01/examples/Indexes_GetVersion_MinimumSet_Gen.json b/specification/ai/data-plane/Azure.AI.Projects/stable/2025-05-01/examples/Indexes_GetVersion_MinimumSet_Gen.json new file mode 100644 index 000000000000..e1d022748151 --- /dev/null +++ b/specification/ai/data-plane/Azure.AI.Projects/stable/2025-05-01/examples/Indexes_GetVersion_MinimumSet_Gen.json @@ -0,0 +1,18 @@ +{ + "title": "Indexes_GetVersion_MinimumSet", + "operationId": "Indexes_GetVersion", + "parameters": { + "api-version": "2025-05-01", + "name": "ssadrgeajxmatjfcakqfxm", + "version": "ckqhgdasokotj" + }, + "responses": { + "200": { + "body": { + "type": "Index", + "name": "mfyjvkkukqfgrzlqtzfbtuldr", + "version": "qrygnibzlcruksqvwa" + } + } + } +} diff --git a/specification/ai/data-plane/Azure.AI.Projects/stable/2025-05-01/examples/Indexes_ListLatest_MaximumSet_Gen.json b/specification/ai/data-plane/Azure.AI.Projects/stable/2025-05-01/examples/Indexes_ListLatest_MaximumSet_Gen.json new file mode 100644 index 000000000000..1e185187835c --- /dev/null +++ b/specification/ai/data-plane/Azure.AI.Projects/stable/2025-05-01/examples/Indexes_ListLatest_MaximumSet_Gen.json @@ -0,0 +1,26 @@ +{ + "title": "Indexes_ListLatest_MaximumSet", + "operationId": "Indexes_ListLatest", + "parameters": { + "api-version": "2025-05-01", + "top": 27, + "skip": "pjv", + "tags": "v", + "listViewType": "ActiveOnly" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "type": "Index", + "id": "ivqkxhapawoqvjiksau", + "name": "mfyjvkkukqfgrzlqtzfbtuldr", + "version": "qrygnibzlcruksqvwa" + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/ai/data-plane/Azure.AI.Projects/stable/2025-05-01/examples/Indexes_ListLatest_MinimumSet_Gen.json b/specification/ai/data-plane/Azure.AI.Projects/stable/2025-05-01/examples/Indexes_ListLatest_MinimumSet_Gen.json new file mode 100644 index 000000000000..5b993cdaa80f --- /dev/null +++ b/specification/ai/data-plane/Azure.AI.Projects/stable/2025-05-01/examples/Indexes_ListLatest_MinimumSet_Gen.json @@ -0,0 +1,20 @@ +{ + "title": "Indexes_ListLatest_MinimumSet", + "operationId": "Indexes_ListLatest", + "parameters": { + "api-version": "2025-05-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "type": "Index", + "name": "mfyjvkkukqfgrzlqtzfbtuldr", + "version": "qrygnibzlcruksqvwa" + } + ] + } + } + } +} diff --git a/specification/ai/data-plane/Azure.AI.Projects/stable/2025-05-01/examples/Indexes_ListVersions_MaximumSet_Gen.json b/specification/ai/data-plane/Azure.AI.Projects/stable/2025-05-01/examples/Indexes_ListVersions_MaximumSet_Gen.json new file mode 100644 index 000000000000..c2d1bda61ccf --- /dev/null +++ b/specification/ai/data-plane/Azure.AI.Projects/stable/2025-05-01/examples/Indexes_ListVersions_MaximumSet_Gen.json @@ -0,0 +1,27 @@ +{ + "title": "Indexes_ListVersions_MaximumSet", + "operationId": "Indexes_ListVersions", + "parameters": { + "api-version": "2025-05-01", + "name": "ympfyjkrpvirlqqfcwbrrmebc", + "top": 1, + "skip": "emybimaziwnaxdvk", + "tags": "bhuogyiydomalwcj", + "listViewType": "ActiveOnly" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "type": "Index", + "id": "ivqkxhapawoqvjiksau", + "name": "mfyjvkkukqfgrzlqtzfbtuldr", + "version": "qrygnibzlcruksqvwa" + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/ai/data-plane/Azure.AI.Projects/stable/2025-05-01/examples/Indexes_ListVersions_MinimumSet_Gen.json b/specification/ai/data-plane/Azure.AI.Projects/stable/2025-05-01/examples/Indexes_ListVersions_MinimumSet_Gen.json new file mode 100644 index 000000000000..767f7c24591e --- /dev/null +++ b/specification/ai/data-plane/Azure.AI.Projects/stable/2025-05-01/examples/Indexes_ListVersions_MinimumSet_Gen.json @@ -0,0 +1,21 @@ +{ + "title": "Indexes_ListVersions_MinimumSet", + "operationId": "Indexes_ListVersions", + "parameters": { + "api-version": "2025-05-01", + "name": "sgpbxddgmugf" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "type": "Index", + "name": "mfyjvkkukqfgrzlqtzfbtuldr", + "version": "qrygnibzlcruksqvwa" + } + ] + } + } + } +} diff --git a/specification/ai/data-plane/Azure.AI.Projects/stable/v1/azure-ai-projects.json b/specification/ai/data-plane/Azure.AI.Projects/stable/v1/azure-ai-projects.json new file mode 100644 index 000000000000..26eff6ca54bb --- /dev/null +++ b/specification/ai/data-plane/Azure.AI.Projects/stable/v1/azure-ai-projects.json @@ -0,0 +1,2167 @@ +{ + "swagger": "2.0", + "info": { + "title": "Azure AI", + "version": "v1", + "x-typespec-generated": [ + { + "emitter": "@azure-tools/typespec-autorest" + } + ] + }, + "schemes": [ + "https" + ], + "x-ms-parameterized-host": { + "hostTemplate": "{endpoint}", + "useSchemePrefix": false, + "parameters": [ + { + "name": "endpoint", + "in": "path", + "description": "Project endpoint. In the form \"https://.services.ai.azure.com/api/projects/_project\"\nif your Foundry Hub has only one Project, or to use the default Project in your Hub. Or in the form \n\"https://.services.ai.azure.com/api/projects/\" if you want to explicitly\nspecify the Foundry Project name.", + "required": true, + "type": "string", + "format": "uri", + "x-ms-skip-url-encoding": true + } + ] + }, + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ], + "security": [ + { + "OAuth2Auth": [ + "https://ai.azure.com/.default" + ] + } + ], + "securityDefinitions": { + "OAuth2Auth": { + "type": "oauth2", + "flow": "implicit", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/v2.0/authorize", + "scopes": { + "https://ai.azure.com/.default": "" + } + } + }, + "tags": [], + "paths": { + "/connections": { + "get": { + "operationId": "Connections_List", + "description": "List all connections in the project, without populating connection credentials", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "connectionType", + "in": "query", + "description": "List connections of this specific type", + "required": false, + "type": "string", + "enum": [ + "AzureOpenAI", + "AzureBlob", + "AzureStorageAccount", + "CognitiveSearch", + "CosmosDB", + "ApiKey", + "AppConfig", + "AppInsights", + "CustomKeys" + ], + "x-ms-enum": { + "name": "ConnectionType", + "modelAsString": true, + "values": [ + { + "name": "AzureOpenAI", + "value": "AzureOpenAI", + "description": "Azure OpenAI Service" + }, + { + "name": "AzureBlobStorage", + "value": "AzureBlob", + "description": "Azure Blob Storage, with specified container" + }, + { + "name": "AzureStorageAccount", + "value": "AzureStorageAccount", + "description": "Azure Blob Storage, with container not specified (used by Agents)" + }, + { + "name": "AzureAISearch", + "value": "CognitiveSearch", + "description": "Azure AI Search" + }, + { + "name": "CosmosDB", + "value": "CosmosDB", + "description": "CosmosDB" + }, + { + "name": "APIKey", + "value": "ApiKey", + "description": "Generic connection that uses API Key authentication" + }, + { + "name": "ApplicationConfiguration", + "value": "AppConfig", + "description": "Application Configuration" + }, + { + "name": "ApplicationInsights", + "value": "AppInsights", + "description": "Application Insights" + }, + { + "name": "Custom", + "value": "CustomKeys", + "description": "Custom Keys" + } + ] + } + }, + { + "name": "defaultConnection", + "in": "query", + "description": "List connections that are default connections", + "required": false, + "type": "boolean" + }, + { + "$ref": "#/parameters/Azure.Core.ClientRequestIdHeader" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/PagedConnection" + }, + "headers": { + "x-ms-client-request-id": { + "type": "string", + "format": "uuid", + "description": "An opaque, globally-unique, client-generated string identifier for the request." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Connections_List_MaximumSet": { + "$ref": "./examples/Connections_List_MaximumSet_Gen.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/connections/{name}": { + "get": { + "operationId": "Connections_Get", + "description": "Get a connection by name, without populating connection credentials", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "name", + "in": "path", + "description": "The friendly name of the connection, provided by the user.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/Azure.Core.ClientRequestIdHeader" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/Connection" + }, + "headers": { + "x-ms-client-request-id": { + "type": "string", + "format": "uuid", + "description": "An opaque, globally-unique, client-generated string identifier for the request." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Connections_Get_MaximumSet": { + "$ref": "./examples/Connections_Get_MaximumSet_Gen.json" + } + } + } + }, + "/connections/{name}/getConnectionWithCredentials": { + "post": { + "operationId": "Connections_GetWithCredentials", + "description": "Get a connection by name, with its connection credentials", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "name", + "in": "path", + "description": "The friendly name of the connection, provided by the user.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/Azure.Core.ClientRequestIdHeader" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/Connection" + }, + "headers": { + "x-ms-client-request-id": { + "type": "string", + "format": "uuid", + "description": "An opaque, globally-unique, client-generated string identifier for the request." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Connections_GetWithCredentials_MaximumSet": { + "$ref": "./examples/Connections_GetWithCredentials_MaximumSet_Gen.json" + } + } + } + }, + "/datasets": { + "get": { + "operationId": "Datasets_ListLatest", + "description": "List the latest version of each DatasetVersion", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/PagedDatasetVersion" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Datasets_ListLatest_MaximumSet": { + "$ref": "./examples/Datasets_ListLatest_MaximumSet_Gen.json" + }, + "Datasets_ListLatest_MinimumSet": { + "$ref": "./examples/Datasets_ListLatest_MinimumSet_Gen.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/datasets/{name}/versions": { + "get": { + "operationId": "Datasets_ListVersions", + "description": "List all versions of the given DatasetVersion", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "name", + "in": "path", + "description": "The name of the resource", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/PagedDatasetVersion" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Datasets_ListVersions_MaximumSet": { + "$ref": "./examples/Datasets_ListVersions_MaximumSet_Gen.json" + }, + "Datasets_ListVersions_MinimumSet": { + "$ref": "./examples/Datasets_ListVersions_MinimumSet_Gen.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/datasets/{name}/versions/{version}": { + "get": { + "operationId": "Datasets_GetVersion", + "description": "Get the specific version of the DatasetVersion", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "name", + "in": "path", + "description": "The name of the resource", + "required": true, + "type": "string" + }, + { + "name": "version", + "in": "path", + "description": "The specific version id of the DatasetVersion to retrieve.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/DatasetVersion" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Datasets_GetVersion_MaximumSet": { + "$ref": "./examples/Datasets_GetVersion_MaximumSet_Gen.json" + }, + "Datasets_GetVersion_MinimumSet": { + "$ref": "./examples/Datasets_GetVersion_MinimumSet_Gen.json" + } + } + }, + "patch": { + "operationId": "Datasets_CreateOrUpdateVersion", + "description": "Create a new or update an existing DatasetVersion with the given version id", + "consumes": [ + "application/merge-patch+json" + ], + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "name", + "in": "path", + "description": "The name of the resource", + "required": true, + "type": "string" + }, + { + "name": "version", + "in": "path", + "description": "The specific version id of the DatasetVersion to create or replace.", + "required": true, + "type": "string" + }, + { + "name": "body", + "in": "body", + "description": "The definition of the DatasetVersion to create or update", + "required": true, + "schema": { + "$ref": "#/definitions/DatasetVersion" + } + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/DatasetVersion" + } + }, + "201": { + "description": "The request has succeeded and a new resource has been created as a result.", + "schema": { + "$ref": "#/definitions/DatasetVersion" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Datasets_CreateOrUpdateVersion_MaximumSet": { + "$ref": "./examples/Datasets_CreateOrUpdateVersion_MaximumSet_Gen.json" + }, + "Datasets_CreateOrUpdateVersion_MinimumSet": { + "$ref": "./examples/Datasets_CreateOrUpdateVersion_MinimumSet_Gen.json" + } + } + }, + "delete": { + "operationId": "Datasets_DeleteVersion", + "description": "Delete the specific version of the DatasetVersion", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "name", + "in": "path", + "description": "The name of the resource", + "required": true, + "type": "string" + }, + { + "name": "version", + "in": "path", + "description": "The version of the DatasetVersion to delete.", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "There is no content to send for this request, but the headers may be useful." + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Datasets_DeleteVersion_MaximumSet": { + "$ref": "./examples/Datasets_DeleteVersion_MaximumSet_Gen.json" + }, + "Datasets_DeleteVersion_MinimumSet": { + "$ref": "./examples/Datasets_DeleteVersion_MinimumSet_Gen.json" + } + } + } + }, + "/datasets/{name}/versions/{version}/credentials": { + "post": { + "operationId": "Datasets_GetCredentials", + "description": "Get the SAS credential to access the storage account associated with a Dataset version.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "name", + "in": "path", + "description": "The name of the resource", + "required": true, + "type": "string" + }, + { + "name": "version", + "in": "path", + "description": "The specific version id of the DatasetVersion to operate on.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/AssetCredentialResponse" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Datasets_GetCredentials_MaximumSet": { + "$ref": "./examples/Datasets_GetCredentials_MaximumSet_Gen.json" + }, + "Datasets_GetCredentials_MinimumSet": { + "$ref": "./examples/Datasets_GetCredentials_MinimumSet_Gen.json" + } + } + } + }, + "/datasets/{name}/versions/{version}/startPendingUpload": { + "post": { + "operationId": "Datasets_StartPendingUploadVersion", + "description": "Start a new or get an existing pending upload of a dataset for a specific version.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "name", + "in": "path", + "description": "The name of the resource", + "required": true, + "type": "string" + }, + { + "name": "version", + "in": "path", + "description": "The specific version id of the DatasetVersion to operate on.", + "required": true, + "type": "string" + }, + { + "name": "body", + "in": "body", + "description": "Parameters for the action", + "required": true, + "schema": { + "$ref": "#/definitions/PendingUploadRequest" + } + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/PendingUploadResponse" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Datasets_StartPendingUploadVersion_MaximumSet": { + "$ref": "./examples/Datasets_StartPendingUploadVersion_MaximumSet_Gen.json" + }, + "Datasets_StartPendingUploadVersion_MinimumSet": { + "$ref": "./examples/Datasets_StartPendingUploadVersion_MinimumSet_Gen.json" + } + } + } + }, + "/deployments": { + "get": { + "operationId": "Deployments_List", + "description": "List all deployed models in the project", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "modelPublisher", + "in": "query", + "description": "Model publisher to filter models by", + "required": false, + "type": "string" + }, + { + "name": "modelName", + "in": "query", + "description": "Model name (the publisher specific name) to filter models by", + "required": false, + "type": "string" + }, + { + "name": "deploymentType", + "in": "query", + "description": "Type of deployment to filter list by", + "required": false, + "type": "string", + "enum": [ + "ModelDeployment" + ], + "x-ms-enum": { + "name": "DeploymentType", + "modelAsString": true, + "values": [ + { + "name": "ModelDeployment", + "value": "ModelDeployment", + "description": "Model deployment" + } + ] + } + }, + { + "$ref": "#/parameters/Azure.Core.ClientRequestIdHeader" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/PagedDeployment" + }, + "headers": { + "x-ms-client-request-id": { + "type": "string", + "format": "uuid", + "description": "An opaque, globally-unique, client-generated string identifier for the request." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Deployments_List_MaximumSet": { + "$ref": "./examples/Deployments_List_MaximumSet_Gen.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/deployments/{name}": { + "get": { + "operationId": "Deployments_Get", + "description": "Get a deployed model.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the deployment", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/Azure.Core.ClientRequestIdHeader" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/Deployment" + }, + "headers": { + "x-ms-client-request-id": { + "type": "string", + "format": "uuid", + "description": "An opaque, globally-unique, client-generated string identifier for the request." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Deployments_Get_MaximumSet": { + "$ref": "./examples/Deployments_Get_MaximumSet_Gen.json" + } + } + } + }, + "/indexes": { + "get": { + "operationId": "Indexes_ListLatest", + "description": "List the latest version of each Index", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/PagedIndex" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Indexes_ListLatest_MaximumSet": { + "$ref": "./examples/Indexes_ListLatest_MaximumSet_Gen.json" + }, + "Indexes_ListLatest_MinimumSet": { + "$ref": "./examples/Indexes_ListLatest_MinimumSet_Gen.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/indexes/{name}/versions": { + "get": { + "operationId": "Indexes_ListVersions", + "description": "List all versions of the given Index", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "name", + "in": "path", + "description": "The name of the resource", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/PagedIndex" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Indexes_ListVersions_MaximumSet": { + "$ref": "./examples/Indexes_ListVersions_MaximumSet_Gen.json" + }, + "Indexes_ListVersions_MinimumSet": { + "$ref": "./examples/Indexes_ListVersions_MinimumSet_Gen.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/indexes/{name}/versions/{version}": { + "get": { + "operationId": "Indexes_GetVersion", + "description": "Get the specific version of the Index", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "name", + "in": "path", + "description": "The name of the resource", + "required": true, + "type": "string" + }, + { + "name": "version", + "in": "path", + "description": "The specific version id of the Index to retrieve.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/Index" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Indexes_GetVersion_MaximumSet": { + "$ref": "./examples/Indexes_GetVersion_MaximumSet_Gen.json" + }, + "Indexes_GetVersion_MinimumSet": { + "$ref": "./examples/Indexes_GetVersion_MinimumSet_Gen.json" + } + } + }, + "patch": { + "operationId": "Indexes_CreateOrUpdateVersion", + "description": "Create a new or update an existing Index with the given version id", + "consumes": [ + "application/merge-patch+json" + ], + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "name", + "in": "path", + "description": "The name of the resource", + "required": true, + "type": "string" + }, + { + "name": "version", + "in": "path", + "description": "The specific version id of the Index to create or replace.", + "required": true, + "type": "string" + }, + { + "name": "body", + "in": "body", + "description": "The definition of the Index to create or update", + "required": true, + "schema": { + "$ref": "#/definitions/Index" + } + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/Index" + } + }, + "201": { + "description": "The request has succeeded and a new resource has been created as a result.", + "schema": { + "$ref": "#/definitions/Index" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Indexes_CreateOrUpdateVersion_MaximumSet": { + "$ref": "./examples/Indexes_CreateOrUpdateVersion_MaximumSet_Gen.json" + }, + "Indexes_CreateOrUpdateVersion_MinimumSet": { + "$ref": "./examples/Indexes_CreateOrUpdateVersion_MinimumSet_Gen.json" + } + } + }, + "delete": { + "operationId": "Indexes_DeleteVersion", + "description": "Delete the specific version of the Index", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "name", + "in": "path", + "description": "The name of the resource", + "required": true, + "type": "string" + }, + { + "name": "version", + "in": "path", + "description": "The version of the Index to delete.", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "There is no content to send for this request, but the headers may be useful." + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Indexes_DeleteVersion_MaximumSet": { + "$ref": "./examples/Indexes_DeleteVersion_MaximumSet_Gen.json" + }, + "Indexes_DeleteVersion_MinimumSet": { + "$ref": "./examples/Indexes_DeleteVersion_MinimumSet_Gen.json" + } + } + } + } + }, + "definitions": { + "ApiKeyCredentials": { + "type": "object", + "description": "API Key Credential definition", + "properties": { + "key": { + "type": "string", + "description": "API Key", + "readOnly": true, + "x-ms-client-name": "apiKey" + } + }, + "allOf": [ + { + "$ref": "#/definitions/BaseCredentials" + } + ], + "x-ms-discriminator-value": "ApiKey" + }, + "AssetCredentialResponse": { + "type": "object", + "description": "Represents a reference to a blob for consumption", + "properties": { + "blobReference": { + "$ref": "#/definitions/BlobReference", + "description": "Credential info to access the storage account." + } + }, + "required": [ + "blobReference" + ] + }, + "Azure.Core.Foundations.Error": { + "type": "object", + "description": "The error object.", + "properties": { + "code": { + "type": "string", + "description": "One of a server-defined set of error codes." + }, + "message": { + "type": "string", + "description": "A human-readable representation of the error." + }, + "target": { + "type": "string", + "description": "The target of the error." + }, + "details": { + "type": "array", + "description": "An array of details about specific errors that led to this reported error.", + "items": { + "$ref": "#/definitions/Azure.Core.Foundations.Error" + }, + "x-ms-identifiers": [] + }, + "innererror": { + "$ref": "#/definitions/Azure.Core.Foundations.InnerError", + "description": "An object containing more specific information than the current object about the error." + } + }, + "required": [ + "code", + "message" + ] + }, + "Azure.Core.Foundations.ErrorResponse": { + "type": "object", + "description": "A response containing error details.", + "properties": { + "error": { + "$ref": "#/definitions/Azure.Core.Foundations.Error", + "description": "The error object." + } + }, + "required": [ + "error" + ] + }, + "Azure.Core.Foundations.InnerError": { + "type": "object", + "description": "An object containing more specific information about the error. As per Microsoft One API guidelines - https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors.", + "properties": { + "code": { + "type": "string", + "description": "One of a server-defined set of error codes." + }, + "innererror": { + "$ref": "#/definitions/Azure.Core.Foundations.InnerError", + "description": "Inner error." + } + } + }, + "AzureAISearchIndex": { + "type": "object", + "description": "Azure AI Search Index Definition", + "properties": { + "connectionName": { + "type": "string", + "description": "Name of connection to Azure AI Search", + "x-ms-mutability": [ + "create" + ] + }, + "indexName": { + "type": "string", + "description": "Name of index in Azure AI Search resource to attach", + "x-ms-mutability": [ + "create" + ] + }, + "fieldMapping": { + "$ref": "#/definitions/FieldMapping", + "description": "Field mapping configuration", + "x-ms-mutability": [ + "create" + ] + } + }, + "required": [ + "connectionName", + "indexName" + ], + "allOf": [ + { + "$ref": "#/definitions/Index" + } + ], + "x-ms-discriminator-value": "AzureSearch" + }, + "BaseCredentials": { + "type": "object", + "description": "A base class for connection credentials", + "properties": { + "type": { + "$ref": "#/definitions/CredentialType", + "description": "The type of credential used by the connection", + "readOnly": true + } + }, + "discriminator": "type", + "required": [ + "type" + ] + }, + "BlobReference": { + "type": "object", + "description": "Blob reference details.", + "properties": { + "blobUri": { + "type": "string", + "description": "Blob URI path for client to upload data. Example: https://blob.windows.core.net/Container/Path" + }, + "storageAccountArmId": { + "type": "string", + "description": "ARM ID of the storage account to use." + }, + "credential": { + "$ref": "#/definitions/SasCredential", + "description": "Credential info to access the storage account." + } + }, + "required": [ + "blobUri", + "storageAccountArmId", + "credential" + ] + }, + "Connection": { + "type": "object", + "description": "Response from the list and get connections operations", + "properties": { + "name": { + "type": "string", + "description": "The friendly name of the connection, provided by the user.", + "readOnly": true + }, + "id": { + "type": "string", + "description": "A unique identifier for the connection, generated by the service", + "readOnly": true + }, + "type": { + "$ref": "#/definitions/ConnectionType", + "description": "Category of the connection", + "readOnly": true + }, + "target": { + "type": "string", + "description": "The connection URL to be used for this service", + "readOnly": true + }, + "isDefault": { + "type": "boolean", + "description": "Whether the connection is tagged as the default connection of its type", + "readOnly": true + }, + "credentials": { + "$ref": "#/definitions/BaseCredentials", + "description": "The credentials used by the connection", + "readOnly": true + }, + "metadata": { + "type": "object", + "description": "Metadata of the connection", + "additionalProperties": { + "type": "string" + }, + "readOnly": true + } + }, + "required": [ + "name", + "id", + "type", + "target", + "isDefault", + "credentials", + "metadata" + ] + }, + "ConnectionType": { + "type": "string", + "description": "The Type (or category) of the connection", + "enum": [ + "AzureOpenAI", + "AzureBlob", + "AzureStorageAccount", + "CognitiveSearch", + "CosmosDB", + "ApiKey", + "AppConfig", + "AppInsights", + "CustomKeys" + ], + "x-ms-enum": { + "name": "ConnectionType", + "modelAsString": true, + "values": [ + { + "name": "AzureOpenAI", + "value": "AzureOpenAI", + "description": "Azure OpenAI Service" + }, + { + "name": "AzureBlobStorage", + "value": "AzureBlob", + "description": "Azure Blob Storage, with specified container" + }, + { + "name": "AzureStorageAccount", + "value": "AzureStorageAccount", + "description": "Azure Blob Storage, with container not specified (used by Agents)" + }, + { + "name": "AzureAISearch", + "value": "CognitiveSearch", + "description": "Azure AI Search" + }, + { + "name": "CosmosDB", + "value": "CosmosDB", + "description": "CosmosDB" + }, + { + "name": "APIKey", + "value": "ApiKey", + "description": "Generic connection that uses API Key authentication" + }, + { + "name": "ApplicationConfiguration", + "value": "AppConfig", + "description": "Application Configuration" + }, + { + "name": "ApplicationInsights", + "value": "AppInsights", + "description": "Application Insights" + }, + { + "name": "Custom", + "value": "CustomKeys", + "description": "Custom Keys" + } + ] + } + }, + "CosmosDBIndex": { + "type": "object", + "description": "CosmosDB Vector Store Index Definition", + "properties": { + "connectionName": { + "type": "string", + "description": "Name of connection to CosmosDB", + "x-ms-mutability": [ + "create" + ] + }, + "databaseName": { + "type": "string", + "description": "Name of the CosmosDB Database", + "x-ms-mutability": [ + "create" + ] + }, + "containerName": { + "type": "string", + "description": "Name of CosmosDB Container", + "x-ms-mutability": [ + "create" + ] + }, + "embeddingConfiguration": { + "$ref": "#/definitions/EmbeddingConfiguration", + "description": "Embedding model configuration", + "x-ms-mutability": [ + "create" + ] + }, + "fieldMapping": { + "$ref": "#/definitions/FieldMapping", + "description": "Field mapping configuration", + "x-ms-mutability": [ + "create" + ] + } + }, + "required": [ + "connectionName", + "databaseName", + "containerName", + "embeddingConfiguration", + "fieldMapping" + ], + "allOf": [ + { + "$ref": "#/definitions/Index" + } + ], + "x-ms-discriminator-value": "CosmosDBNoSqlVectorStore" + }, + "CredentialType": { + "type": "string", + "description": "The credential type used by the connection", + "enum": [ + "ApiKey", + "AAD", + "SAS", + "CustomKeys", + "None" + ], + "x-ms-enum": { + "name": "CredentialType", + "modelAsString": true, + "values": [ + { + "name": "apiKey", + "value": "ApiKey", + "description": "API Key credential" + }, + { + "name": "entraId", + "value": "AAD", + "description": "Entra ID credential (formerly known as AAD)" + }, + { + "name": "SAS", + "value": "SAS", + "description": "Shared Access Signature (SAS) credential" + }, + { + "name": "custom", + "value": "CustomKeys", + "description": "Custom credential" + }, + { + "name": "None", + "value": "None", + "description": "No credential" + } + ] + } + }, + "CustomCredential": { + "type": "object", + "description": "Custom credential definition", + "properties": { + "keys": { + "type": "object", + "description": "The credential type", + "additionalProperties": { + "type": "string" + }, + "readOnly": true + } + }, + "required": [ + "keys" + ], + "allOf": [ + { + "$ref": "#/definitions/BaseCredentials" + } + ], + "x-ms-discriminator-value": "CustomKeys" + }, + "DatasetType": { + "type": "string", + "description": "Enum to determine the type of data.", + "enum": [ + "uri_file", + "uri_folder" + ], + "x-ms-enum": { + "name": "DatasetType", + "modelAsString": true, + "values": [ + { + "name": "uri_file", + "value": "uri_file", + "description": "URI file." + }, + { + "name": "uri_folder", + "value": "uri_folder", + "description": "URI folder." + } + ] + } + }, + "DatasetVersion": { + "type": "object", + "description": "DatasetVersion Definition", + "properties": { + "dataUri": { + "type": "string", + "description": "URI of the data. Example: https://go.microsoft.com/fwlink/?linkid=2202330", + "minLength": 1, + "pattern": "[a-zA-Z0-9_]", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "type": { + "$ref": "#/definitions/DatasetType", + "description": "Dataset type" + }, + "isReference": { + "type": "boolean", + "description": "Indicates if the dataset holds a reference to the storage, or the dataset manages storage itself. If true, the underlying data will not be deleted when the dataset version is deleted", + "readOnly": true + }, + "connectionName": { + "type": "string", + "description": "The Azure Storage Account connection name. Required if startPendingUploadVersion was not called before creating the Dataset", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "id": { + "type": "string", + "description": "Asset ID, a unique identifier for the asset", + "readOnly": true + }, + "name": { + "type": "string", + "description": "The name of the resource", + "readOnly": true + }, + "version": { + "type": "string", + "description": "The version of the resource", + "readOnly": true + }, + "description": { + "type": "string", + "description": "The asset description text.", + "x-ms-mutability": [ + "update", + "create" + ] + }, + "tags": { + "type": "object", + "description": "Tag dictionary. Tags can be added, removed, and updated.", + "additionalProperties": { + "type": "string" + }, + "x-ms-mutability": [ + "update", + "create" + ] + } + }, + "discriminator": "type", + "required": [ + "dataUri", + "type", + "name", + "version" + ] + }, + "Deployment": { + "type": "object", + "description": "Model Deployment Definition", + "properties": { + "type": { + "$ref": "#/definitions/DeploymentType", + "description": "The type of the deployment" + }, + "name": { + "type": "string", + "description": "Name of the deployment", + "readOnly": true + } + }, + "discriminator": "type", + "required": [ + "type", + "name" + ] + }, + "DeploymentType": { + "type": "string", + "enum": [ + "ModelDeployment" + ], + "x-ms-enum": { + "name": "DeploymentType", + "modelAsString": true, + "values": [ + { + "name": "ModelDeployment", + "value": "ModelDeployment", + "description": "Model deployment" + } + ] + } + }, + "EmbeddingConfiguration": { + "type": "object", + "description": "Embedding configuration class", + "properties": { + "modelDeploymentName": { + "type": "string", + "description": "Deployment name of embedding model. It can point to a model deployment either in the parent AIServices or a connection.", + "x-ms-mutability": [ + "create" + ] + }, + "embeddingField": { + "type": "string", + "description": "Embedding field", + "x-ms-mutability": [ + "create" + ] + } + }, + "required": [ + "modelDeploymentName", + "embeddingField" + ] + }, + "EntraIDCredentials": { + "type": "object", + "description": "Entra ID credential definition", + "allOf": [ + { + "$ref": "#/definitions/BaseCredentials" + } + ], + "x-ms-discriminator-value": "AAD" + }, + "FieldMapping": { + "type": "object", + "description": "Field mapping configuration class", + "properties": { + "contentFields": { + "type": "array", + "description": "List of fields with text content", + "items": { + "type": "string" + }, + "x-ms-mutability": [ + "create" + ] + }, + "filepathField": { + "type": "string", + "description": "Path of file to be used as a source of text content", + "x-ms-mutability": [ + "create" + ] + }, + "titleField": { + "type": "string", + "description": "Field containing the title of the document", + "x-ms-mutability": [ + "create" + ] + }, + "urlField": { + "type": "string", + "description": "Field containing the url of the document", + "x-ms-mutability": [ + "create" + ] + }, + "vectorFields": { + "type": "array", + "description": "List of fields with vector content", + "items": { + "type": "string" + }, + "x-ms-mutability": [ + "create" + ] + }, + "metadataFields": { + "type": "array", + "description": "List of fields with metadata content", + "items": { + "type": "string" + }, + "x-ms-mutability": [ + "create" + ] + } + }, + "required": [ + "contentFields" + ] + }, + "FileDatasetVersion": { + "type": "object", + "description": "FileDatasetVersion Definition", + "allOf": [ + { + "$ref": "#/definitions/DatasetVersion" + } + ], + "x-ms-discriminator-value": "uri_file" + }, + "FolderDatasetVersion": { + "type": "object", + "description": "FileDatasetVersion Definition", + "allOf": [ + { + "$ref": "#/definitions/DatasetVersion" + } + ], + "x-ms-discriminator-value": "uri_folder" + }, + "Index": { + "type": "object", + "description": "Index resource Definition", + "properties": { + "type": { + "$ref": "#/definitions/IndexType", + "description": "Type of index" + }, + "id": { + "type": "string", + "description": "Asset ID, a unique identifier for the asset", + "readOnly": true + }, + "name": { + "type": "string", + "description": "The name of the resource", + "readOnly": true + }, + "version": { + "type": "string", + "description": "The version of the resource", + "readOnly": true + }, + "description": { + "type": "string", + "description": "The asset description text.", + "x-ms-mutability": [ + "update", + "create" + ] + }, + "tags": { + "type": "object", + "description": "Tag dictionary. Tags can be added, removed, and updated.", + "additionalProperties": { + "type": "string" + }, + "x-ms-mutability": [ + "update", + "create" + ] + } + }, + "discriminator": "type", + "required": [ + "type", + "name", + "version" + ] + }, + "IndexType": { + "type": "string", + "enum": [ + "AzureSearch", + "CosmosDBNoSqlVectorStore", + "ManagedAzureSearch" + ], + "x-ms-enum": { + "name": "IndexType", + "modelAsString": true, + "values": [ + { + "name": "azureSearch", + "value": "AzureSearch", + "description": "Azure search" + }, + { + "name": "cosmosDB", + "value": "CosmosDBNoSqlVectorStore", + "description": "CosmosDB" + }, + { + "name": "managedAzureSearch", + "value": "ManagedAzureSearch", + "description": "Managed Azure Search" + } + ] + } + }, + "ManagedAzureAISearchIndex": { + "type": "object", + "description": "Managed Azure AI Search Index Definition", + "properties": { + "vectorStoreId": { + "type": "string", + "description": "Vector store id of managed index", + "x-ms-mutability": [ + "create" + ] + } + }, + "required": [ + "vectorStoreId" + ], + "allOf": [ + { + "$ref": "#/definitions/Index" + } + ], + "x-ms-discriminator-value": "ManagedAzureSearch" + }, + "ModelDeployment": { + "type": "object", + "description": "Model Deployment Definition", + "properties": { + "modelName": { + "type": "string", + "description": "Publisher-specific name of the deployed model", + "readOnly": true + }, + "modelVersion": { + "type": "string", + "description": "Publisher-specific version of the deployed model", + "readOnly": true + }, + "modelPublisher": { + "type": "string", + "description": "Name of the deployed model's publisher", + "readOnly": true + }, + "capabilities": { + "type": "object", + "description": "Capabilities of deployed model", + "additionalProperties": { + "type": "string" + }, + "readOnly": true + }, + "sku": { + "$ref": "#/definitions/Sku", + "description": "Sku of the model deployment", + "readOnly": true + }, + "connectionName": { + "type": "string", + "description": "Name of the connection the deployment comes from", + "readOnly": true + } + }, + "required": [ + "modelName", + "modelVersion", + "modelPublisher", + "capabilities", + "sku" + ], + "allOf": [ + { + "$ref": "#/definitions/Deployment" + } + ], + "x-ms-discriminator-value": "ModelDeployment" + }, + "NoAuthenticationCredentials": { + "type": "object", + "description": "Credentials that do not require authentication", + "allOf": [ + { + "$ref": "#/definitions/BaseCredentials" + } + ], + "x-ms-discriminator-value": "None" + }, + "PagedConnection": { + "type": "object", + "description": "Paged collection of Connection items", + "properties": { + "value": { + "type": "array", + "description": "The Connection items on this page", + "items": { + "$ref": "#/definitions/Connection" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "PagedDatasetVersion": { + "type": "object", + "description": "Paged collection of DatasetVersion items", + "properties": { + "value": { + "type": "array", + "description": "The DatasetVersion items on this page", + "items": { + "$ref": "#/definitions/DatasetVersion" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "PagedDeployment": { + "type": "object", + "description": "Paged collection of Deployment items", + "properties": { + "value": { + "type": "array", + "description": "The Deployment items on this page", + "items": { + "$ref": "#/definitions/Deployment" + }, + "x-ms-identifiers": [] + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "PagedIndex": { + "type": "object", + "description": "Paged collection of Index items", + "properties": { + "value": { + "type": "array", + "description": "The Index items on this page", + "items": { + "$ref": "#/definitions/Index" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "PendingUploadCredentialType": { + "type": "string", + "description": "The type of credential used to access the storage account.", + "enum": [ + "SAS" + ], + "x-ms-enum": { + "name": "PendingUploadCredentialType", + "modelAsString": true, + "values": [ + { + "name": "sas", + "value": "SAS", + "description": "SAS credential type." + } + ] + } + }, + "PendingUploadRequest": { + "type": "object", + "description": "Represents a request for a pending upload.", + "properties": { + "pendingUploadId": { + "type": "string", + "description": "If PendingUploadId is not provided, a random GUID will be used." + }, + "connectionName": { + "type": "string", + "description": "Azure Storage Account connection name to use for generating temporary SAS token" + }, + "pendingUploadType": { + "type": "string", + "description": "BlobReference is the only supported type.", + "enum": [ + "BlobReference" + ], + "x-ms-enum": { + "modelAsString": false + } + } + }, + "required": [ + "pendingUploadType" + ] + }, + "PendingUploadResponse": { + "type": "object", + "description": "Represents the response for a pending upload request", + "properties": { + "blobReference": { + "$ref": "#/definitions/BlobReference", + "description": "Container-level read, write, list SAS." + }, + "pendingUploadId": { + "type": "string", + "description": "ID for this upload request." + }, + "version": { + "type": "string", + "description": "Version of asset to be created if user did not specify version when initially creating upload" + }, + "pendingUploadType": { + "type": "string", + "description": "BlobReference is the only supported type", + "enum": [ + "BlobReference" + ], + "x-ms-enum": { + "modelAsString": false + } + } + }, + "required": [ + "blobReference", + "pendingUploadId", + "pendingUploadType" + ] + }, + "PendingUploadType": { + "type": "string", + "description": "The type of pending upload.", + "enum": [ + "None", + "BlobReference" + ], + "x-ms-enum": { + "name": "PendingUploadType", + "modelAsString": true, + "values": [ + { + "name": "none", + "value": "None", + "description": "No pending upload." + }, + { + "name": "BlobReference", + "value": "BlobReference", + "description": "Blob Reference is the only supported type." + } + ] + } + }, + "SASCredentials": { + "type": "object", + "description": "Shared Access Signature (SAS) credential definition", + "properties": { + "SAS": { + "type": "string", + "description": "SAS token", + "readOnly": true, + "x-ms-client-name": "sasToken" + } + }, + "allOf": [ + { + "$ref": "#/definitions/BaseCredentials" + } + ], + "x-ms-discriminator-value": "SAS" + }, + "SasCredential": { + "type": "object", + "description": "SAS Credential definition", + "properties": { + "sasUri": { + "type": "string", + "description": "SAS uri", + "readOnly": true + }, + "type": { + "type": "string", + "description": "Type of credential", + "enum": [ + "SAS" + ], + "x-ms-enum": { + "modelAsString": false + }, + "readOnly": true + } + }, + "required": [ + "sasUri", + "type" + ] + }, + "Sku": { + "type": "object", + "description": "Sku information", + "properties": { + "capacity": { + "type": "integer", + "format": "int64", + "description": "Sku capacity" + }, + "family": { + "type": "string", + "description": "Sku family" + }, + "name": { + "type": "string", + "description": "Sku name" + }, + "size": { + "type": "string", + "description": "Sku size" + }, + "tier": { + "type": "string", + "description": "Sku tier" + } + }, + "required": [ + "capacity", + "family", + "name", + "size", + "tier" + ] + } + }, + "parameters": { + "Azure.Core.ClientRequestIdHeader": { + "name": "x-ms-client-request-id", + "in": "header", + "description": "An opaque, globally-unique, client-generated string identifier for the request.", + "required": false, + "type": "string", + "format": "uuid", + "x-ms-parameter-location": "method", + "x-ms-client-name": "clientRequestId" + }, + "Azure.Core.Foundations.ApiVersionParameter": { + "name": "api-version", + "in": "query", + "description": "The API version to use for this operation.", + "required": true, + "type": "string", + "minLength": 1, + "x-ms-parameter-location": "method", + "x-ms-client-name": "apiVersion" + } + } +} diff --git a/specification/ai/data-plane/Azure.AI.Projects/stable/v1/examples/Connections_GetWithCredentials_MaximumSet_Gen.json b/specification/ai/data-plane/Azure.AI.Projects/stable/v1/examples/Connections_GetWithCredentials_MaximumSet_Gen.json new file mode 100644 index 000000000000..fbb3f544c752 --- /dev/null +++ b/specification/ai/data-plane/Azure.AI.Projects/stable/v1/examples/Connections_GetWithCredentials_MaximumSet_Gen.json @@ -0,0 +1,26 @@ +{ + "title": "Connections_GetWithCredentials_MaximumSet", + "operationId": "Connections_GetWithCredentials", + "parameters": { + "api-version": "v1", + "name": "jqgcfdexf", + "x-ms-client-request-id": "cf35b680-dc80-4815-ab83-9364acc3bce6" + }, + "responses": { + "200": { + "body": { + "name": "we", + "id": "unique-id", + "type": "AzureOpenAI", + "target": "bbzo", + "isDefault": true, + "credentials": { + "type": "BaseCredentials" + }, + "metadata": { + "key9765": "voknfqanbxnseqg" + } + } + } + } +} diff --git a/specification/ai/data-plane/Azure.AI.Projects/stable/v1/examples/Connections_Get_MaximumSet_Gen.json b/specification/ai/data-plane/Azure.AI.Projects/stable/v1/examples/Connections_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..1e695083b491 --- /dev/null +++ b/specification/ai/data-plane/Azure.AI.Projects/stable/v1/examples/Connections_Get_MaximumSet_Gen.json @@ -0,0 +1,26 @@ +{ + "title": "Connections_Get_MaximumSet", + "operationId": "Connections_Get", + "parameters": { + "api-version": "v1", + "name": "gvwpqdivyfaiftzdfcjoj", + "x-ms-client-request-id": "cf35b680-dc80-4815-ab83-9364acc3bce6" + }, + "responses": { + "200": { + "body": { + "name": "we", + "id": "unique-id", + "type": "AzureOpenAI", + "target": "bbzo", + "isDefault": true, + "credentials": { + "type": "BaseCredentials" + }, + "metadata": { + "key9765": "voknfqanbxnseqg" + } + } + } + } +} diff --git a/specification/ai/data-plane/Azure.AI.Projects/stable/v1/examples/Connections_List_MaximumSet_Gen.json b/specification/ai/data-plane/Azure.AI.Projects/stable/v1/examples/Connections_List_MaximumSet_Gen.json new file mode 100644 index 000000000000..d4a34496485e --- /dev/null +++ b/specification/ai/data-plane/Azure.AI.Projects/stable/v1/examples/Connections_List_MaximumSet_Gen.json @@ -0,0 +1,35 @@ +{ + "title": "Connections_List_MaximumSet", + "operationId": "Connections_List", + "parameters": { + "api-version": "v1", + "connectionType": "AzureOpenAI", + "defaultConnection": true, + "top": 6, + "skip": 12, + "maxpagesize": 11, + "x-ms-client-request-id": "cf35b680-dc80-4815-ab83-9364acc3bce6" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "we", + "id": "unique-id", + "type": "AzureOpenAI", + "target": "bbzo", + "isDefault": true, + "credentials": { + "type": "BaseCredentials" + }, + "metadata": { + "key9765": "voknfqanbxnseqg" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/ai/data-plane/Azure.AI.Projects/stable/v1/examples/Datasets_CreateOrUpdateVersion_MaximumSet_Gen.json b/specification/ai/data-plane/Azure.AI.Projects/stable/v1/examples/Datasets_CreateOrUpdateVersion_MaximumSet_Gen.json new file mode 100644 index 000000000000..8c9bc28da150 --- /dev/null +++ b/specification/ai/data-plane/Azure.AI.Projects/stable/v1/examples/Datasets_CreateOrUpdateVersion_MaximumSet_Gen.json @@ -0,0 +1,39 @@ +{ + "title": "Datasets_CreateOrUpdateVersion_MaximumSet", + "operationId": "Datasets_CreateOrUpdateVersion", + "parameters": { + "api-version": "v1", + "name": "nsvugzcnsvqodrxiojanhtdymgglnx", + "version": "utbfmfka", + "body": { + "dataUri": "Replace this value with a string matching RegExp [a-zA-Z0-9_]", + "type": "DatasetVersion", + "description": "grthjigklkewz", + "tags": { + "key868": "yjmiiufnnccqfiljtndr" + } + } + }, + "responses": { + "200": { + "body": { + "dataUri": "Replace this value with a string matching RegExp [a-zA-Z0-9_]", + "type": "DatasetVersion", + "isReference": true, + "id": "cfgncrzpcpqbpxefd", + "name": "zoskzytcqmndtyqwugy", + "version": "joegai" + } + }, + "201": { + "body": { + "dataUri": "Replace this value with a string matching RegExp [a-zA-Z0-9_]", + "type": "DatasetVersion", + "isReference": true, + "id": "cfgncrzpcpqbpxefd", + "name": "zoskzytcqmndtyqwugy", + "version": "joegai" + } + } + } +} diff --git a/specification/ai/data-plane/Azure.AI.Projects/stable/v1/examples/Datasets_CreateOrUpdateVersion_MinimumSet_Gen.json b/specification/ai/data-plane/Azure.AI.Projects/stable/v1/examples/Datasets_CreateOrUpdateVersion_MinimumSet_Gen.json new file mode 100644 index 000000000000..907ad46f02a2 --- /dev/null +++ b/specification/ai/data-plane/Azure.AI.Projects/stable/v1/examples/Datasets_CreateOrUpdateVersion_MinimumSet_Gen.json @@ -0,0 +1,31 @@ +{ + "title": "Datasets_CreateOrUpdateVersion_MinimumSet", + "operationId": "Datasets_CreateOrUpdateVersion", + "parameters": { + "api-version": "v1", + "name": "pluvp", + "version": "playwidjgezovivciosnkerrdwe", + "body": { + "dataUri": "Replace this value with a string matching RegExp [a-zA-Z0-9_]", + "type": "DatasetVersion" + } + }, + "responses": { + "200": { + "body": { + "dataUri": "Replace this value with a string matching RegExp [a-zA-Z0-9_]", + "type": "DatasetVersion", + "name": "zoskzytcqmndtyqwugy", + "version": "joegai" + } + }, + "201": { + "body": { + "dataUri": "Replace this value with a string matching RegExp [a-zA-Z0-9_]", + "type": "DatasetVersion", + "name": "zoskzytcqmndtyqwugy", + "version": "joegai" + } + } + } +} diff --git a/specification/ai/data-plane/Azure.AI.Projects/stable/v1/examples/Datasets_DeleteVersion_MaximumSet_Gen.json b/specification/ai/data-plane/Azure.AI.Projects/stable/v1/examples/Datasets_DeleteVersion_MaximumSet_Gen.json new file mode 100644 index 000000000000..6d32c7b8bd30 --- /dev/null +++ b/specification/ai/data-plane/Azure.AI.Projects/stable/v1/examples/Datasets_DeleteVersion_MaximumSet_Gen.json @@ -0,0 +1,12 @@ +{ + "title": "Datasets_DeleteVersion_MaximumSet", + "operationId": "Datasets_DeleteVersion", + "parameters": { + "api-version": "v1", + "name": "dfmimccx", + "version": "mukc" + }, + "responses": { + "204": {} + } +} diff --git a/specification/ai/data-plane/Azure.AI.Projects/stable/v1/examples/Datasets_DeleteVersion_MinimumSet_Gen.json b/specification/ai/data-plane/Azure.AI.Projects/stable/v1/examples/Datasets_DeleteVersion_MinimumSet_Gen.json new file mode 100644 index 000000000000..7c629dd22c35 --- /dev/null +++ b/specification/ai/data-plane/Azure.AI.Projects/stable/v1/examples/Datasets_DeleteVersion_MinimumSet_Gen.json @@ -0,0 +1,12 @@ +{ + "title": "Datasets_DeleteVersion_MinimumSet", + "operationId": "Datasets_DeleteVersion", + "parameters": { + "api-version": "v1", + "name": "nkaivxoayhkrxavagybliogwwgvbk", + "version": "pmavzwbusicqau" + }, + "responses": { + "204": {} + } +} diff --git a/specification/ai/data-plane/Azure.AI.Projects/stable/v1/examples/Datasets_GetCredentials_MaximumSet_Gen.json b/specification/ai/data-plane/Azure.AI.Projects/stable/v1/examples/Datasets_GetCredentials_MaximumSet_Gen.json new file mode 100644 index 000000000000..3a94a266ebd4 --- /dev/null +++ b/specification/ai/data-plane/Azure.AI.Projects/stable/v1/examples/Datasets_GetCredentials_MaximumSet_Gen.json @@ -0,0 +1,24 @@ +{ + "title": "Datasets_GetCredentials_MaximumSet", + "operationId": "Datasets_GetCredentials", + "parameters": { + "api-version": "v1", + "name": "hpvjnkljsuospxwrypot", + "version": "rlf", + "body": {} + }, + "responses": { + "200": { + "body": { + "blobReference": { + "blobUri": "kbodccbnhdznekrtu", + "storageAccountArmId": "gcsdeid", + "credential": { + "sasUri": "mzmtfelripgmz", + "type": "SAS" + } + } + } + } + } +} diff --git a/specification/ai/data-plane/Azure.AI.Projects/stable/v1/examples/Datasets_GetCredentials_MinimumSet_Gen.json b/specification/ai/data-plane/Azure.AI.Projects/stable/v1/examples/Datasets_GetCredentials_MinimumSet_Gen.json new file mode 100644 index 000000000000..acaebdaeb748 --- /dev/null +++ b/specification/ai/data-plane/Azure.AI.Projects/stable/v1/examples/Datasets_GetCredentials_MinimumSet_Gen.json @@ -0,0 +1,24 @@ +{ + "title": "Datasets_GetCredentials_MinimumSet", + "operationId": "Datasets_GetCredentials", + "parameters": { + "api-version": "v1", + "name": "udrhdaxbjptksqqwztnfswzku", + "version": "ytogupzn", + "body": {} + }, + "responses": { + "200": { + "body": { + "blobReference": { + "blobUri": "kbodccbnhdznekrtu", + "storageAccountArmId": "gcsdeid", + "credential": { + "sasUri": "mzmtfelripgmz", + "type": "SAS" + } + } + } + } + } +} diff --git a/specification/ai/data-plane/Azure.AI.Projects/stable/v1/examples/Datasets_GetVersion_MaximumSet_Gen.json b/specification/ai/data-plane/Azure.AI.Projects/stable/v1/examples/Datasets_GetVersion_MaximumSet_Gen.json new file mode 100644 index 000000000000..5e8855d2e79b --- /dev/null +++ b/specification/ai/data-plane/Azure.AI.Projects/stable/v1/examples/Datasets_GetVersion_MaximumSet_Gen.json @@ -0,0 +1,21 @@ +{ + "title": "Datasets_GetVersion_MaximumSet", + "operationId": "Datasets_GetVersion", + "parameters": { + "api-version": "v1", + "name": "ppdba", + "version": "ttetev" + }, + "responses": { + "200": { + "body": { + "dataUri": "Replace this value with a string matching RegExp [a-zA-Z0-9_]", + "type": "DatasetVersion", + "isReference": true, + "id": "cfgncrzpcpqbpxefd", + "name": "zoskzytcqmndtyqwugy", + "version": "joegai" + } + } + } +} diff --git a/specification/ai/data-plane/Azure.AI.Projects/stable/v1/examples/Datasets_GetVersion_MinimumSet_Gen.json b/specification/ai/data-plane/Azure.AI.Projects/stable/v1/examples/Datasets_GetVersion_MinimumSet_Gen.json new file mode 100644 index 000000000000..f3295b63731b --- /dev/null +++ b/specification/ai/data-plane/Azure.AI.Projects/stable/v1/examples/Datasets_GetVersion_MinimumSet_Gen.json @@ -0,0 +1,19 @@ +{ + "title": "Datasets_GetVersion_MinimumSet", + "operationId": "Datasets_GetVersion", + "parameters": { + "api-version": "v1", + "name": "ivkedy", + "version": "vxufccznqvuctabcyagbczidvr" + }, + "responses": { + "200": { + "body": { + "dataUri": "Replace this value with a string matching RegExp [a-zA-Z0-9_]", + "type": "DatasetVersion", + "name": "zoskzytcqmndtyqwugy", + "version": "joegai" + } + } + } +} diff --git a/specification/ai/data-plane/Azure.AI.Projects/stable/v1/examples/Datasets_ListLatest_MaximumSet_Gen.json b/specification/ai/data-plane/Azure.AI.Projects/stable/v1/examples/Datasets_ListLatest_MaximumSet_Gen.json new file mode 100644 index 000000000000..9f3ef0ba4438 --- /dev/null +++ b/specification/ai/data-plane/Azure.AI.Projects/stable/v1/examples/Datasets_ListLatest_MaximumSet_Gen.json @@ -0,0 +1,28 @@ +{ + "title": "Datasets_ListLatest_MaximumSet", + "operationId": "Datasets_ListLatest", + "parameters": { + "api-version": "v1", + "top": 16, + "skip": "wbilbzmgugbikcwaguhtq", + "tags": "azsufezp", + "listViewType": "ActiveOnly" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "dataUri": "Replace this value with a string matching RegExp [a-zA-Z0-9_]", + "type": "DatasetVersion", + "isReference": true, + "id": "cfgncrzpcpqbpxefd", + "name": "zoskzytcqmndtyqwugy", + "version": "joegai" + } + ], + "nextLink": "https://microsoft.com/al" + } + } + } +} diff --git a/specification/ai/data-plane/Azure.AI.Projects/stable/v1/examples/Datasets_ListLatest_MinimumSet_Gen.json b/specification/ai/data-plane/Azure.AI.Projects/stable/v1/examples/Datasets_ListLatest_MinimumSet_Gen.json new file mode 100644 index 000000000000..31fc6a22a0fb --- /dev/null +++ b/specification/ai/data-plane/Azure.AI.Projects/stable/v1/examples/Datasets_ListLatest_MinimumSet_Gen.json @@ -0,0 +1,21 @@ +{ + "title": "Datasets_ListLatest_MinimumSet", + "operationId": "Datasets_ListLatest", + "parameters": { + "api-version": "v1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "dataUri": "Replace this value with a string matching RegExp [a-zA-Z0-9_]", + "type": "DatasetVersion", + "name": "zoskzytcqmndtyqwugy", + "version": "joegai" + } + ] + } + } + } +} diff --git a/specification/ai/data-plane/Azure.AI.Projects/stable/v1/examples/Datasets_ListVersions_MaximumSet_Gen.json b/specification/ai/data-plane/Azure.AI.Projects/stable/v1/examples/Datasets_ListVersions_MaximumSet_Gen.json new file mode 100644 index 000000000000..eea8f66948db --- /dev/null +++ b/specification/ai/data-plane/Azure.AI.Projects/stable/v1/examples/Datasets_ListVersions_MaximumSet_Gen.json @@ -0,0 +1,29 @@ +{ + "title": "Datasets_ListVersions_MaximumSet", + "operationId": "Datasets_ListVersions", + "parameters": { + "api-version": "v1", + "name": "ojjzgfffyyyr", + "top": 4, + "skip": "bafjlmqcftwnjlofuwnxoc", + "tags": "taynswmfxqo", + "listViewType": "ActiveOnly" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "dataUri": "Replace this value with a string matching RegExp [a-zA-Z0-9_]", + "type": "DatasetVersion", + "isReference": true, + "id": "cfgncrzpcpqbpxefd", + "name": "zoskzytcqmndtyqwugy", + "version": "joegai" + } + ], + "nextLink": "https://microsoft.com/al" + } + } + } +} diff --git a/specification/ai/data-plane/Azure.AI.Projects/stable/v1/examples/Datasets_ListVersions_MinimumSet_Gen.json b/specification/ai/data-plane/Azure.AI.Projects/stable/v1/examples/Datasets_ListVersions_MinimumSet_Gen.json new file mode 100644 index 000000000000..eb947adf9e1c --- /dev/null +++ b/specification/ai/data-plane/Azure.AI.Projects/stable/v1/examples/Datasets_ListVersions_MinimumSet_Gen.json @@ -0,0 +1,22 @@ +{ + "title": "Datasets_ListVersions_MinimumSet", + "operationId": "Datasets_ListVersions", + "parameters": { + "api-version": "v1", + "name": "fauawvl" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "dataUri": "Replace this value with a string matching RegExp [a-zA-Z0-9_]", + "type": "DatasetVersion", + "name": "zoskzytcqmndtyqwugy", + "version": "joegai" + } + ] + } + } + } +} diff --git a/specification/ai/data-plane/Azure.AI.Projects/stable/v1/examples/Datasets_StartPendingUploadVersion_MaximumSet_Gen.json b/specification/ai/data-plane/Azure.AI.Projects/stable/v1/examples/Datasets_StartPendingUploadVersion_MaximumSet_Gen.json new file mode 100644 index 000000000000..dec49019bfd6 --- /dev/null +++ b/specification/ai/data-plane/Azure.AI.Projects/stable/v1/examples/Datasets_StartPendingUploadVersion_MaximumSet_Gen.json @@ -0,0 +1,31 @@ +{ + "title": "Datasets_StartPendingUploadVersion_MaximumSet", + "operationId": "Datasets_StartPendingUploadVersion", + "parameters": { + "api-version": "v1", + "name": "cncrcmiaksswirlujwcptxeaef", + "version": "jkqqzmj", + "body": { + "pendingUploadId": "gxuutkdhlygsmsbtszqzx", + "connectionName": "hsgskbhwucytwglwlm", + "pendingUploadType": "BlobReference" + } + }, + "responses": { + "200": { + "body": { + "blobReference": { + "blobUri": "kbodccbnhdznekrtu", + "storageAccountArmId": "gcsdeid", + "credential": { + "sasUri": "mzmtfelripgmz", + "type": "SAS" + } + }, + "pendingUploadId": "qdxymiww", + "version": "bofnujdjvnnhjtzzu", + "pendingUploadType": "BlobReference" + } + } + } +} diff --git a/specification/ai/data-plane/Azure.AI.Projects/stable/v1/examples/Datasets_StartPendingUploadVersion_MinimumSet_Gen.json b/specification/ai/data-plane/Azure.AI.Projects/stable/v1/examples/Datasets_StartPendingUploadVersion_MinimumSet_Gen.json new file mode 100644 index 000000000000..8df70d95ceab --- /dev/null +++ b/specification/ai/data-plane/Azure.AI.Projects/stable/v1/examples/Datasets_StartPendingUploadVersion_MinimumSet_Gen.json @@ -0,0 +1,28 @@ +{ + "title": "Datasets_StartPendingUploadVersion_MinimumSet", + "operationId": "Datasets_StartPendingUploadVersion", + "parameters": { + "api-version": "v1", + "name": "atopkjwxsjtforndczju", + "version": "yftpnjxwjylhixypopcytxd", + "body": { + "pendingUploadType": "BlobReference" + } + }, + "responses": { + "200": { + "body": { + "blobReference": { + "blobUri": "kbodccbnhdznekrtu", + "storageAccountArmId": "gcsdeid", + "credential": { + "sasUri": "mzmtfelripgmz", + "type": "SAS" + } + }, + "pendingUploadId": "qdxymiww", + "pendingUploadType": "BlobReference" + } + } + } +} diff --git a/specification/ai/data-plane/Azure.AI.Projects/stable/v1/examples/Deployments_Get_MaximumSet_Gen.json b/specification/ai/data-plane/Azure.AI.Projects/stable/v1/examples/Deployments_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..8023d41a5e89 --- /dev/null +++ b/specification/ai/data-plane/Azure.AI.Projects/stable/v1/examples/Deployments_Get_MaximumSet_Gen.json @@ -0,0 +1,17 @@ +{ + "title": "Deployments_Get_MaximumSet", + "operationId": "Deployments_Get", + "parameters": { + "api-version": "v1", + "name": "ft", + "x-ms-client-request-id": "cf35b680-dc80-4815-ab83-9364acc3bce6" + }, + "responses": { + "200": { + "body": { + "type": "Deployment", + "name": "yfnhkglimmtfavwsetvoopcuyewygg" + } + } + } +} diff --git a/specification/ai/data-plane/Azure.AI.Projects/stable/v1/examples/Deployments_List_MaximumSet_Gen.json b/specification/ai/data-plane/Azure.AI.Projects/stable/v1/examples/Deployments_List_MaximumSet_Gen.json new file mode 100644 index 000000000000..5e6110856a4b --- /dev/null +++ b/specification/ai/data-plane/Azure.AI.Projects/stable/v1/examples/Deployments_List_MaximumSet_Gen.json @@ -0,0 +1,26 @@ +{ + "title": "Deployments_List_MaximumSet", + "operationId": "Deployments_List", + "parameters": { + "api-version": "v1", + "modelPublisher": "tb", + "modelName": "xdlvjxymsmdnebesolv", + "top": 6, + "skip": 12, + "maxpagesize": 11, + "x-ms-client-request-id": "cf35b680-dc80-4815-ab83-9364acc3bce6" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "type": "Deployment", + "name": "yfnhkglimmtfavwsetvoopcuyewygg" + } + ], + "nextLink": "https://microsoft.com/aoecpoh" + } + } + } +} diff --git a/specification/ai/data-plane/Azure.AI.Projects/stable/v1/examples/Indexes_CreateOrUpdateVersion_MaximumSet_Gen.json b/specification/ai/data-plane/Azure.AI.Projects/stable/v1/examples/Indexes_CreateOrUpdateVersion_MaximumSet_Gen.json new file mode 100644 index 000000000000..b43bd4b291f1 --- /dev/null +++ b/specification/ai/data-plane/Azure.AI.Projects/stable/v1/examples/Indexes_CreateOrUpdateVersion_MaximumSet_Gen.json @@ -0,0 +1,34 @@ +{ + "title": "Indexes_CreateOrUpdateVersion_MaximumSet", + "operationId": "Indexes_CreateOrUpdateVersion", + "parameters": { + "api-version": "v1", + "name": "kptgsnpfjcunvvdgzfjdmnurq", + "version": "hxutytnzwioiijfinpdojrnrqhqb", + "body": { + "type": "Index", + "description": "wtjqhnlwihffw", + "tags": { + "key1654": "aqtywrvy" + } + } + }, + "responses": { + "200": { + "body": { + "type": "Index", + "id": "xtjevbrwrwuwkbujuwpq", + "name": "wwikvkcdcobt", + "version": "swnonkxmjl" + } + }, + "201": { + "body": { + "type": "Index", + "id": "xtjevbrwrwuwkbujuwpq", + "name": "wwikvkcdcobt", + "version": "swnonkxmjl" + } + } + } +} diff --git a/specification/ai/data-plane/Azure.AI.Projects/stable/v1/examples/Indexes_CreateOrUpdateVersion_MinimumSet_Gen.json b/specification/ai/data-plane/Azure.AI.Projects/stable/v1/examples/Indexes_CreateOrUpdateVersion_MinimumSet_Gen.json new file mode 100644 index 000000000000..bf495cf8c9d5 --- /dev/null +++ b/specification/ai/data-plane/Azure.AI.Projects/stable/v1/examples/Indexes_CreateOrUpdateVersion_MinimumSet_Gen.json @@ -0,0 +1,28 @@ +{ + "title": "Indexes_CreateOrUpdateVersion_MinimumSet", + "operationId": "Indexes_CreateOrUpdateVersion", + "parameters": { + "api-version": "v1", + "name": "dpfjghwaowffzhoyuwrnmws", + "version": "priaizsqiwxrwnhhyk", + "body": { + "type": "Index" + } + }, + "responses": { + "200": { + "body": { + "type": "Index", + "name": "wwikvkcdcobt", + "version": "swnonkxmjl" + } + }, + "201": { + "body": { + "type": "Index", + "name": "wwikvkcdcobt", + "version": "swnonkxmjl" + } + } + } +} diff --git a/specification/ai/data-plane/Azure.AI.Projects/stable/v1/examples/Indexes_DeleteVersion_MaximumSet_Gen.json b/specification/ai/data-plane/Azure.AI.Projects/stable/v1/examples/Indexes_DeleteVersion_MaximumSet_Gen.json new file mode 100644 index 000000000000..abca9b51ee02 --- /dev/null +++ b/specification/ai/data-plane/Azure.AI.Projects/stable/v1/examples/Indexes_DeleteVersion_MaximumSet_Gen.json @@ -0,0 +1,12 @@ +{ + "title": "Indexes_DeleteVersion_MaximumSet", + "operationId": "Indexes_DeleteVersion", + "parameters": { + "api-version": "v1", + "name": "fb", + "version": "ajbuwvsxobvnynpcliqcylqdp" + }, + "responses": { + "204": {} + } +} diff --git a/specification/ai/data-plane/Azure.AI.Projects/stable/v1/examples/Indexes_DeleteVersion_MinimumSet_Gen.json b/specification/ai/data-plane/Azure.AI.Projects/stable/v1/examples/Indexes_DeleteVersion_MinimumSet_Gen.json new file mode 100644 index 000000000000..b8742995962a --- /dev/null +++ b/specification/ai/data-plane/Azure.AI.Projects/stable/v1/examples/Indexes_DeleteVersion_MinimumSet_Gen.json @@ -0,0 +1,12 @@ +{ + "title": "Indexes_DeleteVersion_MinimumSet", + "operationId": "Indexes_DeleteVersion", + "parameters": { + "api-version": "v1", + "name": "zoxequ", + "version": "akulwzwrfeqxh" + }, + "responses": { + "204": {} + } +} diff --git a/specification/ai/data-plane/Azure.AI.Projects/stable/v1/examples/Indexes_GetVersion_MaximumSet_Gen.json b/specification/ai/data-plane/Azure.AI.Projects/stable/v1/examples/Indexes_GetVersion_MaximumSet_Gen.json new file mode 100644 index 000000000000..22119a544952 --- /dev/null +++ b/specification/ai/data-plane/Azure.AI.Projects/stable/v1/examples/Indexes_GetVersion_MaximumSet_Gen.json @@ -0,0 +1,19 @@ +{ + "title": "Indexes_GetVersion_MaximumSet", + "operationId": "Indexes_GetVersion", + "parameters": { + "api-version": "v1", + "name": "ascwgkgwpqxeinbp", + "version": "bqhzitucneeoxurvf" + }, + "responses": { + "200": { + "body": { + "type": "Index", + "id": "xtjevbrwrwuwkbujuwpq", + "name": "wwikvkcdcobt", + "version": "swnonkxmjl" + } + } + } +} diff --git a/specification/ai/data-plane/Azure.AI.Projects/stable/v1/examples/Indexes_GetVersion_MinimumSet_Gen.json b/specification/ai/data-plane/Azure.AI.Projects/stable/v1/examples/Indexes_GetVersion_MinimumSet_Gen.json new file mode 100644 index 000000000000..f3918ab409a3 --- /dev/null +++ b/specification/ai/data-plane/Azure.AI.Projects/stable/v1/examples/Indexes_GetVersion_MinimumSet_Gen.json @@ -0,0 +1,18 @@ +{ + "title": "Indexes_GetVersion_MinimumSet", + "operationId": "Indexes_GetVersion", + "parameters": { + "api-version": "v1", + "name": "sflsamumttlwccuxveocgozlkmdme", + "version": "txg" + }, + "responses": { + "200": { + "body": { + "type": "Index", + "name": "wwikvkcdcobt", + "version": "swnonkxmjl" + } + } + } +} diff --git a/specification/ai/data-plane/Azure.AI.Projects/stable/v1/examples/Indexes_ListLatest_MaximumSet_Gen.json b/specification/ai/data-plane/Azure.AI.Projects/stable/v1/examples/Indexes_ListLatest_MaximumSet_Gen.json new file mode 100644 index 000000000000..5a34d862b95c --- /dev/null +++ b/specification/ai/data-plane/Azure.AI.Projects/stable/v1/examples/Indexes_ListLatest_MaximumSet_Gen.json @@ -0,0 +1,26 @@ +{ + "title": "Indexes_ListLatest_MaximumSet", + "operationId": "Indexes_ListLatest", + "parameters": { + "api-version": "v1", + "top": 16, + "skip": "cbeuhxuzaucwgqj", + "tags": "ecxlvszgcepwunik", + "listViewType": "ActiveOnly" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "type": "Index", + "id": "xtjevbrwrwuwkbujuwpq", + "name": "wwikvkcdcobt", + "version": "swnonkxmjl" + } + ], + "nextLink": "https://microsoft.com/av" + } + } + } +} diff --git a/specification/ai/data-plane/Azure.AI.Projects/stable/v1/examples/Indexes_ListLatest_MinimumSet_Gen.json b/specification/ai/data-plane/Azure.AI.Projects/stable/v1/examples/Indexes_ListLatest_MinimumSet_Gen.json new file mode 100644 index 000000000000..9ee9e1422b9c --- /dev/null +++ b/specification/ai/data-plane/Azure.AI.Projects/stable/v1/examples/Indexes_ListLatest_MinimumSet_Gen.json @@ -0,0 +1,20 @@ +{ + "title": "Indexes_ListLatest_MinimumSet", + "operationId": "Indexes_ListLatest", + "parameters": { + "api-version": "v1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "type": "Index", + "name": "wwikvkcdcobt", + "version": "swnonkxmjl" + } + ] + } + } + } +} diff --git a/specification/ai/data-plane/Azure.AI.Projects/stable/v1/examples/Indexes_ListVersions_MaximumSet_Gen.json b/specification/ai/data-plane/Azure.AI.Projects/stable/v1/examples/Indexes_ListVersions_MaximumSet_Gen.json new file mode 100644 index 000000000000..63e20b44b11a --- /dev/null +++ b/specification/ai/data-plane/Azure.AI.Projects/stable/v1/examples/Indexes_ListVersions_MaximumSet_Gen.json @@ -0,0 +1,27 @@ +{ + "title": "Indexes_ListVersions_MaximumSet", + "operationId": "Indexes_ListVersions", + "parameters": { + "api-version": "v1", + "name": "ugobcytrjfdfu", + "top": 12, + "skip": "vspvqu", + "tags": "fwbwsyszezlzabrudeswnvoqoq", + "listViewType": "ActiveOnly" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "type": "Index", + "id": "xtjevbrwrwuwkbujuwpq", + "name": "wwikvkcdcobt", + "version": "swnonkxmjl" + } + ], + "nextLink": "https://microsoft.com/av" + } + } + } +} diff --git a/specification/ai/data-plane/Azure.AI.Projects/stable/v1/examples/Indexes_ListVersions_MinimumSet_Gen.json b/specification/ai/data-plane/Azure.AI.Projects/stable/v1/examples/Indexes_ListVersions_MinimumSet_Gen.json new file mode 100644 index 000000000000..ba599e422489 --- /dev/null +++ b/specification/ai/data-plane/Azure.AI.Projects/stable/v1/examples/Indexes_ListVersions_MinimumSet_Gen.json @@ -0,0 +1,21 @@ +{ + "title": "Indexes_ListVersions_MinimumSet", + "operationId": "Indexes_ListVersions", + "parameters": { + "api-version": "v1", + "name": "lenbliqxnfqi" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "type": "Index", + "name": "wwikvkcdcobt", + "version": "swnonkxmjl" + } + ] + } + } + } +}