Class DataLabelingClient
Service client instance for DataLabeling.
Implements
Inherited Members
Namespace: Oci.DatalabelingservicedataplaneService
Assembly: OCI.DotNetSDK.Datalabelingservicedataplane.dll
Syntax
public class DataLabelingClient : RegionalClientBase, IDisposable
Constructors
DataLabelingClient(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 DataLabelingClient(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 DataLabelingPaginators Paginators { get; }
Property Value
Type | Description |
---|---|
DataLabelingPaginators |
Waiters
Declaration
public DataLabelingWaiters Waiters { get; }
Property Value
Type | Description |
---|---|
DataLabelingWaiters |
Methods
CreateAnnotation(CreateAnnotationRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Creates an annotation.
Declaration
public Task<CreateAnnotationResponse> CreateAnnotation(CreateAnnotationRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
CreateAnnotationRequest | 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<CreateAnnotationResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use CreateAnnotation API.
CreateRecord(CreateRecordRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Creates a record.
Declaration
public Task<CreateRecordResponse> CreateRecord(CreateRecordRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
CreateRecordRequest | 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<CreateRecordResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use CreateRecord API.
DeleteAnnotation(DeleteAnnotationRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
It deletes an annotation resource by identifier.
Declaration
public Task<DeleteAnnotationResponse> DeleteAnnotation(DeleteAnnotationRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
DeleteAnnotationRequest | 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<DeleteAnnotationResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use DeleteAnnotation API.
DeleteRecord(DeleteRecordRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Deletes a record resource by identifier.
Declaration
public Task<DeleteRecordResponse> DeleteRecord(DeleteRecordRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
DeleteRecordRequest | 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<DeleteRecordResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use DeleteRecord API.
GetAnnotation(GetAnnotationRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Gets an annotation.
Declaration
public Task<GetAnnotationResponse> GetAnnotation(GetAnnotationRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
GetAnnotationRequest | 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<GetAnnotationResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use GetAnnotation API.
GetDataset(GetDatasetRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Gets a dataset by identifier.
Declaration
public Task<GetDatasetResponse> GetDataset(GetDatasetRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
GetDatasetRequest | 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<GetDatasetResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use GetDataset API.
GetRecord(GetRecordRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Gets a record.
Declaration
public Task<GetRecordResponse> GetRecord(GetRecordRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
GetRecordRequest | 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<GetRecordResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use GetRecord API.
GetRecordContent(GetRecordContentRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Retrieves the content of the record from the dataset source.
Declaration
public Task<GetRecordContentResponse> GetRecordContent(GetRecordContentRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
GetRecordContentRequest | 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<GetRecordContentResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use GetRecordContent API.
GetRecordPreviewContent(GetRecordPreviewContentRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Retrieves the preview of the record content from the dataset source.
Declaration
public Task<GetRecordPreviewContentResponse> GetRecordPreviewContent(GetRecordPreviewContentRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
GetRecordPreviewContentRequest | 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<GetRecordPreviewContentResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use GetRecordPreviewContent API.
ListAnnotations(ListAnnotationsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Returns a list of annotations.
Declaration
public Task<ListAnnotationsResponse> ListAnnotations(ListAnnotationsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListAnnotationsRequest | 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<ListAnnotationsResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListAnnotations API.
ListRecords(ListRecordsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
The list of records in the specified compartment.
Declaration
public Task<ListRecordsResponse> ListRecords(ListRecordsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListRecordsRequest | 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<ListRecordsResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListRecords API.
SummarizeAnnotationAnalytics(SummarizeAnnotationAnalyticsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Summarize the annotations created for a given dataset.
Declaration
public Task<SummarizeAnnotationAnalyticsResponse> SummarizeAnnotationAnalytics(SummarizeAnnotationAnalyticsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
SummarizeAnnotationAnalyticsRequest | 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<SummarizeAnnotationAnalyticsResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use SummarizeAnnotationAnalytics API.
SummarizeRecordAnalytics(SummarizeRecordAnalyticsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Summarize the records created for a given dataset.
Declaration
public Task<SummarizeRecordAnalyticsResponse> SummarizeRecordAnalytics(SummarizeRecordAnalyticsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
SummarizeRecordAnalyticsRequest | 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<SummarizeRecordAnalyticsResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use SummarizeRecordAnalytics API.
UpdateAnnotation(UpdateAnnotationRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Updates an annotation.
Declaration
public Task<UpdateAnnotationResponse> UpdateAnnotation(UpdateAnnotationRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
UpdateAnnotationRequest | 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<UpdateAnnotationResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use UpdateAnnotation API.
UpdateRecord(UpdateRecordRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Updates a record.
Declaration
public Task<UpdateRecordResponse> UpdateRecord(UpdateRecordRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
UpdateRecordRequest | 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<UpdateRecordResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use UpdateRecord API.