Class GenerativeAiAgentClient

Service client instance for GenerativeAiAgent.

Inheritance

object

ClientBase

RegionalClientBase

GenerativeAiAgentClient

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)

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Oci.GenerativeaiagentService

Assembly: OCI.DotNetSDK.Generativeaiagent.dll

Syntax

public class GenerativeAiAgentClient : RegionalClientBase, IDisposable

Constructors

GenerativeAiAgentClient(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 GenerativeAiAgentClient(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 GenerativeAiAgentPaginators Paginators { get; }

Property Value

Type	Description
GenerativeAiAgentPaginators

Waiters

Declaration

public GenerativeAiAgentWaiters Waiters { get; }

Property Value

Type	Description
GenerativeAiAgentWaiters

Methods

CancelWorkRequest(CancelWorkRequestRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Cancels a work request.

Declaration

public Task<CancelWorkRequestResponse> CancelWorkRequest(CancelWorkRequestRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
CancelWorkRequestRequest	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<CancelWorkRequestResponse>	A response object containing details about the completed operation

Examples

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

ChangeAgentCompartment(ChangeAgentCompartmentRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Moves an agent 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<ChangeAgentCompartmentResponse> ChangeAgentCompartment(ChangeAgentCompartmentRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ChangeAgentCompartmentRequest	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<ChangeAgentCompartmentResponse>	A response object containing details about the completed operation

Examples

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

ChangeAgentEndpointCompartment(ChangeAgentEndpointCompartmentRequest, 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<ChangeAgentEndpointCompartmentResponse> ChangeAgentEndpointCompartment(ChangeAgentEndpointCompartmentRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ChangeAgentEndpointCompartmentRequest	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<ChangeAgentEndpointCompartmentResponse>	A response object containing details about the completed operation

Examples

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

ChangeKnowledgeBaseCompartment(ChangeKnowledgeBaseCompartmentRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Moves a knowledge base 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<ChangeKnowledgeBaseCompartmentResponse> ChangeKnowledgeBaseCompartment(ChangeKnowledgeBaseCompartmentRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ChangeKnowledgeBaseCompartmentRequest	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<ChangeKnowledgeBaseCompartmentResponse>	A response object containing details about the completed operation

Examples

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

CreateAgent(CreateAgentRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Creates an agent.

Declaration

public Task<CreateAgentResponse> CreateAgent(CreateAgentRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
CreateAgentRequest	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<CreateAgentResponse>	A response object containing details about the completed operation

Examples

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

CreateAgentEndpoint(CreateAgentEndpointRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Creates an endpoint.

Declaration

public Task<CreateAgentEndpointResponse> CreateAgentEndpoint(CreateAgentEndpointRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
CreateAgentEndpointRequest	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<CreateAgentEndpointResponse>	A response object containing details about the completed operation

Examples

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

CreateDataIngestionJob(CreateDataIngestionJobRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Creates a data ingestion job.

Declaration

public Task<CreateDataIngestionJobResponse> CreateDataIngestionJob(CreateDataIngestionJobRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
CreateDataIngestionJobRequest	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<CreateDataIngestionJobResponse>	A response object containing details about the completed operation

Examples

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

CreateDataSource(CreateDataSourceRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Creates a data source.

Declaration

public Task<CreateDataSourceResponse> CreateDataSource(CreateDataSourceRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
CreateDataSourceRequest	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<CreateDataSourceResponse>	A response object containing details about the completed operation

Examples

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

CreateKnowledgeBase(CreateKnowledgeBaseRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Creates a knowledge base.

Declaration

public Task<CreateKnowledgeBaseResponse> CreateKnowledgeBase(CreateKnowledgeBaseRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
CreateKnowledgeBaseRequest	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<CreateKnowledgeBaseResponse>	A response object containing details about the completed operation

Examples

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

CreateTool(CreateToolRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Creates a tool.

Declaration

public Task<CreateToolResponse> CreateTool(CreateToolRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
CreateToolRequest	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<CreateToolResponse>	A response object containing details about the completed operation

Examples

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

DeleteAgent(DeleteAgentRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Deletes an agent.

Declaration

public Task<DeleteAgentResponse> DeleteAgent(DeleteAgentRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
DeleteAgentRequest	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<DeleteAgentResponse>	A response object containing details about the completed operation

Examples

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

DeleteAgentEndpoint(DeleteAgentEndpointRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Deletes an endpoint.

Declaration

public Task<DeleteAgentEndpointResponse> DeleteAgentEndpoint(DeleteAgentEndpointRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
DeleteAgentEndpointRequest	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<DeleteAgentEndpointResponse>	A response object containing details about the completed operation

Examples

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

DeleteDataIngestionJob(DeleteDataIngestionJobRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Deletes a data ingestion job.

Declaration

public Task<DeleteDataIngestionJobResponse> DeleteDataIngestionJob(DeleteDataIngestionJobRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
DeleteDataIngestionJobRequest	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<DeleteDataIngestionJobResponse>	A response object containing details about the completed operation

Examples

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

DeleteDataSource(DeleteDataSourceRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Deletes a data source.

Declaration

public Task<DeleteDataSourceResponse> DeleteDataSource(DeleteDataSourceRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
DeleteDataSourceRequest	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<DeleteDataSourceResponse>	A response object containing details about the completed operation

Examples

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

DeleteKnowledgeBase(DeleteKnowledgeBaseRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Deletes a knowledge base.

Declaration

public Task<DeleteKnowledgeBaseResponse> DeleteKnowledgeBase(DeleteKnowledgeBaseRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
DeleteKnowledgeBaseRequest	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<DeleteKnowledgeBaseResponse>	A response object containing details about the completed operation

Examples

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

DeleteTool(DeleteToolRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Deletes a tool.

Declaration

public Task<DeleteToolResponse> DeleteTool(DeleteToolRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
DeleteToolRequest	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<DeleteToolResponse>	A response object containing details about the completed operation

Examples

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

GetAgent(GetAgentRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Gets information about an agent.

Declaration

public Task<GetAgentResponse> GetAgent(GetAgentRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
GetAgentRequest	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<GetAgentResponse>	A response object containing details about the completed operation

Examples

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

GetAgentEndpoint(GetAgentEndpointRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Gets information about an endpoint.

Declaration

public Task<GetAgentEndpointResponse> GetAgentEndpoint(GetAgentEndpointRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
GetAgentEndpointRequest	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<GetAgentEndpointResponse>	A response object containing details about the completed operation

Examples

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

GetDataIngestionJob(GetDataIngestionJobRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Gets information about a data ingestion job.

Declaration

public Task<GetDataIngestionJobResponse> GetDataIngestionJob(GetDataIngestionJobRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
GetDataIngestionJobRequest	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<GetDataIngestionJobResponse>	A response object containing details about the completed operation

Examples

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

GetDataIngestionJobLogContent(GetDataIngestionJobLogContentRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Returns the raw log file for the specified data ingestion job in text format.

Declaration

public Task<GetDataIngestionJobLogContentResponse> GetDataIngestionJobLogContent(GetDataIngestionJobLogContentRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
GetDataIngestionJobLogContentRequest	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<GetDataIngestionJobLogContentResponse>	A response object containing details about the completed operation

Examples

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

GetDataSource(GetDataSourceRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Gets information about a data source.

Declaration

public Task<GetDataSourceResponse> GetDataSource(GetDataSourceRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
GetDataSourceRequest	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<GetDataSourceResponse>	A response object containing details about the completed operation

Examples

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

GetKnowledgeBase(GetKnowledgeBaseRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Gets information about a knowledge base.

Declaration

public Task<GetKnowledgeBaseResponse> GetKnowledgeBase(GetKnowledgeBaseRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
GetKnowledgeBaseRequest	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<GetKnowledgeBaseResponse>	A response object containing details about the completed operation

Examples

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

GetTool(GetToolRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Gets information about a tool.

Declaration

public Task<GetToolResponse> GetTool(GetToolRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
GetToolRequest	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<GetToolResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use GetTool 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.

ListAgentEndpoints(ListAgentEndpointsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Gets a list of endpoints.

Declaration

public Task<ListAgentEndpointsResponse> ListAgentEndpoints(ListAgentEndpointsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ListAgentEndpointsRequest	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<ListAgentEndpointsResponse>	A response object containing details about the completed operation

Examples

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

ListAgents(ListAgentsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Gets a list of agents.

Declaration

public Task<ListAgentsResponse> ListAgents(ListAgentsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ListAgentsRequest	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<ListAgentsResponse>	A response object containing details about the completed operation

Examples

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

ListDataIngestionJobs(ListDataIngestionJobsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Gets a list of data ingestion jobs.

Declaration

public Task<ListDataIngestionJobsResponse> ListDataIngestionJobs(ListDataIngestionJobsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ListDataIngestionJobsRequest	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<ListDataIngestionJobsResponse>	A response object containing details about the completed operation

Examples

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

ListDataSources(ListDataSourcesRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Gets a list of data sources.

Declaration

public Task<ListDataSourcesResponse> ListDataSources(ListDataSourcesRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ListDataSourcesRequest	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<ListDataSourcesResponse>	A response object containing details about the completed operation

Examples

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

ListKnowledgeBases(ListKnowledgeBasesRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Gets a list of knowledge bases.

Declaration

public Task<ListKnowledgeBasesResponse> ListKnowledgeBases(ListKnowledgeBasesRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ListKnowledgeBasesRequest	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<ListKnowledgeBasesResponse>	A response object containing details about the completed operation

Examples

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

ListTools(ListToolsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Gets a list of tools.

Declaration

public Task<ListToolsResponse> ListTools(ListToolsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ListToolsRequest	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<ListToolsResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use ListTools 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.

UpdateAgent(UpdateAgentRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Updates an agent.

Declaration

public Task<UpdateAgentResponse> UpdateAgent(UpdateAgentRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
UpdateAgentRequest	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<UpdateAgentResponse>	A response object containing details about the completed operation

Examples

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

UpdateAgentEndpoint(UpdateAgentEndpointRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Updates an endpoint.

Declaration

public Task<UpdateAgentEndpointResponse> UpdateAgentEndpoint(UpdateAgentEndpointRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
UpdateAgentEndpointRequest	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<UpdateAgentEndpointResponse>	A response object containing details about the completed operation

Examples

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

UpdateDataSource(UpdateDataSourceRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Updates a data source.

Declaration

public Task<UpdateDataSourceResponse> UpdateDataSource(UpdateDataSourceRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
UpdateDataSourceRequest	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<UpdateDataSourceResponse>	A response object containing details about the completed operation

Examples

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

UpdateKnowledgeBase(UpdateKnowledgeBaseRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Updates a knowledge base.

Declaration

public Task<UpdateKnowledgeBaseResponse> UpdateKnowledgeBase(UpdateKnowledgeBaseRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
UpdateKnowledgeBaseRequest	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<UpdateKnowledgeBaseResponse>	A response object containing details about the completed operation

Examples

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

UpdateTool(UpdateToolRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Updates a tool.

Declaration

public Task<UpdateToolResponse> UpdateTool(UpdateToolRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
UpdateToolRequest	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<UpdateToolResponse>	A response object containing details about the completed operation

Examples

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

Implements

IDisposable