func GetAnnotationLifecycleStateEnumStringValues() []string
GetAnnotationLifecycleStateEnumStringValues Enumerates the set of values in String for AnnotationLifecycleStateEnum
func GetCreateSourceDetailsSourceTypeEnumStringValues() []string
GetCreateSourceDetailsSourceTypeEnumStringValues Enumerates the set of values in String for CreateSourceDetailsSourceTypeEnum
func GetDatasetFormatDetailsFormatTypeEnumStringValues() []string
GetDatasetFormatDetailsFormatTypeEnumStringValues Enumerates the set of values in String for DatasetFormatDetailsFormatTypeEnum
func GetDatasetLifecycleStateEnumStringValues() []string
GetDatasetLifecycleStateEnumStringValues Enumerates the set of values in String for DatasetLifecycleStateEnum
func GetDatasetLifecycleSubstateEnumStringValues() []string
GetDatasetLifecycleSubstateEnumStringValues Enumerates the set of values in String for DatasetLifecycleSubstateEnum
func GetDatasetSourceDetailsSourceTypeEnumStringValues() []string
GetDatasetSourceDetailsSourceTypeEnumStringValues Enumerates the set of values in String for DatasetSourceDetailsSourceTypeEnum
func GetEntityEntityTypeEnumStringValues() []string
GetEntityEntityTypeEnumStringValues Enumerates the set of values in String for EntityEntityTypeEnum
func GetImportFormatNameEnumStringValues() []string
GetImportFormatNameEnumStringValues Enumerates the set of values in String for ImportFormatNameEnum
func GetImportFormatVersionEnumStringValues() []string
GetImportFormatVersionEnumStringValues Enumerates the set of values in String for ImportFormatVersionEnum
func GetImportMetadataPathSourceTypeEnumStringValues() []string
GetImportMetadataPathSourceTypeEnumStringValues Enumerates the set of values in String for ImportMetadataPathSourceTypeEnum
func GetListAnnotationsSortByEnumStringValues() []string
GetListAnnotationsSortByEnumStringValues Enumerates the set of values in String for ListAnnotationsSortByEnum
func GetListAnnotationsSortOrderEnumStringValues() []string
GetListAnnotationsSortOrderEnumStringValues Enumerates the set of values in String for ListAnnotationsSortOrderEnum
func GetListRecordsSortByEnumStringValues() []string
GetListRecordsSortByEnumStringValues Enumerates the set of values in String for ListRecordsSortByEnum
func GetListRecordsSortOrderEnumStringValues() []string
GetListRecordsSortOrderEnumStringValues Enumerates the set of values in String for ListRecordsSortOrderEnum
func GetRecordLifecycleStateEnumStringValues() []string
GetRecordLifecycleStateEnumStringValues Enumerates the set of values in String for RecordLifecycleStateEnum
func GetRecordMetadataRecordTypeEnumStringValues() []string
GetRecordMetadataRecordTypeEnumStringValues Enumerates the set of values in String for RecordMetadataRecordTypeEnum
func GetSortOrdersEnumStringValues() []string
GetSortOrdersEnumStringValues Enumerates the set of values in String for SortOrdersEnum
func GetSourceDetailsSourceTypeEnumStringValues() []string
GetSourceDetailsSourceTypeEnumStringValues Enumerates the set of values in String for SourceDetailsSourceTypeEnum
func GetSummarizeAnnotationAnalyticsAnnotationGroupByEnumStringValues() []string
GetSummarizeAnnotationAnalyticsAnnotationGroupByEnumStringValues Enumerates the set of values in String for SummarizeAnnotationAnalyticsAnnotationGroupByEnum
func GetSummarizeAnnotationAnalyticsSortByEnumStringValues() []string
GetSummarizeAnnotationAnalyticsSortByEnumStringValues Enumerates the set of values in String for SummarizeAnnotationAnalyticsSortByEnum
func GetSummarizeAnnotationAnalyticsSortOrderEnumStringValues() []string
GetSummarizeAnnotationAnalyticsSortOrderEnumStringValues Enumerates the set of values in String for SummarizeAnnotationAnalyticsSortOrderEnum
func GetSummarizeRecordAnalyticsRecordGroupByEnumStringValues() []string
GetSummarizeRecordAnalyticsRecordGroupByEnumStringValues Enumerates the set of values in String for SummarizeRecordAnalyticsRecordGroupByEnum
func GetSummarizeRecordAnalyticsSortByEnumStringValues() []string
GetSummarizeRecordAnalyticsSortByEnumStringValues Enumerates the set of values in String for SummarizeRecordAnalyticsSortByEnum
func GetSummarizeRecordAnalyticsSortOrderEnumStringValues() []string
GetSummarizeRecordAnalyticsSortOrderEnumStringValues Enumerates the set of values in String for SummarizeRecordAnalyticsSortOrderEnum
func GetTextFileTypeMetadataFormatTypeEnumStringValues() []string
GetTextFileTypeMetadataFormatTypeEnumStringValues Enumerates the set of values in String for TextFileTypeMetadataFormatTypeEnum
Annotation An annotation represents a user- or 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 which created the annotation.
CreatedBy *string `mandatory:"true" json:"createdBy"`
// The OCID of the principal which updated the annotation.
UpdatedBy *string `mandatory:"true" json:"updatedBy"`
// The OCID of the record annotated.
RecordId *string `mandatory:"true" json:"recordId"`
// The entity types are 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"`
// The lifecycle state of an annotation.
// ACTIVE - The annotation is active to be used for labeling.
// INACTIVE - The annotation has been marked as inactive and should not be used for labeling.
// DELETED - Tha annotation been deleted and no longer available for labeling.
LifecycleState AnnotationLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`
// A simple key-value pair that is applied without any predefined name, type, or scope. It exists for cross-compatibility only.
// For example: `{"bar-key": "value"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// The defined tags for this resource. Each key is predefined and scoped to a namespace.
// For 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
func (m Annotation) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
AnnotationAggregationDimensions The dimensions to summarize annotations for a given dataset.
type AnnotationAggregationDimensions struct {
Label *Label `mandatory:"false" json:"label"`
// The OCID of the principal which updated the resource.
UpdatedBy *string `mandatory:"false" json:"updatedBy"`
}
func (m AnnotationAggregationDimensions) String() string
func (m AnnotationAggregationDimensions) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
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 applied to the list API, have to show up in the aggregation.
type AnnotationAnalyticsAggregation struct {
// The count of the matching results.
Count *float32 `mandatory:"true" json:"count"`
// The OCID of the dataset the annotations belong to.
DatasetId *string `mandatory:"true" json:"datasetId"`
// The OCID of the compartment containing the annotations.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
Dimensions *AnnotationAggregationDimensions `mandatory:"false" json:"dimensions"`
// The OCID of the principal which 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
func (m AnnotationAnalyticsAggregation) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
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 applied to the list API, have to show up in the aggregation.
type AnnotationAnalyticsAggregationCollection struct {
// The list of annotation entities.
Items []AnnotationAnalyticsAggregation `mandatory:"true" json:"items"`
}
func (m AnnotationAnalyticsAggregationCollection) String() string
func (m AnnotationAnalyticsAggregationCollection) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
AnnotationCollection The results of an annotations search. It contains AnnotationSummary items and other information, such as metadata.
type AnnotationCollection struct {
// The list of annotations.
Items []AnnotationSummary `mandatory:"true" json:"items"`
}
func (m AnnotationCollection) String() string
func (m AnnotationCollection) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
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
func GetMappingAnnotationLifecycleStateEnum(val string) (AnnotationLifecycleStateEnum, bool)
GetMappingAnnotationLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum
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"`
// A simple key-value pair that is applied without any predefined name, type, or scope. It exists for cross-compatibility only.
// For example: `{"bar-key": "value"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// The defined tags for this resource. Each key is predefined and scoped to a namespace.
// For example: `{"foo-namespace": {"bar-key": "value"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
}
func (m AnnotationSummary) String() string
func (m AnnotationSummary) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
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 the order of the segments they connect.
NormalizedVertices []NormalizedVertex `mandatory:"true" json:"normalizedVertices"`
}
func (m BoundingPolygon) String() string
func (m BoundingPolygon) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
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 are validated against the dataset to ensure consistency.
Entities []Entity `mandatory:"true" json:"entities"`
// A simple key-value pair that is applied without any predefined name, type, or scope. It exists for cross-compatibility only.
// For example: `{"bar-key": "value"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// The defined tags for this resource. Each key is predefined and scoped to a namespace.
// For 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
func (m CreateAnnotationDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
CreateAnnotationRequest wrapper for the CreateAnnotation operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/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, without risk of executing that same action again, if there is a timeout or
// server error. Retry tokens expire after 24
// hours, but can be invalidated before then if there are 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
func (request CreateAnnotationRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
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"`
// A 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
func (m CreateObjectStorageSourceDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
CreateRecordDetails A record represents an entry in a dataset that needs labeling.
type CreateRecordDetails struct {
// The name is automatically assigned by the service. It is 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"`
RecordMetadata RecordMetadata `mandatory:"false" json:"recordMetadata"`
// A simple key-value pair that is applied without any predefined name, type, or scope. It exists for cross-compatibility only.
// For example: `{"bar-key": "value"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// The defined tags for this resource. Each key is predefined and scoped to a namespace.
// For 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
func (m CreateRecordDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
CreateRecordRequest wrapper for the CreateRecord operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/datalabelingservicedataplane/CreateRecord.go.html to see an example of how to use CreateRecordRequest.
type CreateRecordRequest struct {
// The details for the new record.
CreateRecordDetails `contributesTo:"body"`
// A token that uniquely identifies a request so it can be retried, without risk of executing that same action again, if there is a timeout or
// server error. Retry tokens expire after 24
// hours, but can be invalidated before then if there are 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
func (request CreateRecordRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
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"`
// A 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
func GetMappingCreateSourceDetailsSourceTypeEnum(val string) (CreateSourceDetailsSourceTypeEnum, bool)
GetMappingCreateSourceDetailsSourceTypeEnum performs case Insensitive comparison on enum value and return the desired enum
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.
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/datalabelingservicedataplane/CreateAnnotation.go.html to see an example of how to use CreateAnnotation API. A default retry strategy applies to this operation CreateAnnotation()
func (client DataLabelingClient) CreateRecord(ctx context.Context, request CreateRecordRequest) (response CreateRecordResponse, err error)
CreateRecord Creates a record.
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/datalabelingservicedataplane/CreateRecord.go.html to see an example of how to use CreateRecord API. A default retry strategy applies to this operation CreateRecord()
func (client DataLabelingClient) DeleteAnnotation(ctx context.Context, request DeleteAnnotationRequest) (response DeleteAnnotationResponse, err error)
DeleteAnnotation It deletes an annotation resource by identifier.
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/datalabelingservicedataplane/DeleteAnnotation.go.html to see an example of how to use DeleteAnnotation API. A default retry strategy applies to this operation DeleteAnnotation()
func (client DataLabelingClient) DeleteRecord(ctx context.Context, request DeleteRecordRequest) (response DeleteRecordResponse, err error)
DeleteRecord Deletes a record resource by identifier.
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/datalabelingservicedataplane/DeleteRecord.go.html to see an example of how to use DeleteRecord API. A default retry strategy applies to this operation DeleteRecord()
func (client DataLabelingClient) GetAnnotation(ctx context.Context, request GetAnnotationRequest) (response GetAnnotationResponse, err error)
GetAnnotation Gets an annotation.
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/datalabelingservicedataplane/GetAnnotation.go.html to see an example of how to use GetAnnotation API. A default retry strategy applies to this operation GetAnnotation()
func (client DataLabelingClient) GetDataset(ctx context.Context, request GetDatasetRequest) (response GetDatasetResponse, err error)
GetDataset Gets a dataset by identifier.
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/datalabelingservicedataplane/GetDataset.go.html to see an example of how to use GetDataset API. A default retry strategy applies to this operation GetDataset()
func (client DataLabelingClient) GetRecord(ctx context.Context, request GetRecordRequest) (response GetRecordResponse, err error)
GetRecord Gets a record.
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/datalabelingservicedataplane/GetRecord.go.html to see an example of how to use GetRecord API. A default retry strategy applies to this operation GetRecord()
func (client DataLabelingClient) GetRecordContent(ctx context.Context, request GetRecordContentRequest) (response GetRecordContentResponse, err error)
GetRecordContent Retrieves the content of the record from the dataset source.
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/datalabelingservicedataplane/GetRecordContent.go.html to see an example of how to use GetRecordContent API. A default retry strategy applies to this operation GetRecordContent()
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.
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/datalabelingservicedataplane/GetRecordPreviewContent.go.html to see an example of how to use GetRecordPreviewContent API. A default retry strategy applies to this operation GetRecordPreviewContent()
func (client DataLabelingClient) ListAnnotations(ctx context.Context, request ListAnnotationsRequest) (response ListAnnotationsResponse, err error)
ListAnnotations Returns a list of annotations.
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/datalabelingservicedataplane/ListAnnotations.go.html to see an example of how to use ListAnnotations API. A default retry strategy applies to this operation ListAnnotations()
func (client DataLabelingClient) ListRecords(ctx context.Context, request ListRecordsRequest) (response ListRecordsResponse, err error)
ListRecords The list of records in the specified compartment.
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/datalabelingservicedataplane/ListRecords.go.html to see an example of how to use ListRecords API. A default retry strategy applies to this operation ListRecords()
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 the annotations created for a given dataset.
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/datalabelingservicedataplane/SummarizeAnnotationAnalytics.go.html to see an example of how to use SummarizeAnnotationAnalytics API. A default retry strategy applies to this operation SummarizeAnnotationAnalytics()
func (client DataLabelingClient) SummarizeRecordAnalytics(ctx context.Context, request SummarizeRecordAnalyticsRequest) (response SummarizeRecordAnalyticsResponse, err error)
SummarizeRecordAnalytics Summarize the records created for a given dataset.
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/datalabelingservicedataplane/SummarizeRecordAnalytics.go.html to see an example of how to use SummarizeRecordAnalytics API. A default retry strategy applies to this operation SummarizeRecordAnalytics()
func (client DataLabelingClient) UpdateAnnotation(ctx context.Context, request UpdateAnnotationRequest) (response UpdateAnnotationResponse, err error)
UpdateAnnotation Updates an annotation.
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/datalabelingservicedataplane/UpdateAnnotation.go.html to see an example of how to use UpdateAnnotation API. A default retry strategy applies to this operation UpdateAnnotation()
func (client DataLabelingClient) UpdateRecord(ctx context.Context, request UpdateRecordRequest) (response UpdateRecordResponse, err error)
UpdateRecord Updates a record.
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/datalabelingservicedataplane/UpdateRecord.go.html to see an example of how to use UpdateRecord API. A default retry strategy applies to this operation UpdateRecord()
Dataset A dataset is a logical collection of records. The dataset contains all the information necessary to describe a record's source, format, the type of annotations allowed for the record, and the 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 last 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"`
// The sub-state of the dataset.
// IMPORT_DATASET - The dataset is being imported.
LifecycleSubstate DatasetLifecycleSubstateEnum `mandatory:"false" json:"lifecycleSubstate,omitempty"`
InitialRecordGenerationConfiguration *InitialRecordGenerationConfiguration `mandatory:"false" json:"initialRecordGenerationConfiguration"`
InitialImportDatasetConfiguration *InitialImportDatasetConfiguration `mandatory:"false" json:"initialImportDatasetConfiguration"`
// The labeling instructions for human labelers in rich text format
LabelingInstructions *string `mandatory:"false" json:"labelingInstructions"`
// A simple key-value pair that is applied without any predefined name, type, or scope. It exists for cross-compatibility only.
// For example: `{"bar-key": "value"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// The defined tags for this resource. Each key is predefined and scoped to a namespace.
// For example: `{"foo-namespace": {"bar-key": "value"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
// The usage of system tag keys. These predefined keys are scoped to namespaces.
// For example: `{"orcl-cloud": {"free-tier-retained": "true"}}`
SystemTags map[string]map[string]interface{} `mandatory:"false" json:"systemTags"`
// A simple key-value pair that is applied without any predefined name, type, or scope. It exists for cross-compatibility only.
// For example: `{"bar-key": "value"}`
AdditionalProperties map[string]string `mandatory:"false" json:"additionalProperties"`
}
func (m Dataset) String() string
func (m *Dataset) UnmarshalJSON(data []byte) (e error)
UnmarshalJSON unmarshals from json
func (m Dataset) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
DatasetFormatDetails It specifies how to process the data. Supported formats include DOCUMENT, 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
func GetMappingDatasetFormatDetailsFormatTypeEnum(val string) (DatasetFormatDetailsFormatTypeEnum, bool)
GetMappingDatasetFormatDetailsFormatTypeEnum performs case Insensitive comparison on enum value and return the desired enum
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
func GetMappingDatasetLifecycleStateEnum(val string) (DatasetLifecycleStateEnum, bool)
GetMappingDatasetLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum
DatasetLifecycleSubstateEnum Enum with underlying type: string
type DatasetLifecycleSubstateEnum string
Set of constants representing the allowable values for DatasetLifecycleSubstateEnum
const (
DatasetLifecycleSubstateImportDataset DatasetLifecycleSubstateEnum = "IMPORT_DATASET"
)
func GetDatasetLifecycleSubstateEnumValues() []DatasetLifecycleSubstateEnum
GetDatasetLifecycleSubstateEnumValues Enumerates the set of values for DatasetLifecycleSubstateEnum
func GetMappingDatasetLifecycleSubstateEnum(val string) (DatasetLifecycleSubstateEnum, bool)
GetMappingDatasetLifecycleSubstateEnum performs case Insensitive comparison on enum value and return the desired enum
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
func GetMappingDatasetSourceDetailsSourceTypeEnum(val string) (DatasetSourceDetailsSourceTypeEnum, bool)
GetMappingDatasetSourceDetailsSourceTypeEnum performs case Insensitive comparison on enum value and return the desired enum
DeleteAnnotationRequest wrapper for the DeleteAnnotation operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/datalabelingservicedataplane/DeleteAnnotation.go.html to see an example of how to use DeleteAnnotationRequest.
type DeleteAnnotationRequest struct {
// A 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 is 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
func (request DeleteAnnotationRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
DeleteAnnotationResponse wrapper for the DeleteAnnotation operation
type DeleteAnnotationResponse struct {
// The underlying http response
RawResponse *http.Response
// A 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
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/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 is 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
func (request DeleteRecordRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
DeleteRecordResponse wrapper for the DeleteRecord operation
type DeleteRecordResponse struct {
// The underlying http response
RawResponse *http.Response
// A 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
DelimitedFileTypeMetadata Metadata of delimited files.
type DelimitedFileTypeMetadata struct {
// The index of a selected column. This is a zero-based index.
ColumnIndex *int `mandatory:"true" json:"columnIndex"`
// The name of a selected column.
ColumnName *string `mandatory:"false" json:"columnName"`
// A column delimiter
ColumnDelimiter *string `mandatory:"false" json:"columnDelimiter"`
// A line delimiter.
LineDelimiter *string `mandatory:"false" json:"lineDelimiter"`
// An escape character.
EscapeCharacter *string `mandatory:"false" json:"escapeCharacter"`
}
func (m DelimitedFileTypeMetadata) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m DelimitedFileTypeMetadata) String() string
func (m DelimitedFileTypeMetadata) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
DocumentDatasetFormatDetails It indicates the dataset is comprised of document files. 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
func (m DocumentDatasetFormatDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
DocumentEntityMetadata This is dedicated Entity to store Document related info.
type DocumentEntityMetadata struct {
// This stores page number of document.
PageNumber *float32 `mandatory:"true" json:"pageNumber"`
}
func (m DocumentEntityMetadata) String() string
func (m DocumentEntityMetadata) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
DocumentMetadata Collection of metadata related to document record.
type DocumentMetadata struct {
// Job id ocid of OCR batch call.
JobId *string `mandatory:"false" json:"jobId"`
}
func (m DocumentMetadata) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m DocumentMetadata) String() string
func (m DocumentMetadata) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
Entity An entity allows the labeler to identify an object in the record to label. This can be, for example, a snippet of text, an entire image, or a bounding box within an image. All entity types have an array of labels that are indexed. If more than one label is provided, but the annotationType on the corresponding dataset is for a single class, the API rejects 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"
EntityEntityTypeKeyvalueselection EntityEntityTypeEnum = "KEYVALUESELECTION"
)
func GetEntityEntityTypeEnumValues() []EntityEntityTypeEnum
GetEntityEntityTypeEnumValues Enumerates the set of values for EntityEntityTypeEnum
func GetMappingEntityEntityTypeEnum(val string) (EntityEntityTypeEnum, bool)
GetMappingEntityEntityTypeEnum performs case Insensitive comparison on enum value and return the desired enum
GenericEntity This is an extensible entity type for users, and the base entity type for some annotation formats.
type GenericEntity struct {
// A collection of label entities.
Labels []Label `mandatory:"true" json:"labels"`
DocumentEntityMetadata *DocumentEntityMetadata `mandatory:"false" json:"documentEntityMetadata"`
// A simple key-value pair that is applied without any predefined name, type, or scope. It exists for cross-compatibility only.
// For 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
func (m GenericEntity) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
GetAnnotationRequest wrapper for the GetAnnotation operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/datalabelingservicedataplane/GetAnnotation.go.html to see an example of how to use GetAnnotationRequest.
type GetAnnotationRequest struct {
// A 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
func (request GetAnnotationRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
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"`
// A 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
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/datalabelingservicedataplane/GetDataset.go.html to see an example of how to use GetDatasetRequest.
type GetDatasetRequest struct {
// A 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
func (request GetDatasetRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
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"`
// A 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
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/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
func (request GetRecordContentRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
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"`
// A 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
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/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
func (request GetRecordPreviewContentRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
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"`
// A 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
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/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
func (request GetRecordRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
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"`
// A 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 It 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
func (m ImageDatasetFormatDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ImageMetadata Collection of metadata related to image record.
type ImageMetadata struct {
// Height of the image record.
Height *int `mandatory:"false" json:"height"`
// Width of the image record.
Width *int `mandatory:"false" json:"width"`
// Depth of the image record.
Depth *int `mandatory:"false" json:"depth"`
}
func (m ImageMetadata) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m ImageMetadata) String() string
func (m ImageMetadata) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ImageObjectSelectionEntity This lets the labeler specify a series of coordinates in the image to represent an object and apply labels to it. The coordinates are connected in the order that they are provided. The last coordinate in the array is connected to the first coordinate.
type ImageObjectSelectionEntity struct {
// A collection of label entities.
Labels []Label `mandatory:"true" json:"labels"`
BoundingPolygon *BoundingPolygon `mandatory:"true" json:"boundingPolygon"`
// A simple key-value pair that is applied without any predefined name, type, or scope. It exists for cross-compatibility only.
// For 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
func (m ImageObjectSelectionEntity) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ImportFormat File format details used for importing dataset
type ImportFormat struct {
// Name of import format
Name ImportFormatNameEnum `mandatory:"true" json:"name"`
// Version of import format
Version ImportFormatVersionEnum `mandatory:"false" json:"version,omitempty"`
}
func (m ImportFormat) String() string
func (m ImportFormat) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ImportFormatNameEnum Enum with underlying type: string
type ImportFormatNameEnum string
Set of constants representing the allowable values for ImportFormatNameEnum
const (
ImportFormatNameJsonlConsolidated ImportFormatNameEnum = "JSONL_CONSOLIDATED"
ImportFormatNameJsonlCompactPlusContent ImportFormatNameEnum = "JSONL_COMPACT_PLUS_CONTENT"
ImportFormatNameConll ImportFormatNameEnum = "CONLL"
ImportFormatNameSpacy ImportFormatNameEnum = "SPACY"
ImportFormatNameCoco ImportFormatNameEnum = "COCO"
ImportFormatNameYolo ImportFormatNameEnum = "YOLO"
ImportFormatNamePascalVoc ImportFormatNameEnum = "PASCAL_VOC"
)
func GetImportFormatNameEnumValues() []ImportFormatNameEnum
GetImportFormatNameEnumValues Enumerates the set of values for ImportFormatNameEnum
func GetMappingImportFormatNameEnum(val string) (ImportFormatNameEnum, bool)
GetMappingImportFormatNameEnum performs case Insensitive comparison on enum value and return the desired enum
ImportFormatVersionEnum Enum with underlying type: string
type ImportFormatVersionEnum string
Set of constants representing the allowable values for ImportFormatVersionEnum
const (
ImportFormatVersionV2003 ImportFormatVersionEnum = "V2003"
ImportFormatVersionV5 ImportFormatVersionEnum = "V5"
)
func GetImportFormatVersionEnumValues() []ImportFormatVersionEnum
GetImportFormatVersionEnumValues Enumerates the set of values for ImportFormatVersionEnum
func GetMappingImportFormatVersionEnum(val string) (ImportFormatVersionEnum, bool)
GetMappingImportFormatVersionEnum performs case Insensitive comparison on enum value and return the desired enum
ImportMetadataPath Object storage path for the metadata file
type ImportMetadataPath interface {
}
ImportMetadataPathSourceTypeEnum Enum with underlying type: string
type ImportMetadataPathSourceTypeEnum string
Set of constants representing the allowable values for ImportMetadataPathSourceTypeEnum
const (
ImportMetadataPathSourceTypeObjectStorage ImportMetadataPathSourceTypeEnum = "OBJECT_STORAGE"
)
func GetImportMetadataPathSourceTypeEnumValues() []ImportMetadataPathSourceTypeEnum
GetImportMetadataPathSourceTypeEnumValues Enumerates the set of values for ImportMetadataPathSourceTypeEnum
func GetMappingImportMetadataPathSourceTypeEnum(val string) (ImportMetadataPathSourceTypeEnum, bool)
GetMappingImportMetadataPathSourceTypeEnum performs case Insensitive comparison on enum value and return the desired enum
InitialImportDatasetConfiguration Initial import dataset configuration. Allows user to create dataset from existing dataset files.
type InitialImportDatasetConfiguration struct {
ImportFormat *ImportFormat `mandatory:"true" json:"importFormat"`
ImportMetadataPath ImportMetadataPath `mandatory:"true" json:"importMetadataPath"`
}
func (m InitialImportDatasetConfiguration) String() string
func (m *InitialImportDatasetConfiguration) UnmarshalJSON(data []byte) (e error)
UnmarshalJSON unmarshals from json
func (m InitialImportDatasetConfiguration) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
InitialRecordGenerationConfiguration The initial generate records configuration. It 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
func (m InitialRecordGenerationConfiguration) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
KeyValueSelectionEntity This allows the labeler to apply label the highlighted text from OCR, this includes labelled and unlabelled data.
type KeyValueSelectionEntity struct {
// Entity Name.
Text *string `mandatory:"true" json:"text"`
BoundingPolygon *BoundingPolygon `mandatory:"true" json:"boundingPolygon"`
// float value, score from OCR.
Confidence *float32 `mandatory:"true" json:"confidence"`
// A collection of label entities.
Labels []Label `mandatory:"false" json:"labels"`
// Integer value.
Rotation *float32 `mandatory:"false" json:"rotation"`
// Integer value.
PageNumber *float32 `mandatory:"false" json:"pageNumber"`
}
func (m KeyValueSelectionEntity) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m KeyValueSelectionEntity) String() string
func (m KeyValueSelectionEntity) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
Label A label is a string value. The API validates that it's one of the dataset's pre-defined labels.
type Label struct {
// The label provided by the annotator.
Label *string `mandatory:"true" json:"label"`
}
func (m Label) String() string
func (m Label) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
LabelName It 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
func (m LabelName) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
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
func (m LabelSet) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ListAnnotationsRequest wrapper for the ListAnnotations operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/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 the results by the OCID of the dataset.
DatasetId *string `mandatory:"true" contributesTo:"query" name:"datasetId"`
// A filter to return only resources whose lifecycleState matches the given lifecycleState.
LifecycleState AnnotationLifecycleStateEnum `mandatory:"false" contributesTo:"query" name:"lifecycleState" omitEmpty:"true"`
// The unique OCID identifier.
Id *string `mandatory:"false" contributesTo:"query" name:"id"`
// The OCID of the principal which 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. The default order for timeCreated is descending. If no value is specified timeCreated is used by 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
func (request ListAnnotationsRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ListAnnotationsResponse wrapper for the ListAnnotations operation
type ListAnnotationsResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of AnnotationCollection instances
AnnotationCollection `presentIn:"body"`
// A 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 the 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
func GetMappingListAnnotationsSortByEnum(val string) (ListAnnotationsSortByEnum, bool)
GetMappingListAnnotationsSortByEnum performs case Insensitive comparison on enum value and return the desired enum
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
func GetMappingListAnnotationsSortOrderEnum(val string) (ListAnnotationsSortOrderEnum, bool)
GetMappingListAnnotationsSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
ListRecordsRequest wrapper for the ListRecords operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/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 the results by the OCID of the dataset.
DatasetId *string `mandatory:"true" contributesTo:"query" name:"datasetId"`
// A filter to return only resources whose lifecycleState matches the given lifecycleState.
LifecycleState RecordLifecycleStateEnum `mandatory:"false" contributesTo:"query" name:"lifecycleState" omitEmpty:"true"`
// The name of the record.
Name *string `mandatory:"false" contributesTo:"query" name:"name"`
// The 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"`
// Lets the user 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. The default order for timeCreated is descending. The default order for name is ascending. If no value is specified, timeCreated is used by 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
func (request ListRecordsRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ListRecordsResponse wrapper for the ListRecords operation
type ListRecordsResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of RecordCollection instances
RecordCollection `presentIn:"body"`
// A 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 the 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
func GetMappingListRecordsSortByEnum(val string) (ListRecordsSortByEnum, bool)
GetMappingListRecordsSortByEnum performs case Insensitive comparison on enum value and return the desired enum
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
func GetMappingListRecordsSortOrderEnum(val string) (ListRecordsSortOrderEnum, bool)
GetMappingListRecordsSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
NormalizedVertex A NormalizedVertex is a cartesian coordinate that represents a corner between two segments of a polygon.
type NormalizedVertex struct {
// The X axis coordinate.
X *float32 `mandatory:"true" json:"x"`
// The Y axis coordinate.
Y *float32 `mandatory:"true" json:"y"`
}
func (m NormalizedVertex) String() string
func (m NormalizedVertex) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
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 {
// The 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. Except for the CSV file type, records are not generated for the objects whose names exactly match with the prefix.
Prefix *string `mandatory:"false" json:"prefix"`
}
func (m ObjectStorageDatasetSourceDetails) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m ObjectStorageDatasetSourceDetails) String() string
func (m ObjectStorageDatasetSourceDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ObjectStorageImportMetadataPath Object Storage details for import metadata path.
type ObjectStorageImportMetadataPath struct {
// Bucket namespace name
Namespace *string `mandatory:"true" json:"namespace"`
// Bucket name
Bucket *string `mandatory:"true" json:"bucket"`
// Path for the metadata file.
Path *string `mandatory:"true" json:"path"`
}
func (m ObjectStorageImportMetadataPath) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m ObjectStorageImportMetadataPath) String() string
func (m ObjectStorageImportMetadataPath) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
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 the 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
func (m ObjectStorageSourceDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
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"`
// The name is created by the user. It is 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 or not the record has been labeled and has associated annotations.
IsLabeled *bool `mandatory:"true" json:"isLabeled"`
// The lifecycle state of the record.
// ACTIVE - The record is active and ready for labeling.
// INACTIVE - The record has been marked as inactive and should not be used for labeling.
// DELETED - The record has been deleted and is no longer available for labeling.
LifecycleState RecordLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`
RecordMetadata RecordMetadata `mandatory:"false" json:"recordMetadata"`
// A simple key-value pair that is applied without any predefined name, type, or scope. It exists for cross-compatibility only.
// For example: `{"bar-key": "value"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// The defined tags for this resource. Each key is predefined and scoped to a namespace.
// For 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
func (m Record) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
RecordAggregationDimensions The dimensions to summarize record information for a given dataset.
type RecordAggregationDimensions struct {
// Whether or not the record has been labeled and has associated annotations.
IsLabeled *bool `mandatory:"false" json:"isLabeled"`
// Whether or not the annotation contains a label.
AnnotationLabelContains *string `mandatory:"false" json:"annotationLabelContains"`
}
func (m RecordAggregationDimensions) String() string
func (m RecordAggregationDimensions) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
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 are used to populate UI elements. Aggregations need to have the fields that identify the exact scope that they're summarizing. Any filters applied to the list API, have to show up in the aggregation.
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
func (m RecordAnalyticsAggregation) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
RecordAnalyticsAggregationCollection Collection of records aggregated.
type RecordAnalyticsAggregationCollection struct {
// The list of record entities.
Items []RecordAnalyticsAggregation `mandatory:"true" json:"items"`
}
func (m RecordAnalyticsAggregationCollection) String() string
func (m RecordAnalyticsAggregationCollection) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
RecordCollection The results of a record search. It contains RecordSummary items and other data.
type RecordCollection struct {
// The list of records.
Items []RecordSummary `mandatory:"true" json:"items"`
}
func (m RecordCollection) String() string
func (m RecordCollection) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
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 GetMappingRecordLifecycleStateEnum(val string) (RecordLifecycleStateEnum, bool)
GetMappingRecordLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum
func GetRecordLifecycleStateEnumValues() []RecordLifecycleStateEnum
GetRecordLifecycleStateEnumValues Enumerates the set of values for RecordLifecycleStateEnum
RecordMetadata Collection of record's metadata. This can be, for example, the height, width or depth of image for an image record.
type RecordMetadata interface {
}
RecordMetadataRecordTypeEnum Enum with underlying type: string
type RecordMetadataRecordTypeEnum string
Set of constants representing the allowable values for RecordMetadataRecordTypeEnum
const (
RecordMetadataRecordTypeImageMetadata RecordMetadataRecordTypeEnum = "IMAGE_METADATA"
RecordMetadataRecordTypeTextMetadata RecordMetadataRecordTypeEnum = "TEXT_METADATA"
RecordMetadataRecordTypeDocumentMetadata RecordMetadataRecordTypeEnum = "DOCUMENT_METADATA"
)
func GetMappingRecordMetadataRecordTypeEnum(val string) (RecordMetadataRecordTypeEnum, bool)
GetMappingRecordMetadataRecordTypeEnum performs case Insensitive comparison on enum value and return the desired enum
func GetRecordMetadataRecordTypeEnumValues() []RecordMetadataRecordTypeEnum
GetRecordMetadataRecordTypeEnumValues Enumerates the set of values for RecordMetadataRecordTypeEnum
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"`
// The name is automatically assigned by the service. It is 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 or not 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"`
RecordMetadata RecordMetadata `mandatory:"false" json:"recordMetadata"`
// A simple key-value pair that is applied without any predefined name, type, or scope. It exists for cross-compatibility only.
// For example: `{"bar-key": "value"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// The defined tags for this resource. Each key is predefined and scoped to a namespace.
// For example: `{"foo-namespace": {"bar-key": "value"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
}
func (m RecordSummary) String() string
func (m *RecordSummary) UnmarshalJSON(data []byte) (e error)
UnmarshalJSON unmarshals from json
func (m RecordSummary) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
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 GetMappingSortOrdersEnum(val string) (SortOrdersEnum, bool)
GetMappingSortOrdersEnum performs case Insensitive comparison on enum value and return the desired enum
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 is 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 GetMappingSourceDetailsSourceTypeEnum(val string) (SourceDetailsSourceTypeEnum, bool)
GetMappingSourceDetailsSourceTypeEnum performs case Insensitive comparison on enum value and return the desired enum
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 GetMappingSummarizeAnnotationAnalyticsAnnotationGroupByEnum(val string) (SummarizeAnnotationAnalyticsAnnotationGroupByEnum, bool)
GetMappingSummarizeAnnotationAnalyticsAnnotationGroupByEnum performs case Insensitive comparison on enum value and return the desired enum
func GetSummarizeAnnotationAnalyticsAnnotationGroupByEnumValues() []SummarizeAnnotationAnalyticsAnnotationGroupByEnum
GetSummarizeAnnotationAnalyticsAnnotationGroupByEnumValues Enumerates the set of values for SummarizeAnnotationAnalyticsAnnotationGroupByEnum
SummarizeAnnotationAnalyticsRequest wrapper for the SummarizeAnnotationAnalytics operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/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 the results by the OCID of the dataset.
DatasetId *string `mandatory:"true" contributesTo:"query" name:"datasetId"`
// A filter to return only resources whose lifecycleState matches the given lifecycleState.
LifecycleState AnnotationLifecycleStateEnum `mandatory:"false" contributesTo:"query" name:"lifecycleState" omitEmpty:"true"`
// It summarizes annotations with the 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. The default order is descending. If no value is specified, updatedBy is used by default.
SortBy SummarizeAnnotationAnalyticsSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`
// The field to group by. If no value is specified, updatedBy is used by 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
func (request SummarizeAnnotationAnalyticsRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
SummarizeAnnotationAnalyticsResponse wrapper for the SummarizeAnnotationAnalytics operation
type SummarizeAnnotationAnalyticsResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of AnnotationAnalyticsAggregationCollection instances
AnnotationAnalyticsAggregationCollection `presentIn:"body"`
// A 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 the 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 GetMappingSummarizeAnnotationAnalyticsSortByEnum(val string) (SummarizeAnnotationAnalyticsSortByEnum, bool)
GetMappingSummarizeAnnotationAnalyticsSortByEnum performs case Insensitive comparison on enum value and return the desired enum
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 GetMappingSummarizeAnnotationAnalyticsSortOrderEnum(val string) (SummarizeAnnotationAnalyticsSortOrderEnum, bool)
GetMappingSummarizeAnnotationAnalyticsSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
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 GetMappingSummarizeRecordAnalyticsRecordGroupByEnum(val string) (SummarizeRecordAnalyticsRecordGroupByEnum, bool)
GetMappingSummarizeRecordAnalyticsRecordGroupByEnum performs case Insensitive comparison on enum value and return the desired enum
func GetSummarizeRecordAnalyticsRecordGroupByEnumValues() []SummarizeRecordAnalyticsRecordGroupByEnum
GetSummarizeRecordAnalyticsRecordGroupByEnumValues Enumerates the set of values for SummarizeRecordAnalyticsRecordGroupByEnum
SummarizeRecordAnalyticsRequest wrapper for the SummarizeRecordAnalytics operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/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 the results by the OCID of the dataset.
DatasetId *string `mandatory:"true" contributesTo:"query" name:"datasetId"`
// A filter to return only resources whose 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 used by default.
RecordGroupBy SummarizeRecordAnalyticsRecordGroupByEnum `mandatory:"false" contributesTo:"query" name:"recordGroupBy" omitEmpty:"true"`
// The field to sort by. Only one sort order may be provided. The default order is descending. If no value is specified, count is used by 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
func (request SummarizeRecordAnalyticsRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
SummarizeRecordAnalyticsResponse wrapper for the SummarizeRecordAnalytics operation
type SummarizeRecordAnalyticsResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of RecordAnalyticsAggregationCollection instances
RecordAnalyticsAggregationCollection `presentIn:"body"`
// A 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 the 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 GetMappingSummarizeRecordAnalyticsSortByEnum(val string) (SummarizeRecordAnalyticsSortByEnum, bool)
GetMappingSummarizeRecordAnalyticsSortByEnum performs case Insensitive comparison on enum value and return the desired enum
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 GetMappingSummarizeRecordAnalyticsSortOrderEnum(val string) (SummarizeRecordAnalyticsSortOrderEnum, bool)
GetMappingSummarizeRecordAnalyticsSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
func GetSummarizeRecordAnalyticsSortOrderEnumValues() []SummarizeRecordAnalyticsSortOrderEnum
GetSummarizeRecordAnalyticsSortOrderEnumValues Enumerates the set of values for SummarizeRecordAnalyticsSortOrderEnum
TextDatasetFormatDetails It indicates the dataset is comprised of TXT files.
type TextDatasetFormatDetails struct {
TextFileTypeMetadata TextFileTypeMetadata `mandatory:"false" json:"textFileTypeMetadata"`
}
func (m TextDatasetFormatDetails) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m TextDatasetFormatDetails) String() string
func (m *TextDatasetFormatDetails) UnmarshalJSON(data []byte) (e error)
UnmarshalJSON unmarshals from json
func (m TextDatasetFormatDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
TextFileTypeMetadata Metadata for files with text content.
type TextFileTypeMetadata interface {
}
TextFileTypeMetadataFormatTypeEnum Enum with underlying type: string
type TextFileTypeMetadataFormatTypeEnum string
Set of constants representing the allowable values for TextFileTypeMetadataFormatTypeEnum
const (
TextFileTypeMetadataFormatTypeDelimited TextFileTypeMetadataFormatTypeEnum = "DELIMITED"
)
func GetMappingTextFileTypeMetadataFormatTypeEnum(val string) (TextFileTypeMetadataFormatTypeEnum, bool)
GetMappingTextFileTypeMetadataFormatTypeEnum performs case Insensitive comparison on enum value and return the desired enum
func GetTextFileTypeMetadataFormatTypeEnumValues() []TextFileTypeMetadataFormatTypeEnum
GetTextFileTypeMetadataFormatTypeEnumValues Enumerates the set of values for TextFileTypeMetadataFormatTypeEnum
TextMetadata Collection of metadata related to text record.
type TextMetadata struct {
}
func (m TextMetadata) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m TextMetadata) String() string
func (m TextMetadata) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
TextSelectionEntity This lets the labeler highlight text, by specifying an offset and a length, and apply labels to it.
type TextSelectionEntity struct {
// A collection of label entities.
Labels []Label `mandatory:"true" json:"labels"`
TextSpan *TextSpan `mandatory:"true" json:"textSpan"`
// A simple key-value pair that is applied without any predefined name, type, or scope. It exists for cross-compatibility only.
// For 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
func (m TextSelectionEntity) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
TextSpan A wrapper class for offset and length, which together, represent a span of text in a text document.
type TextSpan struct {
// The offset of the selected text within the entire text.
Offset *float32 `mandatory:"false" json:"offset"`
// The length of the selected text.
Length *float32 `mandatory:"false" json:"length"`
}
func (m TextSpan) String() string
func (m TextSpan) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
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 are validated against the dataset to ensure consistency.
Entities []Entity `mandatory:"false" json:"entities"`
// A simple key-value pair that is applied without any predefined name, type, or scope. It exists for cross-compatibility only.
// For example: `{"bar-key": "value"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// The defined tags for this resource. Each key is predefined and scoped to a namespace.
// For 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
func (m UpdateAnnotationDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
UpdateAnnotationRequest wrapper for the UpdateAnnotation operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/datalabelingservicedataplane/UpdateAnnotation.go.html to see an example of how to use UpdateAnnotationRequest.
type UpdateAnnotationRequest struct {
// A unique annotation identifier.
AnnotationId *string `mandatory:"true" contributesTo:"path" name:"annotationId"`
// The 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 is 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
func (request UpdateAnnotationRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
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"`
// A 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 The details of the tags that is updated.
type UpdateRecordDetails struct {
// A simple key-value pair that is applied without any predefined name, type, or scope. It exists for cross-compatibility only.
// For example: `{"bar-key": "value"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// The defined tags for this resource. Each key is predefined and scoped to a namespace.
// For example: `{"foo-namespace": {"bar-key": "value"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
RecordMetadata RecordMetadata `mandatory:"false" json:"recordMetadata"`
}
func (m UpdateRecordDetails) String() string
func (m *UpdateRecordDetails) UnmarshalJSON(data []byte) (e error)
UnmarshalJSON unmarshals from json
func (m UpdateRecordDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
UpdateRecordRequest wrapper for the UpdateRecord operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/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 is 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
func (request UpdateRecordRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
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"`
// A 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