datalabelingservicedataplane

package
v65.73.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Aug 27, 2024 License: Apache-2.0, UPL-1.0 Imports: 8 Imported by: 1

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func GetAnnotationLifecycleStateEnumStringValues 

func GetAnnotationLifecycleStateEnumStringValues() []string

GetAnnotationLifecycleStateEnumStringValues Enumerates the set of values in String for AnnotationLifecycleStateEnum

func GetCreateSourceDetailsSourceTypeEnumStringValues 

func GetCreateSourceDetailsSourceTypeEnumStringValues() []string

GetCreateSourceDetailsSourceTypeEnumStringValues Enumerates the set of values in String for CreateSourceDetailsSourceTypeEnum

func GetDatasetFormatDetailsFormatTypeEnumStringValues 

func GetDatasetFormatDetailsFormatTypeEnumStringValues() []string

GetDatasetFormatDetailsFormatTypeEnumStringValues Enumerates the set of values in String for DatasetFormatDetailsFormatTypeEnum

func GetDatasetLifecycleStateEnumStringValues 

func GetDatasetLifecycleStateEnumStringValues() []string

GetDatasetLifecycleStateEnumStringValues Enumerates the set of values in String for DatasetLifecycleStateEnum

func GetDatasetLifecycleSubstateEnumStringValues added in v65.41.1 

func GetDatasetLifecycleSubstateEnumStringValues() []string

GetDatasetLifecycleSubstateEnumStringValues Enumerates the set of values in String for DatasetLifecycleSubstateEnum

func GetDatasetSourceDetailsSourceTypeEnumStringValues 

func GetDatasetSourceDetailsSourceTypeEnumStringValues() []string

GetDatasetSourceDetailsSourceTypeEnumStringValues Enumerates the set of values in String for DatasetSourceDetailsSourceTypeEnum

func GetEntityEntityTypeEnumStringValues 

func GetEntityEntityTypeEnumStringValues() []string

GetEntityEntityTypeEnumStringValues Enumerates the set of values in String for EntityEntityTypeEnum

func GetImportFormatNameEnumStringValues added in v65.41.1 

func GetImportFormatNameEnumStringValues() []string

GetImportFormatNameEnumStringValues Enumerates the set of values in String for ImportFormatNameEnum

func GetImportFormatVersionEnumStringValues added in v65.41.1 

func GetImportFormatVersionEnumStringValues() []string

GetImportFormatVersionEnumStringValues Enumerates the set of values in String for ImportFormatVersionEnum

func GetImportMetadataPathSourceTypeEnumStringValues added in v65.41.1 

func GetImportMetadataPathSourceTypeEnumStringValues() []string

GetImportMetadataPathSourceTypeEnumStringValues Enumerates the set of values in String for ImportMetadataPathSourceTypeEnum

func GetListAnnotationsSortByEnumStringValues 

func GetListAnnotationsSortByEnumStringValues() []string

GetListAnnotationsSortByEnumStringValues Enumerates the set of values in String for ListAnnotationsSortByEnum

func GetListAnnotationsSortOrderEnumStringValues 

func GetListAnnotationsSortOrderEnumStringValues() []string

GetListAnnotationsSortOrderEnumStringValues Enumerates the set of values in String for ListAnnotationsSortOrderEnum

func GetListRecordsSortByEnumStringValues 

func GetListRecordsSortByEnumStringValues() []string

GetListRecordsSortByEnumStringValues Enumerates the set of values in String for ListRecordsSortByEnum

func GetListRecordsSortOrderEnumStringValues 

func GetListRecordsSortOrderEnumStringValues() []string

GetListRecordsSortOrderEnumStringValues Enumerates the set of values in String for ListRecordsSortOrderEnum

func GetRecordLifecycleStateEnumStringValues 

func GetRecordLifecycleStateEnumStringValues() []string

GetRecordLifecycleStateEnumStringValues Enumerates the set of values in String for RecordLifecycleStateEnum

func GetRecordMetadataRecordTypeEnumStringValues 

func GetRecordMetadataRecordTypeEnumStringValues() []string

GetRecordMetadataRecordTypeEnumStringValues Enumerates the set of values in String for RecordMetadataRecordTypeEnum

func GetSortOrdersEnumStringValues 

func GetSortOrdersEnumStringValues() []string

GetSortOrdersEnumStringValues Enumerates the set of values in String for SortOrdersEnum

func GetSourceDetailsSourceTypeEnumStringValues 

func GetSourceDetailsSourceTypeEnumStringValues() []string

GetSourceDetailsSourceTypeEnumStringValues Enumerates the set of values in String for SourceDetailsSourceTypeEnum

func GetSummarizeAnnotationAnalyticsAnnotationGroupByEnumStringValues 

func GetSummarizeAnnotationAnalyticsAnnotationGroupByEnumStringValues() []string

GetSummarizeAnnotationAnalyticsAnnotationGroupByEnumStringValues Enumerates the set of values in String for SummarizeAnnotationAnalyticsAnnotationGroupByEnum

func GetSummarizeAnnotationAnalyticsSortByEnumStringValues 

func GetSummarizeAnnotationAnalyticsSortByEnumStringValues() []string

GetSummarizeAnnotationAnalyticsSortByEnumStringValues Enumerates the set of values in String for SummarizeAnnotationAnalyticsSortByEnum

func GetSummarizeAnnotationAnalyticsSortOrderEnumStringValues 

func GetSummarizeAnnotationAnalyticsSortOrderEnumStringValues() []string

GetSummarizeAnnotationAnalyticsSortOrderEnumStringValues Enumerates the set of values in String for SummarizeAnnotationAnalyticsSortOrderEnum

func GetSummarizeRecordAnalyticsRecordGroupByEnumStringValues 

func GetSummarizeRecordAnalyticsRecordGroupByEnumStringValues() []string

GetSummarizeRecordAnalyticsRecordGroupByEnumStringValues Enumerates the set of values in String for SummarizeRecordAnalyticsRecordGroupByEnum

func GetSummarizeRecordAnalyticsSortByEnumStringValues 

func GetSummarizeRecordAnalyticsSortByEnumStringValues() []string

GetSummarizeRecordAnalyticsSortByEnumStringValues Enumerates the set of values in String for SummarizeRecordAnalyticsSortByEnum

func GetSummarizeRecordAnalyticsSortOrderEnumStringValues 

func GetSummarizeRecordAnalyticsSortOrderEnumStringValues() []string

GetSummarizeRecordAnalyticsSortOrderEnumStringValues Enumerates the set of values in String for SummarizeRecordAnalyticsSortOrderEnum

func GetTextFileTypeMetadataFormatTypeEnumStringValues added in v65.10.0 

func GetTextFileTypeMetadataFormatTypeEnumStringValues() []string

GetTextFileTypeMetadataFormatTypeEnumStringValues Enumerates the set of values in String for TextFileTypeMetadataFormatTypeEnum

Types

type Annotation 

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"`
}

Annotation An annotation represents a user- or machine-generated annotation for a given record. The details of the annotation are captured in the RecordAnnotationDetails.

func (Annotation) String 

func (m Annotation) String() string

func (*Annotation) UnmarshalJSON 

func (m *Annotation) UnmarshalJSON(data []byte) (e error)

UnmarshalJSON unmarshals from json

func (Annotation) ValidateEnumValue 

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

type AnnotationAggregationDimensions 

type AnnotationAggregationDimensions struct {
	Label *Label `mandatory:"false" json:"label"`

	// The OCID of the principal which updated the resource.
	UpdatedBy *string `mandatory:"false" json:"updatedBy"`
}

AnnotationAggregationDimensions The dimensions to summarize annotations for a given dataset.

func (AnnotationAggregationDimensions) String 

func (m AnnotationAggregationDimensions) String() string

func (AnnotationAggregationDimensions) ValidateEnumValue 

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

type AnnotationAnalyticsAggregation 

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"`
}

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.

func (AnnotationAnalyticsAggregation) String 

func (m AnnotationAnalyticsAggregation) String() string

func (AnnotationAnalyticsAggregation) ValidateEnumValue 

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

type AnnotationAnalyticsAggregationCollection 

type AnnotationAnalyticsAggregationCollection struct {

	// The list of annotation entities.
	Items []AnnotationAnalyticsAggregation `mandatory:"true" json:"items"`
}

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.

func (AnnotationAnalyticsAggregationCollection) String 

func (m AnnotationAnalyticsAggregationCollection) String() string

func (AnnotationAnalyticsAggregationCollection) ValidateEnumValue 

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

type AnnotationCollection 

type AnnotationCollection struct {

	// The list of annotations.
	Items []AnnotationSummary `mandatory:"true" json:"items"`
}

AnnotationCollection The results of an annotations search. It contains AnnotationSummary items and other information, such as metadata.

func (AnnotationCollection) String 

func (m AnnotationCollection) String() string

