Class GenerativeAiClient

Service client instance for GenerativeAi.

Inheritance

object

ClientBase

RegionalClientBase

GenerativeAiClient

Implements

IDisposable

Inherited Members

RegionalClientBase.logger

RegionalClientBase.SetRegion(Region)

RegionalClientBase.SetRegion(string)

RegionalClientBase.UseRealmSpecificEndpointTemplate(bool)

RegionalClientBase.PopulateServiceParametersInEndpointTemplate(RestClient, Dictionary<string, object>)

RegionalClientBase.parseEndpointForParameters(string)

ClientBase.restClient

ClientBase.service

ClientBase.userAgent

ClientBase.Dispose()

ClientBase.Dispose(bool)

ClientBase.SetEndpoint(string)

ClientBase.GetEndpoint()

ClientBase.GetUserAgent()

ClientBase.SetRealmSpecificEndpointTemplate(string)

ClientBase.EnableDualStackEndpoints(bool)

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Oci.GenerativeaiService

Assembly: OCI.DotNetSDK.Generativeai.dll

Syntax

public class GenerativeAiClient : RegionalClientBase, IDisposable

Constructors

GenerativeAiClient(IBasicAuthenticationDetailsProvider, ClientConfiguration, string)

Creates a new service instance using the given authentication provider and/or client configuration and/or endpoint. A client configuration can also be provided optionally to adjust REST client behaviors.

Declaration

public GenerativeAiClient(IBasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration clientConfiguration = null, string endpoint = null)

Parameters

Type	Name	Description
IBasicAuthenticationDetailsProvider	authenticationDetailsProvider	The authentication details provider. Required.
ClientConfiguration	clientConfiguration	The client configuration that contains settings to adjust REST client behaviors. Optional.
string	endpoint	The endpoint of the service. If not provided and the client is a regional client, the endpoint will be constructed based on region information. Optional.

Properties

Paginators

Declaration

public GenerativeAiPaginators Paginators { get; }

Property Value

Type	Description
GenerativeAiPaginators

Waiters

Declaration

public GenerativeAiWaiters Waiters { get; }

Property Value

Type	Description
GenerativeAiWaiters

Methods

