Query Parameters
+ *Name | Type | Required | Description |
---|---|---|---|
connectionType | String | No | List connections of this specific type. Allowed values: + * "AzureOpenAI", "AzureBlob", "AzureStorageAccount", "CognitiveSearch", "CosmosDB", "ApiKey", "AppConfig", + * "AppInsights", "CustomKeys". |
defaultConnection | Boolean | No | List connections that are default + * connections |
Response Body Schema
+ * + *+ * {@code + * { + * name: String (Required) + * id: String (Required) + * type: String(AzureOpenAI/AzureBlob/AzureStorageAccount/CognitiveSearch/CosmosDB/ApiKey/AppConfig/AppInsights/CustomKeys) (Required) + * target: String (Required) + * isDefault: boolean (Required) + * credentials (Required): { + * type: String(ApiKey/AAD/SAS/CustomKeys/None) (Required) + * } + * metadata (Required): { + * String: String (Required) + * } + * } + * } + *+ * + * @param requestOptions The options to configure the HTTP request before HTTP client sends it. + * @throws HttpResponseException thrown if the request is rejected by server. + * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401. + * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404. + * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409. + * @return paged collection of Connection items as paginated response with {@link PagedFlux}. + */ + @Generated + @ServiceMethod(returns = ReturnType.COLLECTION) + public PagedFlux
Response Body Schema
+ * + *+ * {@code + * { + * name: String (Required) + * id: String (Required) + * type: String(AzureOpenAI/AzureBlob/AzureStorageAccount/CognitiveSearch/CosmosDB/ApiKey/AppConfig/AppInsights/CustomKeys) (Required) + * target: String (Required) + * isDefault: boolean (Required) + * credentials (Required): { + * type: String(ApiKey/AAD/SAS/CustomKeys/None) (Required) + * } + * metadata (Required): { + * String: String (Required) + * } + * } + * } + *+ * + * @param name The friendly name of the connection, provided by the user. + * @param requestOptions The options to configure the HTTP request before HTTP client sends it. + * @throws HttpResponseException thrown if the request is rejected by server. + * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401. + * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404. + * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409. + * @return a connection by name, without populating connection credentials along with {@link Response} on successful + * completion of {@link Mono}. + */ + @Generated + @ServiceMethod(returns = ReturnType.SINGLE) + Mono
Response Body Schema
+ * + *+ * {@code + * { + * name: String (Required) + * id: String (Required) + * type: String(AzureOpenAI/AzureBlob/AzureStorageAccount/CognitiveSearch/CosmosDB/ApiKey/AppConfig/AppInsights/CustomKeys) (Required) + * target: String (Required) + * isDefault: boolean (Required) + * credentials (Required): { + * type: String(ApiKey/AAD/SAS/CustomKeys/None) (Required) + * } + * metadata (Required): { + * String: String (Required) + * } + * } + * } + *+ * + * @param name The friendly name of the connection, provided by the user. + * @param requestOptions The options to configure the HTTP request before HTTP client sends it. + * @throws HttpResponseException thrown if the request is rejected by server. + * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401. + * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404. + * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409. + * @return a connection by name, with its connection credentials along with {@link Response} on successful + * completion of {@link Mono}. + */ + @Generated + @ServiceMethod(returns = ReturnType.SINGLE) + Mono
Query Parameters
+ *Name | Type | Required | Description |
---|---|---|---|
connectionType | String | No | List connections of this specific type. Allowed values: + * "AzureOpenAI", "AzureBlob", "AzureStorageAccount", "CognitiveSearch", "CosmosDB", "ApiKey", "AppConfig", + * "AppInsights", "CustomKeys". |
defaultConnection | Boolean | No | List connections that are default + * connections |
Response Body Schema
+ * + *+ * {@code + * { + * name: String (Required) + * id: String (Required) + * type: String(AzureOpenAI/AzureBlob/AzureStorageAccount/CognitiveSearch/CosmosDB/ApiKey/AppConfig/AppInsights/CustomKeys) (Required) + * target: String (Required) + * isDefault: boolean (Required) + * credentials (Required): { + * type: String(ApiKey/AAD/SAS/CustomKeys/None) (Required) + * } + * metadata (Required): { + * String: String (Required) + * } + * } + * } + *+ * + * @param requestOptions The options to configure the HTTP request before HTTP client sends it. + * @throws HttpResponseException thrown if the request is rejected by server. + * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401. + * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404. + * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409. + * @return paged collection of Connection items as paginated response with {@link PagedIterable}. + */ + @Generated + @ServiceMethod(returns = ReturnType.COLLECTION) + public PagedIterable
Response Body Schema
+ * + *+ * {@code + * { + * name: String (Required) + * id: String (Required) + * type: String(AzureOpenAI/AzureBlob/AzureStorageAccount/CognitiveSearch/CosmosDB/ApiKey/AppConfig/AppInsights/CustomKeys) (Required) + * target: String (Required) + * isDefault: boolean (Required) + * credentials (Required): { + * type: String(ApiKey/AAD/SAS/CustomKeys/None) (Required) + * } + * metadata (Required): { + * String: String (Required) + * } + * } + * } + *+ * + * @param name The friendly name of the connection, provided by the user. + * @param requestOptions The options to configure the HTTP request before HTTP client sends it. + * @throws HttpResponseException thrown if the request is rejected by server. + * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401. + * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404. + * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409. + * @return a connection by name, without populating connection credentials along with {@link Response}. + */ + @Generated + @ServiceMethod(returns = ReturnType.SINGLE) + Response
Response Body Schema
+ * + *+ * {@code + * { + * name: String (Required) + * id: String (Required) + * type: String(AzureOpenAI/AzureBlob/AzureStorageAccount/CognitiveSearch/CosmosDB/ApiKey/AppConfig/AppInsights/CustomKeys) (Required) + * target: String (Required) + * isDefault: boolean (Required) + * credentials (Required): { + * type: String(ApiKey/AAD/SAS/CustomKeys/None) (Required) + * } + * metadata (Required): { + * String: String (Required) + * } + * } + * } + *+ * + * @param name The friendly name of the connection, provided by the user. + * @param requestOptions The options to configure the HTTP request before HTTP client sends it. + * @throws HttpResponseException thrown if the request is rejected by server. + * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401. + * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404. + * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409. + * @return a connection by name, with its connection credentials along with {@link Response}. + */ + @Generated + @ServiceMethod(returns = ReturnType.SINGLE) + Response
Request Body Schema
+ * + *+ * {@code + * { + * pendingUploadId: String (Optional) + * connectionName: String (Optional) + * pendingUploadType: String(None/BlobReference) (Required) + * } + * } + *+ * + *
Response Body Schema
+ * + *+ * {@code + * { + * blobReference (Required): { + * blobUri: String (Required) + * storageAccountArmId: String (Required) + * credential (Required): { + * sasUri: String (Required) + * type: String (Required) + * } + * } + * pendingUploadId: String (Required) + * version: String (Optional) + * pendingUploadType: String(None/BlobReference) (Required) + * } + * } + *+ * + * @param name The name of the resource. + * @param version The specific version id of the DatasetVersion to operate on. + * @param body Parameters for the action. + * @param requestOptions The options to configure the HTTP request before HTTP client sends it. + * @throws HttpResponseException thrown if the request is rejected by server. + * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401. + * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404. + * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409. + * @return represents the response for a pending upload request along with {@link Response} on successful completion + * of {@link Mono}. + */ + @Generated + @ServiceMethod(returns = ReturnType.SINGLE) + public Mono
Response Body Schema
+ * + *+ * {@code + * { + * blobReference (Required): { + * blobUri: String (Required) + * storageAccountArmId: String (Required) + * credential (Required): { + * sasUri: String (Required) + * type: String (Required) + * } + * } + * } + * } + *+ * + * @param name The name of the resource. + * @param version The specific version id of the DatasetVersion to operate on. + * @param requestOptions The options to configure the HTTP request before HTTP client sends it. + * @throws HttpResponseException thrown if the request is rejected by server. + * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401. + * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404. + * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409. + * @return the SAS credential to access the storage account associated with a Dataset version along with + * {@link Response} on successful completion of {@link Mono}. + */ + @Generated + @ServiceMethod(returns = ReturnType.SINGLE) + public Mono
Response Body Schema
+ * + *+ * {@code + * { + * type: String(uri_file/uri_folder) (Required) + * dataUri: String (Optional, Required on create) + * isReference: Boolean (Optional) + * connectionName: String (Optional) + * id: String (Optional) + * name: String (Required) + * version: String (Required) + * description: String (Optional) + * tags (Optional): { + * String: String (Required) + * } + * } + * } + *+ * + * @param name The name of the resource. + * @param requestOptions The options to configure the HTTP request before HTTP client sends it. + * @throws HttpResponseException thrown if the request is rejected by server. + * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401. + * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404. + * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409. + * @return paged collection of DatasetVersion items as paginated response with {@link PagedFlux}. + */ + @Generated + @ServiceMethod(returns = ReturnType.COLLECTION) + public PagedFlux
Response Body Schema
+ * + *+ * {@code + * { + * type: String(uri_file/uri_folder) (Required) + * dataUri: String (Optional, Required on create) + * isReference: Boolean (Optional) + * connectionName: String (Optional) + * id: String (Optional) + * name: String (Required) + * version: String (Required) + * description: String (Optional) + * tags (Optional): { + * String: String (Required) + * } + * } + * } + *+ * + * @param requestOptions The options to configure the HTTP request before HTTP client sends it. + * @throws HttpResponseException thrown if the request is rejected by server. + * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401. + * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404. + * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409. + * @return paged collection of DatasetVersion items as paginated response with {@link PagedFlux}. + */ + @Generated + @ServiceMethod(returns = ReturnType.COLLECTION) + public PagedFlux
Response Body Schema
+ * + *+ * {@code + * { + * type: String(uri_file/uri_folder) (Required) + * dataUri: String (Optional, Required on create) + * isReference: Boolean (Optional) + * connectionName: String (Optional) + * id: String (Optional) + * name: String (Required) + * version: String (Required) + * description: String (Optional) + * tags (Optional): { + * String: String (Required) + * } + * } + * } + *+ * + * @param name The name of the resource. + * @param version The specific version id of the DatasetVersion to retrieve. + * @param requestOptions The options to configure the HTTP request before HTTP client sends it. + * @throws HttpResponseException thrown if the request is rejected by server. + * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401. + * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404. + * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409. + * @return the specific version of the DatasetVersion along with {@link Response} on successful completion of + * {@link Mono}. + */ + @Generated + @ServiceMethod(returns = ReturnType.SINGLE) + public Mono
Request Body Schema
+ * + *+ * {@code + * { + * type: String(uri_file/uri_folder) (Required) + * dataUri: String (Optional, Required on create) + * isReference: Boolean (Optional) + * connectionName: String (Optional) + * id: String (Optional) + * name: String (Required) + * version: String (Required) + * description: String (Optional) + * tags (Optional): { + * String: String (Required) + * } + * } + * } + *+ * + *
Response Body Schema
+ * + *+ * {@code + * { + * type: String(uri_file/uri_folder) (Required) + * dataUri: String (Optional, Required on create) + * isReference: Boolean (Optional) + * connectionName: String (Optional) + * id: String (Optional) + * name: String (Required) + * version: String (Required) + * description: String (Optional) + * tags (Optional): { + * String: String (Required) + * } + * } + * } + *+ * + * @param name The name of the resource. + * @param version The specific version id of the DatasetVersion to create or replace. + * @param body The definition of the DatasetVersion to create or update. + * @param requestOptions The options to configure the HTTP request before HTTP client sends it. + * @throws HttpResponseException thrown if the request is rejected by server. + * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401. + * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404. + * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409. + * @return datasetVersion Definition along with {@link Response} on successful completion of {@link Mono}. + */ + @Generated + @ServiceMethod(returns = ReturnType.SINGLE) + public Mono
Request Body Schema
+ * + *+ * {@code + * { + * pendingUploadId: String (Optional) + * connectionName: String (Optional) + * pendingUploadType: String(None/BlobReference) (Required) + * } + * } + *+ * + *
Response Body Schema
+ * + *+ * {@code + * { + * blobReference (Required): { + * blobUri: String (Required) + * storageAccountArmId: String (Required) + * credential (Required): { + * sasUri: String (Required) + * type: String (Required) + * } + * } + * pendingUploadId: String (Required) + * version: String (Optional) + * pendingUploadType: String(None/BlobReference) (Required) + * } + * } + *+ * + * @param name The name of the resource. + * @param version The specific version id of the DatasetVersion to operate on. + * @param body Parameters for the action. + * @param requestOptions The options to configure the HTTP request before HTTP client sends it. + * @throws HttpResponseException thrown if the request is rejected by server. + * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401. + * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404. + * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409. + * @return represents the response for a pending upload request along with {@link Response}. + */ + @Generated + @ServiceMethod(returns = ReturnType.SINGLE) + public Response
Response Body Schema
+ * + *+ * {@code + * { + * blobReference (Required): { + * blobUri: String (Required) + * storageAccountArmId: String (Required) + * credential (Required): { + * sasUri: String (Required) + * type: String (Required) + * } + * } + * } + * } + *+ * + * @param name The name of the resource. + * @param version The specific version id of the DatasetVersion to operate on. + * @param requestOptions The options to configure the HTTP request before HTTP client sends it. + * @throws HttpResponseException thrown if the request is rejected by server. + * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401. + * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404. + * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409. + * @return the SAS credential to access the storage account associated with a Dataset version along with + * {@link Response}. + */ + @Generated + @ServiceMethod(returns = ReturnType.SINGLE) + public Response
Response Body Schema
+ * + *+ * {@code + * { + * type: String(uri_file/uri_folder) (Required) + * dataUri: String (Optional, Required on create) + * isReference: Boolean (Optional) + * connectionName: String (Optional) + * id: String (Optional) + * name: String (Required) + * version: String (Required) + * description: String (Optional) + * tags (Optional): { + * String: String (Required) + * } + * } + * } + *+ * + * @param name The name of the resource. + * @param requestOptions The options to configure the HTTP request before HTTP client sends it. + * @throws HttpResponseException thrown if the request is rejected by server. + * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401. + * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404. + * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409. + * @return paged collection of DatasetVersion items as paginated response with {@link PagedIterable}. + */ + @Generated + @ServiceMethod(returns = ReturnType.COLLECTION) + public PagedIterable
Response Body Schema
+ * + *+ * {@code + * { + * type: String(uri_file/uri_folder) (Required) + * dataUri: String (Optional, Required on create) + * isReference: Boolean (Optional) + * connectionName: String (Optional) + * id: String (Optional) + * name: String (Required) + * version: String (Required) + * description: String (Optional) + * tags (Optional): { + * String: String (Required) + * } + * } + * } + *+ * + * @param requestOptions The options to configure the HTTP request before HTTP client sends it. + * @throws HttpResponseException thrown if the request is rejected by server. + * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401. + * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404. + * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409. + * @return paged collection of DatasetVersion items as paginated response with {@link PagedIterable}. + */ + @Generated + @ServiceMethod(returns = ReturnType.COLLECTION) + public PagedIterable
Response Body Schema
+ * + *+ * {@code + * { + * type: String(uri_file/uri_folder) (Required) + * dataUri: String (Optional, Required on create) + * isReference: Boolean (Optional) + * connectionName: String (Optional) + * id: String (Optional) + * name: String (Required) + * version: String (Required) + * description: String (Optional) + * tags (Optional): { + * String: String (Required) + * } + * } + * } + *+ * + * @param name The name of the resource. + * @param version The specific version id of the DatasetVersion to retrieve. + * @param requestOptions The options to configure the HTTP request before HTTP client sends it. + * @throws HttpResponseException thrown if the request is rejected by server. + * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401. + * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404. + * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409. + * @return the specific version of the DatasetVersion along with {@link Response}. + */ + @Generated + @ServiceMethod(returns = ReturnType.SINGLE) + public Response
Request Body Schema
+ * + *+ * {@code + * { + * type: String(uri_file/uri_folder) (Required) + * dataUri: String (Optional, Required on create) + * isReference: Boolean (Optional) + * connectionName: String (Optional) + * id: String (Optional) + * name: String (Required) + * version: String (Required) + * description: String (Optional) + * tags (Optional): { + * String: String (Required) + * } + * } + * } + *+ * + *
Response Body Schema
+ * + *+ * {@code + * { + * type: String(uri_file/uri_folder) (Required) + * dataUri: String (Optional, Required on create) + * isReference: Boolean (Optional) + * connectionName: String (Optional) + * id: String (Optional) + * name: String (Required) + * version: String (Required) + * description: String (Optional) + * tags (Optional): { + * String: String (Required) + * } + * } + * } + *+ * + * @param name The name of the resource. + * @param version The specific version id of the DatasetVersion to create or replace. + * @param body The definition of the DatasetVersion to create or update. + * @param requestOptions The options to configure the HTTP request before HTTP client sends it. + * @throws HttpResponseException thrown if the request is rejected by server. + * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401. + * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404. + * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409. + * @return datasetVersion Definition along with {@link Response}. + */ + @Generated + @ServiceMethod(returns = ReturnType.SINGLE) + public Response
Response Body Schema
+ * + *+ * {@code + * { + * type: String(ModelDeployment) (Required) + * name: String (Required) + * } + * } + *+ * + * @param name Name of the deployment. + * @param requestOptions The options to configure the HTTP request before HTTP client sends it. + * @throws HttpResponseException thrown if the request is rejected by server. + * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401. + * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404. + * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409. + * @return a deployed model along with {@link Response} on successful completion of {@link Mono}. + */ + @Generated + @ServiceMethod(returns = ReturnType.SINGLE) + public Mono
Query Parameters
+ *Name | Type | Required | Description |
---|---|---|---|
modelPublisher | String | No | Model publisher to filter models by |
modelName | String | No | Model name (the publisher specific name) to filter models + * by |
deploymentType | String | No | Type of deployment to filter list by. Allowed values: + * "ModelDeployment". |
Response Body Schema
+ * + *+ * {@code + * { + * type: String(ModelDeployment) (Required) + * name: String (Required) + * } + * } + *+ * + * @param requestOptions The options to configure the HTTP request before HTTP client sends it. + * @throws HttpResponseException thrown if the request is rejected by server. + * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401. + * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404. + * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409. + * @return paged collection of Deployment items as paginated response with {@link PagedFlux}. + */ + @Generated + @ServiceMethod(returns = ReturnType.COLLECTION) + public PagedFlux
Response Body Schema
+ * + *+ * {@code + * { + * type: String(ModelDeployment) (Required) + * name: String (Required) + * } + * } + *+ * + * @param name Name of the deployment. + * @param requestOptions The options to configure the HTTP request before HTTP client sends it. + * @throws HttpResponseException thrown if the request is rejected by server. + * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401. + * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404. + * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409. + * @return a deployed model along with {@link Response}. + */ + @Generated + @ServiceMethod(returns = ReturnType.SINGLE) + public Response
Query Parameters
+ *Name | Type | Required | Description |
---|---|---|---|
modelPublisher | String | No | Model publisher to filter models by |
modelName | String | No | Model name (the publisher specific name) to filter models + * by |
deploymentType | String | No | Type of deployment to filter list by. Allowed values: + * "ModelDeployment". |
Response Body Schema
+ * + *+ * {@code + * { + * type: String(ModelDeployment) (Required) + * name: String (Required) + * } + * } + *+ * + * @param requestOptions The options to configure the HTTP request before HTTP client sends it. + * @throws HttpResponseException thrown if the request is rejected by server. + * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401. + * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404. + * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409. + * @return paged collection of Deployment items as paginated response with {@link PagedIterable}. + */ + @Generated + @ServiceMethod(returns = ReturnType.COLLECTION) + public PagedIterable
Request Body Schema
+ * + *+ * {@code + * { + * runId: String (Required) + * threadId: String (Optional) + * evaluators (Required): { + * String (Required): { + * id: String (Required) + * initParams (Optional): { + * String: BinaryData (Required) + * } + * dataMapping (Optional): { + * String: String (Required) + * } + * } + * } + * samplingConfiguration (Optional): { + * name: String (Required) + * samplingPercent: double (Required) + * maxRequestRate: double (Required) + * } + * redactionConfiguration (Optional): { + * redactScoreProperties: Boolean (Optional) + * } + * appInsightsConnectionString: String (Required) + * } + * } + *+ * + *
Response Body Schema
+ * + *+ * {@code + * { + * id: String (Required) + * status: String (Required) + * error: String (Optional) + * result (Optional): [ + * (Optional){ + * evaluator: String (Required) + * evaluatorId: String (Required) + * score: double (Required) + * status: String (Required) + * reason: String (Optional) + * version: String (Optional) + * threadId: String (Optional) + * runId: String (Required) + * error: String (Optional) + * additionalDetails (Optional): { + * String: String (Required) + * } + * } + * ] + * } + * } + *+ * + * @param evaluation Agent evaluation to be run. + * @param requestOptions The options to configure the HTTP request before HTTP client sends it. + * @throws HttpResponseException thrown if the request is rejected by server. + * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401. + * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404. + * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409. + * @return evaluation response for agent evaluation run along with {@link Response} on successful completion of + * {@link Mono}. + */ + @Generated + @ServiceMethod(returns = ReturnType.SINGLE) + public Mono
Response Body Schema
+ * + *+ * {@code + * { + * id: String (Required) + * data (Required): { + * type: String (Required) + * } + * displayName: String (Optional) + * description: String (Optional) + * status: String (Optional) + * tags (Optional): { + * String: String (Required) + * } + * properties (Optional): { + * String: String (Required) + * } + * evaluators (Required): { + * String (Required): { + * id: String (Required) + * initParams (Optional): { + * String: BinaryData (Required) + * } + * dataMapping (Optional): { + * String: String (Required) + * } + * } + * } + * } + * } + *+ * + * @param name Identifier of the evaluation. + * @param requestOptions The options to configure the HTTP request before HTTP client sends it. + * @throws HttpResponseException thrown if the request is rejected by server. + * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401. + * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404. + * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409. + * @return an evaluation run by name along with {@link Response} on successful completion of {@link Mono}. + */ + @Generated + @ServiceMethod(returns = ReturnType.SINGLE) + public Mono
Response Body Schema
+ * + *+ * {@code + * { + * id: String (Required) + * data (Required): { + * type: String (Required) + * } + * displayName: String (Optional) + * description: String (Optional) + * status: String (Optional) + * tags (Optional): { + * String: String (Required) + * } + * properties (Optional): { + * String: String (Required) + * } + * evaluators (Required): { + * String (Required): { + * id: String (Required) + * initParams (Optional): { + * String: BinaryData (Required) + * } + * dataMapping (Optional): { + * String: String (Required) + * } + * } + * } + * } + * } + *+ * + * @param requestOptions The options to configure the HTTP request before HTTP client sends it. + * @throws HttpResponseException thrown if the request is rejected by server. + * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401. + * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404. + * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409. + * @return paged collection of Evaluation items as paginated response with {@link PagedFlux}. + */ + @Generated + @ServiceMethod(returns = ReturnType.COLLECTION) + public PagedFlux
Request Body Schema
+ * + *+ * {@code + * { + * id: String (Required) + * data (Required): { + * type: String (Required) + * } + * displayName: String (Optional) + * description: String (Optional) + * status: String (Optional) + * tags (Optional): { + * String: String (Required) + * } + * properties (Optional): { + * String: String (Required) + * } + * evaluators (Required): { + * String (Required): { + * id: String (Required) + * initParams (Optional): { + * String: BinaryData (Required) + * } + * dataMapping (Optional): { + * String: String (Required) + * } + * } + * } + * } + * } + *+ * + *
Response Body Schema
+ * + *+ * {@code + * { + * id: String (Required) + * data (Required): { + * type: String (Required) + * } + * displayName: String (Optional) + * description: String (Optional) + * status: String (Optional) + * tags (Optional): { + * String: String (Required) + * } + * properties (Optional): { + * String: String (Required) + * } + * evaluators (Required): { + * String (Required): { + * id: String (Required) + * initParams (Optional): { + * String: BinaryData (Required) + * } + * dataMapping (Optional): { + * String: String (Required) + * } + * } + * } + * } + * } + *+ * + * @param evaluation Evaluation to be run. + * @param requestOptions The options to configure the HTTP request before HTTP client sends it. + * @throws HttpResponseException thrown if the request is rejected by server. + * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401. + * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404. + * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409. + * @return evaluation Definition along with {@link Response} on successful completion of {@link Mono}. + */ + @Generated + @ServiceMethod(returns = ReturnType.SINGLE) + public Mono
Request Body Schema
+ * + *+ * {@code + * { + * runId: String (Required) + * threadId: String (Optional) + * evaluators (Required): { + * String (Required): { + * id: String (Required) + * initParams (Optional): { + * String: BinaryData (Required) + * } + * dataMapping (Optional): { + * String: String (Required) + * } + * } + * } + * samplingConfiguration (Optional): { + * name: String (Required) + * samplingPercent: double (Required) + * maxRequestRate: double (Required) + * } + * redactionConfiguration (Optional): { + * redactScoreProperties: Boolean (Optional) + * } + * appInsightsConnectionString: String (Required) + * } + * } + *+ * + *
Response Body Schema
+ * + *+ * {@code + * { + * id: String (Required) + * status: String (Required) + * error: String (Optional) + * result (Optional): [ + * (Optional){ + * evaluator: String (Required) + * evaluatorId: String (Required) + * score: double (Required) + * status: String (Required) + * reason: String (Optional) + * version: String (Optional) + * threadId: String (Optional) + * runId: String (Required) + * error: String (Optional) + * additionalDetails (Optional): { + * String: String (Required) + * } + * } + * ] + * } + * } + *+ * + * @param evaluation Agent evaluation to be run. + * @param requestOptions The options to configure the HTTP request before HTTP client sends it. + * @throws HttpResponseException thrown if the request is rejected by server. + * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401. + * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404. + * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409. + * @return evaluation response for agent evaluation run along with {@link Response}. + */ + @Generated + @ServiceMethod(returns = ReturnType.SINGLE) + public Response
Response Body Schema
+ * + *+ * {@code + * { + * id: String (Required) + * data (Required): { + * type: String (Required) + * } + * displayName: String (Optional) + * description: String (Optional) + * status: String (Optional) + * tags (Optional): { + * String: String (Required) + * } + * properties (Optional): { + * String: String (Required) + * } + * evaluators (Required): { + * String (Required): { + * id: String (Required) + * initParams (Optional): { + * String: BinaryData (Required) + * } + * dataMapping (Optional): { + * String: String (Required) + * } + * } + * } + * } + * } + *+ * + * @param name Identifier of the evaluation. + * @param requestOptions The options to configure the HTTP request before HTTP client sends it. + * @throws HttpResponseException thrown if the request is rejected by server. + * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401. + * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404. + * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409. + * @return an evaluation run by name along with {@link Response}. + */ + @Generated + @ServiceMethod(returns = ReturnType.SINGLE) + public Response
Response Body Schema
+ * + *+ * {@code + * { + * id: String (Required) + * data (Required): { + * type: String (Required) + * } + * displayName: String (Optional) + * description: String (Optional) + * status: String (Optional) + * tags (Optional): { + * String: String (Required) + * } + * properties (Optional): { + * String: String (Required) + * } + * evaluators (Required): { + * String (Required): { + * id: String (Required) + * initParams (Optional): { + * String: BinaryData (Required) + * } + * dataMapping (Optional): { + * String: String (Required) + * } + * } + * } + * } + * } + *+ * + * @param requestOptions The options to configure the HTTP request before HTTP client sends it. + * @throws HttpResponseException thrown if the request is rejected by server. + * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401. + * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404. + * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409. + * @return paged collection of Evaluation items as paginated response with {@link PagedIterable}. + */ + @Generated + @ServiceMethod(returns = ReturnType.COLLECTION) + public PagedIterable
Request Body Schema
+ * + *+ * {@code + * { + * id: String (Required) + * data (Required): { + * type: String (Required) + * } + * displayName: String (Optional) + * description: String (Optional) + * status: String (Optional) + * tags (Optional): { + * String: String (Required) + * } + * properties (Optional): { + * String: String (Required) + * } + * evaluators (Required): { + * String (Required): { + * id: String (Required) + * initParams (Optional): { + * String: BinaryData (Required) + * } + * dataMapping (Optional): { + * String: String (Required) + * } + * } + * } + * } + * } + *+ * + *
Response Body Schema
+ * + *+ * {@code + * { + * id: String (Required) + * data (Required): { + * type: String (Required) + * } + * displayName: String (Optional) + * description: String (Optional) + * status: String (Optional) + * tags (Optional): { + * String: String (Required) + * } + * properties (Optional): { + * String: String (Required) + * } + * evaluators (Required): { + * String (Required): { + * id: String (Required) + * initParams (Optional): { + * String: BinaryData (Required) + * } + * dataMapping (Optional): { + * String: String (Required) + * } + * } + * } + * } + * } + *+ * + * @param evaluation Evaluation to be run. + * @param requestOptions The options to configure the HTTP request before HTTP client sends it. + * @throws HttpResponseException thrown if the request is rejected by server. + * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401. + * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404. + * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409. + * @return evaluation Definition along with {@link Response}. + */ + @Generated + @ServiceMethod(returns = ReturnType.SINGLE) + public Response
Response Body Schema
+ * + *+ * {@code + * { + * type: String(AzureSearch/CosmosDBNoSqlVectorStore/ManagedAzureSearch) (Required) + * id: String (Optional) + * name: String (Required) + * version: String (Required) + * description: String (Optional) + * tags (Optional): { + * String: String (Required) + * } + * } + * } + *+ * + * @param name The name of the resource. + * @param requestOptions The options to configure the HTTP request before HTTP client sends it. + * @throws HttpResponseException thrown if the request is rejected by server. + * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401. + * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404. + * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409. + * @return paged collection of Index items as paginated response with {@link PagedFlux}. + */ + @Generated + @ServiceMethod(returns = ReturnType.COLLECTION) + public PagedFlux
Response Body Schema
+ * + *+ * {@code + * { + * type: String(AzureSearch/CosmosDBNoSqlVectorStore/ManagedAzureSearch) (Required) + * id: String (Optional) + * name: String (Required) + * version: String (Required) + * description: String (Optional) + * tags (Optional): { + * String: String (Required) + * } + * } + * } + *+ * + * @param requestOptions The options to configure the HTTP request before HTTP client sends it. + * @throws HttpResponseException thrown if the request is rejected by server. + * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401. + * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404. + * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409. + * @return paged collection of Index items as paginated response with {@link PagedFlux}. + */ + @Generated + @ServiceMethod(returns = ReturnType.COLLECTION) + public PagedFlux
Response Body Schema
+ * + *+ * {@code + * { + * type: String(AzureSearch/CosmosDBNoSqlVectorStore/ManagedAzureSearch) (Required) + * id: String (Optional) + * name: String (Required) + * version: String (Required) + * description: String (Optional) + * tags (Optional): { + * String: String (Required) + * } + * } + * } + *+ * + * @param name The name of the resource. + * @param version The specific version id of the Index to retrieve. + * @param requestOptions The options to configure the HTTP request before HTTP client sends it. + * @throws HttpResponseException thrown if the request is rejected by server. + * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401. + * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404. + * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409. + * @return the specific version of the Index along with {@link Response} on successful completion of {@link Mono}. + */ + @Generated + @ServiceMethod(returns = ReturnType.SINGLE) + public Mono
Request Body Schema
+ * + *+ * {@code + * { + * type: String(AzureSearch/CosmosDBNoSqlVectorStore/ManagedAzureSearch) (Required) + * id: String (Optional) + * name: String (Required) + * version: String (Required) + * description: String (Optional) + * tags (Optional): { + * String: String (Required) + * } + * } + * } + *+ * + *
Response Body Schema
+ * + *+ * {@code + * { + * type: String(AzureSearch/CosmosDBNoSqlVectorStore/ManagedAzureSearch) (Required) + * id: String (Optional) + * name: String (Required) + * version: String (Required) + * description: String (Optional) + * tags (Optional): { + * String: String (Required) + * } + * } + * } + *+ * + * @param name The name of the resource. + * @param version The specific version id of the Index to create or replace. + * @param body The definition of the Index to create or update. + * @param requestOptions The options to configure the HTTP request before HTTP client sends it. + * @throws HttpResponseException thrown if the request is rejected by server. + * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401. + * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404. + * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409. + * @return index resource Definition along with {@link Response} on successful completion of {@link Mono}. + */ + @Generated + @ServiceMethod(returns = ReturnType.SINGLE) + public Mono
Response Body Schema
+ * + *+ * {@code + * { + * type: String(AzureSearch/CosmosDBNoSqlVectorStore/ManagedAzureSearch) (Required) + * id: String (Optional) + * name: String (Required) + * version: String (Required) + * description: String (Optional) + * tags (Optional): { + * String: String (Required) + * } + * } + * } + *+ * + * @param name The name of the resource. + * @param requestOptions The options to configure the HTTP request before HTTP client sends it. + * @throws HttpResponseException thrown if the request is rejected by server. + * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401. + * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404. + * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409. + * @return paged collection of Index items as paginated response with {@link PagedIterable}. + */ + @Generated + @ServiceMethod(returns = ReturnType.COLLECTION) + public PagedIterable
Response Body Schema
+ * + *+ * {@code + * { + * type: String(AzureSearch/CosmosDBNoSqlVectorStore/ManagedAzureSearch) (Required) + * id: String (Optional) + * name: String (Required) + * version: String (Required) + * description: String (Optional) + * tags (Optional): { + * String: String (Required) + * } + * } + * } + *+ * + * @param requestOptions The options to configure the HTTP request before HTTP client sends it. + * @throws HttpResponseException thrown if the request is rejected by server. + * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401. + * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404. + * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409. + * @return paged collection of Index items as paginated response with {@link PagedIterable}. + */ + @Generated + @ServiceMethod(returns = ReturnType.COLLECTION) + public PagedIterable
Response Body Schema
+ * + *+ * {@code + * { + * type: String(AzureSearch/CosmosDBNoSqlVectorStore/ManagedAzureSearch) (Required) + * id: String (Optional) + * name: String (Required) + * version: String (Required) + * description: String (Optional) + * tags (Optional): { + * String: String (Required) + * } + * } + * } + *+ * + * @param name The name of the resource. + * @param version The specific version id of the Index to retrieve. + * @param requestOptions The options to configure the HTTP request before HTTP client sends it. + * @throws HttpResponseException thrown if the request is rejected by server. + * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401. + * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404. + * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409. + * @return the specific version of the Index along with {@link Response}. + */ + @Generated + @ServiceMethod(returns = ReturnType.SINGLE) + public Response
Request Body Schema
+ * + *+ * {@code + * { + * type: String(AzureSearch/CosmosDBNoSqlVectorStore/ManagedAzureSearch) (Required) + * id: String (Optional) + * name: String (Required) + * version: String (Required) + * description: String (Optional) + * tags (Optional): { + * String: String (Required) + * } + * } + * } + *+ * + *
Response Body Schema
+ * + *+ * {@code + * { + * type: String(AzureSearch/CosmosDBNoSqlVectorStore/ManagedAzureSearch) (Required) + * id: String (Optional) + * name: String (Required) + * version: String (Required) + * description: String (Optional) + * tags (Optional): { + * String: String (Required) + * } + * } + * } + *+ * + * @param name The name of the resource. + * @param version The specific version id of the Index to create or replace. + * @param body The definition of the Index to create or update. + * @param requestOptions The options to configure the HTTP request before HTTP client sends it. + * @throws HttpResponseException thrown if the request is rejected by server. + * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401. + * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404. + * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409. + * @return index resource Definition along with {@link Response}. + */ + @Generated + @ServiceMethod(returns = ReturnType.SINGLE) + public Response
Response Body Schema
+ * + *+ * {@code + * { + * id: String (Required) + * displayName: String (Optional) + * numTurns: Integer (Optional) + * attackStrategies (Optional): [ + * String(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) (Optional) + * ] + * simulationOnly: Boolean (Optional) + * riskCategories (Optional): [ + * String(HateUnfairness/Violence/Sexual/SelfHarm) (Optional) + * ] + * applicationScenario: String (Optional) + * tags (Optional): { + * String: String (Required) + * } + * properties (Optional): { + * String: String (Required) + * } + * status: String (Optional) + * target (Required): { + * type: String (Required) + * } + * } + * } + *+ * + * @param name Identifier of the red team run. + * @param requestOptions The options to configure the HTTP request before HTTP client sends it. + * @throws HttpResponseException thrown if the request is rejected by server. + * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401. + * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404. + * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409. + * @return a redteam by name along with {@link Response} on successful completion of {@link Mono}. + */ + @Generated + @ServiceMethod(returns = ReturnType.SINGLE) + public Mono
Response Body Schema
+ * + *+ * {@code + * { + * id: String (Required) + * displayName: String (Optional) + * numTurns: Integer (Optional) + * attackStrategies (Optional): [ + * String(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) (Optional) + * ] + * simulationOnly: Boolean (Optional) + * riskCategories (Optional): [ + * String(HateUnfairness/Violence/Sexual/SelfHarm) (Optional) + * ] + * applicationScenario: String (Optional) + * tags (Optional): { + * String: String (Required) + * } + * properties (Optional): { + * String: String (Required) + * } + * status: String (Optional) + * target (Required): { + * type: String (Required) + * } + * } + * } + *+ * + * @param requestOptions The options to configure the HTTP request before HTTP client sends it. + * @throws HttpResponseException thrown if the request is rejected by server. + * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401. + * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404. + * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409. + * @return paged collection of RedTeam items as paginated response with {@link PagedFlux}. + */ + @Generated + @ServiceMethod(returns = ReturnType.COLLECTION) + public PagedFlux
Request Body Schema
+ * + *+ * {@code + * { + * id: String (Required) + * displayName: String (Optional) + * numTurns: Integer (Optional) + * attackStrategies (Optional): [ + * String(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) (Optional) + * ] + * simulationOnly: Boolean (Optional) + * riskCategories (Optional): [ + * String(HateUnfairness/Violence/Sexual/SelfHarm) (Optional) + * ] + * applicationScenario: String (Optional) + * tags (Optional): { + * String: String (Required) + * } + * properties (Optional): { + * String: String (Required) + * } + * status: String (Optional) + * target (Required): { + * type: String (Required) + * } + * } + * } + *+ * + *
Response Body Schema
+ * + *+ * {@code + * { + * id: String (Required) + * displayName: String (Optional) + * numTurns: Integer (Optional) + * attackStrategies (Optional): [ + * String(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) (Optional) + * ] + * simulationOnly: Boolean (Optional) + * riskCategories (Optional): [ + * String(HateUnfairness/Violence/Sexual/SelfHarm) (Optional) + * ] + * applicationScenario: String (Optional) + * tags (Optional): { + * String: String (Required) + * } + * properties (Optional): { + * String: String (Required) + * } + * status: String (Optional) + * target (Required): { + * type: String (Required) + * } + * } + * } + *+ * + * @param redTeam Redteam to be run. + * @param requestOptions The options to configure the HTTP request before HTTP client sends it. + * @throws HttpResponseException thrown if the request is rejected by server. + * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401. + * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404. + * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409. + * @return red team details along with {@link Response} on successful completion of {@link Mono}. + */ + @Generated + @ServiceMethod(returns = ReturnType.SINGLE) + public Mono
Response Body Schema
+ * + *+ * {@code + * { + * id: String (Required) + * displayName: String (Optional) + * numTurns: Integer (Optional) + * attackStrategies (Optional): [ + * String(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) (Optional) + * ] + * simulationOnly: Boolean (Optional) + * riskCategories (Optional): [ + * String(HateUnfairness/Violence/Sexual/SelfHarm) (Optional) + * ] + * applicationScenario: String (Optional) + * tags (Optional): { + * String: String (Required) + * } + * properties (Optional): { + * String: String (Required) + * } + * status: String (Optional) + * target (Required): { + * type: String (Required) + * } + * } + * } + *+ * + * @param name Identifier of the red team run. + * @param requestOptions The options to configure the HTTP request before HTTP client sends it. + * @throws HttpResponseException thrown if the request is rejected by server. + * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401. + * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404. + * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409. + * @return a redteam by name along with {@link Response}. + */ + @Generated + @ServiceMethod(returns = ReturnType.SINGLE) + public Response
Response Body Schema
+ * + *+ * {@code + * { + * id: String (Required) + * displayName: String (Optional) + * numTurns: Integer (Optional) + * attackStrategies (Optional): [ + * String(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) (Optional) + * ] + * simulationOnly: Boolean (Optional) + * riskCategories (Optional): [ + * String(HateUnfairness/Violence/Sexual/SelfHarm) (Optional) + * ] + * applicationScenario: String (Optional) + * tags (Optional): { + * String: String (Required) + * } + * properties (Optional): { + * String: String (Required) + * } + * status: String (Optional) + * target (Required): { + * type: String (Required) + * } + * } + * } + *+ * + * @param requestOptions The options to configure the HTTP request before HTTP client sends it. + * @throws HttpResponseException thrown if the request is rejected by server. + * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401. + * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404. + * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409. + * @return paged collection of RedTeam items as paginated response with {@link PagedIterable}. + */ + @Generated + @ServiceMethod(returns = ReturnType.COLLECTION) + public PagedIterable
Request Body Schema
+ * + *+ * {@code + * { + * id: String (Required) + * displayName: String (Optional) + * numTurns: Integer (Optional) + * attackStrategies (Optional): [ + * String(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) (Optional) + * ] + * simulationOnly: Boolean (Optional) + * riskCategories (Optional): [ + * String(HateUnfairness/Violence/Sexual/SelfHarm) (Optional) + * ] + * applicationScenario: String (Optional) + * tags (Optional): { + * String: String (Required) + * } + * properties (Optional): { + * String: String (Required) + * } + * status: String (Optional) + * target (Required): { + * type: String (Required) + * } + * } + * } + *+ * + *
Response Body Schema
+ * + *+ * {@code + * { + * id: String (Required) + * displayName: String (Optional) + * numTurns: Integer (Optional) + * attackStrategies (Optional): [ + * String(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) (Optional) + * ] + * simulationOnly: Boolean (Optional) + * riskCategories (Optional): [ + * String(HateUnfairness/Violence/Sexual/SelfHarm) (Optional) + * ] + * applicationScenario: String (Optional) + * tags (Optional): { + * String: String (Required) + * } + * properties (Optional): { + * String: String (Required) + * } + * status: String (Optional) + * target (Required): { + * type: String (Required) + * } + * } + * } + *+ * + * @param redTeam Redteam to be run. + * @param requestOptions The options to configure the HTTP request before HTTP client sends it. + * @throws HttpResponseException thrown if the request is rejected by server. + * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401. + * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404. + * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409. + * @return red team details along with {@link Response}. + */ + @Generated + @ServiceMethod(returns = ReturnType.SINGLE) + public Response
Response Body Schema
+ * + *+ * {@code + * { + * name: String (Required) + * id: String (Required) + * type: String(AzureOpenAI/AzureBlob/AzureStorageAccount/CognitiveSearch/CosmosDB/ApiKey/AppConfig/AppInsights/CustomKeys) (Required) + * target: String (Required) + * isDefault: boolean (Required) + * credentials (Required): { + * type: String(ApiKey/AAD/SAS/CustomKeys/None) (Required) + * } + * metadata (Required): { + * String: String (Required) + * } + * } + * } + *+ * + * @param name The friendly name of the connection, provided by the user. + * @param requestOptions The options to configure the HTTP request before HTTP client sends it. + * @throws HttpResponseException thrown if the request is rejected by server. + * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401. + * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404. + * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409. + * @return a connection by name, without populating connection credentials along with {@link Response} on successful + * completion of {@link Mono}. + */ + @ServiceMethod(returns = ReturnType.SINGLE) + public Mono
Response Body Schema
+ * + *+ * {@code + * { + * name: String (Required) + * id: String (Required) + * type: String(AzureOpenAI/AzureBlob/AzureStorageAccount/CognitiveSearch/CosmosDB/ApiKey/AppConfig/AppInsights/CustomKeys) (Required) + * target: String (Required) + * isDefault: boolean (Required) + * credentials (Required): { + * type: String(ApiKey/AAD/SAS/CustomKeys/None) (Required) + * } + * metadata (Required): { + * String: String (Required) + * } + * } + * } + *+ * + * @param name The friendly name of the connection, provided by the user. + * @param requestOptions The options to configure the HTTP request before HTTP client sends it. + * @throws HttpResponseException thrown if the request is rejected by server. + * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401. + * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404. + * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409. + * @return a connection by name, without populating connection credentials along with {@link Response}. + */ + @ServiceMethod(returns = ReturnType.SINGLE) + public Response
Response Body Schema
+ * + *+ * {@code + * { + * name: String (Required) + * id: String (Required) + * type: String(AzureOpenAI/AzureBlob/AzureStorageAccount/CognitiveSearch/CosmosDB/ApiKey/AppConfig/AppInsights/CustomKeys) (Required) + * target: String (Required) + * isDefault: boolean (Required) + * credentials (Required): { + * type: String(ApiKey/AAD/SAS/CustomKeys/None) (Required) + * } + * metadata (Required): { + * String: String (Required) + * } + * } + * } + *+ * + * @param name The friendly name of the connection, provided by the user. + * @param requestOptions The options to configure the HTTP request before HTTP client sends it. + * @throws HttpResponseException thrown if the request is rejected by server. + * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401. + * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404. + * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409. + * @return a connection by name, with its connection credentials along with {@link Response} on successful + * completion of {@link Mono}. + */ + @ServiceMethod(returns = ReturnType.SINGLE) + public Mono
Response Body Schema
+ * + *+ * {@code + * { + * name: String (Required) + * id: String (Required) + * type: String(AzureOpenAI/AzureBlob/AzureStorageAccount/CognitiveSearch/CosmosDB/ApiKey/AppConfig/AppInsights/CustomKeys) (Required) + * target: String (Required) + * isDefault: boolean (Required) + * credentials (Required): { + * type: String(ApiKey/AAD/SAS/CustomKeys/None) (Required) + * } + * metadata (Required): { + * String: String (Required) + * } + * } + * } + *+ * + * @param name The friendly name of the connection, provided by the user. + * @param requestOptions The options to configure the HTTP request before HTTP client sends it. + * @throws HttpResponseException thrown if the request is rejected by server. + * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401. + * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404. + * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409. + * @return a connection by name, with its connection credentials along with {@link Response}. + */ + @ServiceMethod(returns = ReturnType.SINGLE) + public Response
Query Parameters
+ *Name | Type | Required | Description |
---|---|---|---|
connectionType | String | No | List connections of this specific type. Allowed values: + * "AzureOpenAI", "AzureBlob", "AzureStorageAccount", "CognitiveSearch", "CosmosDB", "ApiKey", "AppConfig", + * "AppInsights", "CustomKeys". |
defaultConnection | Boolean | No | List connections that are default + * connections |
Response Body Schema
+ * + *+ * {@code + * { + * name: String (Required) + * id: String (Required) + * type: String(AzureOpenAI/AzureBlob/AzureStorageAccount/CognitiveSearch/CosmosDB/ApiKey/AppConfig/AppInsights/CustomKeys) (Required) + * target: String (Required) + * isDefault: boolean (Required) + * credentials (Required): { + * type: String(ApiKey/AAD/SAS/CustomKeys/None) (Required) + * } + * metadata (Required): { + * String: String (Required) + * } + * } + * } + *+ * + * @param requestOptions The options to configure the HTTP request before HTTP client sends it. + * @throws HttpResponseException thrown if the request is rejected by server. + * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401. + * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404. + * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409. + * @return paged collection of Connection items along with {@link PagedResponse} on successful completion of + * {@link Mono}. + */ + @ServiceMethod(returns = ReturnType.SINGLE) + private Mono
Query Parameters
+ *Name | Type | Required | Description |
---|---|---|---|
connectionType | String | No | List connections of this specific type. Allowed values: + * "AzureOpenAI", "AzureBlob", "AzureStorageAccount", "CognitiveSearch", "CosmosDB", "ApiKey", "AppConfig", + * "AppInsights", "CustomKeys". |
defaultConnection | Boolean | No | List connections that are default + * connections |
Response Body Schema
+ * + *+ * {@code + * { + * name: String (Required) + * id: String (Required) + * type: String(AzureOpenAI/AzureBlob/AzureStorageAccount/CognitiveSearch/CosmosDB/ApiKey/AppConfig/AppInsights/CustomKeys) (Required) + * target: String (Required) + * isDefault: boolean (Required) + * credentials (Required): { + * type: String(ApiKey/AAD/SAS/CustomKeys/None) (Required) + * } + * metadata (Required): { + * String: String (Required) + * } + * } + * } + *+ * + * @param requestOptions The options to configure the HTTP request before HTTP client sends it. + * @throws HttpResponseException thrown if the request is rejected by server. + * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401. + * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404. + * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409. + * @return paged collection of Connection items as paginated response with {@link PagedFlux}. + */ + @ServiceMethod(returns = ReturnType.COLLECTION) + public PagedFlux
Query Parameters
+ *Name | Type | Required | Description |
---|---|---|---|
connectionType | String | No | List connections of this specific type. Allowed values: + * "AzureOpenAI", "AzureBlob", "AzureStorageAccount", "CognitiveSearch", "CosmosDB", "ApiKey", "AppConfig", + * "AppInsights", "CustomKeys". |
defaultConnection | Boolean | No | List connections that are default + * connections |
Response Body Schema
+ * + *+ * {@code + * { + * name: String (Required) + * id: String (Required) + * type: String(AzureOpenAI/AzureBlob/AzureStorageAccount/CognitiveSearch/CosmosDB/ApiKey/AppConfig/AppInsights/CustomKeys) (Required) + * target: String (Required) + * isDefault: boolean (Required) + * credentials (Required): { + * type: String(ApiKey/AAD/SAS/CustomKeys/None) (Required) + * } + * metadata (Required): { + * String: String (Required) + * } + * } + * } + *+ * + * @param requestOptions The options to configure the HTTP request before HTTP client sends it. + * @throws HttpResponseException thrown if the request is rejected by server. + * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401. + * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404. + * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409. + * @return paged collection of Connection items along with {@link PagedResponse}. + */ + @ServiceMethod(returns = ReturnType.SINGLE) + private PagedResponse
Query Parameters
+ *Name | Type | Required | Description |
---|---|---|---|
connectionType | String | No | List connections of this specific type. Allowed values: + * "AzureOpenAI", "AzureBlob", "AzureStorageAccount", "CognitiveSearch", "CosmosDB", "ApiKey", "AppConfig", + * "AppInsights", "CustomKeys". |
defaultConnection | Boolean | No | List connections that are default + * connections |
Response Body Schema
+ * + *+ * {@code + * { + * name: String (Required) + * id: String (Required) + * type: String(AzureOpenAI/AzureBlob/AzureStorageAccount/CognitiveSearch/CosmosDB/ApiKey/AppConfig/AppInsights/CustomKeys) (Required) + * target: String (Required) + * isDefault: boolean (Required) + * credentials (Required): { + * type: String(ApiKey/AAD/SAS/CustomKeys/None) (Required) + * } + * metadata (Required): { + * String: String (Required) + * } + * } + * } + *+ * + * @param requestOptions The options to configure the HTTP request before HTTP client sends it. + * @throws HttpResponseException thrown if the request is rejected by server. + * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401. + * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404. + * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409. + * @return paged collection of Connection items as paginated response with {@link PagedIterable}. + */ + @ServiceMethod(returns = ReturnType.COLLECTION) + public PagedIterable
Response Body Schema
+ * + *+ * {@code + * { + * name: String (Required) + * id: String (Required) + * type: String(AzureOpenAI/AzureBlob/AzureStorageAccount/CognitiveSearch/CosmosDB/ApiKey/AppConfig/AppInsights/CustomKeys) (Required) + * target: String (Required) + * isDefault: boolean (Required) + * credentials (Required): { + * type: String(ApiKey/AAD/SAS/CustomKeys/None) (Required) + * } + * metadata (Required): { + * String: String (Required) + * } + * } + * } + *+ * + * @param nextLink The URL to get the next list of items. + * @param requestOptions The options to configure the HTTP request before HTTP client sends it. + * @throws HttpResponseException thrown if the request is rejected by server. + * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401. + * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404. + * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409. + * @return paged collection of Connection items along with {@link PagedResponse} on successful completion of + * {@link Mono}. + */ + @ServiceMethod(returns = ReturnType.SINGLE) + private Mono
Response Body Schema
+ * + *+ * {@code + * { + * name: String (Required) + * id: String (Required) + * type: String(AzureOpenAI/AzureBlob/AzureStorageAccount/CognitiveSearch/CosmosDB/ApiKey/AppConfig/AppInsights/CustomKeys) (Required) + * target: String (Required) + * isDefault: boolean (Required) + * credentials (Required): { + * type: String(ApiKey/AAD/SAS/CustomKeys/None) (Required) + * } + * metadata (Required): { + * String: String (Required) + * } + * } + * } + *+ * + * @param nextLink The URL to get the next list of items. + * @param requestOptions The options to configure the HTTP request before HTTP client sends it. + * @throws HttpResponseException thrown if the request is rejected by server. + * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401. + * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404. + * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409. + * @return paged collection of Connection items along with {@link PagedResponse}. + */ + @ServiceMethod(returns = ReturnType.SINGLE) + private PagedResponse
Response Body Schema
+ * + *+ * {@code + * { + * type: String(uri_file/uri_folder) (Required) + * dataUri: String (Optional, Required on create) + * isReference: Boolean (Optional) + * connectionName: String (Optional) + * id: String (Optional) + * name: String (Required) + * version: String (Required) + * description: String (Optional) + * tags (Optional): { + * String: String (Required) + * } + * } + * } + *+ * + * @param name The name of the resource. + * @param requestOptions The options to configure the HTTP request before HTTP client sends it. + * @throws HttpResponseException thrown if the request is rejected by server. + * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401. + * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404. + * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409. + * @return paged collection of DatasetVersion items along with {@link PagedResponse} on successful completion of + * {@link Mono}. + */ + @ServiceMethod(returns = ReturnType.SINGLE) + private Mono
Response Body Schema
+ * + *+ * {@code + * { + * type: String(uri_file/uri_folder) (Required) + * dataUri: String (Optional, Required on create) + * isReference: Boolean (Optional) + * connectionName: String (Optional) + * id: String (Optional) + * name: String (Required) + * version: String (Required) + * description: String (Optional) + * tags (Optional): { + * String: String (Required) + * } + * } + * } + *+ * + * @param name The name of the resource. + * @param requestOptions The options to configure the HTTP request before HTTP client sends it. + * @throws HttpResponseException thrown if the request is rejected by server. + * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401. + * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404. + * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409. + * @return paged collection of DatasetVersion items as paginated response with {@link PagedFlux}. + */ + @ServiceMethod(returns = ReturnType.COLLECTION) + public PagedFlux
Response Body Schema
+ * + *+ * {@code + * { + * type: String(uri_file/uri_folder) (Required) + * dataUri: String (Optional, Required on create) + * isReference: Boolean (Optional) + * connectionName: String (Optional) + * id: String (Optional) + * name: String (Required) + * version: String (Required) + * description: String (Optional) + * tags (Optional): { + * String: String (Required) + * } + * } + * } + *+ * + * @param name The name of the resource. + * @param requestOptions The options to configure the HTTP request before HTTP client sends it. + * @throws HttpResponseException thrown if the request is rejected by server. + * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401. + * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404. + * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409. + * @return paged collection of DatasetVersion items along with {@link PagedResponse}. + */ + @ServiceMethod(returns = ReturnType.SINGLE) + private PagedResponse
Response Body Schema
+ * + *+ * {@code + * { + * type: String(uri_file/uri_folder) (Required) + * dataUri: String (Optional, Required on create) + * isReference: Boolean (Optional) + * connectionName: String (Optional) + * id: String (Optional) + * name: String (Required) + * version: String (Required) + * description: String (Optional) + * tags (Optional): { + * String: String (Required) + * } + * } + * } + *+ * + * @param name The name of the resource. + * @param requestOptions The options to configure the HTTP request before HTTP client sends it. + * @throws HttpResponseException thrown if the request is rejected by server. + * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401. + * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404. + * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409. + * @return paged collection of DatasetVersion items as paginated response with {@link PagedIterable}. + */ + @ServiceMethod(returns = ReturnType.COLLECTION) + public PagedIterable
Response Body Schema
+ * + *+ * {@code + * { + * type: String(uri_file/uri_folder) (Required) + * dataUri: String (Optional, Required on create) + * isReference: Boolean (Optional) + * connectionName: String (Optional) + * id: String (Optional) + * name: String (Required) + * version: String (Required) + * description: String (Optional) + * tags (Optional): { + * String: String (Required) + * } + * } + * } + *+ * + * @param requestOptions The options to configure the HTTP request before HTTP client sends it. + * @throws HttpResponseException thrown if the request is rejected by server. + * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401. + * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404. + * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409. + * @return paged collection of DatasetVersion items along with {@link PagedResponse} on successful completion of + * {@link Mono}. + */ + @ServiceMethod(returns = ReturnType.SINGLE) + private Mono
Response Body Schema
+ * + *+ * {@code + * { + * type: String(uri_file/uri_folder) (Required) + * dataUri: String (Optional, Required on create) + * isReference: Boolean (Optional) + * connectionName: String (Optional) + * id: String (Optional) + * name: String (Required) + * version: String (Required) + * description: String (Optional) + * tags (Optional): { + * String: String (Required) + * } + * } + * } + *+ * + * @param requestOptions The options to configure the HTTP request before HTTP client sends it. + * @throws HttpResponseException thrown if the request is rejected by server. + * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401. + * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404. + * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409. + * @return paged collection of DatasetVersion items as paginated response with {@link PagedFlux}. + */ + @ServiceMethod(returns = ReturnType.COLLECTION) + public PagedFlux
Response Body Schema
+ * + *+ * {@code + * { + * type: String(uri_file/uri_folder) (Required) + * dataUri: String (Optional, Required on create) + * isReference: Boolean (Optional) + * connectionName: String (Optional) + * id: String (Optional) + * name: String (Required) + * version: String (Required) + * description: String (Optional) + * tags (Optional): { + * String: String (Required) + * } + * } + * } + *+ * + * @param requestOptions The options to configure the HTTP request before HTTP client sends it. + * @throws HttpResponseException thrown if the request is rejected by server. + * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401. + * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404. + * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409. + * @return paged collection of DatasetVersion items along with {@link PagedResponse}. + */ + @ServiceMethod(returns = ReturnType.SINGLE) + private PagedResponse
Response Body Schema
+ * + *+ * {@code + * { + * type: String(uri_file/uri_folder) (Required) + * dataUri: String (Optional, Required on create) + * isReference: Boolean (Optional) + * connectionName: String (Optional) + * id: String (Optional) + * name: String (Required) + * version: String (Required) + * description: String (Optional) + * tags (Optional): { + * String: String (Required) + * } + * } + * } + *+ * + * @param requestOptions The options to configure the HTTP request before HTTP client sends it. + * @throws HttpResponseException thrown if the request is rejected by server. + * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401. + * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404. + * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409. + * @return paged collection of DatasetVersion items as paginated response with {@link PagedIterable}. + */ + @ServiceMethod(returns = ReturnType.COLLECTION) + public PagedIterable
Response Body Schema
+ * + *+ * {@code + * { + * type: String(uri_file/uri_folder) (Required) + * dataUri: String (Optional, Required on create) + * isReference: Boolean (Optional) + * connectionName: String (Optional) + * id: String (Optional) + * name: String (Required) + * version: String (Required) + * description: String (Optional) + * tags (Optional): { + * String: String (Required) + * } + * } + * } + *+ * + * @param name The name of the resource. + * @param version The specific version id of the DatasetVersion to retrieve. + * @param requestOptions The options to configure the HTTP request before HTTP client sends it. + * @throws HttpResponseException thrown if the request is rejected by server. + * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401. + * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404. + * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409. + * @return the specific version of the DatasetVersion along with {@link Response} on successful completion of + * {@link Mono}. + */ + @ServiceMethod(returns = ReturnType.SINGLE) + public Mono
Response Body Schema
+ * + *+ * {@code + * { + * type: String(uri_file/uri_folder) (Required) + * dataUri: String (Optional, Required on create) + * isReference: Boolean (Optional) + * connectionName: String (Optional) + * id: String (Optional) + * name: String (Required) + * version: String (Required) + * description: String (Optional) + * tags (Optional): { + * String: String (Required) + * } + * } + * } + *+ * + * @param name The name of the resource. + * @param version The specific version id of the DatasetVersion to retrieve. + * @param requestOptions The options to configure the HTTP request before HTTP client sends it. + * @throws HttpResponseException thrown if the request is rejected by server. + * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401. + * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404. + * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409. + * @return the specific version of the DatasetVersion along with {@link Response}. + */ + @ServiceMethod(returns = ReturnType.SINGLE) + public Response
Request Body Schema
+ * + *+ * {@code + * { + * type: String(uri_file/uri_folder) (Required) + * dataUri: String (Optional, Required on create) + * isReference: Boolean (Optional) + * connectionName: String (Optional) + * id: String (Optional) + * name: String (Required) + * version: String (Required) + * description: String (Optional) + * tags (Optional): { + * String: String (Required) + * } + * } + * } + *+ * + *
Response Body Schema
+ * + *+ * {@code + * { + * type: String(uri_file/uri_folder) (Required) + * dataUri: String (Optional, Required on create) + * isReference: Boolean (Optional) + * connectionName: String (Optional) + * id: String (Optional) + * name: String (Required) + * version: String (Required) + * description: String (Optional) + * tags (Optional): { + * String: String (Required) + * } + * } + * } + *+ * + * @param name The name of the resource. + * @param version The specific version id of the DatasetVersion to create or replace. + * @param body The definition of the DatasetVersion to create or update. + * @param requestOptions The options to configure the HTTP request before HTTP client sends it. + * @throws HttpResponseException thrown if the request is rejected by server. + * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401. + * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404. + * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409. + * @return datasetVersion Definition along with {@link Response} on successful completion of {@link Mono}. + */ + @ServiceMethod(returns = ReturnType.SINGLE) + public Mono
Request Body Schema
+ * + *+ * {@code + * { + * type: String(uri_file/uri_folder) (Required) + * dataUri: String (Optional, Required on create) + * isReference: Boolean (Optional) + * connectionName: String (Optional) + * id: String (Optional) + * name: String (Required) + * version: String (Required) + * description: String (Optional) + * tags (Optional): { + * String: String (Required) + * } + * } + * } + *+ * + *
Response Body Schema
+ * + *+ * {@code + * { + * type: String(uri_file/uri_folder) (Required) + * dataUri: String (Optional, Required on create) + * isReference: Boolean (Optional) + * connectionName: String (Optional) + * id: String (Optional) + * name: String (Required) + * version: String (Required) + * description: String (Optional) + * tags (Optional): { + * String: String (Required) + * } + * } + * } + *+ * + * @param name The name of the resource. + * @param version The specific version id of the DatasetVersion to create or replace. + * @param body The definition of the DatasetVersion to create or update. + * @param requestOptions The options to configure the HTTP request before HTTP client sends it. + * @throws HttpResponseException thrown if the request is rejected by server. + * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401. + * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404. + * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409. + * @return datasetVersion Definition along with {@link Response}. + */ + @ServiceMethod(returns = ReturnType.SINGLE) + public Response
Request Body Schema
+ * + *+ * {@code + * { + * pendingUploadId: String (Optional) + * connectionName: String (Optional) + * pendingUploadType: String(None/BlobReference) (Required) + * } + * } + *+ * + *
Response Body Schema
+ * + *+ * {@code + * { + * blobReference (Required): { + * blobUri: String (Required) + * storageAccountArmId: String (Required) + * credential (Required): { + * sasUri: String (Required) + * type: String (Required) + * } + * } + * pendingUploadId: String (Required) + * version: String (Optional) + * pendingUploadType: String(None/BlobReference) (Required) + * } + * } + *+ * + * @param name The name of the resource. + * @param version The specific version id of the DatasetVersion to operate on. + * @param body Parameters for the action. + * @param requestOptions The options to configure the HTTP request before HTTP client sends it. + * @throws HttpResponseException thrown if the request is rejected by server. + * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401. + * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404. + * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409. + * @return represents the response for a pending upload request along with {@link Response} on successful completion + * of {@link Mono}. + */ + @ServiceMethod(returns = ReturnType.SINGLE) + public Mono
Request Body Schema
+ * + *+ * {@code + * { + * pendingUploadId: String (Optional) + * connectionName: String (Optional) + * pendingUploadType: String(None/BlobReference) (Required) + * } + * } + *+ * + *
Response Body Schema
+ * + *+ * {@code + * { + * blobReference (Required): { + * blobUri: String (Required) + * storageAccountArmId: String (Required) + * credential (Required): { + * sasUri: String (Required) + * type: String (Required) + * } + * } + * pendingUploadId: String (Required) + * version: String (Optional) + * pendingUploadType: String(None/BlobReference) (Required) + * } + * } + *+ * + * @param name The name of the resource. + * @param version The specific version id of the DatasetVersion to operate on. + * @param body Parameters for the action. + * @param requestOptions The options to configure the HTTP request before HTTP client sends it. + * @throws HttpResponseException thrown if the request is rejected by server. + * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401. + * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404. + * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409. + * @return represents the response for a pending upload request along with {@link Response}. + */ + @ServiceMethod(returns = ReturnType.SINGLE) + public Response
Response Body Schema
+ * + *+ * {@code + * { + * blobReference (Required): { + * blobUri: String (Required) + * storageAccountArmId: String (Required) + * credential (Required): { + * sasUri: String (Required) + * type: String (Required) + * } + * } + * } + * } + *+ * + * @param name The name of the resource. + * @param version The specific version id of the DatasetVersion to operate on. + * @param requestOptions The options to configure the HTTP request before HTTP client sends it. + * @throws HttpResponseException thrown if the request is rejected by server. + * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401. + * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404. + * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409. + * @return the SAS credential to access the storage account associated with a Dataset version along with + * {@link Response} on successful completion of {@link Mono}. + */ + @ServiceMethod(returns = ReturnType.SINGLE) + public Mono
Response Body Schema
+ * + *+ * {@code + * { + * blobReference (Required): { + * blobUri: String (Required) + * storageAccountArmId: String (Required) + * credential (Required): { + * sasUri: String (Required) + * type: String (Required) + * } + * } + * } + * } + *+ * + * @param name The name of the resource. + * @param version The specific version id of the DatasetVersion to operate on. + * @param requestOptions The options to configure the HTTP request before HTTP client sends it. + * @throws HttpResponseException thrown if the request is rejected by server. + * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401. + * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404. + * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409. + * @return the SAS credential to access the storage account associated with a Dataset version along with + * {@link Response}. + */ + @ServiceMethod(returns = ReturnType.SINGLE) + public Response
Response Body Schema
+ * + *+ * {@code + * { + * type: String(uri_file/uri_folder) (Required) + * dataUri: String (Optional, Required on create) + * isReference: Boolean (Optional) + * connectionName: String (Optional) + * id: String (Optional) + * name: String (Required) + * version: String (Required) + * description: String (Optional) + * tags (Optional): { + * String: String (Required) + * } + * } + * } + *+ * + * @param nextLink The URL to get the next list of items. + * @param requestOptions The options to configure the HTTP request before HTTP client sends it. + * @throws HttpResponseException thrown if the request is rejected by server. + * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401. + * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404. + * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409. + * @return paged collection of DatasetVersion items along with {@link PagedResponse} on successful completion of + * {@link Mono}. + */ + @ServiceMethod(returns = ReturnType.SINGLE) + private Mono
Response Body Schema
+ * + *+ * {@code + * { + * type: String(uri_file/uri_folder) (Required) + * dataUri: String (Optional, Required on create) + * isReference: Boolean (Optional) + * connectionName: String (Optional) + * id: String (Optional) + * name: String (Required) + * version: String (Required) + * description: String (Optional) + * tags (Optional): { + * String: String (Required) + * } + * } + * } + *+ * + * @param nextLink The URL to get the next list of items. + * @param requestOptions The options to configure the HTTP request before HTTP client sends it. + * @throws HttpResponseException thrown if the request is rejected by server. + * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401. + * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404. + * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409. + * @return paged collection of DatasetVersion items along with {@link PagedResponse}. + */ + @ServiceMethod(returns = ReturnType.SINGLE) + private PagedResponse
Response Body Schema
+ * + *+ * {@code + * { + * type: String(uri_file/uri_folder) (Required) + * dataUri: String (Optional, Required on create) + * isReference: Boolean (Optional) + * connectionName: String (Optional) + * id: String (Optional) + * name: String (Required) + * version: String (Required) + * description: String (Optional) + * tags (Optional): { + * String: String (Required) + * } + * } + * } + *+ * + * @param nextLink The URL to get the next list of items. + * @param requestOptions The options to configure the HTTP request before HTTP client sends it. + * @throws HttpResponseException thrown if the request is rejected by server. + * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401. + * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404. + * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409. + * @return paged collection of DatasetVersion items along with {@link PagedResponse} on successful completion of + * {@link Mono}. + */ + @ServiceMethod(returns = ReturnType.SINGLE) + private Mono
Response Body Schema
+ * + *+ * {@code + * { + * type: String(uri_file/uri_folder) (Required) + * dataUri: String (Optional, Required on create) + * isReference: Boolean (Optional) + * connectionName: String (Optional) + * id: String (Optional) + * name: String (Required) + * version: String (Required) + * description: String (Optional) + * tags (Optional): { + * String: String (Required) + * } + * } + * } + *+ * + * @param nextLink The URL to get the next list of items. + * @param requestOptions The options to configure the HTTP request before HTTP client sends it. + * @throws HttpResponseException thrown if the request is rejected by server. + * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401. + * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404. + * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409. + * @return paged collection of DatasetVersion items along with {@link PagedResponse}. + */ + @ServiceMethod(returns = ReturnType.SINGLE) + private PagedResponse
Response Body Schema
+ * + *+ * {@code + * { + * type: String(ModelDeployment) (Required) + * name: String (Required) + * } + * } + *+ * + * @param name Name of the deployment. + * @param requestOptions The options to configure the HTTP request before HTTP client sends it. + * @throws HttpResponseException thrown if the request is rejected by server. + * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401. + * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404. + * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409. + * @return a deployed model along with {@link Response} on successful completion of {@link Mono}. + */ + @ServiceMethod(returns = ReturnType.SINGLE) + public Mono
Response Body Schema
+ * + *+ * {@code + * { + * type: String(ModelDeployment) (Required) + * name: String (Required) + * } + * } + *+ * + * @param name Name of the deployment. + * @param requestOptions The options to configure the HTTP request before HTTP client sends it. + * @throws HttpResponseException thrown if the request is rejected by server. + * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401. + * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404. + * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409. + * @return a deployed model along with {@link Response}. + */ + @ServiceMethod(returns = ReturnType.SINGLE) + public Response
Query Parameters
+ *Name | Type | Required | Description |
---|---|---|---|
modelPublisher | String | No | Model publisher to filter models by |
modelName | String | No | Model name (the publisher specific name) to filter models + * by |
deploymentType | String | No | Type of deployment to filter list by. Allowed values: + * "ModelDeployment". |
Response Body Schema
+ * + *+ * {@code + * { + * type: String(ModelDeployment) (Required) + * name: String (Required) + * } + * } + *+ * + * @param requestOptions The options to configure the HTTP request before HTTP client sends it. + * @throws HttpResponseException thrown if the request is rejected by server. + * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401. + * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404. + * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409. + * @return paged collection of Deployment items along with {@link PagedResponse} on successful completion of + * {@link Mono}. + */ + @ServiceMethod(returns = ReturnType.SINGLE) + private Mono
Query Parameters
+ *Name | Type | Required | Description |
---|---|---|---|
modelPublisher | String | No | Model publisher to filter models by |
modelName | String | No | Model name (the publisher specific name) to filter models + * by |
deploymentType | String | No | Type of deployment to filter list by. Allowed values: + * "ModelDeployment". |
Response Body Schema
+ * + *+ * {@code + * { + * type: String(ModelDeployment) (Required) + * name: String (Required) + * } + * } + *+ * + * @param requestOptions The options to configure the HTTP request before HTTP client sends it. + * @throws HttpResponseException thrown if the request is rejected by server. + * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401. + * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404. + * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409. + * @return paged collection of Deployment items as paginated response with {@link PagedFlux}. + */ + @ServiceMethod(returns = ReturnType.COLLECTION) + public PagedFlux
Query Parameters
+ *Name | Type | Required | Description |
---|---|---|---|
modelPublisher | String | No | Model publisher to filter models by |
modelName | String | No | Model name (the publisher specific name) to filter models + * by |
deploymentType | String | No | Type of deployment to filter list by. Allowed values: + * "ModelDeployment". |
Response Body Schema
+ * + *+ * {@code + * { + * type: String(ModelDeployment) (Required) + * name: String (Required) + * } + * } + *+ * + * @param requestOptions The options to configure the HTTP request before HTTP client sends it. + * @throws HttpResponseException thrown if the request is rejected by server. + * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401. + * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404. + * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409. + * @return paged collection of Deployment items along with {@link PagedResponse}. + */ + @ServiceMethod(returns = ReturnType.SINGLE) + private PagedResponse
Query Parameters
+ *Name | Type | Required | Description |
---|---|---|---|
modelPublisher | String | No | Model publisher to filter models by |
modelName | String | No | Model name (the publisher specific name) to filter models + * by |
deploymentType | String | No | Type of deployment to filter list by. Allowed values: + * "ModelDeployment". |
Response Body Schema
+ * + *+ * {@code + * { + * type: String(ModelDeployment) (Required) + * name: String (Required) + * } + * } + *+ * + * @param requestOptions The options to configure the HTTP request before HTTP client sends it. + * @throws HttpResponseException thrown if the request is rejected by server. + * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401. + * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404. + * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409. + * @return paged collection of Deployment items as paginated response with {@link PagedIterable}. + */ + @ServiceMethod(returns = ReturnType.COLLECTION) + public PagedIterable
Response Body Schema
+ * + *+ * {@code + * { + * type: String(ModelDeployment) (Required) + * name: String (Required) + * } + * } + *+ * + * @param nextLink The URL to get the next list of items. + * @param requestOptions The options to configure the HTTP request before HTTP client sends it. + * @throws HttpResponseException thrown if the request is rejected by server. + * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401. + * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404. + * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409. + * @return paged collection of Deployment items along with {@link PagedResponse} on successful completion of + * {@link Mono}. + */ + @ServiceMethod(returns = ReturnType.SINGLE) + private Mono
Response Body Schema
+ * + *+ * {@code + * { + * type: String(ModelDeployment) (Required) + * name: String (Required) + * } + * } + *+ * + * @param nextLink The URL to get the next list of items. + * @param requestOptions The options to configure the HTTP request before HTTP client sends it. + * @throws HttpResponseException thrown if the request is rejected by server. + * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401. + * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404. + * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409. + * @return paged collection of Deployment items along with {@link PagedResponse}. + */ + @ServiceMethod(returns = ReturnType.SINGLE) + private PagedResponse
Response Body Schema
+ * + *+ * {@code + * { + * id: String (Required) + * data (Required): { + * type: String (Required) + * } + * displayName: String (Optional) + * description: String (Optional) + * status: String (Optional) + * tags (Optional): { + * String: String (Required) + * } + * properties (Optional): { + * String: String (Required) + * } + * evaluators (Required): { + * String (Required): { + * id: String (Required) + * initParams (Optional): { + * String: BinaryData (Required) + * } + * dataMapping (Optional): { + * String: String (Required) + * } + * } + * } + * } + * } + *+ * + * @param name Identifier of the evaluation. + * @param requestOptions The options to configure the HTTP request before HTTP client sends it. + * @throws HttpResponseException thrown if the request is rejected by server. + * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401. + * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404. + * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409. + * @return an evaluation run by name along with {@link Response} on successful completion of {@link Mono}. + */ + @ServiceMethod(returns = ReturnType.SINGLE) + public Mono
Response Body Schema
+ * + *+ * {@code + * { + * id: String (Required) + * data (Required): { + * type: String (Required) + * } + * displayName: String (Optional) + * description: String (Optional) + * status: String (Optional) + * tags (Optional): { + * String: String (Required) + * } + * properties (Optional): { + * String: String (Required) + * } + * evaluators (Required): { + * String (Required): { + * id: String (Required) + * initParams (Optional): { + * String: BinaryData (Required) + * } + * dataMapping (Optional): { + * String: String (Required) + * } + * } + * } + * } + * } + *+ * + * @param name Identifier of the evaluation. + * @param requestOptions The options to configure the HTTP request before HTTP client sends it. + * @throws HttpResponseException thrown if the request is rejected by server. + * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401. + * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404. + * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409. + * @return an evaluation run by name along with {@link Response}. + */ + @ServiceMethod(returns = ReturnType.SINGLE) + public Response
Response Body Schema
+ * + *+ * {@code + * { + * id: String (Required) + * data (Required): { + * type: String (Required) + * } + * displayName: String (Optional) + * description: String (Optional) + * status: String (Optional) + * tags (Optional): { + * String: String (Required) + * } + * properties (Optional): { + * String: String (Required) + * } + * evaluators (Required): { + * String (Required): { + * id: String (Required) + * initParams (Optional): { + * String: BinaryData (Required) + * } + * dataMapping (Optional): { + * String: String (Required) + * } + * } + * } + * } + * } + *+ * + * @param requestOptions The options to configure the HTTP request before HTTP client sends it. + * @throws HttpResponseException thrown if the request is rejected by server. + * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401. + * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404. + * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409. + * @return paged collection of Evaluation items along with {@link PagedResponse} on successful completion of + * {@link Mono}. + */ + @ServiceMethod(returns = ReturnType.SINGLE) + private Mono
Response Body Schema
+ * + *+ * {@code + * { + * id: String (Required) + * data (Required): { + * type: String (Required) + * } + * displayName: String (Optional) + * description: String (Optional) + * status: String (Optional) + * tags (Optional): { + * String: String (Required) + * } + * properties (Optional): { + * String: String (Required) + * } + * evaluators (Required): { + * String (Required): { + * id: String (Required) + * initParams (Optional): { + * String: BinaryData (Required) + * } + * dataMapping (Optional): { + * String: String (Required) + * } + * } + * } + * } + * } + *+ * + * @param requestOptions The options to configure the HTTP request before HTTP client sends it. + * @throws HttpResponseException thrown if the request is rejected by server. + * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401. + * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404. + * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409. + * @return paged collection of Evaluation items as paginated response with {@link PagedFlux}. + */ + @ServiceMethod(returns = ReturnType.COLLECTION) + public PagedFlux
Response Body Schema
+ * + *+ * {@code + * { + * id: String (Required) + * data (Required): { + * type: String (Required) + * } + * displayName: String (Optional) + * description: String (Optional) + * status: String (Optional) + * tags (Optional): { + * String: String (Required) + * } + * properties (Optional): { + * String: String (Required) + * } + * evaluators (Required): { + * String (Required): { + * id: String (Required) + * initParams (Optional): { + * String: BinaryData (Required) + * } + * dataMapping (Optional): { + * String: String (Required) + * } + * } + * } + * } + * } + *+ * + * @param requestOptions The options to configure the HTTP request before HTTP client sends it. + * @throws HttpResponseException thrown if the request is rejected by server. + * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401. + * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404. + * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409. + * @return paged collection of Evaluation items along with {@link PagedResponse}. + */ + @ServiceMethod(returns = ReturnType.SINGLE) + private PagedResponse
Response Body Schema
+ * + *+ * {@code + * { + * id: String (Required) + * data (Required): { + * type: String (Required) + * } + * displayName: String (Optional) + * description: String (Optional) + * status: String (Optional) + * tags (Optional): { + * String: String (Required) + * } + * properties (Optional): { + * String: String (Required) + * } + * evaluators (Required): { + * String (Required): { + * id: String (Required) + * initParams (Optional): { + * String: BinaryData (Required) + * } + * dataMapping (Optional): { + * String: String (Required) + * } + * } + * } + * } + * } + *+ * + * @param requestOptions The options to configure the HTTP request before HTTP client sends it. + * @throws HttpResponseException thrown if the request is rejected by server. + * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401. + * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404. + * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409. + * @return paged collection of Evaluation items as paginated response with {@link PagedIterable}. + */ + @ServiceMethod(returns = ReturnType.COLLECTION) + public PagedIterable
Request Body Schema
+ * + *+ * {@code + * { + * id: String (Required) + * data (Required): { + * type: String (Required) + * } + * displayName: String (Optional) + * description: String (Optional) + * status: String (Optional) + * tags (Optional): { + * String: String (Required) + * } + * properties (Optional): { + * String: String (Required) + * } + * evaluators (Required): { + * String (Required): { + * id: String (Required) + * initParams (Optional): { + * String: BinaryData (Required) + * } + * dataMapping (Optional): { + * String: String (Required) + * } + * } + * } + * } + * } + *+ * + *
Response Body Schema
+ * + *+ * {@code + * { + * id: String (Required) + * data (Required): { + * type: String (Required) + * } + * displayName: String (Optional) + * description: String (Optional) + * status: String (Optional) + * tags (Optional): { + * String: String (Required) + * } + * properties (Optional): { + * String: String (Required) + * } + * evaluators (Required): { + * String (Required): { + * id: String (Required) + * initParams (Optional): { + * String: BinaryData (Required) + * } + * dataMapping (Optional): { + * String: String (Required) + * } + * } + * } + * } + * } + *+ * + * @param evaluation Evaluation to be run. + * @param requestOptions The options to configure the HTTP request before HTTP client sends it. + * @throws HttpResponseException thrown if the request is rejected by server. + * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401. + * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404. + * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409. + * @return evaluation Definition along with {@link Response} on successful completion of {@link Mono}. + */ + @ServiceMethod(returns = ReturnType.SINGLE) + public Mono
Request Body Schema
+ * + *+ * {@code + * { + * id: String (Required) + * data (Required): { + * type: String (Required) + * } + * displayName: String (Optional) + * description: String (Optional) + * status: String (Optional) + * tags (Optional): { + * String: String (Required) + * } + * properties (Optional): { + * String: String (Required) + * } + * evaluators (Required): { + * String (Required): { + * id: String (Required) + * initParams (Optional): { + * String: BinaryData (Required) + * } + * dataMapping (Optional): { + * String: String (Required) + * } + * } + * } + * } + * } + *+ * + *
Response Body Schema
+ * + *+ * {@code + * { + * id: String (Required) + * data (Required): { + * type: String (Required) + * } + * displayName: String (Optional) + * description: String (Optional) + * status: String (Optional) + * tags (Optional): { + * String: String (Required) + * } + * properties (Optional): { + * String: String (Required) + * } + * evaluators (Required): { + * String (Required): { + * id: String (Required) + * initParams (Optional): { + * String: BinaryData (Required) + * } + * dataMapping (Optional): { + * String: String (Required) + * } + * } + * } + * } + * } + *+ * + * @param evaluation Evaluation to be run. + * @param requestOptions The options to configure the HTTP request before HTTP client sends it. + * @throws HttpResponseException thrown if the request is rejected by server. + * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401. + * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404. + * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409. + * @return evaluation Definition along with {@link Response}. + */ + @ServiceMethod(returns = ReturnType.SINGLE) + public Response
Request Body Schema
+ * + *+ * {@code + * { + * runId: String (Required) + * threadId: String (Optional) + * evaluators (Required): { + * String (Required): { + * id: String (Required) + * initParams (Optional): { + * String: BinaryData (Required) + * } + * dataMapping (Optional): { + * String: String (Required) + * } + * } + * } + * samplingConfiguration (Optional): { + * name: String (Required) + * samplingPercent: double (Required) + * maxRequestRate: double (Required) + * } + * redactionConfiguration (Optional): { + * redactScoreProperties: Boolean (Optional) + * } + * appInsightsConnectionString: String (Required) + * } + * } + *+ * + *
Response Body Schema
+ * + *+ * {@code + * { + * id: String (Required) + * status: String (Required) + * error: String (Optional) + * result (Optional): [ + * (Optional){ + * evaluator: String (Required) + * evaluatorId: String (Required) + * score: double (Required) + * status: String (Required) + * reason: String (Optional) + * version: String (Optional) + * threadId: String (Optional) + * runId: String (Required) + * error: String (Optional) + * additionalDetails (Optional): { + * String: String (Required) + * } + * } + * ] + * } + * } + *+ * + * @param evaluation Agent evaluation to be run. + * @param requestOptions The options to configure the HTTP request before HTTP client sends it. + * @throws HttpResponseException thrown if the request is rejected by server. + * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401. + * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404. + * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409. + * @return evaluation response for agent evaluation run along with {@link Response} on successful completion of + * {@link Mono}. + */ + @ServiceMethod(returns = ReturnType.SINGLE) + public Mono
Request Body Schema
+ * + *+ * {@code + * { + * runId: String (Required) + * threadId: String (Optional) + * evaluators (Required): { + * String (Required): { + * id: String (Required) + * initParams (Optional): { + * String: BinaryData (Required) + * } + * dataMapping (Optional): { + * String: String (Required) + * } + * } + * } + * samplingConfiguration (Optional): { + * name: String (Required) + * samplingPercent: double (Required) + * maxRequestRate: double (Required) + * } + * redactionConfiguration (Optional): { + * redactScoreProperties: Boolean (Optional) + * } + * appInsightsConnectionString: String (Required) + * } + * } + *+ * + *
Response Body Schema
+ * + *+ * {@code + * { + * id: String (Required) + * status: String (Required) + * error: String (Optional) + * result (Optional): [ + * (Optional){ + * evaluator: String (Required) + * evaluatorId: String (Required) + * score: double (Required) + * status: String (Required) + * reason: String (Optional) + * version: String (Optional) + * threadId: String (Optional) + * runId: String (Required) + * error: String (Optional) + * additionalDetails (Optional): { + * String: String (Required) + * } + * } + * ] + * } + * } + *+ * + * @param evaluation Agent evaluation to be run. + * @param requestOptions The options to configure the HTTP request before HTTP client sends it. + * @throws HttpResponseException thrown if the request is rejected by server. + * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401. + * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404. + * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409. + * @return evaluation response for agent evaluation run along with {@link Response}. + */ + @ServiceMethod(returns = ReturnType.SINGLE) + public Response
Response Body Schema
+ * + *+ * {@code + * { + * id: String (Required) + * data (Required): { + * type: String (Required) + * } + * displayName: String (Optional) + * description: String (Optional) + * status: String (Optional) + * tags (Optional): { + * String: String (Required) + * } + * properties (Optional): { + * String: String (Required) + * } + * evaluators (Required): { + * String (Required): { + * id: String (Required) + * initParams (Optional): { + * String: BinaryData (Required) + * } + * dataMapping (Optional): { + * String: String (Required) + * } + * } + * } + * } + * } + *+ * + * @param nextLink The URL to get the next list of items. + * @param requestOptions The options to configure the HTTP request before HTTP client sends it. + * @throws HttpResponseException thrown if the request is rejected by server. + * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401. + * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404. + * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409. + * @return paged collection of Evaluation items along with {@link PagedResponse} on successful completion of + * {@link Mono}. + */ + @ServiceMethod(returns = ReturnType.SINGLE) + private Mono
Response Body Schema
+ * + *+ * {@code + * { + * id: String (Required) + * data (Required): { + * type: String (Required) + * } + * displayName: String (Optional) + * description: String (Optional) + * status: String (Optional) + * tags (Optional): { + * String: String (Required) + * } + * properties (Optional): { + * String: String (Required) + * } + * evaluators (Required): { + * String (Required): { + * id: String (Required) + * initParams (Optional): { + * String: BinaryData (Required) + * } + * dataMapping (Optional): { + * String: String (Required) + * } + * } + * } + * } + * } + *+ * + * @param nextLink The URL to get the next list of items. + * @param requestOptions The options to configure the HTTP request before HTTP client sends it. + * @throws HttpResponseException thrown if the request is rejected by server. + * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401. + * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404. + * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409. + * @return paged collection of Evaluation items along with {@link PagedResponse}. + */ + @ServiceMethod(returns = ReturnType.SINGLE) + private PagedResponse