func (AnnotationCollection) ValidateEnumValue 

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

type AnnotationLifecycleStateEnum 

type AnnotationLifecycleStateEnum string

AnnotationLifecycleStateEnum Enum with underlying type: string 

const (
	AnnotationLifecycleStateActive   AnnotationLifecycleStateEnum = "ACTIVE"
	AnnotationLifecycleStateInactive AnnotationLifecycleStateEnum = "INACTIVE"
	AnnotationLifecycleStateDeleted  AnnotationLifecycleStateEnum = "DELETED"
)

Set of constants representing the allowable values for AnnotationLifecycleStateEnum

func GetAnnotationLifecycleStateEnumValues 

func GetAnnotationLifecycleStateEnumValues() []AnnotationLifecycleStateEnum

GetAnnotationLifecycleStateEnumValues Enumerates the set of values for AnnotationLifecycleStateEnum

func GetMappingAnnotationLifecycleStateEnum 

func GetMappingAnnotationLifecycleStateEnum(val string) (AnnotationLifecycleStateEnum, bool)

GetMappingAnnotationLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum

type AnnotationSummary 

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"`
}

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.

func (AnnotationSummary) String 

func (m AnnotationSummary) String() string

func (AnnotationSummary) ValidateEnumValue 

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

type BoundingPolygon 

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"`
}

BoundingPolygon A polygon used to describe the location of an object.

func (BoundingPolygon) String 

func (m BoundingPolygon) String() string

func (BoundingPolygon) ValidateEnumValue 

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

type CreateAnnotationDetails 

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"`
}

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.

func (CreateAnnotationDetails) String 

func (m CreateAnnotationDetails) String() string

func (*CreateAnnotationDetails) UnmarshalJSON 

func (m *CreateAnnotationDetails) UnmarshalJSON(data []byte) (e error)

UnmarshalJSON unmarshals from json

func (CreateAnnotationDetails) ValidateEnumValue 

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

type 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
}

CreateAnnotationRequest wrapper for the CreateAnnotation operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/datalabelingservicedataplane/CreateAnnotation.go.html to see an example of how to use CreateAnnotationRequest.

func (CreateAnnotationRequest) BinaryRequestBody 

func (request CreateAnnotationRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (CreateAnnotationRequest) HTTPRequest 

func (request CreateAnnotationRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (CreateAnnotationRequest) RetryPolicy 

func (request CreateAnnotationRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (CreateAnnotationRequest) String 

func (request CreateAnnotationRequest) String() string

func (CreateAnnotationRequest) ValidateEnumValue 

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

type CreateAnnotationResponse 

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"`
}

CreateAnnotationResponse wrapper for the CreateAnnotation operation

func (CreateAnnotationResponse) HTTPResponse 

func (response CreateAnnotationResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (CreateAnnotationResponse) String 

func (response CreateAnnotationResponse) String() string

type CreateObjectStorageSourceDetails 

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"`
}

CreateObjectStorageSourceDetails Object Storage Source Details.

func (CreateObjectStorageSourceDetails) MarshalJSON 

func (m CreateObjectStorageSourceDetails) MarshalJSON() (buff []byte, e error)

MarshalJSON marshals to json representation

func (CreateObjectStorageSourceDetails) String 

func (m CreateObjectStorageSourceDetails) String() string

func (CreateObjectStorageSourceDetails) ValidateEnumValue 

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

type CreateRecordDetails 

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"`
}

CreateRecordDetails A record represents an entry in a dataset that needs labeling.

func (CreateRecordDetails) String 

func (m CreateRecordDetails) String() string

func (*CreateRecordDetails) UnmarshalJSON 

func (m *CreateRecordDetails) UnmarshalJSON(data []byte) (e error)

UnmarshalJSON unmarshals from json

func (CreateRecordDetails) ValidateEnumValue 

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

type 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
}

CreateRecordRequest wrapper for the CreateRecord operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/datalabelingservicedataplane/CreateRecord.go.html to see an example of how to use CreateRecordRequest.

func (CreateRecordRequest) BinaryRequestBody 