AddArtifact(AddArtifactRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

add image with isAutoDeploy flag.

Declaration

public Task<AddArtifactResponse> AddArtifact(AddArtifactRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
AddArtifactRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<AddArtifactResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use AddArtifact API.

CancelVectorStoreConnectorFileSync(CancelVectorStoreConnectorFileSyncRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Cancels a vectorStoreConnectorFileSync.

Declaration

public Task<CancelVectorStoreConnectorFileSyncResponse> CancelVectorStoreConnectorFileSync(CancelVectorStoreConnectorFileSyncRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
CancelVectorStoreConnectorFileSyncRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<CancelVectorStoreConnectorFileSyncResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use CancelVectorStoreConnectorFileSync API.

ChangeApiKeyCompartment(ChangeApiKeyCompartmentRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Moves an API key into a different compartment within the same tenancy. For information about moving resources between compartments, see Moving Resources to a Different Compartment.

Declaration

public Task<ChangeApiKeyCompartmentResponse> ChangeApiKeyCompartment(ChangeApiKeyCompartmentRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ChangeApiKeyCompartmentRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<ChangeApiKeyCompartmentResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use ChangeApiKeyCompartment API.

ChangeDedicatedAiClusterCompartment(ChangeDedicatedAiClusterCompartmentRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Moves a dedicated AI cluster into a different compartment within the same tenancy. For information about moving resources between compartments, see Moving Resources to a Different Compartment.

Declaration

public Task<ChangeDedicatedAiClusterCompartmentResponse> ChangeDedicatedAiClusterCompartment(ChangeDedicatedAiClusterCompartmentRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ChangeDedicatedAiClusterCompartmentRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<ChangeDedicatedAiClusterCompartmentResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use ChangeDedicatedAiClusterCompartment API.

ChangeEndpointCompartment(ChangeEndpointCompartmentRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Moves an endpoint into a different compartment within the same tenancy. For information about moving resources between compartments, see Moving Resources to a Different Compartment.

Declaration

public Task<ChangeEndpointCompartmentResponse> ChangeEndpointCompartment(ChangeEndpointCompartmentRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ChangeEndpointCompartmentRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<ChangeEndpointCompartmentResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use ChangeEndpointCompartment API.

ChangeGenerativeAiPrivateEndpointCompartment(ChangeGenerativeAiPrivateEndpointCompartmentRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Moves a Generative AI private endpoint into a different compartment. When provided, If-Match is checked against ETag values of the resource.

Declaration

public Task<ChangeGenerativeAiPrivateEndpointCompartmentResponse> ChangeGenerativeAiPrivateEndpointCompartment(ChangeGenerativeAiPrivateEndpointCompartmentRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ChangeGenerativeAiPrivateEndpointCompartmentRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<ChangeGenerativeAiPrivateEndpointCompartmentResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use ChangeGenerativeAiPrivateEndpointCompartment API.

ChangeGenerativeAiProjectCompartment(ChangeGenerativeAiProjectCompartmentRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Moves a generativeAiProject into a different compartment within the same tenancy. For information about moving resources between compartments, see Moving Resources to a Different Compartment.

Declaration

public Task<ChangeGenerativeAiProjectCompartmentResponse> ChangeGenerativeAiProjectCompartment(ChangeGenerativeAiProjectCompartmentRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ChangeGenerativeAiProjectCompartmentRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<ChangeGenerativeAiProjectCompartmentResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use ChangeGenerativeAiProjectCompartment API.

ChangeHostedApplicationCompartment(ChangeHostedApplicationCompartmentRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Moves a hosted application into a different compartment within the same tenancy. For information about moving resources between compartments, see Moving Resources to a Different Compartment.

Declaration

public Task<ChangeHostedApplicationCompartmentResponse> ChangeHostedApplicationCompartment(ChangeHostedApplicationCompartmentRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ChangeHostedApplicationCompartmentRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<ChangeHostedApplicationCompartmentResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use ChangeHostedApplicationCompartment API.

ChangeHostedApplicationStorageCompartment(ChangeHostedApplicationStorageCompartmentRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Moves a hosted application storage into a different compartment within the same tenancy. For information about moving resources between compartments, see Moving Resources to a Different Compartment.

Declaration

public Task<ChangeHostedApplicationStorageCompartmentResponse> ChangeHostedApplicationStorageCompartment(ChangeHostedApplicationStorageCompartmentRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ChangeHostedApplicationStorageCompartmentRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<ChangeHostedApplicationStorageCompartmentResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use ChangeHostedApplicationStorageCompartment API.

ChangeImportedModelCompartment(ChangeImportedModelCompartmentRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Moves an imported model into a different compartment. For information about moving resources between compartments, see Moving Resources to a Different Compartment.

Declaration

public Task<ChangeImportedModelCompartmentResponse> ChangeImportedModelCompartment(ChangeImportedModelCompartmentRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ChangeImportedModelCompartmentRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<ChangeImportedModelCompartmentResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use ChangeImportedModelCompartment API.

ChangeModelCompartment(ChangeModelCompartmentRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Moves a custom model into a different compartment. For information about moving resources between compartments, see Moving Resources to a Different Compartment.

Declaration

public Task<ChangeModelCompartmentResponse> ChangeModelCompartment(ChangeModelCompartmentRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ChangeModelCompartmentRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<ChangeModelCompartmentResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use ChangeModelCompartment API.

ChangeSemanticStoreCompartment(ChangeSemanticStoreCompartmentRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Moves a SemanticStore into a different compartment within the same tenancy. For information about moving resources between compartments, see Moving Resources to a Different Compartment.

Declaration

public Task<ChangeSemanticStoreCompartmentResponse> ChangeSemanticStoreCompartment(ChangeSemanticStoreCompartmentRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ChangeSemanticStoreCompartmentRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<ChangeSemanticStoreCompartmentResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use ChangeSemanticStoreCompartment API.

CreateApiKey(CreateApiKeyRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Creates a new API key in the specified compartment.

Declaration

public Task<CreateApiKeyResponse> CreateApiKey(CreateApiKeyRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
CreateApiKeyRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<CreateApiKeyResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use CreateApiKey API.

CreateDedicatedAiCluster(CreateDedicatedAiClusterRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Creates a dedicated AI cluster.

Declaration

public Task<CreateDedicatedAiClusterResponse> CreateDedicatedAiCluster(CreateDedicatedAiClusterRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
CreateDedicatedAiClusterRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<CreateDedicatedAiClusterResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use CreateDedicatedAiCluster API.

CreateEndpoint(CreateEndpointRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Creates an endpoint. <br/> The header contains an opc-work-request-id, which is the id for the WorkRequest that tracks the endpoint creation progress.

Declaration

public Task<CreateEndpointResponse> CreateEndpoint(CreateEndpointRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
CreateEndpointRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<CreateEndpointResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use CreateEndpoint API.

CreateGenerativeAiPrivateEndpoint(CreateGenerativeAiPrivateEndpointRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Creates a Generative AI private endpoint.

Declaration

public Task<CreateGenerativeAiPrivateEndpointResponse> CreateGenerativeAiPrivateEndpoint(CreateGenerativeAiPrivateEndpointRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
CreateGenerativeAiPrivateEndpointRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<CreateGenerativeAiPrivateEndpointResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use CreateGenerativeAiPrivateEndpoint API.

CreateGenerativeAiProject(CreateGenerativeAiProjectRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Creates a GenerativeAiProject. The header contains an opc-work-request-id, which is the id for the WorkRequest that tracks the generativeAiProject creation progress.

Declaration

public Task<CreateGenerativeAiProjectResponse> CreateGenerativeAiProject(CreateGenerativeAiProjectRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
CreateGenerativeAiProjectRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<CreateGenerativeAiProjectResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use CreateGenerativeAiProject API.

CreateHostedApplication(CreateHostedApplicationRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Creates a hosted application.

Declaration

public Task<CreateHostedApplicationResponse> CreateHostedApplication(CreateHostedApplicationRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
CreateHostedApplicationRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<CreateHostedApplicationResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use CreateHostedApplication API.

CreateHostedApplicationStorage(CreateHostedApplicationStorageRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Creates a hosted application storage.

Declaration

public Task<CreateHostedApplicationStorageResponse> CreateHostedApplicationStorage(CreateHostedApplicationStorageRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
CreateHostedApplicationStorageRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<CreateHostedApplicationStorageResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use CreateHostedApplicationStorage API.

CreateHostedDeployment(CreateHostedDeploymentRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Creates a hosted deployment.

Declaration

public Task<CreateHostedDeploymentResponse> CreateHostedDeployment(CreateHostedDeploymentRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
CreateHostedDeploymentRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<CreateHostedDeploymentResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use CreateHostedDeployment API.

CreateImportedModel(CreateImportedModelRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Import a model from ModelDataSource. <br/> The header contains an opc-work-request-id, which is the id for the WorkRequest that tracks the importedModel creation progress.

Declaration

public Task<CreateImportedModelResponse> CreateImportedModel(CreateImportedModelRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
CreateImportedModelRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<CreateImportedModelResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use CreateImportedModel API.

CreateModel(CreateModelRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Creates a custom model by fine-tuning a base model with your own dataset. You can create a new custom models or create a new version of existing custom model.. <br/> The header contains an opc-work-request-id, which is the id for the WorkRequest that tracks the model creation progress.

Declaration

public Task<CreateModelResponse> CreateModel(CreateModelRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
CreateModelRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<CreateModelResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use CreateModel API.

CreateSemanticStore(CreateSemanticStoreRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Creates a SemanticStore.

Declaration

public Task<CreateSemanticStoreResponse> CreateSemanticStore(CreateSemanticStoreRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
CreateSemanticStoreRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<CreateSemanticStoreResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use CreateSemanticStore API.

CreateVectorStoreConnector(CreateVectorStoreConnectorRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Creates a VectorStoreConnector. The header contains an opc-work-request-id, which is the id for the WorkRequest that tracks the vectorStoreConnector creation progress.

Declaration

public Task<CreateVectorStoreConnectorResponse> CreateVectorStoreConnector(CreateVectorStoreConnectorRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
CreateVectorStoreConnectorRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<CreateVectorStoreConnectorResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use CreateVectorStoreConnector API.

CreateVectorStoreConnectorFileSync(CreateVectorStoreConnectorFileSyncRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Creates a File Sync operation for a VectorStoreConnector. The header contains an opc-work-request-id, which is the id for the WorkRequest that tracks the vectorStoreConnectorFileSync creation progress.

Declaration

public Task<CreateVectorStoreConnectorFileSyncResponse> CreateVectorStoreConnectorFileSync(CreateVectorStoreConnectorFileSyncRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
CreateVectorStoreConnectorFileSyncRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<CreateVectorStoreConnectorFileSyncResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use CreateVectorStoreConnectorFileSync API.

DeleteApiKey(DeleteApiKeyRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Deletes an API key.

Declaration

public Task<DeleteApiKeyResponse> DeleteApiKey(DeleteApiKeyRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
DeleteApiKeyRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<DeleteApiKeyResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use DeleteApiKey API.

DeleteDedicatedAiCluster(DeleteDedicatedAiClusterRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Deletes a dedicated AI cluster. <br/> You can only delete clusters without attached resources. Before you delete a hosting dedicated AI cluster, you must delete the endpoints associated to that cluster. Before you delete a fine-tuning dedicated AI cluster, you must delete the custom model on that cluster. The delete action permanently deletes the cluster. This action can't be undone.

Declaration

public Task<DeleteDedicatedAiClusterResponse> DeleteDedicatedAiCluster(DeleteDedicatedAiClusterRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
DeleteDedicatedAiClusterRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<DeleteDedicatedAiClusterResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use DeleteDedicatedAiCluster API.

DeleteEndpoint(DeleteEndpointRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Deletes an endpoint.

Declaration

public Task<DeleteEndpointResponse> DeleteEndpoint(DeleteEndpointRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
DeleteEndpointRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<DeleteEndpointResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use DeleteEndpoint API.

DeleteGenerativeAiPrivateEndpoint(DeleteGenerativeAiPrivateEndpointRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Deletes a Generative AI private endpoint using privateEndpointId.

Declaration

public Task<DeleteGenerativeAiPrivateEndpointResponse> DeleteGenerativeAiPrivateEndpoint(DeleteGenerativeAiPrivateEndpointRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
DeleteGenerativeAiPrivateEndpointRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<DeleteGenerativeAiPrivateEndpointResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use DeleteGenerativeAiPrivateEndpoint API.

DeleteGenerativeAiProject(DeleteGenerativeAiProjectRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Deletes a generativeAiProject.

Declaration

public Task<DeleteGenerativeAiProjectResponse> DeleteGenerativeAiProject(DeleteGenerativeAiProjectRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
DeleteGenerativeAiProjectRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<DeleteGenerativeAiProjectResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use DeleteGenerativeAiProject API.

DeleteHostedApplication(DeleteHostedApplicationRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Deletes a hosted application. You can only delete hosted application without attached resources. Before you delete a hosting hosted application, you must delete the endpoints associated to that application. Before you delete a fine-tuning hosted application, you must delete the custom model on that application. The delete action permanently deletes the cluster. This action can't be undone.

Declaration

public Task<DeleteHostedApplicationResponse> DeleteHostedApplication(DeleteHostedApplicationRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
DeleteHostedApplicationRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<DeleteHostedApplicationResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use DeleteHostedApplication API.

DeleteHostedApplicationStorage(DeleteHostedApplicationStorageRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Declaration

public Task<DeleteHostedApplicationStorageResponse> DeleteHostedApplicationStorage(DeleteHostedApplicationStorageRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
DeleteHostedApplicationStorageRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<DeleteHostedApplicationStorageResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use DeleteHostedApplicationStorage API.

DeleteHostedDeployment(DeleteHostedDeploymentRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Deletes a hosted deployment. You can only delete hosted deployment without attached resources. Before you delete a hosting hosted deployment, you must delete the endpoints associated to that deployment. Before you delete a fine-tuning hosted deployment, you must delete the custom model on that deployment. The delete action permanently deletes the cluster. This action can't be undone.

Declaration

public Task<DeleteHostedDeploymentResponse> DeleteHostedDeployment(DeleteHostedDeploymentRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
DeleteHostedDeploymentRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<DeleteHostedDeploymentResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use DeleteHostedDeployment API.

DeleteHostedDeploymentArtifact(DeleteHostedDeploymentArtifactRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

delete artifact.

Declaration

public Task<DeleteHostedDeploymentArtifactResponse> DeleteHostedDeploymentArtifact(DeleteHostedDeploymentArtifactRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
DeleteHostedDeploymentArtifactRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<DeleteHostedDeploymentArtifactResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use DeleteHostedDeploymentArtifact API.

DeleteImportedModel(DeleteImportedModelRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Deletes an imported model. An imported model shouldn't be deleted if there's one or more active endpoints associated with that imported model.

Declaration

public Task<DeleteImportedModelResponse> DeleteImportedModel(DeleteImportedModelRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
DeleteImportedModelRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<DeleteImportedModelResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use DeleteImportedModel API.

DeleteModel(DeleteModelRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Deletes a custom model. A model shouldn't be deleted if there's one or more active endpoints associated with that model.

Declaration

public Task<DeleteModelResponse> DeleteModel(DeleteModelRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
DeleteModelRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<DeleteModelResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use DeleteModel API.

DeleteSemanticStore(DeleteSemanticStoreRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Deletes a semanticStore.

Declaration

public Task<DeleteSemanticStoreResponse> DeleteSemanticStore(DeleteSemanticStoreRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
DeleteSemanticStoreRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<DeleteSemanticStoreResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use DeleteSemanticStore API.

DeleteVectorStoreConnector(DeleteVectorStoreConnectorRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Deletes a vectorStoreConnector.

Declaration

public Task<DeleteVectorStoreConnectorResponse> DeleteVectorStoreConnector(DeleteVectorStoreConnectorRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
DeleteVectorStoreConnectorRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<DeleteVectorStoreConnectorResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use DeleteVectorStoreConnector API.

GetApiKey(GetApiKeyRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Gets information about an API key.

Declaration

public Task<GetApiKeyResponse> GetApiKey(GetApiKeyRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
GetApiKeyRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<GetApiKeyResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use GetApiKey API.

GetDedicatedAiCluster(GetDedicatedAiClusterRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Gets information about a dedicated AI cluster.

Declaration

public Task<GetDedicatedAiClusterResponse> GetDedicatedAiCluster(GetDedicatedAiClusterRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
GetDedicatedAiClusterRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<GetDedicatedAiClusterResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use GetDedicatedAiCluster API.

GetEndpoint(GetEndpointRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Gets information about an endpoint.

Declaration

public Task<GetEndpointResponse> GetEndpoint(GetEndpointRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
GetEndpointRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<GetEndpointResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use GetEndpoint API.

GetGenerativeAiPrivateEndpoint(GetGenerativeAiPrivateEndpointRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Retrieves an Generative AI private endpoint using a privateEndpointId.

Declaration

public Task<GetGenerativeAiPrivateEndpointResponse> GetGenerativeAiPrivateEndpoint(GetGenerativeAiPrivateEndpointRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
GetGenerativeAiPrivateEndpointRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<GetGenerativeAiPrivateEndpointResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use GetGenerativeAiPrivateEndpoint API.

GetGenerativeAiProject(GetGenerativeAiProjectRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Gets information about a generativeAiProject.

Declaration

public Task<GetGenerativeAiProjectResponse> GetGenerativeAiProject(GetGenerativeAiProjectRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
GetGenerativeAiProjectRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<GetGenerativeAiProjectResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use GetGenerativeAiProject API.

GetHostedApplication(GetHostedApplicationRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Gets information about a hosted application.

Declaration

public Task<GetHostedApplicationResponse> GetHostedApplication(GetHostedApplicationRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
GetHostedApplicationRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<GetHostedApplicationResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use GetHostedApplication API.

GetHostedApplicationStorage(GetHostedApplicationStorageRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Gets information about a hosted application storage.

Declaration

public Task<GetHostedApplicationStorageResponse> GetHostedApplicationStorage(GetHostedApplicationStorageRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
GetHostedApplicationStorageRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<GetHostedApplicationStorageResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use GetHostedApplicationStorage API.

GetHostedDeployment(GetHostedDeploymentRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Gets information about a hosted deployment.

Declaration

public Task<GetHostedDeploymentResponse> GetHostedDeployment(GetHostedDeploymentRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
GetHostedDeploymentRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<GetHostedDeploymentResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use GetHostedDeployment API.

GetImportedModel(GetImportedModelRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Gets information about an imported model.

Declaration

public Task<GetImportedModelResponse> GetImportedModel(GetImportedModelRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
GetImportedModelRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<GetImportedModelResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use GetImportedModel API.

GetModel(GetModelRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Gets information about a custom model.

Declaration

public Task<GetModelResponse> GetModel(GetModelRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
GetModelRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<GetModelResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use GetModel API.

GetSemanticStore(GetSemanticStoreRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Gets information about a semanticStore.

Declaration

public Task<GetSemanticStoreResponse> GetSemanticStore(GetSemanticStoreRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
GetSemanticStoreRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<GetSemanticStoreResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use GetSemanticStore API.

GetVectorStoreConnector(GetVectorStoreConnectorRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Gets information about a vectorStoreConnector.

Declaration

public Task<GetVectorStoreConnectorResponse> GetVectorStoreConnector(GetVectorStoreConnectorRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
GetVectorStoreConnectorRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<GetVectorStoreConnectorResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use GetVectorStoreConnector API.

GetVectorStoreConnectorFileSync(GetVectorStoreConnectorFileSyncRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Gets information about a vectorStoreConnectorFileSync.

Declaration

public Task<GetVectorStoreConnectorFileSyncResponse> GetVectorStoreConnectorFileSync(GetVectorStoreConnectorFileSyncRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
GetVectorStoreConnectorFileSyncRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<GetVectorStoreConnectorFileSyncResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use GetVectorStoreConnectorFileSync API.

GetVectorStoreConnectorStats(GetVectorStoreConnectorStatsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Gets Sync statistics from a vectorStoreConnector.

Declaration

public Task<GetVectorStoreConnectorStatsResponse> GetVectorStoreConnectorStats(GetVectorStoreConnectorStatsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
GetVectorStoreConnectorStatsRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<GetVectorStoreConnectorStatsResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use GetVectorStoreConnectorStats API.

GetWorkRequest(GetWorkRequestRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Gets the details of a work request.

Declaration

public Task<GetWorkRequestResponse> GetWorkRequest(GetWorkRequestRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
GetWorkRequestRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<GetWorkRequestResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use GetWorkRequest API.

ListApiKeys(ListApiKeysRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Lists the ApiKeys of a specific compartment.

Declaration

public Task<ListApiKeysResponse> ListApiKeys(ListApiKeysRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ListApiKeysRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<ListApiKeysResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use ListApiKeys API.

ListDedicatedAiClusters(ListDedicatedAiClustersRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Lists the dedicated AI clusters in a specific compartment.

Declaration

public Task<ListDedicatedAiClustersResponse> ListDedicatedAiClusters(ListDedicatedAiClustersRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ListDedicatedAiClustersRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<ListDedicatedAiClustersResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use ListDedicatedAiClusters API.

ListEndpoints(ListEndpointsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Lists the endpoints of a specific compartment.

Declaration

public Task<ListEndpointsResponse> ListEndpoints(ListEndpointsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ListEndpointsRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<ListEndpointsResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use ListEndpoints API.

ListGenerativeAiPrivateEndpoints(ListGenerativeAiPrivateEndpointsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Lists all Generative AI private endpoints in the specified compartment.

Declaration

public Task<ListGenerativeAiPrivateEndpointsResponse> ListGenerativeAiPrivateEndpoints(ListGenerativeAiPrivateEndpointsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ListGenerativeAiPrivateEndpointsRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<ListGenerativeAiPrivateEndpointsResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use ListGenerativeAiPrivateEndpoints API.

ListGenerativeAiProjects(ListGenerativeAiProjectsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Lists the generativeAiProjects of a specific compartment.

Declaration

public Task<ListGenerativeAiProjectsResponse> ListGenerativeAiProjects(ListGenerativeAiProjectsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ListGenerativeAiProjectsRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<ListGenerativeAiProjectsResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use ListGenerativeAiProjects API.

ListHostedApplicationStorages(ListHostedApplicationStoragesRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Lists the hosted application storage in a specific compartment.

Declaration

public Task<ListHostedApplicationStoragesResponse> ListHostedApplicationStorages(ListHostedApplicationStoragesRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ListHostedApplicationStoragesRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<ListHostedApplicationStoragesResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use ListHostedApplicationStorages API.

ListHostedApplications(ListHostedApplicationsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Lists the hosted applications in a specific compartment.

Declaration

public Task<ListHostedApplicationsResponse> ListHostedApplications(ListHostedApplicationsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ListHostedApplicationsRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<ListHostedApplicationsResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use ListHostedApplications API.

ListHostedDeployments(ListHostedDeploymentsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Lists the hosted applications in a specific compartment.

Declaration

public Task<ListHostedDeploymentsResponse> ListHostedDeployments(ListHostedDeploymentsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ListHostedDeploymentsRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<ListHostedDeploymentsResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use ListHostedDeployments API.

ListImportedModels(ListImportedModelsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Lists imported models in a specific compartment.

Declaration

public Task<ListImportedModelsResponse> ListImportedModels(ListImportedModelsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ListImportedModelsRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<ListImportedModelsResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use ListImportedModels API.

ListModels(ListModelsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Lists the models in a specific compartment. Includes pretrained base models and fine-tuned custom models.

Declaration

public Task<ListModelsResponse> ListModels(ListModelsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ListModelsRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<ListModelsResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use ListModels API.

ListSemanticStores(ListSemanticStoresRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Lists the SemanticStores given specific filter.

Declaration

public Task<ListSemanticStoresResponse> ListSemanticStores(ListSemanticStoresRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ListSemanticStoresRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<ListSemanticStoresResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use ListSemanticStores API.

ListVectorStoreConnectorFileSyncIngestionLogs(ListVectorStoreConnectorFileSyncIngestionLogsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Gets Ingestion logs for a vectorStoreConnectorFileSync operation.

Declaration

public Task<ListVectorStoreConnectorFileSyncIngestionLogsResponse> ListVectorStoreConnectorFileSyncIngestionLogs(ListVectorStoreConnectorFileSyncIngestionLogsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ListVectorStoreConnectorFileSyncIngestionLogsRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<ListVectorStoreConnectorFileSyncIngestionLogsResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use ListVectorStoreConnectorFileSyncIngestionLogs API.

ListVectorStoreConnectorFileSyncs(ListVectorStoreConnectorFileSyncsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Lists the vectorStoreConnectorFileSyncs of a specific compartment.

Declaration

public Task<ListVectorStoreConnectorFileSyncsResponse> ListVectorStoreConnectorFileSyncs(ListVectorStoreConnectorFileSyncsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ListVectorStoreConnectorFileSyncsRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<ListVectorStoreConnectorFileSyncsResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use ListVectorStoreConnectorFileSyncs API.

ListVectorStoreConnectorIngestionLogs(ListVectorStoreConnectorIngestionLogsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Gets Ingestion logs for a vectorStoreConnector.

Declaration

public Task<ListVectorStoreConnectorIngestionLogsResponse> ListVectorStoreConnectorIngestionLogs(ListVectorStoreConnectorIngestionLogsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ListVectorStoreConnectorIngestionLogsRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<ListVectorStoreConnectorIngestionLogsResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use ListVectorStoreConnectorIngestionLogs API.

ListVectorStoreConnectors(ListVectorStoreConnectorsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Lists the vectorStoreConnectors of a specific compartment.

Declaration

public Task<ListVectorStoreConnectorsResponse> ListVectorStoreConnectors(ListVectorStoreConnectorsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ListVectorStoreConnectorsRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<ListVectorStoreConnectorsResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use ListVectorStoreConnectors API.

ListWorkRequestErrors(ListWorkRequestErrorsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Lists the errors for a work request.

Declaration

public Task<ListWorkRequestErrorsResponse> ListWorkRequestErrors(ListWorkRequestErrorsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ListWorkRequestErrorsRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<ListWorkRequestErrorsResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use ListWorkRequestErrors API.

ListWorkRequestLogs(ListWorkRequestLogsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Lists the logs for a work request.

Declaration

public Task<ListWorkRequestLogsResponse> ListWorkRequestLogs(ListWorkRequestLogsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ListWorkRequestLogsRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<ListWorkRequestLogsResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use ListWorkRequestLogs API.

ListWorkRequests(ListWorkRequestsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Lists the work requests in a compartment.

Declaration

public Task<ListWorkRequestsResponse> ListWorkRequests(ListWorkRequestsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ListWorkRequestsRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<ListWorkRequestsResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use ListWorkRequests API.

RenewApiKey(RenewApiKeyRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Renew the primary or secondary key.

Declaration

public Task<RenewApiKeyResponse> RenewApiKey(RenewApiKeyRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
RenewApiKeyRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<RenewApiKeyResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use RenewApiKey API.

SetApiKeyState(SetApiKeyStateRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Set state of the key.

Declaration

public Task<SetApiKeyStateResponse> SetApiKeyState(SetApiKeyStateRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
SetApiKeyStateRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<SetApiKeyStateResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use SetApiKeyState API.

UpdateApiKey(UpdateApiKeyRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Updates the properties of an apiKey.

Declaration

public Task<UpdateApiKeyResponse> UpdateApiKey(UpdateApiKeyRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
UpdateApiKeyRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<UpdateApiKeyResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use UpdateApiKey API.

UpdateDedicatedAiCluster(UpdateDedicatedAiClusterRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Updates a dedicated AI cluster.

Declaration

public Task<UpdateDedicatedAiClusterResponse> UpdateDedicatedAiCluster(UpdateDedicatedAiClusterRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
UpdateDedicatedAiClusterRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<UpdateDedicatedAiClusterResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use UpdateDedicatedAiCluster API.

UpdateEndpoint(UpdateEndpointRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Updates the properties of an endpoint.

Declaration

public Task<UpdateEndpointResponse> UpdateEndpoint(UpdateEndpointRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
UpdateEndpointRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<UpdateEndpointResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use UpdateEndpoint API.

UpdateGenerativeAiPrivateEndpoint(UpdateGenerativeAiPrivateEndpointRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Updates a Generative AI private endpoint using a privateEndpointId.

Declaration

public Task<UpdateGenerativeAiPrivateEndpointResponse> UpdateGenerativeAiPrivateEndpoint(UpdateGenerativeAiPrivateEndpointRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
UpdateGenerativeAiPrivateEndpointRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<UpdateGenerativeAiPrivateEndpointResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use UpdateGenerativeAiPrivateEndpoint API.

UpdateGenerativeAiProject(UpdateGenerativeAiProjectRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Updates the properties of a generativeAiProject.

Declaration

public Task<UpdateGenerativeAiProjectResponse> UpdateGenerativeAiProject(UpdateGenerativeAiProjectRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
UpdateGenerativeAiProjectRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<UpdateGenerativeAiProjectResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use UpdateGenerativeAiProject API.

UpdateHostedApplication(UpdateHostedApplicationRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Updates a hosted application.

Declaration

public Task<UpdateHostedApplicationResponse> UpdateHostedApplication(UpdateHostedApplicationRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
UpdateHostedApplicationRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<UpdateHostedApplicationResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use UpdateHostedApplication API.

UpdateHostedDeployment(UpdateHostedDeploymentRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Updates a hosted deployment.

Declaration

public Task<UpdateHostedDeploymentResponse> UpdateHostedDeployment(UpdateHostedDeploymentRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
UpdateHostedDeploymentRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<UpdateHostedDeploymentResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use UpdateHostedDeployment API.

UpdateImportedModel(UpdateImportedModelRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Updates the properties of an imported model such as name, description, freeform tags, and defined tags.

Declaration

public Task<UpdateImportedModelResponse> UpdateImportedModel(UpdateImportedModelRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
UpdateImportedModelRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<UpdateImportedModelResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use UpdateImportedModel API.

UpdateModel(UpdateModelRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Updates the properties of a custom model such as name, description, version, freeform tags, and defined tags.

Declaration

public Task<UpdateModelResponse> UpdateModel(UpdateModelRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
UpdateModelRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<UpdateModelResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use UpdateModel API.

UpdateSemanticStore(UpdateSemanticStoreRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Updates the properties of a SemanticStore.

Declaration

public Task<UpdateSemanticStoreResponse> UpdateSemanticStore(UpdateSemanticStoreRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
UpdateSemanticStoreRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<UpdateSemanticStoreResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use UpdateSemanticStore API.

UpdateVectorStoreConnector(UpdateVectorStoreConnectorRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Updates the properties of a vectorStoreConnector.

Declaration

public Task<UpdateVectorStoreConnectorResponse> UpdateVectorStoreConnector(UpdateVectorStoreConnectorRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
UpdateVectorStoreConnectorRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<UpdateVectorStoreConnectorResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use UpdateVectorStoreConnector API.

Implements

IDisposable