Annotation An Annotation represents a user/machine generated annotation for a given record. The details of the annotation are captured in the RecordAnnotationDetails.
type Annotation struct { // The OCID of the annotation Id *string `mandatory:"true" json:"id"` // The date and time the annotation was created, in the timestamp format defined by RFC3339. TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"` // The date and time the resource was updated, in the timestamp format defined by RFC3339. TimeUpdated *common.SDKTime `mandatory:"true" json:"timeUpdated"` // The OCID of the principal who created the annotation CreatedBy *string `mandatory:"true" json:"createdBy"` // The OCID of the principal who updated the annotation UpdatedBy *string `mandatory:"true" json:"updatedBy"` // The OCID of the record annotated RecordId *string `mandatory:"true" json:"recordId"` // The entity types will be validated against the dataset to ensure consistency. Entities []Entity `mandatory:"true" json:"entities"` // The OCID of the compartment for the annotation. This is tied to the dataset. It is not changeable on the record itself. CompartmentId *string `mandatory:"true" json:"compartmentId"` // Lifecycle State of an Annotation. // ACTIVE - Annotation is active to be used for labeling. // INACTIVE - Annotation has been marked as inactive and should not be used for labeling. // DELETED - Annotation been deleted and no longer available for labeling. LifecycleState AnnotationLifecycleStateEnum `mandatory:"true" json:"lifecycleState"` // Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. // Example: `{"bar-key": "value"}` FreeformTags map[string]string `mandatory:"false" json:"freeformTags"` // Defined tags for this resource. Each key is predefined and scoped to a namespace. // Example: `{"foo-namespace": {"bar-key": "value"}}` DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"` }
func (m Annotation) String() string
func (m *Annotation) UnmarshalJSON(data []byte) (e error)
UnmarshalJSON unmarshals from json
AnnotationAggregationDimensions Dimensions to summarize annotations for a given dataset
type AnnotationAggregationDimensions struct { Label *Label `mandatory:"false" json:"label"` // The OCID of the principal who updated the resource. UpdatedBy *string `mandatory:"false" json:"updatedBy"` }
func (m AnnotationAggregationDimensions) String() string
AnnotationAnalyticsAggregation Aggregation entities are required by the api consistency guidelines for API Consistency Guidelines#AnalyticsAPIs. These are used to summarize annotations for a given dataset and will be used to populate UI elements. Aggregations need to have the fields that identify the exact scope that they're summarizing. Any filters to the list API we apply would have to show up in the aggregation. We should limit the number of filters and dimensions as much as possible.
type AnnotationAnalyticsAggregation struct { // the count of the matching results Count *float32 `mandatory:"true" json:"count"` // OCID of the dataset the annotations belongs to DatasetId *string `mandatory:"true" json:"datasetId"` // OCID of the compartment containing the annotations CompartmentId *string `mandatory:"true" json:"compartmentId"` Dimensions *AnnotationAggregationDimensions `mandatory:"false" json:"dimensions"` // The OCID of the principal who updated the annotation UpdatedBy *string `mandatory:"false" json:"updatedBy"` // Describes the lifecycle state. LifecycleState AnnotationLifecycleStateEnum `mandatory:"false" json:"lifecycleState,omitempty"` }
func (m AnnotationAnalyticsAggregation) String() string
AnnotationAnalyticsAggregationCollection Aggregation entities are required by the api consistency guidelines for API Consistency Guidelines#AnalyticsAPIs. These are used to summarize annotations for a given dataset and will be used to populate UI elements. Aggregations need to have the fields that identify the exact scope that they're summarizing. Any filters to the list API we apply would have to show up in the aggregation. We should limit the number of filters and dimensions as much as possible.
type AnnotationAnalyticsAggregationCollection struct { // List of Annotation entities. Items []AnnotationAnalyticsAggregation `mandatory:"true" json:"items"` }
func (m AnnotationAnalyticsAggregationCollection) String() string
AnnotationCollection Results of a annotations search. Contains boh AnnotationSummary items and other information, such as metadata.
type AnnotationCollection struct { // List of annotations. Items []AnnotationSummary `mandatory:"true" json:"items"` }
func (m AnnotationCollection) String() string
AnnotationLifecycleStateEnum Enum with underlying type: string
type AnnotationLifecycleStateEnum string
Set of constants representing the allowable values for AnnotationLifecycleStateEnum
const ( AnnotationLifecycleStateActive AnnotationLifecycleStateEnum = "ACTIVE" AnnotationLifecycleStateInactive AnnotationLifecycleStateEnum = "INACTIVE" AnnotationLifecycleStateDeleted AnnotationLifecycleStateEnum = "DELETED" )
func GetAnnotationLifecycleStateEnumValues() []AnnotationLifecycleStateEnum
GetAnnotationLifecycleStateEnumValues Enumerates the set of values for AnnotationLifecycleStateEnum
AnnotationSummary An annotation summary is the representation returned in list views. It is usually a subset of the full annotation entity and should not contain any potentially sensitive information.
type AnnotationSummary struct { // The OCID of the annotation Id *string `mandatory:"true" json:"id"` // The date and time the annotation was created, in the timestamp format defined by RFC3339. TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"` // The date and time the resource was updated, in the timestamp format defined by RFC3339. TimeUpdated *common.SDKTime `mandatory:"true" json:"timeUpdated"` // The OCID of the record annotated RecordId *string `mandatory:"true" json:"recordId"` // The OCID of the compartment for the annotation CompartmentId *string `mandatory:"true" json:"compartmentId"` // Describes the lifecycle state. LifecycleState AnnotationLifecycleStateEnum `mandatory:"true" json:"lifecycleState"` // Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. // Example: `{"bar-key": "value"}` FreeformTags map[string]string `mandatory:"false" json:"freeformTags"` // Defined tags for this resource. Each key is predefined and scoped to a namespace. // Example: `{"foo-namespace": {"bar-key": "value"}}` DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"` }
func (m AnnotationSummary) String() string
BoundingPolygon A polygon used to describe the location of an object.
type BoundingPolygon struct { // The normalized vertices that make up the polygon. They are in order of the segments that they connect. NormalizedVertices []NormalizedVertex `mandatory:"true" json:"normalizedVertices"` }
func (m BoundingPolygon) String() string
CreateAnnotationDetails This is the payload sent in the CreateAnnotation operation. It contains all the information required for a user to create an Annotation for a record.
type CreateAnnotationDetails struct { // The OCID of the record annotated RecordId *string `mandatory:"true" json:"recordId"` // The OCID of the compartment for the annotation CompartmentId *string `mandatory:"true" json:"compartmentId"` // The entity types will be validated against the dataset to ensure consistency. Entities []Entity `mandatory:"true" json:"entities"` // Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. // Example: `{"bar-key": "value"}` FreeformTags map[string]string `mandatory:"false" json:"freeformTags"` // Defined tags for this resource. Each key is predefined and scoped to a namespace. // Example: `{"foo-namespace": {"bar-key": "value"}}` DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"` }
func (m CreateAnnotationDetails) String() string
func (m *CreateAnnotationDetails) UnmarshalJSON(data []byte) (e error)
UnmarshalJSON unmarshals from json
CreateAnnotationRequest wrapper for the CreateAnnotation operation
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/55.0.0/datalabelingservicedataplane/CreateAnnotation.go.html to see an example of how to use CreateAnnotationRequest.
type CreateAnnotationRequest struct { // Details for the new CreateAnnotation. CreateAnnotationDetails `contributesTo:"body"` // A token that uniquely identifies a request so it can be retried in case of a timeout or // server error without risk of executing that same action again. Retry tokens expire after 24 // hours, but can be invalidated before then due to conflicting operations. For example, if a resource // has been deleted and purged from the system, then a retry of the original creation request // might be rejected. OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"` // The client request ID for tracing. OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"` // Metadata about the request. This information will not be transmitted to the service, but // represents information that the SDK will consume to drive retry behavior. RequestMetadata common.RequestMetadata }
func (request CreateAnnotationRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request CreateAnnotationRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request CreateAnnotationRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request CreateAnnotationRequest) String() string
CreateAnnotationResponse wrapper for the CreateAnnotation operation
type CreateAnnotationResponse struct { // The underlying http response RawResponse *http.Response // The Annotation instance Annotation `presentIn:"body"` // For optimistic concurrency control. See `if-match`. Etag *string `presentIn:"header" name:"etag"` // Unique Oracle-assigned identifier for the request. If you need to contact // Oracle about a particular request, please provide the request ID. OpcRequestId *string `presentIn:"header" name:"opc-request-id"` }
func (response CreateAnnotationResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response CreateAnnotationResponse) String() string
CreateObjectStorageSourceDetails Object Storage Source Details.
type CreateObjectStorageSourceDetails struct { // The path relative to the prefix specified in the dataset source details (file name). RelativePath *string `mandatory:"true" json:"relativePath"` // The offset into the file containing the content. Offset *float32 `mandatory:"false" json:"offset"` // The length from offset into the file containing the content. Length *float32 `mandatory:"false" json:"length"` }
func (m CreateObjectStorageSourceDetails) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m CreateObjectStorageSourceDetails) String() string
CreateRecordDetails A record represents an entry in a dataset that needs labeling.
type CreateRecordDetails struct { // This will be automatically assigned by the service. It will be unique and immutable. Name *string `mandatory:"true" json:"name"` // The OCID of the dataset to associate the record with. DatasetId *string `mandatory:"true" json:"datasetId"` // The OCID of the compartment for the record. This is tied to the dataset. It is not changeable on the record itself. CompartmentId *string `mandatory:"true" json:"compartmentId"` SourceDetails CreateSourceDetails `mandatory:"true" json:"sourceDetails"` // Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. // Example: `{"bar-key": "value"}` FreeformTags map[string]string `mandatory:"false" json:"freeformTags"` // Defined tags for this resource. Each key is predefined and scoped to a namespace. // Example: `{"foo-namespace": {"bar-key": "value"}}` DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"` }
func (m CreateRecordDetails) String() string
func (m *CreateRecordDetails) UnmarshalJSON(data []byte) (e error)
UnmarshalJSON unmarshals from json
CreateRecordRequest wrapper for the CreateRecord operation
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/55.0.0/datalabelingservicedataplane/CreateRecord.go.html to see an example of how to use CreateRecordRequest.
type CreateRecordRequest struct { // Details for the new Record. CreateRecordDetails `contributesTo:"body"` // A token that uniquely identifies a request so it can be retried in case of a timeout or // server error without risk of executing that same action again. Retry tokens expire after 24 // hours, but can be invalidated before then due to conflicting operations. For example, if a resource // has been deleted and purged from the system, then a retry of the original creation request // might be rejected. OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"` // The client request ID for tracing. OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"` // Metadata about the request. This information will not be transmitted to the service, but // represents information that the SDK will consume to drive retry behavior. RequestMetadata common.RequestMetadata }
func (request CreateRecordRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request CreateRecordRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request CreateRecordRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request CreateRecordRequest) String() string
CreateRecordResponse wrapper for the CreateRecord operation
type CreateRecordResponse struct { // The underlying http response RawResponse *http.Response // The Record instance Record `presentIn:"body"` // For optimistic concurrency control. See `if-match`. Etag *string `presentIn:"header" name:"etag"` // Unique Oracle-assigned identifier for the request. If you need to contact // Oracle about a particular request, please provide the request ID. OpcRequestId *string `presentIn:"header" name:"opc-request-id"` }
func (response CreateRecordResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response CreateRecordResponse) String() string
CreateSourceDetails The source information is a polymorphic entity. It captures the details of how to access the data for record creation. The discriminator type must match the dataset's source type. The convention will be enforced by the API. It should only provide the difference in data necessary to access the content, i.e. the object storage path, or the database record id.
type CreateSourceDetails interface { }
CreateSourceDetailsSourceTypeEnum Enum with underlying type: string
type CreateSourceDetailsSourceTypeEnum string
Set of constants representing the allowable values for CreateSourceDetailsSourceTypeEnum
const ( CreateSourceDetailsSourceTypeObjectStorage CreateSourceDetailsSourceTypeEnum = "OBJECT_STORAGE" )
func GetCreateSourceDetailsSourceTypeEnumValues() []CreateSourceDetailsSourceTypeEnum
GetCreateSourceDetailsSourceTypeEnumValues Enumerates the set of values for CreateSourceDetailsSourceTypeEnum
DataLabelingClient a client for DataLabeling
type DataLabelingClient struct { common.BaseClient // contains filtered or unexported fields }
func NewDataLabelingClientWithConfigurationProvider(configProvider common.ConfigurationProvider) (client DataLabelingClient, err error)
NewDataLabelingClientWithConfigurationProvider Creates a new default DataLabeling client with the given configuration provider. the configuration provider will be used for the default signer as well as reading the region
func NewDataLabelingClientWithOboToken(configProvider common.ConfigurationProvider, oboToken string) (client DataLabelingClient, err error)
NewDataLabelingClientWithOboToken Creates a new default DataLabeling client with the given configuration provider. The obotoken will be added to default headers and signed; the configuration provider will be used for the signer
as well as reading the region
func (client *DataLabelingClient) ConfigurationProvider() *common.ConfigurationProvider
ConfigurationProvider the ConfigurationProvider used in this client, or null if none set
func (client DataLabelingClient) CreateAnnotation(ctx context.Context, request CreateAnnotationRequest) (response CreateAnnotationResponse, err error)
CreateAnnotation Creates an annotation.
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/55.0.0/datalabelingservicedataplane/CreateAnnotation.go.html to see an example of how to use CreateAnnotation API.
func (client DataLabelingClient) CreateRecord(ctx context.Context, request CreateRecordRequest) (response CreateRecordResponse, err error)
CreateRecord Creates a Record.
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/55.0.0/datalabelingservicedataplane/CreateRecord.go.html to see an example of how to use CreateRecord API.
func (client DataLabelingClient) DeleteAnnotation(ctx context.Context, request DeleteAnnotationRequest) (response DeleteAnnotationResponse, err error)
DeleteAnnotation Deletes an Annotation resource by identifier
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/55.0.0/datalabelingservicedataplane/DeleteAnnotation.go.html to see an example of how to use DeleteAnnotation API.
func (client DataLabelingClient) DeleteRecord(ctx context.Context, request DeleteRecordRequest) (response DeleteRecordResponse, err error)
DeleteRecord Deletes a Record resource by identifier
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/55.0.0/datalabelingservicedataplane/DeleteRecord.go.html to see an example of how to use DeleteRecord API.
func (client DataLabelingClient) GetAnnotation(ctx context.Context, request GetAnnotationRequest) (response GetAnnotationResponse, err error)
GetAnnotation Gets an Annotation
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/55.0.0/datalabelingservicedataplane/GetAnnotation.go.html to see an example of how to use GetAnnotation API.
func (client DataLabelingClient) GetDataset(ctx context.Context, request GetDatasetRequest) (response GetDatasetResponse, err error)
GetDataset Gets a Dataset by identifier
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/55.0.0/datalabelingservicedataplane/GetDataset.go.html to see an example of how to use GetDataset API.
func (client DataLabelingClient) GetRecord(ctx context.Context, request GetRecordRequest) (response GetRecordResponse, err error)
GetRecord Gets a record
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/55.0.0/datalabelingservicedataplane/GetRecord.go.html to see an example of how to use GetRecord API.
func (client DataLabelingClient) GetRecordContent(ctx context.Context, request GetRecordContentRequest) (response GetRecordContentResponse, err error)
GetRecordContent Retrieves the content of the record from the Dataset source.
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/55.0.0/datalabelingservicedataplane/GetRecordContent.go.html to see an example of how to use GetRecordContent API.
func (client DataLabelingClient) GetRecordPreviewContent(ctx context.Context, request GetRecordPreviewContentRequest) (response GetRecordPreviewContentResponse, err error)
GetRecordPreviewContent Retrieves the preview of the record content from the Dataset source.
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/55.0.0/datalabelingservicedataplane/GetRecordPreviewContent.go.html to see an example of how to use GetRecordPreviewContent API.
func (client DataLabelingClient) ListAnnotations(ctx context.Context, request ListAnnotationsRequest) (response ListAnnotationsResponse, err error)
ListAnnotations Returns a list of Annotations.
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/55.0.0/datalabelingservicedataplane/ListAnnotations.go.html to see an example of how to use ListAnnotations API.
func (client DataLabelingClient) ListRecords(ctx context.Context, request ListRecordsRequest) (response ListRecordsResponse, err error)
ListRecords List Record in the specified compartment.
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/55.0.0/datalabelingservicedataplane/ListRecords.go.html to see an example of how to use ListRecords API.
func (client *DataLabelingClient) SetRegion(region string)
SetRegion overrides the region of this client.
func (client DataLabelingClient) SummarizeAnnotationAnalytics(ctx context.Context, request SummarizeAnnotationAnalyticsRequest) (response SummarizeAnnotationAnalyticsResponse, err error)
SummarizeAnnotationAnalytics Summarize annotations created for a given dataset
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/55.0.0/datalabelingservicedataplane/SummarizeAnnotationAnalytics.go.html to see an example of how to use SummarizeAnnotationAnalytics API.
func (client DataLabelingClient) SummarizeRecordAnalytics(ctx context.Context, request SummarizeRecordAnalyticsRequest) (response SummarizeRecordAnalyticsResponse, err error)
SummarizeRecordAnalytics Summarize records created for a given dataset
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/55.0.0/datalabelingservicedataplane/SummarizeRecordAnalytics.go.html to see an example of how to use SummarizeRecordAnalytics API.
func (client DataLabelingClient) UpdateAnnotation(ctx context.Context, request UpdateAnnotationRequest) (response UpdateAnnotationResponse, err error)
UpdateAnnotation Updates an annotation.
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/55.0.0/datalabelingservicedataplane/UpdateAnnotation.go.html to see an example of how to use UpdateAnnotation API.
func (client DataLabelingClient) UpdateRecord(ctx context.Context, request UpdateRecordRequest) (response UpdateRecordResponse, err error)
UpdateRecord Updates record.
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/55.0.0/datalabelingservicedataplane/UpdateRecord.go.html to see an example of how to use UpdateRecord API.
Dataset A dataset is a logical collection of records. The dataset contains all the information necessary to describe a record's source, format, type of annotations allowed on these records, and labels allowed on annotations.
type Dataset struct { // The OCID of the Dataset. Id *string `mandatory:"true" json:"id"` // The OCID of the compartment of the resource. CompartmentId *string `mandatory:"true" json:"compartmentId"` // The date and time the resource was created, in the timestamp format defined by RFC3339. TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"` // The date and time the resource was updated, in the timestamp format defined by RFC3339. TimeUpdated *common.SDKTime `mandatory:"true" json:"timeUpdated"` // The state of a dataset. // CREATING - The dataset is being created. It will transition to ACTIVE when it is ready for labeling. // ACTIVE - The dataset is ready for labeling. // UPDATING - The dataset is being updated. It and its related resources may be unavailable for other updates until it returns to ACTIVE. // NEEDS_ATTENTION - A dataset updation operation has failed due to validation or other errors and needs attention. // DELETING - The dataset and its related resources are being deleted. // DELETED - The dataset has been deleted and is no longer available. // FAILED - The dataset has failed due to validation or other errors. LifecycleState DatasetLifecycleStateEnum `mandatory:"true" json:"lifecycleState"` // The annotation format name required for labeling records. AnnotationFormat *string `mandatory:"true" json:"annotationFormat"` DatasetSourceDetails DatasetSourceDetails `mandatory:"true" json:"datasetSourceDetails"` DatasetFormatDetails DatasetFormatDetails `mandatory:"true" json:"datasetFormatDetails"` LabelSet *LabelSet `mandatory:"true" json:"labelSet"` // A user-friendly display name for the resource. DisplayName *string `mandatory:"false" json:"displayName"` // A user provided description of the dataset Description *string `mandatory:"false" json:"description"` // A message describing the current state in more detail. For example, it can be used to provide actionable information for a resource in FAILED or NEEDS_ATTENTION state. LifecycleDetails *string `mandatory:"false" json:"lifecycleDetails"` InitialRecordGenerationConfiguration *InitialRecordGenerationConfiguration `mandatory:"false" json:"initialRecordGenerationConfiguration"` // Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. // Example: `{"bar-key": "value"}` FreeformTags map[string]string `mandatory:"false" json:"freeformTags"` // Defined tags for this resource. Each key is predefined and scoped to a namespace. // Example: `{"foo-namespace": {"bar-key": "value"}}` DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"` // Usage of system tag keys. These predefined keys are scoped to namespaces. // Example: `{"orcl-cloud": {"free-tier-retained": "true"}}` SystemTags map[string]map[string]interface{} `mandatory:"false" json:"systemTags"` }
func (m Dataset) String() string
func (m *Dataset) UnmarshalJSON(data []byte) (e error)
UnmarshalJSON unmarshals from json
DatasetFormatDetails Specifies how to process the data. Supported formats include IMAGE and TEXT.
type DatasetFormatDetails interface { }
DatasetFormatDetailsFormatTypeEnum Enum with underlying type: string
type DatasetFormatDetailsFormatTypeEnum string
Set of constants representing the allowable values for DatasetFormatDetailsFormatTypeEnum
const ( DatasetFormatDetailsFormatTypeDocument DatasetFormatDetailsFormatTypeEnum = "DOCUMENT" DatasetFormatDetailsFormatTypeImage DatasetFormatDetailsFormatTypeEnum = "IMAGE" DatasetFormatDetailsFormatTypeText DatasetFormatDetailsFormatTypeEnum = "TEXT" )
func GetDatasetFormatDetailsFormatTypeEnumValues() []DatasetFormatDetailsFormatTypeEnum
GetDatasetFormatDetailsFormatTypeEnumValues Enumerates the set of values for DatasetFormatDetailsFormatTypeEnum
DatasetLifecycleStateEnum Enum with underlying type: string
type DatasetLifecycleStateEnum string
Set of constants representing the allowable values for DatasetLifecycleStateEnum
const ( DatasetLifecycleStateCreating DatasetLifecycleStateEnum = "CREATING" DatasetLifecycleStateUpdating DatasetLifecycleStateEnum = "UPDATING" DatasetLifecycleStateActive DatasetLifecycleStateEnum = "ACTIVE" DatasetLifecycleStateNeedsAttention DatasetLifecycleStateEnum = "NEEDS_ATTENTION" DatasetLifecycleStateDeleting DatasetLifecycleStateEnum = "DELETING" DatasetLifecycleStateDeleted DatasetLifecycleStateEnum = "DELETED" DatasetLifecycleStateFailed DatasetLifecycleStateEnum = "FAILED" )
func GetDatasetLifecycleStateEnumValues() []DatasetLifecycleStateEnum
GetDatasetLifecycleStateEnumValues Enumerates the set of values for DatasetLifecycleStateEnum
DatasetSourceDetails This allows the customer to specify the source of the dataset.
type DatasetSourceDetails interface { }
DatasetSourceDetailsSourceTypeEnum Enum with underlying type: string
type DatasetSourceDetailsSourceTypeEnum string
Set of constants representing the allowable values for DatasetSourceDetailsSourceTypeEnum
const ( DatasetSourceDetailsSourceTypeObjectStorage DatasetSourceDetailsSourceTypeEnum = "OBJECT_STORAGE" )
func GetDatasetSourceDetailsSourceTypeEnumValues() []DatasetSourceDetailsSourceTypeEnum
GetDatasetSourceDetailsSourceTypeEnumValues Enumerates the set of values for DatasetSourceDetailsSourceTypeEnum
DeleteAnnotationRequest wrapper for the DeleteAnnotation operation
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/55.0.0/datalabelingservicedataplane/DeleteAnnotation.go.html to see an example of how to use DeleteAnnotationRequest.
type DeleteAnnotationRequest struct { // unique Annotation identifier AnnotationId *string `mandatory:"true" contributesTo:"path" name:"annotationId"` // For optimistic concurrency control. In the PUT or DELETE call // for a resource, set the `if-match` parameter to the value of the // etag from a previous GET or POST response for that resource. // The resource will be updated or deleted only if the etag you // provide matches the resource's current etag value. IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"` // The client request ID for tracing. OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"` // Metadata about the request. This information will not be transmitted to the service, but // represents information that the SDK will consume to drive retry behavior. RequestMetadata common.RequestMetadata }
func (request DeleteAnnotationRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request DeleteAnnotationRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request DeleteAnnotationRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request DeleteAnnotationRequest) String() string
DeleteAnnotationResponse wrapper for the DeleteAnnotation operation
type DeleteAnnotationResponse struct { // The underlying http response RawResponse *http.Response // Unique Oracle-assigned identifier for the request. If you need to contact // Oracle about a particular request, please provide the request ID. OpcRequestId *string `presentIn:"header" name:"opc-request-id"` }
func (response DeleteAnnotationResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response DeleteAnnotationResponse) String() string
DeleteRecordRequest wrapper for the DeleteRecord operation
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/55.0.0/datalabelingservicedataplane/DeleteRecord.go.html to see an example of how to use DeleteRecordRequest.
type DeleteRecordRequest struct { // The OCID of the record annotated RecordId *string `mandatory:"true" contributesTo:"path" name:"recordId"` // For optimistic concurrency control. In the PUT or DELETE call // for a resource, set the `if-match` parameter to the value of the // etag from a previous GET or POST response for that resource. // The resource will be updated or deleted only if the etag you // provide matches the resource's current etag value. IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"` // The client request ID for tracing. OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"` // Metadata about the request. This information will not be transmitted to the service, but // represents information that the SDK will consume to drive retry behavior. RequestMetadata common.RequestMetadata }
func (request DeleteRecordRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request DeleteRecordRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request DeleteRecordRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request DeleteRecordRequest) String() string
DeleteRecordResponse wrapper for the DeleteRecord operation
type DeleteRecordResponse struct { // The underlying http response RawResponse *http.Response // Unique Oracle-assigned identifier for the request. If you need to contact // Oracle about a particular request, please provide the request ID. OpcRequestId *string `presentIn:"header" name:"opc-request-id"` }
func (response DeleteRecordResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response DeleteRecordResponse) String() string
DocumentDatasetFormatDetails Allows the user to specify that the dataset is comprised of document files (e.g. PDFs, DOCs, etc.). It is open for further configurability.
type DocumentDatasetFormatDetails struct { }
func (m DocumentDatasetFormatDetails) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m DocumentDatasetFormatDetails) String() string
Entity An entity allows the labeler to identify an object in the record to label. This can be a snippet of text, an entire image, a bounding box within an image, or, eventually, a custom format that works for them. All entity types will have an array of labels that we'll index. If more than one label is provided, but the annotationType on the corresponding Dataset is for single class, the API will reject the create annotation request.
type Entity interface { }
EntityEntityTypeEnum Enum with underlying type: string
type EntityEntityTypeEnum string
Set of constants representing the allowable values for EntityEntityTypeEnum
const ( EntityEntityTypeGeneric EntityEntityTypeEnum = "GENERIC" EntityEntityTypeImageobjectselection EntityEntityTypeEnum = "IMAGEOBJECTSELECTION" EntityEntityTypeTextselection EntityEntityTypeEnum = "TEXTSELECTION" )
func GetEntityEntityTypeEnumValues() []EntityEntityTypeEnum
GetEntityEntityTypeEnumValues Enumerates the set of values for EntityEntityTypeEnum
GenericEntity This is an extensible entity type for users and the base entity type for some annotation formats
type GenericEntity struct { // collection of Label entities Labels []Label `mandatory:"true" json:"labels"` // Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. // Example: `{"bar-key": "value"}` ExtendedMetadata map[string]string `mandatory:"false" json:"extendedMetadata"` }
func (m GenericEntity) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m GenericEntity) String() string
GetAnnotationRequest wrapper for the GetAnnotation operation
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/55.0.0/datalabelingservicedataplane/GetAnnotation.go.html to see an example of how to use GetAnnotationRequest.
type GetAnnotationRequest struct { // unique Annotation identifier AnnotationId *string `mandatory:"true" contributesTo:"path" name:"annotationId"` // The client request ID for tracing. OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"` // Metadata about the request. This information will not be transmitted to the service, but // represents information that the SDK will consume to drive retry behavior. RequestMetadata common.RequestMetadata }
func (request GetAnnotationRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request GetAnnotationRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetAnnotationRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetAnnotationRequest) String() string
GetAnnotationResponse wrapper for the GetAnnotation operation
type GetAnnotationResponse struct { // The underlying http response RawResponse *http.Response // The Annotation instance Annotation `presentIn:"body"` // For optimistic concurrency control. See `if-match`. Etag *string `presentIn:"header" name:"etag"` // Unique Oracle-assigned identifier for the request. If you need to contact // Oracle about a particular request, please provide the request ID. OpcRequestId *string `presentIn:"header" name:"opc-request-id"` }
func (response GetAnnotationResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetAnnotationResponse) String() string
GetDatasetRequest wrapper for the GetDataset operation
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/55.0.0/datalabelingservicedataplane/GetDataset.go.html to see an example of how to use GetDatasetRequest.
type GetDatasetRequest struct { // Unique Dataset OCID DatasetId *string `mandatory:"true" contributesTo:"path" name:"datasetId"` // The client request ID for tracing. OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"` // Metadata about the request. This information will not be transmitted to the service, but // represents information that the SDK will consume to drive retry behavior. RequestMetadata common.RequestMetadata }
func (request GetDatasetRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request GetDatasetRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetDatasetRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetDatasetRequest) String() string
GetDatasetResponse wrapper for the GetDataset operation
type GetDatasetResponse struct { // The underlying http response RawResponse *http.Response // The Dataset instance Dataset `presentIn:"body"` // For optimistic concurrency control. See `if-match`. Etag *string `presentIn:"header" name:"etag"` // Unique Oracle-assigned identifier for the request. If you need to contact // Oracle about a particular request, please provide the request ID. OpcRequestId *string `presentIn:"header" name:"opc-request-id"` }
func (response GetDatasetResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetDatasetResponse) String() string
GetRecordContentRequest wrapper for the GetRecordContent operation
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/55.0.0/datalabelingservicedataplane/GetRecordContent.go.html to see an example of how to use GetRecordContentRequest.
type GetRecordContentRequest struct { // The OCID of the record annotated RecordId *string `mandatory:"true" contributesTo:"path" name:"recordId"` // The client request ID for tracing. OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"` // For optimistic concurrency control. In the GET call // for a resource, set the `if-none-match` parameter to the value of the // etag from a previous GET or POST response for that resource. // The resource will be fetched only if the etag you provide does // not match the resource's current etag value. IfNoneMatch *string `mandatory:"false" contributesTo:"header" name:"if-none-match"` // Metadata about the request. This information will not be transmitted to the service, but // represents information that the SDK will consume to drive retry behavior. RequestMetadata common.RequestMetadata }
func (request GetRecordContentRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request GetRecordContentRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetRecordContentRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetRecordContentRequest) String() string
GetRecordContentResponse wrapper for the GetRecordContent operation
type GetRecordContentResponse struct { // The underlying http response RawResponse *http.Response // The io.ReadCloser instance Content io.ReadCloser `presentIn:"body" encoding:"binary"` // For optimistic concurrency control. See `if-match`. Etag *string `presentIn:"header" name:"etag"` // Unique Oracle-assigned identifier for the request. If you need to contact // Oracle about a particular request, please provide the request ID. OpcRequestId *string `presentIn:"header" name:"opc-request-id"` // The content size of the body in bytes. ContentLength *int64 `presentIn:"header" name:"content-length"` // The content disposition of the body, as described in RFC 2616 (https://tools.ietf.org/rfc/rfc2616), section 19.5.1. ContentDisposition *string `presentIn:"header" name:"content-disposition"` // The content type as described in RFC 2616 (https://tools.ietf.org/rfc/rfc2616), section 14.17. ContentType *string `presentIn:"header" name:"content-type"` // Cache-control allows us to tell browsers to cache assets, how long to store them, and whether to validate them. CacheControl *string `presentIn:"header" name:"cache-control"` // Flag to indicate whether or not the object was modified. If this is true, // the getter for the object itself will return null. Callers should check this // if they specified one of the request params that might result in a conditional // response (like 'if-match'/'if-none-match'). IsNotModified bool }
func (response GetRecordContentResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetRecordContentResponse) String() string
GetRecordPreviewContentRequest wrapper for the GetRecordPreviewContent operation
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/55.0.0/datalabelingservicedataplane/GetRecordPreviewContent.go.html to see an example of how to use GetRecordPreviewContentRequest.
type GetRecordPreviewContentRequest struct { // The OCID of the record annotated RecordId *string `mandatory:"true" contributesTo:"path" name:"recordId"` // The client request ID for tracing. OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"` // For optimistic concurrency control. In the GET call // for a resource, set the `if-none-match` parameter to the value of the // etag from a previous GET or POST response for that resource. // The resource will be fetched only if the etag you provide does // not match the resource's current etag value. IfNoneMatch *string `mandatory:"false" contributesTo:"header" name:"if-none-match"` // Metadata about the request. This information will not be transmitted to the service, but // represents information that the SDK will consume to drive retry behavior. RequestMetadata common.RequestMetadata }
func (request GetRecordPreviewContentRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request GetRecordPreviewContentRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetRecordPreviewContentRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetRecordPreviewContentRequest) String() string
GetRecordPreviewContentResponse wrapper for the GetRecordPreviewContent operation
type GetRecordPreviewContentResponse struct { // The underlying http response RawResponse *http.Response // The io.ReadCloser instance Content io.ReadCloser `presentIn:"body" encoding:"binary"` // For optimistic concurrency control. See `if-match`. Etag *string `presentIn:"header" name:"etag"` // Unique Oracle-assigned identifier for the request. If you need to contact // Oracle about a particular request, please provide the request ID. OpcRequestId *string `presentIn:"header" name:"opc-request-id"` // The content size of the body in bytes. ContentLength *int64 `presentIn:"header" name:"content-length"` // The content disposition of the body, as described in RFC 2616 (https://tools.ietf.org/rfc/rfc2616), section 19.5.1. ContentDisposition *string `presentIn:"header" name:"content-disposition"` // The content type as described in RFC 2616 (https://tools.ietf.org/rfc/rfc2616), section 14.17. ContentType *string `presentIn:"header" name:"content-type"` // Cache-control allows us to tell browsers to cache assets, how long to store them, and whether to validate them. CacheControl *string `presentIn:"header" name:"cache-control"` // Flag to indicate whether or not the object was modified. If this is true, // the getter for the object itself will return null. Callers should check this // if they specified one of the request params that might result in a conditional // response (like 'if-match'/'if-none-match'). IsNotModified bool }
func (response GetRecordPreviewContentResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetRecordPreviewContentResponse) String() string
GetRecordRequest wrapper for the GetRecord operation
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/55.0.0/datalabelingservicedataplane/GetRecord.go.html to see an example of how to use GetRecordRequest.
type GetRecordRequest struct { // The OCID of the record annotated RecordId *string `mandatory:"true" contributesTo:"path" name:"recordId"` // The client request ID for tracing. OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"` // Metadata about the request. This information will not be transmitted to the service, but // represents information that the SDK will consume to drive retry behavior. RequestMetadata common.RequestMetadata }
func (request GetRecordRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request GetRecordRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetRecordRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetRecordRequest) String() string
GetRecordResponse wrapper for the GetRecord operation
type GetRecordResponse struct { // The underlying http response RawResponse *http.Response // The Record instance Record `presentIn:"body"` // For optimistic concurrency control. See `if-match`. Etag *string `presentIn:"header" name:"etag"` // Unique Oracle-assigned identifier for the request. If you need to contact // Oracle about a particular request, please provide the request ID. OpcRequestId *string `presentIn:"header" name:"opc-request-id"` }
func (response GetRecordResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetRecordResponse) String() string
ImageDatasetFormatDetails Indicates the dataset is comprised of images.
type ImageDatasetFormatDetails struct { }
func (m ImageDatasetFormatDetails) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m ImageDatasetFormatDetails) String() string
ImageObjectSelectionEntity This allows the labeler to use specify a series of coordinates in the image to represent an object and apply labels to it. The coordinates will be connected in the order that they are provided and the last coordinate in the array will be connected to the first.
type ImageObjectSelectionEntity struct { // Collection of Label entities Labels []Label `mandatory:"true" json:"labels"` BoundingPolygon *BoundingPolygon `mandatory:"true" json:"boundingPolygon"` // Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. // Example: `{"bar-key": "value"}` ExtendedMetadata map[string]string `mandatory:"false" json:"extendedMetadata"` }
func (m ImageObjectSelectionEntity) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m ImageObjectSelectionEntity) String() string
InitialRecordGenerationConfiguration Initial Generate Records configuration, generates records from the Dataset's source.
type InitialRecordGenerationConfiguration struct { // the maximum number of records to generate. Limit *float32 `mandatory:"false" json:"limit"` }
func (m InitialRecordGenerationConfiguration) String() string
Label A label is a string value. The API will validate that it's one of the dataset's pre-defined labels. In the future, we'll be able to support a confidence score.
type Label struct { // The label provided by the annotator. Label *string `mandatory:"true" json:"label"` }
func (m Label) String() string
LabelName Represents a label.
type LabelName struct { // An unique name for a label within its dataset. Name *string `mandatory:"false" json:"name"` }
func (m LabelName) String() string
LabelSet An ordered collection of Labels that are unique by name.
type LabelSet struct { // An ordered collection of Labels that are unique by name. Items []LabelName `mandatory:"false" json:"items"` }
func (m LabelSet) String() string
ListAnnotationsRequest wrapper for the ListAnnotations operation
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/55.0.0/datalabelingservicedataplane/ListAnnotations.go.html to see an example of how to use ListAnnotationsRequest.
type ListAnnotationsRequest struct { // The ID of the compartment in which to list resources. CompartmentId *string `mandatory:"true" contributesTo:"query" name:"compartmentId"` // Filter results by the OCID of the dataset. DatasetId *string `mandatory:"true" contributesTo:"query" name:"datasetId"` // A filter to return only resources their lifecycleState matches the given lifecycleState. LifecycleState AnnotationLifecycleStateEnum `mandatory:"false" contributesTo:"query" name:"lifecycleState" omitEmpty:"true"` // Unique OCID identifier Id *string `mandatory:"false" contributesTo:"query" name:"id"` // The OCID of the principal who updated the annotation. UpdatedBy *string `mandatory:"false" contributesTo:"query" name:"updatedBy"` // The OCID of the record annotated RecordId *string `mandatory:"false" contributesTo:"query" name:"recordId"` // The date and time the resource was created, in the timestamp format defined by RFC3339. TimeCreatedGreaterThanOrEqualTo *common.SDKTime `mandatory:"false" contributesTo:"query" name:"timeCreatedGreaterThanOrEqualTo"` // The date and time the resource was created, in the timestamp format defined by RFC3339. TimeCreatedLessThanOrEqualTo *common.SDKTime `mandatory:"false" contributesTo:"query" name:"timeCreatedLessThanOrEqualTo"` // The maximum number of items to return. Limit *int `mandatory:"false" contributesTo:"query" name:"limit"` // The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call. Page *string `mandatory:"false" contributesTo:"query" name:"page"` // The sort order to use, either 'asc' or 'desc'. SortOrder ListAnnotationsSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"` // The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. If no value is specified timeCreated is default. SortBy ListAnnotationsSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"` // The client request ID for tracing. OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"` // Metadata about the request. This information will not be transmitted to the service, but // represents information that the SDK will consume to drive retry behavior. RequestMetadata common.RequestMetadata }
func (request ListAnnotationsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListAnnotationsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListAnnotationsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListAnnotationsRequest) String() string
ListAnnotationsResponse wrapper for the ListAnnotations operation
type ListAnnotationsResponse struct { // The underlying http response RawResponse *http.Response // A list of AnnotationCollection instances AnnotationCollection `presentIn:"body"` // Unique Oracle-assigned identifier for the request. If you need to contact // Oracle about a particular request, please provide the request ID. OpcRequestId *string `presentIn:"header" name:"opc-request-id"` // For pagination of a list of items. When paging through a list, if this header appears in the response, // then a partial list might have been returned. Include this value as the `page` parameter for the // subsequent GET request to get the next batch of items. OpcNextPage *string `presentIn:"header" name:"opc-next-page"` }
func (response ListAnnotationsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListAnnotationsResponse) String() string
ListAnnotationsSortByEnum Enum with underlying type: string
type ListAnnotationsSortByEnum string
Set of constants representing the allowable values for ListAnnotationsSortByEnum
const ( ListAnnotationsSortByTimecreated ListAnnotationsSortByEnum = "timeCreated" ListAnnotationsSortByLabel ListAnnotationsSortByEnum = "label" )
func GetListAnnotationsSortByEnumValues() []ListAnnotationsSortByEnum
GetListAnnotationsSortByEnumValues Enumerates the set of values for ListAnnotationsSortByEnum
ListAnnotationsSortOrderEnum Enum with underlying type: string
type ListAnnotationsSortOrderEnum string
Set of constants representing the allowable values for ListAnnotationsSortOrderEnum
const ( ListAnnotationsSortOrderAsc ListAnnotationsSortOrderEnum = "ASC" ListAnnotationsSortOrderDesc ListAnnotationsSortOrderEnum = "DESC" )
func GetListAnnotationsSortOrderEnumValues() []ListAnnotationsSortOrderEnum
GetListAnnotationsSortOrderEnumValues Enumerates the set of values for ListAnnotationsSortOrderEnum
ListRecordsRequest wrapper for the ListRecords operation
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/55.0.0/datalabelingservicedataplane/ListRecords.go.html to see an example of how to use ListRecordsRequest.
type ListRecordsRequest struct { // The ID of the compartment in which to list resources. CompartmentId *string `mandatory:"true" contributesTo:"query" name:"compartmentId"` // Filter results by the OCID of the dataset. DatasetId *string `mandatory:"true" contributesTo:"query" name:"datasetId"` // A filter to return only resources their lifecycleState matches the given lifecycleState. LifecycleState RecordLifecycleStateEnum `mandatory:"false" contributesTo:"query" name:"lifecycleState" omitEmpty:"true"` // Name of the record Name *string `mandatory:"false" contributesTo:"query" name:"name"` // Unique OCID identifier Id *string `mandatory:"false" contributesTo:"query" name:"id"` // Whether the record has been labeled and has associated annotations. IsLabeled *bool `mandatory:"false" contributesTo:"query" name:"isLabeled"` // Allows the user to filter records based on the related annotations. AnnotationLabelsContains []string `contributesTo:"query" name:"annotationLabelsContains" collectionFormat:"multi"` // The maximum number of items to return. Limit *int `mandatory:"false" contributesTo:"query" name:"limit"` // The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call. Page *string `mandatory:"false" contributesTo:"query" name:"page"` // The sort order to use, either 'asc' or 'desc'. SortOrder ListRecordsSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"` // The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. Default order for name is ascending. If no value is specified timeCreated is default. SortBy ListRecordsSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"` // The client request ID for tracing. OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"` // Metadata about the request. This information will not be transmitted to the service, but // represents information that the SDK will consume to drive retry behavior. RequestMetadata common.RequestMetadata }
func (request ListRecordsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListRecordsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListRecordsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListRecordsRequest) String() string
ListRecordsResponse wrapper for the ListRecords operation
type ListRecordsResponse struct { // The underlying http response RawResponse *http.Response // A list of RecordCollection instances RecordCollection `presentIn:"body"` // Unique Oracle-assigned identifier for the request. If you need to contact // Oracle about a particular request, please provide the request ID. OpcRequestId *string `presentIn:"header" name:"opc-request-id"` // For pagination of a list of items. When paging through a list, if this header appears in the response, // then a partial list might have been returned. Include this value as the `page` parameter for the // subsequent GET request to get the next batch of items. OpcNextPage *string `presentIn:"header" name:"opc-next-page"` }
func (response ListRecordsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListRecordsResponse) String() string
ListRecordsSortByEnum Enum with underlying type: string
type ListRecordsSortByEnum string
Set of constants representing the allowable values for ListRecordsSortByEnum
const ( ListRecordsSortByTimecreated ListRecordsSortByEnum = "timeCreated" ListRecordsSortByName ListRecordsSortByEnum = "name" )
func GetListRecordsSortByEnumValues() []ListRecordsSortByEnum
GetListRecordsSortByEnumValues Enumerates the set of values for ListRecordsSortByEnum
ListRecordsSortOrderEnum Enum with underlying type: string
type ListRecordsSortOrderEnum string
Set of constants representing the allowable values for ListRecordsSortOrderEnum
const ( ListRecordsSortOrderAsc ListRecordsSortOrderEnum = "ASC" ListRecordsSortOrderDesc ListRecordsSortOrderEnum = "DESC" )
func GetListRecordsSortOrderEnumValues() []ListRecordsSortOrderEnum
GetListRecordsSortOrderEnumValues Enumerates the set of values for ListRecordsSortOrderEnum
NormalizedVertex A NormalizedVertex is a cartesian coordinate that represents a corner between two segments of a polygon.
type NormalizedVertex struct { // X axis coordinate X *float32 `mandatory:"true" json:"x"` // Y axis coordinate Y *float32 `mandatory:"true" json:"y"` }
func (m NormalizedVertex) String() string
ObjectStorageDatasetSourceDetails Specifies the dataset location in object storage. This requires that all records are in this bucket, and under this prefix. We do not support a dataset with objects in arbitrary locations across buckets or prefixes.
type ObjectStorageDatasetSourceDetails struct { // Namespace of the bucket that contains the dataset data source Namespace *string `mandatory:"true" json:"namespace"` // The object storage bucket that contains the dataset data source Bucket *string `mandatory:"true" json:"bucket"` // A common path prefix shared by the objects that make up the dataset. Prefix *string `mandatory:"false" json:"prefix"` }
func (m ObjectStorageDatasetSourceDetails) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m ObjectStorageDatasetSourceDetails) String() string
ObjectStorageSourceDetails Object Storage Source Details.
type ObjectStorageSourceDetails struct { // The path relative to the prefix specified in the dataset source details (file name). RelativePath *string `mandatory:"true" json:"relativePath"` // The full path of the file this record belongs to. Path *string `mandatory:"true" json:"path"` // The offset into the file containing the content. Offset *float32 `mandatory:"false" json:"offset"` // The length from offset into the file containing the content. Length *float32 `mandatory:"false" json:"length"` }
func (m ObjectStorageSourceDetails) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m ObjectStorageSourceDetails) String() string
Record A record represents an entry in a dataset that needs labeling.
type Record struct { // The OCID of the record Id *string `mandatory:"true" json:"id"` // This will be created by Customer. It will be unique and immutable. Name *string `mandatory:"true" json:"name"` // The date and time the resource was created, in the timestamp format defined by RFC3339. TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"` // The date and time the resource was updated, in the timestamp format defined by RFC3339. TimeUpdated *common.SDKTime `mandatory:"true" json:"timeUpdated"` // The OCID of the dataset to associate the record with DatasetId *string `mandatory:"true" json:"datasetId"` // The OCID of the compartment for the task. CompartmentId *string `mandatory:"true" json:"compartmentId"` SourceDetails SourceDetails `mandatory:"true" json:"sourceDetails"` // Whether the record has been labeled and has associated annotations. IsLabeled *bool `mandatory:"true" json:"isLabeled"` // Lifecycle state of the Record. // ACTIVE - Record is active and ready for labeling. // INACTIVE - Record has been marked as inactive and should not be used for labeling. // DELETED - Record has been deleted and no longer available for labeling. LifecycleState RecordLifecycleStateEnum `mandatory:"true" json:"lifecycleState"` // Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. // Example: `{"bar-key": "value"}` FreeformTags map[string]string `mandatory:"false" json:"freeformTags"` // Defined tags for this resource. Each key is predefined and scoped to a namespace. // Example: `{"foo-namespace": {"bar-key": "value"}}` DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"` }
func (m Record) String() string
func (m *Record) UnmarshalJSON(data []byte) (e error)
UnmarshalJSON unmarshals from json
RecordAggregationDimensions Dimensions to summarize record information for a given dataset
type RecordAggregationDimensions struct { // Whether the record has been labeled and has associated annotations. IsLabeled *bool `mandatory:"false" json:"isLabeled"` // Whether the annotation contains label. AnnotationLabelContains *string `mandatory:"false" json:"annotationLabelContains"` }
func (m RecordAggregationDimensions) String() string
RecordAnalyticsAggregation Aggregation entities are required by the api consistency guidelines for API Consistency Guidelines#AnalyticsAPIs. These are used to summarize record information for a given dataset and will be used to populate UI elements. Aggregations need to have the fields that identify the exact scope that they're summarizing. Any filters to the list API we apply would have to show up in the aggregation. We should limit the number of filters and dimensions as much as possible.
type RecordAnalyticsAggregation struct { // the count of the matching results Count *float32 `mandatory:"true" json:"count"` // ocid of the dataset the annotation belongs to DatasetId *string `mandatory:"true" json:"datasetId"` // ocid of the compartment the records CompartmentId *string `mandatory:"true" json:"compartmentId"` Dimensions *RecordAggregationDimensions `mandatory:"false" json:"dimensions"` // Describes the lifecycle state. LifecycleState RecordLifecycleStateEnum `mandatory:"false" json:"lifecycleState,omitempty"` }
func (m RecordAnalyticsAggregation) String() string
RecordAnalyticsAggregationCollection Collection of records aggregated.
type RecordAnalyticsAggregationCollection struct { // List of Record entities. Items []RecordAnalyticsAggregation `mandatory:"true" json:"items"` }
func (m RecordAnalyticsAggregationCollection) String() string
RecordCollection Results of a record search. Contains both RecordSummary items and other data.
type RecordCollection struct { // List of records. Items []RecordSummary `mandatory:"true" json:"items"` }
func (m RecordCollection) String() string
RecordLifecycleStateEnum Enum with underlying type: string
type RecordLifecycleStateEnum string
Set of constants representing the allowable values for RecordLifecycleStateEnum
const ( RecordLifecycleStateActive RecordLifecycleStateEnum = "ACTIVE" RecordLifecycleStateInactive RecordLifecycleStateEnum = "INACTIVE" RecordLifecycleStateDeleted RecordLifecycleStateEnum = "DELETED" )
func GetRecordLifecycleStateEnumValues() []RecordLifecycleStateEnum
GetRecordLifecycleStateEnumValues Enumerates the set of values for RecordLifecycleStateEnum
RecordSummary A record summary is the representation returned in list views. It is usually a subset of the full record entity and should not contain any potentially sensitive information.
type RecordSummary struct { // The OCID of the record Id *string `mandatory:"true" json:"id"` // This will be automatically assigned by the service. It will be unique and immutable Name *string `mandatory:"true" json:"name"` // The date and time the resource was created, in the timestamp format defined by RFC3339. TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"` // The date and time the resource was updated, in the timestamp format defined by RFC3339. TimeUpdated *common.SDKTime `mandatory:"true" json:"timeUpdated"` // The OCID of the dataset to associate the record with DatasetId *string `mandatory:"true" json:"datasetId"` // The OCID of the compartment for the task. CompartmentId *string `mandatory:"true" json:"compartmentId"` // Whether the record has been labeled and has associated annotations. IsLabeled *bool `mandatory:"true" json:"isLabeled"` // Describes the lifecycle state. LifecycleState RecordLifecycleStateEnum `mandatory:"true" json:"lifecycleState"` // Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. // Example: `{"bar-key": "value"}` FreeformTags map[string]string `mandatory:"false" json:"freeformTags"` // Defined tags for this resource. Each key is predefined and scoped to a namespace. // Example: `{"foo-namespace": {"bar-key": "value"}}` DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"` }
func (m RecordSummary) String() string
SortOrdersEnum Enum with underlying type: string
type SortOrdersEnum string
Set of constants representing the allowable values for SortOrdersEnum
const ( SortOrdersAsc SortOrdersEnum = "ASC" SortOrdersDesc SortOrdersEnum = "DESC" )
func GetSortOrdersEnumValues() []SortOrdersEnum
GetSortOrdersEnumValues Enumerates the set of values for SortOrdersEnum
SourceDetails The source information is a polymorphic entity. It captures the details of data used for record creation. The discriminator type must match the dataset's source type. The convention will be enforced by the API.
type SourceDetails interface { }
SourceDetailsSourceTypeEnum Enum with underlying type: string
type SourceDetailsSourceTypeEnum string
Set of constants representing the allowable values for SourceDetailsSourceTypeEnum
const ( SourceDetailsSourceTypeObjectStorage SourceDetailsSourceTypeEnum = "OBJECT_STORAGE" )
func GetSourceDetailsSourceTypeEnumValues() []SourceDetailsSourceTypeEnum
GetSourceDetailsSourceTypeEnumValues Enumerates the set of values for SourceDetailsSourceTypeEnum
SummarizeAnnotationAnalyticsAnnotationGroupByEnum Enum with underlying type: string
type SummarizeAnnotationAnalyticsAnnotationGroupByEnum string
Set of constants representing the allowable values for SummarizeAnnotationAnalyticsAnnotationGroupByEnum
const ( SummarizeAnnotationAnalyticsAnnotationGroupByUpdatedby SummarizeAnnotationAnalyticsAnnotationGroupByEnum = "updatedBy" SummarizeAnnotationAnalyticsAnnotationGroupByLabel SummarizeAnnotationAnalyticsAnnotationGroupByEnum = "label" )
func GetSummarizeAnnotationAnalyticsAnnotationGroupByEnumValues() []SummarizeAnnotationAnalyticsAnnotationGroupByEnum
GetSummarizeAnnotationAnalyticsAnnotationGroupByEnumValues Enumerates the set of values for SummarizeAnnotationAnalyticsAnnotationGroupByEnum
SummarizeAnnotationAnalyticsRequest wrapper for the SummarizeAnnotationAnalytics operation
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/55.0.0/datalabelingservicedataplane/SummarizeAnnotationAnalytics.go.html to see an example of how to use SummarizeAnnotationAnalyticsRequest.
type SummarizeAnnotationAnalyticsRequest struct { // The ID of the compartment in which to list resources. CompartmentId *string `mandatory:"true" contributesTo:"query" name:"compartmentId"` // Filter results by the OCID of the dataset. DatasetId *string `mandatory:"true" contributesTo:"query" name:"datasetId"` // A filter to return only resources their lifecycleState matches the given lifecycleState. LifecycleState AnnotationLifecycleStateEnum `mandatory:"false" contributesTo:"query" name:"lifecycleState" omitEmpty:"true"` // This field is used to summarize annotations with specified label. Label *string `mandatory:"false" contributesTo:"query" name:"label"` // The maximum number of items to return. Limit *int `mandatory:"false" contributesTo:"query" name:"limit"` // The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call. Page *string `mandatory:"false" contributesTo:"query" name:"page"` // The sort order to use, either 'asc' or 'desc'. SortOrder SummarizeAnnotationAnalyticsSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"` // The field to sort by. Only one sort order may be provided. Default order is descending. If no value is specified updatedBy is default. SortBy SummarizeAnnotationAnalyticsSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"` // The field to group by. If no value is specified updatedBy is default. AnnotationGroupBy SummarizeAnnotationAnalyticsAnnotationGroupByEnum `mandatory:"false" contributesTo:"query" name:"annotationGroupBy" omitEmpty:"true"` // The client request ID for tracing. OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"` // Metadata about the request. This information will not be transmitted to the service, but // represents information that the SDK will consume to drive retry behavior. RequestMetadata common.RequestMetadata }
func (request SummarizeAnnotationAnalyticsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request SummarizeAnnotationAnalyticsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request SummarizeAnnotationAnalyticsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request SummarizeAnnotationAnalyticsRequest) String() string
SummarizeAnnotationAnalyticsResponse wrapper for the SummarizeAnnotationAnalytics operation
type SummarizeAnnotationAnalyticsResponse struct { // The underlying http response RawResponse *http.Response // A list of AnnotationAnalyticsAggregationCollection instances AnnotationAnalyticsAggregationCollection `presentIn:"body"` // Unique Oracle-assigned identifier for the request. If you need to contact // Oracle about a particular request, please provide the request ID. OpcRequestId *string `presentIn:"header" name:"opc-request-id"` // For pagination of a list of items. When paging through a list, if this header appears in the response, // then a partial list might have been returned. Include this value as the `page` parameter for the // subsequent GET request to get the next batch of items. OpcNextPage *string `presentIn:"header" name:"opc-next-page"` }
func (response SummarizeAnnotationAnalyticsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response SummarizeAnnotationAnalyticsResponse) String() string
SummarizeAnnotationAnalyticsSortByEnum Enum with underlying type: string
type SummarizeAnnotationAnalyticsSortByEnum string
Set of constants representing the allowable values for SummarizeAnnotationAnalyticsSortByEnum
const ( SummarizeAnnotationAnalyticsSortByCount SummarizeAnnotationAnalyticsSortByEnum = "count" SummarizeAnnotationAnalyticsSortByLabel SummarizeAnnotationAnalyticsSortByEnum = "label" SummarizeAnnotationAnalyticsSortByUpdatedby SummarizeAnnotationAnalyticsSortByEnum = "updatedBy" )
func GetSummarizeAnnotationAnalyticsSortByEnumValues() []SummarizeAnnotationAnalyticsSortByEnum
GetSummarizeAnnotationAnalyticsSortByEnumValues Enumerates the set of values for SummarizeAnnotationAnalyticsSortByEnum
SummarizeAnnotationAnalyticsSortOrderEnum Enum with underlying type: string
type SummarizeAnnotationAnalyticsSortOrderEnum string
Set of constants representing the allowable values for SummarizeAnnotationAnalyticsSortOrderEnum
const ( SummarizeAnnotationAnalyticsSortOrderAsc SummarizeAnnotationAnalyticsSortOrderEnum = "ASC" SummarizeAnnotationAnalyticsSortOrderDesc SummarizeAnnotationAnalyticsSortOrderEnum = "DESC" )
func GetSummarizeAnnotationAnalyticsSortOrderEnumValues() []SummarizeAnnotationAnalyticsSortOrderEnum
GetSummarizeAnnotationAnalyticsSortOrderEnumValues Enumerates the set of values for SummarizeAnnotationAnalyticsSortOrderEnum
SummarizeRecordAnalyticsRecordGroupByEnum Enum with underlying type: string
type SummarizeRecordAnalyticsRecordGroupByEnum string
Set of constants representing the allowable values for SummarizeRecordAnalyticsRecordGroupByEnum
const ( SummarizeRecordAnalyticsRecordGroupByIslabeled SummarizeRecordAnalyticsRecordGroupByEnum = "isLabeled" SummarizeRecordAnalyticsRecordGroupByAnnotationlabelcontains SummarizeRecordAnalyticsRecordGroupByEnum = "annotationLabelContains" )
func GetSummarizeRecordAnalyticsRecordGroupByEnumValues() []SummarizeRecordAnalyticsRecordGroupByEnum
GetSummarizeRecordAnalyticsRecordGroupByEnumValues Enumerates the set of values for SummarizeRecordAnalyticsRecordGroupByEnum
SummarizeRecordAnalyticsRequest wrapper for the SummarizeRecordAnalytics operation
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/55.0.0/datalabelingservicedataplane/SummarizeRecordAnalytics.go.html to see an example of how to use SummarizeRecordAnalyticsRequest.
type SummarizeRecordAnalyticsRequest struct { // The ID of the compartment in which to list resources. CompartmentId *string `mandatory:"true" contributesTo:"query" name:"compartmentId"` // Filter results by the OCID of the dataset. DatasetId *string `mandatory:"true" contributesTo:"query" name:"datasetId"` // A filter to return only resources their lifecycleState matches the given lifecycleState. LifecycleState RecordLifecycleStateEnum `mandatory:"false" contributesTo:"query" name:"lifecycleState" omitEmpty:"true"` // The maximum number of items to return. Limit *int `mandatory:"false" contributesTo:"query" name:"limit"` // The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call. Page *string `mandatory:"false" contributesTo:"query" name:"page"` // The sort order to use, either 'asc' or 'desc'. SortOrder SummarizeRecordAnalyticsSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"` // The field to group by. If no value is specified isLabeled is default. RecordGroupBy SummarizeRecordAnalyticsRecordGroupByEnum `mandatory:"false" contributesTo:"query" name:"recordGroupBy" omitEmpty:"true"` // The field to sort by. Only one sort order may be provided. Default order is descending. If no value is specified count is default. SortBy SummarizeRecordAnalyticsSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"` // The client request ID for tracing. OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"` // Metadata about the request. This information will not be transmitted to the service, but // represents information that the SDK will consume to drive retry behavior. RequestMetadata common.RequestMetadata }
func (request SummarizeRecordAnalyticsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request SummarizeRecordAnalyticsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request SummarizeRecordAnalyticsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request SummarizeRecordAnalyticsRequest) String() string
SummarizeRecordAnalyticsResponse wrapper for the SummarizeRecordAnalytics operation
type SummarizeRecordAnalyticsResponse struct { // The underlying http response RawResponse *http.Response // A list of RecordAnalyticsAggregationCollection instances RecordAnalyticsAggregationCollection `presentIn:"body"` // Unique Oracle-assigned identifier for the request. If you need to contact // Oracle about a particular request, please provide the request ID. OpcRequestId *string `presentIn:"header" name:"opc-request-id"` // For pagination of a list of items. When paging through a list, if this header appears in the response, // then a partial list might have been returned. Include this value as the `page` parameter for the // subsequent GET request to get the next batch of items. OpcNextPage *string `presentIn:"header" name:"opc-next-page"` }
func (response SummarizeRecordAnalyticsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response SummarizeRecordAnalyticsResponse) String() string
SummarizeRecordAnalyticsSortByEnum Enum with underlying type: string
type SummarizeRecordAnalyticsSortByEnum string
Set of constants representing the allowable values for SummarizeRecordAnalyticsSortByEnum
const ( SummarizeRecordAnalyticsSortByCount SummarizeRecordAnalyticsSortByEnum = "count" SummarizeRecordAnalyticsSortByIslabeled SummarizeRecordAnalyticsSortByEnum = "isLabeled" )
func GetSummarizeRecordAnalyticsSortByEnumValues() []SummarizeRecordAnalyticsSortByEnum
GetSummarizeRecordAnalyticsSortByEnumValues Enumerates the set of values for SummarizeRecordAnalyticsSortByEnum
SummarizeRecordAnalyticsSortOrderEnum Enum with underlying type: string
type SummarizeRecordAnalyticsSortOrderEnum string
Set of constants representing the allowable values for SummarizeRecordAnalyticsSortOrderEnum
const ( SummarizeRecordAnalyticsSortOrderAsc SummarizeRecordAnalyticsSortOrderEnum = "ASC" SummarizeRecordAnalyticsSortOrderDesc SummarizeRecordAnalyticsSortOrderEnum = "DESC" )
func GetSummarizeRecordAnalyticsSortOrderEnumValues() []SummarizeRecordAnalyticsSortOrderEnum
GetSummarizeRecordAnalyticsSortOrderEnumValues Enumerates the set of values for SummarizeRecordAnalyticsSortOrderEnum
TextDatasetFormatDetails Indicates the dataset is comprised of txt files.
type TextDatasetFormatDetails struct { }
func (m TextDatasetFormatDetails) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m TextDatasetFormatDetails) String() string
TextSelectionEntity This allows the labeler to highlight text by specifying an offset and a length and apply labels to it.
type TextSelectionEntity struct { // Collection of Label entities Labels []Label `mandatory:"true" json:"labels"` TextSpan *TextSpan `mandatory:"true" json:"textSpan"` // Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. // Example: `{"bar-key": "value"}` ExtendedMetadata map[string]string `mandatory:"false" json:"extendedMetadata"` }
func (m TextSelectionEntity) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m TextSelectionEntity) String() string
TextSpan A wrapper class for offset and length, which together represent a span of text in a text document.
type TextSpan struct { // Offset of the selected text within the entire text. Offset *float32 `mandatory:"false" json:"offset"` // Length of the selected text. Length *float32 `mandatory:"false" json:"length"` }
func (m TextSpan) String() string
UpdateAnnotationDetails This is the payload sent in the CreateAnnotation operation. It contains all the information required for a user to create an Annotation for a record.
type UpdateAnnotationDetails struct { // The entity types will be validated against the dataset to ensure consistency. Entities []Entity `mandatory:"false" json:"entities"` // Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. // Example: `{"bar-key": "value"}` FreeformTags map[string]string `mandatory:"false" json:"freeformTags"` // Defined tags for this resource. Each key is predefined and scoped to a namespace. // Example: `{"foo-namespace": {"bar-key": "value"}}` DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"` }
func (m UpdateAnnotationDetails) String() string
func (m *UpdateAnnotationDetails) UnmarshalJSON(data []byte) (e error)
UnmarshalJSON unmarshals from json
UpdateAnnotationRequest wrapper for the UpdateAnnotation operation
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/55.0.0/datalabelingservicedataplane/UpdateAnnotation.go.html to see an example of how to use UpdateAnnotationRequest.
type UpdateAnnotationRequest struct { // unique Annotation identifier AnnotationId *string `mandatory:"true" contributesTo:"path" name:"annotationId"` // Information to be updated. UpdateAnnotationDetails `contributesTo:"body"` // For optimistic concurrency control. In the PUT or DELETE call // for a resource, set the `if-match` parameter to the value of the // etag from a previous GET or POST response for that resource. // The resource will be updated or deleted only if the etag you // provide matches the resource's current etag value. IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"` // The client request ID for tracing. OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"` // Metadata about the request. This information will not be transmitted to the service, but // represents information that the SDK will consume to drive retry behavior. RequestMetadata common.RequestMetadata }
func (request UpdateAnnotationRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request UpdateAnnotationRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request UpdateAnnotationRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request UpdateAnnotationRequest) String() string
UpdateAnnotationResponse wrapper for the UpdateAnnotation operation
type UpdateAnnotationResponse struct { // The underlying http response RawResponse *http.Response // The Annotation instance Annotation `presentIn:"body"` // For optimistic concurrency control. See `if-match`. Etag *string `presentIn:"header" name:"etag"` // Unique Oracle-assigned identifier for the request. If you need to contact // Oracle about a particular request, please provide the request ID. OpcRequestId *string `presentIn:"header" name:"opc-request-id"` }
func (response UpdateAnnotationResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response UpdateAnnotationResponse) String() string
UpdateRecordDetails Assuming we support tags, tags are supposed to be updatable.
type UpdateRecordDetails struct { // Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. // Example: `{"bar-key": "value"}` FreeformTags map[string]string `mandatory:"false" json:"freeformTags"` // Defined tags for this resource. Each key is predefined and scoped to a namespace. // Example: `{"foo-namespace": {"bar-key": "value"}}` DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"` }
func (m UpdateRecordDetails) String() string
UpdateRecordRequest wrapper for the UpdateRecord operation
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/55.0.0/datalabelingservicedataplane/UpdateRecord.go.html to see an example of how to use UpdateRecordRequest.
type UpdateRecordRequest struct { // The OCID of the record annotated RecordId *string `mandatory:"true" contributesTo:"path" name:"recordId"` // Information to be updated. UpdateRecordDetails `contributesTo:"body"` // For optimistic concurrency control. In the PUT or DELETE call // for a resource, set the `if-match` parameter to the value of the // etag from a previous GET or POST response for that resource. // The resource will be updated or deleted only if the etag you // provide matches the resource's current etag value. IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"` // The client request ID for tracing. OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"` // Metadata about the request. This information will not be transmitted to the service, but // represents information that the SDK will consume to drive retry behavior. RequestMetadata common.RequestMetadata }
func (request UpdateRecordRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request UpdateRecordRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request UpdateRecordRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request UpdateRecordRequest) String() string
UpdateRecordResponse wrapper for the UpdateRecord operation
type UpdateRecordResponse struct { // The underlying http response RawResponse *http.Response // The Record instance Record `presentIn:"body"` // For optimistic concurrency control. See `if-match`. Etag *string `presentIn:"header" name:"etag"` // Unique Oracle-assigned identifier for the request. If you need to contact // Oracle about a particular request, please provide the request ID. OpcRequestId *string `presentIn:"header" name:"opc-request-id"` }
func (response UpdateRecordResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response UpdateRecordResponse) String() string