func (request CreateRecordRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (CreateRecordRequest) HTTPRequest 

func (request CreateRecordRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (CreateRecordRequest) RetryPolicy 

func (request CreateRecordRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (CreateRecordRequest) String 

func (request CreateRecordRequest) String() string

func (CreateRecordRequest) ValidateEnumValue 

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

type CreateRecordResponse 

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"`
}

CreateRecordResponse wrapper for the CreateRecord operation

func (CreateRecordResponse) HTTPResponse 

func (response CreateRecordResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (CreateRecordResponse) String 

func (response CreateRecordResponse) String() string

type CreateSourceDetails 

type CreateSourceDetails interface {
}

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 CreateSourceDetailsSourceTypeEnum 

type CreateSourceDetailsSourceTypeEnum string

CreateSourceDetailsSourceTypeEnum Enum with underlying type: string 

const (
	CreateSourceDetailsSourceTypeObjectStorage CreateSourceDetailsSourceTypeEnum = "OBJECT_STORAGE"
)

Set of constants representing the allowable values for CreateSourceDetailsSourceTypeEnum

func GetCreateSourceDetailsSourceTypeEnumValues 

func GetCreateSourceDetailsSourceTypeEnumValues() []CreateSourceDetailsSourceTypeEnum

GetCreateSourceDetailsSourceTypeEnumValues Enumerates the set of values for CreateSourceDetailsSourceTypeEnum

func GetMappingCreateSourceDetailsSourceTypeEnum 

func GetMappingCreateSourceDetailsSourceTypeEnum(val string) (CreateSourceDetailsSourceTypeEnum, bool)

GetMappingCreateSourceDetailsSourceTypeEnum performs case Insensitive comparison on enum value and return the desired enum

type DataLabelingClient 

type DataLabelingClient struct {
	common.BaseClient
	// contains filtered or unexported fields
}

DataLabelingClient a client for DataLabeling

func NewDataLabelingClientWithConfigurationProvider 

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 

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 (*DataLabelingClient) ConfigurationProvider 

func (client *DataLabelingClient) ConfigurationProvider() *common.ConfigurationProvider

ConfigurationProvider the ConfigurationProvider used in this client, or null if none set

func (DataLabelingClient) CreateAnnotation 

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/latest/datalabelingservicedataplane/CreateAnnotation.go.html to see an example of how to use CreateAnnotation API. A default retry strategy applies to this operation CreateAnnotation()

func (DataLabelingClient) CreateRecord 

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/latest/datalabelingservicedataplane/CreateRecord.go.html to see an example of how to use CreateRecord API. A default retry strategy applies to this operation CreateRecord()

func (DataLabelingClient) DeleteAnnotation 

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/latest/datalabelingservicedataplane/DeleteAnnotation.go.html to see an example of how to use DeleteAnnotation API. A default retry strategy applies to this operation DeleteAnnotation()

func (DataLabelingClient) DeleteRecord 

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/latest/datalabelingservicedataplane/DeleteRecord.go.html to see an example of how to use DeleteRecord API. A default retry strategy applies to this operation DeleteRecord()

func (DataLabelingClient) GetAnnotation 

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/latest/datalabelingservicedataplane/GetAnnotation.go.html to see an example of how to use GetAnnotation API. A default retry strategy applies to this operation GetAnnotation()

func (DataLabelingClient) GetDataset 

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/latest/datalabelingservicedataplane/GetDataset.go.html to see an example of how to use GetDataset API. A default retry strategy applies to this operation GetDataset()

func (DataLabelingClient) GetRecord 

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/latest/datalabelingservicedataplane/GetRecord.go.html to see an example of how to use GetRecord API. A default retry strategy applies to this operation GetRecord()

func (DataLabelingClient) GetRecordContent 

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/latest/datalabelingservicedataplane/GetRecordContent.go.html to see an example of how to use GetRecordContent API. A default retry strategy applies to this operation GetRecordContent()

func (DataLabelingClient) GetRecordPreviewContent 

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/latest/datalabelingservicedataplane/GetRecordPreviewContent.go.html to see an example of how to use GetRecordPreviewContent API. A default retry strategy applies to this operation GetRecordPreviewContent()

func (DataLabelingClient) ListAnnotations 

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/latest/datalabelingservicedataplane/ListAnnotations.go.html to see an example of how to use ListAnnotations API. A default retry strategy applies to this operation ListAnnotations()

func (DataLabelingClient) ListRecords 

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/latest/datalabelingservicedataplane/ListRecords.go.html to see an example of how to use ListRecords API. A default retry strategy applies to this operation ListRecords()

func (*DataLabelingClient) SetRegion 

func (client *DataLabelingClient) SetRegion(region string)

SetRegion overrides the region of this client.

func (DataLabelingClient) SummarizeAnnotationAnalytics 

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/latest/datalabelingservicedataplane/SummarizeAnnotationAnalytics.go.html to see an example of how to use SummarizeAnnotationAnalytics API. A default retry strategy applies to this operation SummarizeAnnotationAnalytics()

func (DataLabelingClient) SummarizeRecordAnalytics 

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/latest/datalabelingservicedataplane/SummarizeRecordAnalytics.go.html to see an example of how to use SummarizeRecordAnalytics API. A default retry strategy applies to this operation SummarizeRecordAnalytics()

func (DataLabelingClient) UpdateAnnotation 

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/latest/datalabelingservicedataplane/UpdateAnnotation.go.html to see an example of how to use UpdateAnnotation API. A default retry strategy applies to this operation UpdateAnnotation()

func (DataLabelingClient) UpdateRecord 

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/latest/datalabelingservicedataplane/UpdateRecord.go.html to see an example of how to use UpdateRecord API. A default retry strategy applies to this operation UpdateRecord()

type Dataset 

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"`
}

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.

func (Dataset) String 

func (m Dataset) String() string

func (*Dataset) UnmarshalJSON 

func (m *Dataset) UnmarshalJSON(data []byte) (e error)

UnmarshalJSON unmarshals from json

func (Dataset) ValidateEnumValue 

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

type DatasetFormatDetails 

type DatasetFormatDetails interface {
}

DatasetFormatDetails It specifies how to process the data. Supported formats include DOCUMENT, IMAGE, and TEXT.

type DatasetFormatDetailsFormatTypeEnum 

type DatasetFormatDetailsFormatTypeEnum string

DatasetFormatDetailsFormatTypeEnum Enum with underlying type: string 

const (
	DatasetFormatDetailsFormatTypeDocument DatasetFormatDetailsFormatTypeEnum = "DOCUMENT"
	DatasetFormatDetailsFormatTypeImage    DatasetFormatDetailsFormatTypeEnum = "IMAGE"
	DatasetFormatDetailsFormatTypeText     DatasetFormatDetailsFormatTypeEnum = "TEXT"
)

Set of constants representing the allowable values for DatasetFormatDetailsFormatTypeEnum

func GetDatasetFormatDetailsFormatTypeEnumValues 

func GetDatasetFormatDetailsFormatTypeEnumValues() []DatasetFormatDetailsFormatTypeEnum

GetDatasetFormatDetailsFormatTypeEnumValues Enumerates the set of values for DatasetFormatDetailsFormatTypeEnum

func GetMappingDatasetFormatDetailsFormatTypeEnum 

func GetMappingDatasetFormatDetailsFormatTypeEnum(val string) (DatasetFormatDetailsFormatTypeEnum, bool)

GetMappingDatasetFormatDetailsFormatTypeEnum performs case Insensitive comparison on enum value and return the desired enum

type DatasetLifecycleStateEnum 

type DatasetLifecycleStateEnum string

DatasetLifecycleStateEnum Enum with underlying type: string 

const (
	DatasetLifecycleStateCreating       DatasetLifecycleStateEnum = "CREATING"
	DatasetLifecycleStateUpdating       DatasetLifecycleStateEnum = "UPDATING"
	DatasetLifecycleStateActive         DatasetLifecycleStateEnum = "ACTIVE"
	DatasetLifecycleStateNeedsAttention DatasetLifecycleStateEnum = "NEEDS_ATTENTION"
	DatasetLifecycleStateDeleting       DatasetLifecycleStateEnum = "DELETING"
	DatasetLifecycleStateDeleted        DatasetLifecycleStateEnum = "DELETED"
	DatasetLifecycleStateFailed         DatasetLifecycleStateEnum = "FAILED"
)

Set of constants representing the allowable values for DatasetLifecycleStateEnum

func GetDatasetLifecycleStateEnumValues 

func GetDatasetLifecycleStateEnumValues() []DatasetLifecycleStateEnum

GetDatasetLifecycleStateEnumValues Enumerates the set of values for DatasetLifecycleStateEnum

func GetMappingDatasetLifecycleStateEnum 

func GetMappingDatasetLifecycleStateEnum(val string) (DatasetLifecycleStateEnum, bool)

GetMappingDatasetLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum

type DatasetLifecycleSubstateEnum added in v65.41.1 

type DatasetLifecycleSubstateEnum string

DatasetLifecycleSubstateEnum Enum with underlying type: string 

const (
	DatasetLifecycleSubstateImportDataset DatasetLifecycleSubstateEnum = "IMPORT_DATASET"
)

Set of constants representing the allowable values for DatasetLifecycleSubstateEnum

func GetDatasetLifecycleSubstateEnumValues added in v65.41.1 

func GetDatasetLifecycleSubstateEnumValues() []DatasetLifecycleSubstateEnum

GetDatasetLifecycleSubstateEnumValues Enumerates the set of values for DatasetLifecycleSubstateEnum

func GetMappingDatasetLifecycleSubstateEnum added in v65.41.1 

func GetMappingDatasetLifecycleSubstateEnum(val string) (DatasetLifecycleSubstateEnum, bool)

GetMappingDatasetLifecycleSubstateEnum performs case Insensitive comparison on enum value and return the desired enum

type DatasetSourceDetails 

type DatasetSourceDetails interface {
}

DatasetSourceDetails This allows the customer to specify the source of the dataset.

type DatasetSourceDetailsSourceTypeEnum 

type DatasetSourceDetailsSourceTypeEnum string

DatasetSourceDetailsSourceTypeEnum Enum with underlying type: string 

const (
	DatasetSourceDetailsSourceTypeObjectStorage DatasetSourceDetailsSourceTypeEnum = "OBJECT_STORAGE"
)

Set of constants representing the allowable values for DatasetSourceDetailsSourceTypeEnum

func GetDatasetSourceDetailsSourceTypeEnumValues 

func GetDatasetSourceDetailsSourceTypeEnumValues() []DatasetSourceDetailsSourceTypeEnum

GetDatasetSourceDetailsSourceTypeEnumValues Enumerates the set of values for DatasetSourceDetailsSourceTypeEnum

func GetMappingDatasetSourceDetailsSourceTypeEnum 

func GetMappingDatasetSourceDetailsSourceTypeEnum(val string) (DatasetSourceDetailsSourceTypeEnum, bool)

GetMappingDatasetSourceDetailsSourceTypeEnum performs case Insensitive comparison on enum value and return the desired enum

type 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
}

DeleteAnnotationRequest wrapper for the DeleteAnnotation operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/datalabelingservicedataplane/DeleteAnnotation.go.html to see an example of how to use DeleteAnnotationRequest.

func (DeleteAnnotationRequest) BinaryRequestBody 

func (request DeleteAnnotationRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (DeleteAnnotationRequest) HTTPRequest 

func (request DeleteAnnotationRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (DeleteAnnotationRequest) RetryPolicy 

func (request DeleteAnnotationRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (DeleteAnnotationRequest) String 

func (request DeleteAnnotationRequest) String() string

func (DeleteAnnotationRequest) ValidateEnumValue 

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

type DeleteAnnotationResponse 

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"`
}

DeleteAnnotationResponse wrapper for the DeleteAnnotation operation

func (DeleteAnnotationResponse) HTTPResponse 

func (response DeleteAnnotationResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (DeleteAnnotationResponse) String 

func (response DeleteAnnotationResponse) String() string

type 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
}

DeleteRecordRequest wrapper for the DeleteRecord operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/datalabelingservicedataplane/DeleteRecord.go.html to see an example of how to use DeleteRecordRequest.

func (DeleteRecordRequest) BinaryRequestBody 

func (request DeleteRecordRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (DeleteRecordRequest) HTTPRequest 

func (request DeleteRecordRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (DeleteRecordRequest) RetryPolicy 

func (request DeleteRecordRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (DeleteRecordRequest) String 

func (request DeleteRecordRequest) String() string

func (DeleteRecordRequest) ValidateEnumValue 

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

type DeleteRecordResponse 

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"`
}

DeleteRecordResponse wrapper for the DeleteRecord operation

func (DeleteRecordResponse) HTTPResponse 

func (response DeleteRecordResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (DeleteRecordResponse) String 

func (response DeleteRecordResponse) String() string

type DelimitedFileTypeMetadata added in v65.10.0 

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"`
}

DelimitedFileTypeMetadata Metadata of delimited files.

func (DelimitedFileTypeMetadata) MarshalJSON added in v65.10.0 

func (m DelimitedFileTypeMetadata) MarshalJSON() (buff []byte, e error)

MarshalJSON marshals to json representation

func (DelimitedFileTypeMetadata) String added in v65.10.0 

func (m DelimitedFileTypeMetadata) String() string

func (DelimitedFileTypeMetadata) ValidateEnumValue added in v65.10.0 

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

type DocumentDatasetFormatDetails 

type DocumentDatasetFormatDetails struct {
}

DocumentDatasetFormatDetails It indicates the dataset is comprised of document files. It is open for further configurability.

func (DocumentDatasetFormatDetails) MarshalJSON 

func (m DocumentDatasetFormatDetails) MarshalJSON() (buff []byte, e error)

MarshalJSON marshals to json representation

func (DocumentDatasetFormatDetails) String 

func (m DocumentDatasetFormatDetails) String() string

func (DocumentDatasetFormatDetails) ValidateEnumValue 

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

type DocumentEntityMetadata added in v65.41.1 

type DocumentEntityMetadata struct {

	// This stores page number of document.
	PageNumber *float32 `mandatory:"true" json:"pageNumber"`
}

DocumentEntityMetadata This is dedicated Entity to store Document related info.

func (DocumentEntityMetadata) String added in v65.41.1 

func (m DocumentEntityMetadata) String() string

func (DocumentEntityMetadata) ValidateEnumValue added in v65.41.1 

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

type DocumentMetadata 

type DocumentMetadata struct {

	// Job id ocid of OCR batch call.
	JobId *string `mandatory:"false" json:"jobId"`
}

DocumentMetadata Collection of metadata related to document record.

func (DocumentMetadata) MarshalJSON 

func (m DocumentMetadata) MarshalJSON() (buff []byte, e error)

MarshalJSON marshals to json representation

func (DocumentMetadata) String 

func (m DocumentMetadata) String() string

func (DocumentMetadata) ValidateEnumValue 

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

type Entity 

type Entity interface {
}

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 EntityEntityTypeEnum 

type EntityEntityTypeEnum string

EntityEntityTypeEnum Enum with underlying type: string 

const (
	EntityEntityTypeGeneric              EntityEntityTypeEnum = "GENERIC"
	EntityEntityTypeImageobjectselection EntityEntityTypeEnum = "IMAGEOBJECTSELECTION"
	EntityEntityTypeTextselection        EntityEntityTypeEnum = "TEXTSELECTION"
	EntityEntityTypeKeyvalueselection    EntityEntityTypeEnum = "KEYVALUESELECTION"
)

Set of constants representing the allowable values for EntityEntityTypeEnum

func GetEntityEntityTypeEnumValues 

func GetEntityEntityTypeEnumValues() []EntityEntityTypeEnum

GetEntityEntityTypeEnumValues Enumerates the set of values for EntityEntityTypeEnum

func GetMappingEntityEntityTypeEnum 

func GetMappingEntityEntityTypeEnum(val string) (EntityEntityTypeEnum, bool)

GetMappingEntityEntityTypeEnum performs case Insensitive comparison on enum value and return the desired enum

type GenericEntity 

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"`
}

GenericEntity This is an extensible entity type for users, and the base entity type for some annotation formats.

func (GenericEntity) MarshalJSON 

func (m GenericEntity) MarshalJSON() (buff []byte, e error)

MarshalJSON marshals to json representation

func (GenericEntity) String 

func (m GenericEntity) String() string

func (GenericEntity) ValidateEnumValue 

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

type 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
}

GetAnnotationRequest wrapper for the GetAnnotation operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/datalabelingservicedataplane/GetAnnotation.go.html to see an example of how to use GetAnnotationRequest.

func (GetAnnotationRequest) BinaryRequestBody 

func (request GetAnnotationRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (GetAnnotationRequest) HTTPRequest 

func (request GetAnnotationRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (GetAnnotationRequest) RetryPolicy 

func (request GetAnnotationRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (GetAnnotationRequest) String 

func (request GetAnnotationRequest) String() string

func (GetAnnotationRequest) ValidateEnumValue 

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

type GetAnnotationResponse 

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"`
}

GetAnnotationResponse wrapper for the GetAnnotation operation

func (GetAnnotationResponse) HTTPResponse 

func (response GetAnnotationResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (GetAnnotationResponse) String 

func (response GetAnnotationResponse) String() string

type 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
}

GetDatasetRequest wrapper for the GetDataset operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/datalabelingservicedataplane/GetDataset.go.html to see an example of how to use GetDatasetRequest.

func (GetDatasetRequest) BinaryRequestBody 

func (request GetDatasetRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (GetDatasetRequest) HTTPRequest 

func (request GetDatasetRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (GetDatasetRequest) RetryPolicy 

func (request GetDatasetRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (GetDatasetRequest) String 

func (request GetDatasetRequest) String() string

func (GetDatasetRequest) ValidateEnumValue 

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

type GetDatasetResponse 

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"`
}

GetDatasetResponse wrapper for the GetDataset operation

func (GetDatasetResponse) HTTPResponse 

func (response GetDatasetResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (GetDatasetResponse) String 

func (response GetDatasetResponse) String() string

type 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
}

GetRecordContentRequest wrapper for the GetRecordContent operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/datalabelingservicedataplane/GetRecordContent.go.html to see an example of how to use GetRecordContentRequest.

func (GetRecordContentRequest) BinaryRequestBody 

func (request GetRecordContentRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (GetRecordContentRequest) HTTPRequest 

func (request GetRecordContentRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (GetRecordContentRequest) RetryPolicy 

func (request GetRecordContentRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (GetRecordContentRequest) String 

func (request GetRecordContentRequest) String() string

func (GetRecordContentRequest) ValidateEnumValue 

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

type GetRecordContentResponse 

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
}

GetRecordContentResponse wrapper for the GetRecordContent operation

func (GetRecordContentResponse) HTTPResponse 

func (response GetRecordContentResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (GetRecordContentResponse) String 

func (response GetRecordContentResponse) String() string

type 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
}

GetRecordPreviewContentRequest wrapper for the GetRecordPreviewContent operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/datalabelingservicedataplane/GetRecordPreviewContent.go.html to see an example of how to use GetRecordPreviewContentRequest.

func (GetRecordPreviewContentRequest) BinaryRequestBody 

func (request GetRecordPreviewContentRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (GetRecordPreviewContentRequest) HTTPRequest 

func (request GetRecordPreviewContentRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (GetRecordPreviewContentRequest) RetryPolicy 

func (request GetRecordPreviewContentRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (GetRecordPreviewContentRequest) String 

func (request GetRecordPreviewContentRequest) String() string

func (GetRecordPreviewContentRequest) ValidateEnumValue 

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

type GetRecordPreviewContentResponse 

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
}

GetRecordPreviewContentResponse wrapper for the GetRecordPreviewContent operation

func (GetRecordPreviewContentResponse) HTTPResponse 

func (response GetRecordPreviewContentResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (GetRecordPreviewContentResponse) String 

func (response GetRecordPreviewContentResponse) String() string

type 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
}

GetRecordRequest wrapper for the GetRecord operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/datalabelingservicedataplane/GetRecord.go.html to see an example of how to use GetRecordRequest.

func (GetRecordRequest) BinaryRequestBody 

func (request GetRecordRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (GetRecordRequest) HTTPRequest 

func (request GetRecordRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (GetRecordRequest) RetryPolicy 

func (request GetRecordRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (GetRecordRequest) String 

func (request GetRecordRequest) String() string

func (GetRecordRequest) ValidateEnumValue 

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

type GetRecordResponse 

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"`
}

GetRecordResponse wrapper for the GetRecord operation

func (GetRecordResponse) HTTPResponse 

func (response GetRecordResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (GetRecordResponse) String 

func (response GetRecordResponse) String() string

type ImageDatasetFormatDetails 

type ImageDatasetFormatDetails struct {
}

ImageDatasetFormatDetails It indicates the dataset is comprised of images.

func (ImageDatasetFormatDetails) MarshalJSON 

func (m ImageDatasetFormatDetails) MarshalJSON() (buff []byte, e error)

MarshalJSON marshals to json representation

func (ImageDatasetFormatDetails) String 

func (m ImageDatasetFormatDetails) String() string

func (ImageDatasetFormatDetails) ValidateEnumValue 

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

type ImageMetadata 

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"`
}

ImageMetadata Collection of metadata related to image record.

func (ImageMetadata) MarshalJSON 

func (m ImageMetadata) MarshalJSON() (buff []byte, e error)

MarshalJSON marshals to json representation

func (ImageMetadata) String 

func (m ImageMetadata) String() string

func (ImageMetadata) ValidateEnumValue 

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

type ImageObjectSelectionEntity 

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"`
}

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.

func (ImageObjectSelectionEntity) MarshalJSON 

func (m ImageObjectSelectionEntity) MarshalJSON() (buff []byte, e error)

MarshalJSON marshals to json representation

func (ImageObjectSelectionEntity) String 

func (m ImageObjectSelectionEntity) String() string

func (ImageObjectSelectionEntity) ValidateEnumValue 

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

type ImportFormat added in v65.41.1 

type ImportFormat struct {

	// Name of import format
	Name ImportFormatNameEnum `mandatory:"true" json:"name"`

	// Version of import format
	Version ImportFormatVersionEnum `mandatory:"false" json:"version,omitempty"`
}

ImportFormat File format details used for importing dataset

func (ImportFormat) String added in v65.41.1 

func (m ImportFormat) String() string

func (ImportFormat) ValidateEnumValue added in v65.41.1 

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

type ImportFormatNameEnum added in v65.41.1 

type ImportFormatNameEnum string

ImportFormatNameEnum Enum with underlying type: string 

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"
)

Set of constants representing the allowable values for ImportFormatNameEnum

func GetImportFormatNameEnumValues added in v65.41.1 

func GetImportFormatNameEnumValues() []ImportFormatNameEnum

GetImportFormatNameEnumValues Enumerates the set of values for ImportFormatNameEnum

func GetMappingImportFormatNameEnum added in v65.41.1 

func GetMappingImportFormatNameEnum(val string) (ImportFormatNameEnum, bool)

GetMappingImportFormatNameEnum performs case Insensitive comparison on enum value and return the desired enum

type ImportFormatVersionEnum added in v65.41.1 

type ImportFormatVersionEnum string

ImportFormatVersionEnum Enum with underlying type: string 

const (
	ImportFormatVersionV2003 ImportFormatVersionEnum = "V2003"
	ImportFormatVersionV5    ImportFormatVersionEnum = "V5"
)

Set of constants representing the allowable values for ImportFormatVersionEnum

func GetImportFormatVersionEnumValues added in v65.41.1 

func GetImportFormatVersionEnumValues() []ImportFormatVersionEnum

GetImportFormatVersionEnumValues Enumerates the set of values for ImportFormatVersionEnum

func GetMappingImportFormatVersionEnum added in v65.41.1 

func GetMappingImportFormatVersionEnum(val string) (ImportFormatVersionEnum, bool)

GetMappingImportFormatVersionEnum performs case Insensitive comparison on enum value and return the desired enum

type ImportMetadataPath added in v65.41.1 

type ImportMetadataPath interface {
}

ImportMetadataPath Object storage path for the metadata file

type ImportMetadataPathSourceTypeEnum added in v65.41.1 

type ImportMetadataPathSourceTypeEnum string

ImportMetadataPathSourceTypeEnum Enum with underlying type: string 

const (
	ImportMetadataPathSourceTypeObjectStorage ImportMetadataPathSourceTypeEnum = "OBJECT_STORAGE"
)

Set of constants representing the allowable values for ImportMetadataPathSourceTypeEnum

func GetImportMetadataPathSourceTypeEnumValues added in v65.41.1 

func GetImportMetadataPathSourceTypeEnumValues() []ImportMetadataPathSourceTypeEnum

GetImportMetadataPathSourceTypeEnumValues Enumerates the set of values for ImportMetadataPathSourceTypeEnum

func GetMappingImportMetadataPathSourceTypeEnum added in v65.41.1 

func GetMappingImportMetadataPathSourceTypeEnum(val string) (ImportMetadataPathSourceTypeEnum, bool)

GetMappingImportMetadataPathSourceTypeEnum performs case Insensitive comparison on enum value and return the desired enum

type InitialImportDatasetConfiguration added in v65.41.1 

type InitialImportDatasetConfiguration struct {
	ImportFormat *ImportFormat `mandatory:"true" json:"importFormat"`

	ImportMetadataPath ImportMetadataPath `mandatory:"true" json:"importMetadataPath"`
}

InitialImportDatasetConfiguration Initial import dataset configuration. Allows user to create dataset from existing dataset files.

func (InitialImportDatasetConfiguration) String added in v65.41.1 

func (m InitialImportDatasetConfiguration) String() string

func (*InitialImportDatasetConfiguration) UnmarshalJSON added in v65.41.1 

func (m *InitialImportDatasetConfiguration) UnmarshalJSON(data []byte) (e error)

UnmarshalJSON unmarshals from json

func (InitialImportDatasetConfiguration) ValidateEnumValue added in v65.41.1 

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

type InitialRecordGenerationConfiguration 

type InitialRecordGenerationConfiguration struct {

	// The maximum number of records to generate.
	Limit *float32 `mandatory:"false" json:"limit"`
}

InitialRecordGenerationConfiguration The initial generate records configuration. It generates records from the dataset's source.

func (InitialRecordGenerationConfiguration) String 

func (m InitialRecordGenerationConfiguration) String() string

func (InitialRecordGenerationConfiguration) ValidateEnumValue 

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

type KeyValueSelectionEntity added in v65.28.1 

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"`
}

KeyValueSelectionEntity This allows the labeler to apply label the highlighted text from OCR, this includes labelled and unlabelled data.

func (KeyValueSelectionEntity) MarshalJSON added in v65.28.1 

func (m KeyValueSelectionEntity) MarshalJSON() (buff []byte, e error)

MarshalJSON marshals to json representation

func (KeyValueSelectionEntity) String added in v65.28.1 

func (m KeyValueSelectionEntity) String() string

func (KeyValueSelectionEntity) ValidateEnumValue added in v65.28.1 

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

type Label 

type Label struct {

	// The label provided by the annotator.
	Label *string `mandatory:"true" json:"label"`
}

Label A label is a string value. The API validates that it's one of the dataset's pre-defined labels.

func (Label) String 

func (m Label) String() string

func (Label) ValidateEnumValue 

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

type LabelName 

type LabelName struct {

	// An unique name for a label within its dataset.
	Name *string `mandatory:"false" json:"name"`
}

LabelName It represents a label.

func (LabelName) String 

func (m LabelName) String() string

func (LabelName) ValidateEnumValue 

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

type LabelSet 

type LabelSet struct {

	// An ordered collection of labels that are unique by name.
	Items []LabelName `mandatory:"false" json:"items"`
}

LabelSet An ordered collection of labels that are unique by name.

func (LabelSet) String 

func (m LabelSet) String() string

func (LabelSet) ValidateEnumValue 

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

type 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
}

ListAnnotationsRequest wrapper for the ListAnnotations operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/datalabelingservicedataplane/ListAnnotations.go.html to see an example of how to use ListAnnotationsRequest.

func (ListAnnotationsRequest) BinaryRequestBody 

func (request ListAnnotationsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (ListAnnotationsRequest) HTTPRequest 

func (request ListAnnotationsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (ListAnnotationsRequest) RetryPolicy 

func (request ListAnnotationsRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (ListAnnotationsRequest) String 

func (request ListAnnotationsRequest) String() string

func (ListAnnotationsRequest) ValidateEnumValue 

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

type ListAnnotationsResponse 

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"`
}

ListAnnotationsResponse wrapper for the ListAnnotations operation

func (ListAnnotationsResponse) HTTPResponse 

func (response ListAnnotationsResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (ListAnnotationsResponse) String 

func (response ListAnnotationsResponse) String() string

type ListAnnotationsSortByEnum 

type ListAnnotationsSortByEnum string

ListAnnotationsSortByEnum Enum with underlying type: string 

const (
	ListAnnotationsSortByTimecreated ListAnnotationsSortByEnum = "timeCreated"
	ListAnnotationsSortByLabel       ListAnnotationsSortByEnum = "label"
)

Set of constants representing the allowable values for ListAnnotationsSortByEnum

func GetListAnnotationsSortByEnumValues 

func GetListAnnotationsSortByEnumValues() []ListAnnotationsSortByEnum

GetListAnnotationsSortByEnumValues Enumerates the set of values for ListAnnotationsSortByEnum

func GetMappingListAnnotationsSortByEnum 

func GetMappingListAnnotationsSortByEnum(val string) (ListAnnotationsSortByEnum, bool)

GetMappingListAnnotationsSortByEnum performs case Insensitive comparison on enum value and return the desired enum

type ListAnnotationsSortOrderEnum 

type ListAnnotationsSortOrderEnum string

ListAnnotationsSortOrderEnum Enum with underlying type: string 

const (
	ListAnnotationsSortOrderAsc  ListAnnotationsSortOrderEnum = "ASC"
	ListAnnotationsSortOrderDesc ListAnnotationsSortOrderEnum = "DESC"
)

Set of constants representing the allowable values for ListAnnotationsSortOrderEnum

func GetListAnnotationsSortOrderEnumValues 

func GetListAnnotationsSortOrderEnumValues() []ListAnnotationsSortOrderEnum

GetListAnnotationsSortOrderEnumValues Enumerates the set of values for ListAnnotationsSortOrderEnum

func GetMappingListAnnotationsSortOrderEnum 

func GetMappingListAnnotationsSortOrderEnum(val string) (ListAnnotationsSortOrderEnum, bool)

GetMappingListAnnotationsSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum

type 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
}

ListRecordsRequest wrapper for the ListRecords operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/datalabelingservicedataplane/ListRecords.go.html to see an example of how to use ListRecordsRequest.

func (ListRecordsRequest) BinaryRequestBody 

func (request ListRecordsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (ListRecordsRequest) HTTPRequest 

func (request ListRecordsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (ListRecordsRequest) RetryPolicy 

func (request ListRecordsRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (ListRecordsRequest) String 

func (request ListRecordsRequest) String() string

func (ListRecordsRequest) ValidateEnumValue 

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

type ListRecordsResponse 

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"`
}

ListRecordsResponse wrapper for the ListRecords operation

func (ListRecordsResponse) HTTPResponse 

func (response ListRecordsResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (ListRecordsResponse) String 

func (response ListRecordsResponse) String() string

type ListRecordsSortByEnum 

type ListRecordsSortByEnum string

ListRecordsSortByEnum Enum with underlying type: string 

const (
	ListRecordsSortByTimecreated ListRecordsSortByEnum = "timeCreated"
	ListRecordsSortByName        ListRecordsSortByEnum = "name"
)

Set of constants representing the allowable values for ListRecordsSortByEnum

func GetListRecordsSortByEnumValues 

func GetListRecordsSortByEnumValues() []ListRecordsSortByEnum

GetListRecordsSortByEnumValues Enumerates the set of values for ListRecordsSortByEnum

func GetMappingListRecordsSortByEnum 

func GetMappingListRecordsSortByEnum(val string) (ListRecordsSortByEnum, bool)

GetMappingListRecordsSortByEnum performs case Insensitive comparison on enum value and return the desired enum

type ListRecordsSortOrderEnum 

type ListRecordsSortOrderEnum string

ListRecordsSortOrderEnum Enum with underlying type: string 

const (
	ListRecordsSortOrderAsc  ListRecordsSortOrderEnum = "ASC"
	ListRecordsSortOrderDesc ListRecordsSortOrderEnum = "DESC"
)

Set of constants representing the allowable values for ListRecordsSortOrderEnum

func GetListRecordsSortOrderEnumValues 

func GetListRecordsSortOrderEnumValues() []ListRecordsSortOrderEnum

GetListRecordsSortOrderEnumValues Enumerates the set of values for ListRecordsSortOrderEnum

func GetMappingListRecordsSortOrderEnum 

func GetMappingListRecordsSortOrderEnum(val string) (ListRecordsSortOrderEnum, bool)

GetMappingListRecordsSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum

type NormalizedVertex 

type NormalizedVertex struct {

	// The X axis coordinate.
	X *float32 `mandatory:"true" json:"x"`

	// The Y axis coordinate.
	Y *float32 `mandatory:"true" json:"y"`
}

NormalizedVertex A NormalizedVertex is a cartesian coordinate that represents a corner between two segments of a polygon.

func (NormalizedVertex) String 

func (m NormalizedVertex) String() string

func (NormalizedVertex) ValidateEnumValue 

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

type ObjectStorageDatasetSourceDetails 

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"`
}

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.

func (ObjectStorageDatasetSourceDetails) MarshalJSON 

func (m ObjectStorageDatasetSourceDetails) MarshalJSON() (buff []byte, e error)

MarshalJSON marshals to json representation

func (ObjectStorageDatasetSourceDetails) String 

func (m ObjectStorageDatasetSourceDetails) String() string

func (ObjectStorageDatasetSourceDetails) ValidateEnumValue 

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

type ObjectStorageImportMetadataPath added in v65.41.1 

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"`
}

ObjectStorageImportMetadataPath Object Storage details for import metadata path.

func (ObjectStorageImportMetadataPath) MarshalJSON added in v65.41.1 

func (m ObjectStorageImportMetadataPath) MarshalJSON() (buff []byte, e error)

MarshalJSON marshals to json representation

func (ObjectStorageImportMetadataPath) String added in v65.41.1 

func (m ObjectStorageImportMetadataPath) String() string

func (ObjectStorageImportMetadataPath) ValidateEnumValue added in v65.41.1 

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

type ObjectStorageSourceDetails 

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"`
}

ObjectStorageSourceDetails Object Storage Source Details.

func (ObjectStorageSourceDetails) MarshalJSON 

func (m ObjectStorageSourceDetails) MarshalJSON() (buff []byte, e error)

MarshalJSON marshals to json representation

func (ObjectStorageSourceDetails) String 

func (m ObjectStorageSourceDetails) String() string

func (ObjectStorageSourceDetails) ValidateEnumValue 

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

type Record 

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"`
}

Record A record represents an entry in a dataset that needs labeling.

func (Record) String 

func (m Record) String() string

func (*Record) UnmarshalJSON 

func (m *Record) UnmarshalJSON(data []byte) (e error)

UnmarshalJSON unmarshals from json

func (Record) ValidateEnumValue 

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

type RecordAggregationDimensions 

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"`
}

RecordAggregationDimensions The dimensions to summarize record information for a given dataset.

func (RecordAggregationDimensions) String 

func (m RecordAggregationDimensions) String() string

func (RecordAggregationDimensions) ValidateEnumValue 

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

type RecordAnalyticsAggregation 

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"`
}

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.

func (RecordAnalyticsAggregation) String 

func (m RecordAnalyticsAggregation) String() string

func (RecordAnalyticsAggregation) ValidateEnumValue 

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

type RecordAnalyticsAggregationCollection 

type RecordAnalyticsAggregationCollection struct {

	// The list of record entities.
	Items []RecordAnalyticsAggregation `mandatory:"true" json:"items"`
}

RecordAnalyticsAggregationCollection Collection of records aggregated.

func (RecordAnalyticsAggregationCollection) String 

func (m RecordAnalyticsAggregationCollection) String() string

func (RecordAnalyticsAggregationCollection) ValidateEnumValue 

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

type RecordCollection 

type RecordCollection struct {

	// The list of records.
	Items []RecordSummary `mandatory:"true" json:"items"`
}

RecordCollection The results of a record search. It contains RecordSummary items and other data.

func (RecordCollection) String 

func (m RecordCollection) String() string

func (RecordCollection) ValidateEnumValue 

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

type RecordLifecycleStateEnum 

type RecordLifecycleStateEnum string

RecordLifecycleStateEnum Enum with underlying type: string 

const (
	RecordLifecycleStateActive   RecordLifecycleStateEnum = "ACTIVE"
	RecordLifecycleStateInactive RecordLifecycleStateEnum = "INACTIVE"
	RecordLifecycleStateDeleted  RecordLifecycleStateEnum = "DELETED"
)

Set of constants representing the allowable values for RecordLifecycleStateEnum

func GetMappingRecordLifecycleStateEnum 

func GetMappingRecordLifecycleStateEnum(val string) (RecordLifecycleStateEnum, bool)

GetMappingRecordLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum

func GetRecordLifecycleStateEnumValues 

func GetRecordLifecycleStateEnumValues() []RecordLifecycleStateEnum

GetRecordLifecycleStateEnumValues Enumerates the set of values for RecordLifecycleStateEnum

type RecordMetadata 

type RecordMetadata interface {
}

RecordMetadata Collection of record's metadata. This can be, for example, the height, width or depth of image for an image record.

type RecordMetadataRecordTypeEnum 

type RecordMetadataRecordTypeEnum string

RecordMetadataRecordTypeEnum Enum with underlying type: string 

const (
	RecordMetadataRecordTypeImageMetadata    RecordMetadataRecordTypeEnum = "IMAGE_METADATA"
	RecordMetadataRecordTypeTextMetadata     RecordMetadataRecordTypeEnum = "TEXT_METADATA"
	RecordMetadataRecordTypeDocumentMetadata RecordMetadataRecordTypeEnum = "DOCUMENT_METADATA"
)

Set of constants representing the allowable values for RecordMetadataRecordTypeEnum

func GetMappingRecordMetadataRecordTypeEnum 

func GetMappingRecordMetadataRecordTypeEnum(val string) (RecordMetadataRecordTypeEnum, bool)

GetMappingRecordMetadataRecordTypeEnum performs case Insensitive comparison on enum value and return the desired enum

func GetRecordMetadataRecordTypeEnumValues 

func GetRecordMetadataRecordTypeEnumValues() []RecordMetadataRecordTypeEnum

GetRecordMetadataRecordTypeEnumValues Enumerates the set of values for RecordMetadataRecordTypeEnum

type RecordSummary 

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"`
}

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.

func (RecordSummary) String 

func (m RecordSummary) String() string

func (*RecordSummary) UnmarshalJSON added in v65.36.0 

func (m *RecordSummary) UnmarshalJSON(data []byte) (e error)

UnmarshalJSON unmarshals from json

func (RecordSummary) ValidateEnumValue 

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

type SortOrdersEnum 

type SortOrdersEnum string

SortOrdersEnum Enum with underlying type: string 

const (
	SortOrdersAsc  SortOrdersEnum = "ASC"
	SortOrdersDesc SortOrdersEnum = "DESC"
)

Set of constants representing the allowable values for SortOrdersEnum

func GetMappingSortOrdersEnum 

func GetMappingSortOrdersEnum(val string) (SortOrdersEnum, bool)

GetMappingSortOrdersEnum performs case Insensitive comparison on enum value and return the desired enum

func GetSortOrdersEnumValues 

func GetSortOrdersEnumValues() []SortOrdersEnum

GetSortOrdersEnumValues Enumerates the set of values for SortOrdersEnum

type SourceDetails 

type SourceDetails interface {
}

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 SourceDetailsSourceTypeEnum 

type SourceDetailsSourceTypeEnum string

SourceDetailsSourceTypeEnum Enum with underlying type: string 

const (
	SourceDetailsSourceTypeObjectStorage SourceDetailsSourceTypeEnum = "OBJECT_STORAGE"
)

Set of constants representing the allowable values for SourceDetailsSourceTypeEnum

func GetMappingSourceDetailsSourceTypeEnum 

func GetMappingSourceDetailsSourceTypeEnum(val string) (SourceDetailsSourceTypeEnum, bool)

GetMappingSourceDetailsSourceTypeEnum performs case Insensitive comparison on enum value and return the desired enum

func GetSourceDetailsSourceTypeEnumValues 

func GetSourceDetailsSourceTypeEnumValues() []SourceDetailsSourceTypeEnum

GetSourceDetailsSourceTypeEnumValues Enumerates the set of values for SourceDetailsSourceTypeEnum

type SummarizeAnnotationAnalyticsAnnotationGroupByEnum 

type SummarizeAnnotationAnalyticsAnnotationGroupByEnum string

SummarizeAnnotationAnalyticsAnnotationGroupByEnum Enum with underlying type: string 

const (
	SummarizeAnnotationAnalyticsAnnotationGroupByUpdatedby SummarizeAnnotationAnalyticsAnnotationGroupByEnum = "updatedBy"
	SummarizeAnnotationAnalyticsAnnotationGroupByLabel     SummarizeAnnotationAnalyticsAnnotationGroupByEnum = "label"
)

Set of constants representing the allowable values for SummarizeAnnotationAnalyticsAnnotationGroupByEnum

func GetMappingSummarizeAnnotationAnalyticsAnnotationGroupByEnum 

func GetMappingSummarizeAnnotationAnalyticsAnnotationGroupByEnum(val string) (SummarizeAnnotationAnalyticsAnnotationGroupByEnum, bool)

GetMappingSummarizeAnnotationAnalyticsAnnotationGroupByEnum performs case Insensitive comparison on enum value and return the desired enum

func GetSummarizeAnnotationAnalyticsAnnotationGroupByEnumValues 

func GetSummarizeAnnotationAnalyticsAnnotationGroupByEnumValues() []SummarizeAnnotationAnalyticsAnnotationGroupByEnum

GetSummarizeAnnotationAnalyticsAnnotationGroupByEnumValues Enumerates the set of values for SummarizeAnnotationAnalyticsAnnotationGroupByEnum

type 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
}

SummarizeAnnotationAnalyticsRequest wrapper for the SummarizeAnnotationAnalytics operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/datalabelingservicedataplane/SummarizeAnnotationAnalytics.go.html to see an example of how to use SummarizeAnnotationAnalyticsRequest.

func (SummarizeAnnotationAnalyticsRequest) BinaryRequestBody 

func (request SummarizeAnnotationAnalyticsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (SummarizeAnnotationAnalyticsRequest) HTTPRequest 

func (request SummarizeAnnotationAnalyticsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (SummarizeAnnotationAnalyticsRequest) RetryPolicy 

func (request SummarizeAnnotationAnalyticsRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (SummarizeAnnotationAnalyticsRequest) String 

func (request SummarizeAnnotationAnalyticsRequest) String() string

func (SummarizeAnnotationAnalyticsRequest) ValidateEnumValue 

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

type SummarizeAnnotationAnalyticsResponse 

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"`
}

SummarizeAnnotationAnalyticsResponse wrapper for the SummarizeAnnotationAnalytics operation

func (SummarizeAnnotationAnalyticsResponse) HTTPResponse 

func (response SummarizeAnnotationAnalyticsResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (SummarizeAnnotationAnalyticsResponse) String 

func (response SummarizeAnnotationAnalyticsResponse) String() string

type SummarizeAnnotationAnalyticsSortByEnum 

type SummarizeAnnotationAnalyticsSortByEnum string

SummarizeAnnotationAnalyticsSortByEnum Enum with underlying type: string 

const (
	SummarizeAnnotationAnalyticsSortByCount     SummarizeAnnotationAnalyticsSortByEnum = "count"
	SummarizeAnnotationAnalyticsSortByLabel     SummarizeAnnotationAnalyticsSortByEnum = "label"
	SummarizeAnnotationAnalyticsSortByUpdatedby SummarizeAnnotationAnalyticsSortByEnum = "updatedBy"
)

Set of constants representing the allowable values for SummarizeAnnotationAnalyticsSortByEnum

func GetMappingSummarizeAnnotationAnalyticsSortByEnum 

func GetMappingSummarizeAnnotationAnalyticsSortByEnum(val string) (SummarizeAnnotationAnalyticsSortByEnum, bool)

GetMappingSummarizeAnnotationAnalyticsSortByEnum performs case Insensitive comparison on enum value and return the desired enum

func GetSummarizeAnnotationAnalyticsSortByEnumValues 

func GetSummarizeAnnotationAnalyticsSortByEnumValues() []SummarizeAnnotationAnalyticsSortByEnum

GetSummarizeAnnotationAnalyticsSortByEnumValues Enumerates the set of values for SummarizeAnnotationAnalyticsSortByEnum

type SummarizeAnnotationAnalyticsSortOrderEnum 

type SummarizeAnnotationAnalyticsSortOrderEnum string

SummarizeAnnotationAnalyticsSortOrderEnum Enum with underlying type: string 

const (
	SummarizeAnnotationAnalyticsSortOrderAsc  SummarizeAnnotationAnalyticsSortOrderEnum = "ASC"
	SummarizeAnnotationAnalyticsSortOrderDesc SummarizeAnnotationAnalyticsSortOrderEnum = "DESC"
)

Set of constants representing the allowable values for SummarizeAnnotationAnalyticsSortOrderEnum

func GetMappingSummarizeAnnotationAnalyticsSortOrderEnum 

func GetMappingSummarizeAnnotationAnalyticsSortOrderEnum(val string) (SummarizeAnnotationAnalyticsSortOrderEnum, bool)

GetMappingSummarizeAnnotationAnalyticsSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum

func GetSummarizeAnnotationAnalyticsSortOrderEnumValues 

func GetSummarizeAnnotationAnalyticsSortOrderEnumValues() []SummarizeAnnotationAnalyticsSortOrderEnum

GetSummarizeAnnotationAnalyticsSortOrderEnumValues Enumerates the set of values for SummarizeAnnotationAnalyticsSortOrderEnum

type SummarizeRecordAnalyticsRecordGroupByEnum 

type SummarizeRecordAnalyticsRecordGroupByEnum string

SummarizeRecordAnalyticsRecordGroupByEnum Enum with underlying type: string 

const (
	SummarizeRecordAnalyticsRecordGroupByIslabeled               SummarizeRecordAnalyticsRecordGroupByEnum = "isLabeled"
	SummarizeRecordAnalyticsRecordGroupByAnnotationlabelcontains SummarizeRecordAnalyticsRecordGroupByEnum = "annotationLabelContains"
)

Set of constants representing the allowable values for SummarizeRecordAnalyticsRecordGroupByEnum

func GetMappingSummarizeRecordAnalyticsRecordGroupByEnum 

func GetMappingSummarizeRecordAnalyticsRecordGroupByEnum(val string) (SummarizeRecordAnalyticsRecordGroupByEnum, bool)

GetMappingSummarizeRecordAnalyticsRecordGroupByEnum performs case Insensitive comparison on enum value and return the desired enum

func GetSummarizeRecordAnalyticsRecordGroupByEnumValues 

func GetSummarizeRecordAnalyticsRecordGroupByEnumValues() []SummarizeRecordAnalyticsRecordGroupByEnum

GetSummarizeRecordAnalyticsRecordGroupByEnumValues Enumerates the set of values for SummarizeRecordAnalyticsRecordGroupByEnum

type 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
}

SummarizeRecordAnalyticsRequest wrapper for the SummarizeRecordAnalytics operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/datalabelingservicedataplane/SummarizeRecordAnalytics.go.html to see an example of how to use SummarizeRecordAnalyticsRequest.

func (SummarizeRecordAnalyticsRequest) BinaryRequestBody 

func (request SummarizeRecordAnalyticsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (SummarizeRecordAnalyticsRequest) HTTPRequest 

func (request SummarizeRecordAnalyticsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (SummarizeRecordAnalyticsRequest) RetryPolicy 

func (request SummarizeRecordAnalyticsRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (SummarizeRecordAnalyticsRequest) String 

func (request SummarizeRecordAnalyticsRequest) String() string

func (SummarizeRecordAnalyticsRequest) ValidateEnumValue 

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

type SummarizeRecordAnalyticsResponse 

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"`
}

SummarizeRecordAnalyticsResponse wrapper for the SummarizeRecordAnalytics operation

func (SummarizeRecordAnalyticsResponse) HTTPResponse 

func (response SummarizeRecordAnalyticsResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (SummarizeRecordAnalyticsResponse) String 

func (response SummarizeRecordAnalyticsResponse) String() string

type SummarizeRecordAnalyticsSortByEnum 

type SummarizeRecordAnalyticsSortByEnum string

SummarizeRecordAnalyticsSortByEnum Enum with underlying type: string 

const (
	SummarizeRecordAnalyticsSortByCount     SummarizeRecordAnalyticsSortByEnum = "count"
	SummarizeRecordAnalyticsSortByIslabeled SummarizeRecordAnalyticsSortByEnum = "isLabeled"
)

Set of constants representing the allowable values for SummarizeRecordAnalyticsSortByEnum

func GetMappingSummarizeRecordAnalyticsSortByEnum 

func GetMappingSummarizeRecordAnalyticsSortByEnum(val string) (SummarizeRecordAnalyticsSortByEnum, bool)

GetMappingSummarizeRecordAnalyticsSortByEnum performs case Insensitive comparison on enum value and return the desired enum

func GetSummarizeRecordAnalyticsSortByEnumValues 

func GetSummarizeRecordAnalyticsSortByEnumValues() []SummarizeRecordAnalyticsSortByEnum

GetSummarizeRecordAnalyticsSortByEnumValues Enumerates the set of values for SummarizeRecordAnalyticsSortByEnum

type SummarizeRecordAnalyticsSortOrderEnum 

type SummarizeRecordAnalyticsSortOrderEnum string

SummarizeRecordAnalyticsSortOrderEnum Enum with underlying type: string 

const (
	SummarizeRecordAnalyticsSortOrderAsc  SummarizeRecordAnalyticsSortOrderEnum = "ASC"
	SummarizeRecordAnalyticsSortOrderDesc SummarizeRecordAnalyticsSortOrderEnum = "DESC"
)

Set of constants representing the allowable values for SummarizeRecordAnalyticsSortOrderEnum

func GetMappingSummarizeRecordAnalyticsSortOrderEnum 

func GetMappingSummarizeRecordAnalyticsSortOrderEnum(val string) (SummarizeRecordAnalyticsSortOrderEnum, bool)

GetMappingSummarizeRecordAnalyticsSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum

func GetSummarizeRecordAnalyticsSortOrderEnumValues 

func GetSummarizeRecordAnalyticsSortOrderEnumValues() []SummarizeRecordAnalyticsSortOrderEnum

GetSummarizeRecordAnalyticsSortOrderEnumValues Enumerates the set of values for SummarizeRecordAnalyticsSortOrderEnum

type TextDatasetFormatDetails 

type TextDatasetFormatDetails struct {
	TextFileTypeMetadata TextFileTypeMetadata `mandatory:"false" json:"textFileTypeMetadata"`
}

TextDatasetFormatDetails It indicates the dataset is comprised of TXT files.

func (TextDatasetFormatDetails) MarshalJSON 

func (m TextDatasetFormatDetails) MarshalJSON() (buff []byte, e error)

MarshalJSON marshals to json representation

func (TextDatasetFormatDetails) String 

func (m TextDatasetFormatDetails) String() string

func (*TextDatasetFormatDetails) UnmarshalJSON added in v65.10.0 

func (m *TextDatasetFormatDetails) UnmarshalJSON(data []byte) (e error)

UnmarshalJSON unmarshals from json

func (TextDatasetFormatDetails) ValidateEnumValue 

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

type TextFileTypeMetadata added in v65.10.0 

type TextFileTypeMetadata interface {
}

TextFileTypeMetadata Metadata for files with text content.

type TextFileTypeMetadataFormatTypeEnum added in v65.10.0 

type TextFileTypeMetadataFormatTypeEnum string

TextFileTypeMetadataFormatTypeEnum Enum with underlying type: string 

const (
	TextFileTypeMetadataFormatTypeDelimited TextFileTypeMetadataFormatTypeEnum = "DELIMITED"
)

Set of constants representing the allowable values for TextFileTypeMetadataFormatTypeEnum

func GetMappingTextFileTypeMetadataFormatTypeEnum added in v65.10.0 

func GetMappingTextFileTypeMetadataFormatTypeEnum(val string) (TextFileTypeMetadataFormatTypeEnum, bool)

GetMappingTextFileTypeMetadataFormatTypeEnum performs case Insensitive comparison on enum value and return the desired enum

func GetTextFileTypeMetadataFormatTypeEnumValues added in v65.10.0 

func GetTextFileTypeMetadataFormatTypeEnumValues() []TextFileTypeMetadataFormatTypeEnum

GetTextFileTypeMetadataFormatTypeEnumValues Enumerates the set of values for TextFileTypeMetadataFormatTypeEnum

type TextMetadata 

type TextMetadata struct {
}

TextMetadata Collection of metadata related to text record.

func (TextMetadata) MarshalJSON 

func (m TextMetadata) MarshalJSON() (buff []byte, e error)

MarshalJSON marshals to json representation

func (TextMetadata) String 

func (m TextMetadata) String() string

func (TextMetadata) ValidateEnumValue 

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

type TextSelectionEntity 

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"`
}

TextSelectionEntity This lets the labeler highlight text, by specifying an offset and a length, and apply labels to it.

func (TextSelectionEntity) MarshalJSON 

func (m TextSelectionEntity) MarshalJSON() (buff []byte, e error)

MarshalJSON marshals to json representation

func (TextSelectionEntity) String 

func (m TextSelectionEntity) String() string

func (TextSelectionEntity) ValidateEnumValue 

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

type TextSpan 

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"`
}

TextSpan A wrapper class for offset and length, which together, represent a span of text in a text document.

func (TextSpan) String 

func (m TextSpan) String() string

func (TextSpan) ValidateEnumValue 

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

type UpdateAnnotationDetails 

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"`
}

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.

func (UpdateAnnotationDetails) String 

func (m UpdateAnnotationDetails) String() string

func (*UpdateAnnotationDetails) UnmarshalJSON 

func (m *UpdateAnnotationDetails) UnmarshalJSON(data []byte) (e error)

UnmarshalJSON unmarshals from json

func (UpdateAnnotationDetails) ValidateEnumValue 

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

type 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
}

UpdateAnnotationRequest wrapper for the UpdateAnnotation operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/datalabelingservicedataplane/UpdateAnnotation.go.html to see an example of how to use UpdateAnnotationRequest.

func (UpdateAnnotationRequest) BinaryRequestBody 

func (request UpdateAnnotationRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (UpdateAnnotationRequest) HTTPRequest 

func (request UpdateAnnotationRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (UpdateAnnotationRequest) RetryPolicy 

func (request UpdateAnnotationRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (UpdateAnnotationRequest) String 

func (request UpdateAnnotationRequest) String() string

func (UpdateAnnotationRequest) ValidateEnumValue 

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

type UpdateAnnotationResponse 

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"`
}

UpdateAnnotationResponse wrapper for the UpdateAnnotation operation

func (UpdateAnnotationResponse) HTTPResponse 

func (response UpdateAnnotationResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (UpdateAnnotationResponse) String 

func (response UpdateAnnotationResponse) String() string

type UpdateRecordDetails 

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"`
}

UpdateRecordDetails The details of the tags that is updated.

func (UpdateRecordDetails) String 

func (m UpdateRecordDetails) String() string

func (*UpdateRecordDetails) UnmarshalJSON 

func (m *UpdateRecordDetails) UnmarshalJSON(data []byte) (e error)

UnmarshalJSON unmarshals from json

func (UpdateRecordDetails) ValidateEnumValue 

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

type 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
}

UpdateRecordRequest wrapper for the UpdateRecord operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/datalabelingservicedataplane/UpdateRecord.go.html to see an example of how to use UpdateRecordRequest.

func (UpdateRecordRequest) BinaryRequestBody 

func (request UpdateRecordRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (UpdateRecordRequest) HTTPRequest 

func (request UpdateRecordRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (UpdateRecordRequest) RetryPolicy 

func (request UpdateRecordRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (UpdateRecordRequest) String 

func (request UpdateRecordRequest) String() string

func (UpdateRecordRequest) ValidateEnumValue 

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

type UpdateRecordResponse 

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"`
}

UpdateRecordResponse wrapper for the UpdateRecord operation

func (UpdateRecordResponse) HTTPResponse 

func (response UpdateRecordResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (UpdateRecordResponse) String 

func (response UpdateRecordResponse) String() string

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.