aidocument

package
v65.77.1 Latest Latest
Warning

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

 Go to latest Published: Oct 23, 2024 License: Apache-2.0, UPL-1.0 Imports: 7 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func GetActionTypeEnumStringValues added in v65.41.0 

func GetActionTypeEnumStringValues() []string

GetActionTypeEnumStringValues Enumerates the set of values in String for ActionTypeEnum

func GetAddModelLockDetailsTypeEnumStringValues added in v65.73.0 

func GetAddModelLockDetailsTypeEnumStringValues() []string

GetAddModelLockDetailsTypeEnumStringValues Enumerates the set of values in String for AddModelLockDetailsTypeEnum

func GetAddProjectLockDetailsTypeEnumStringValues added in v65.73.0 

func GetAddProjectLockDetailsTypeEnumStringValues() []string

GetAddProjectLockDetailsTypeEnumStringValues Enumerates the set of values in String for AddProjectLockDetailsTypeEnum

func GetDatasetDatasetTypeEnumStringValues added in v65.41.0 

func GetDatasetDatasetTypeEnumStringValues() []string

GetDatasetDatasetTypeEnumStringValues Enumerates the set of values in String for DatasetDatasetTypeEnum

func GetDimensionsUnitEnumStringValues 

func GetDimensionsUnitEnumStringValues() []string

GetDimensionsUnitEnumStringValues Enumerates the set of values in String for DimensionsUnitEnum

func GetDocumentDetailsSourceEnumStringValues added in v65.43.0 

func GetDocumentDetailsSourceEnumStringValues() []string

GetDocumentDetailsSourceEnumStringValues Enumerates the set of values in String for DocumentDetailsSourceEnum

func GetDocumentFeatureFeatureTypeEnumStringValues 

func GetDocumentFeatureFeatureTypeEnumStringValues() []string

GetDocumentFeatureFeatureTypeEnumStringValues Enumerates the set of values in String for DocumentFeatureFeatureTypeEnum

func GetDocumentFieldFieldTypeEnumStringValues 

func GetDocumentFieldFieldTypeEnumStringValues() []string

GetDocumentFieldFieldTypeEnumStringValues Enumerates the set of values in String for DocumentFieldFieldTypeEnum

func GetDocumentTypeEnumStringValues 

func GetDocumentTypeEnumStringValues() []string

GetDocumentTypeEnumStringValues Enumerates the set of values in String for DocumentTypeEnum

func GetFieldValueValueTypeEnumStringValues 

func GetFieldValueValueTypeEnumStringValues() []string

GetFieldValueValueTypeEnumStringValues Enumerates the set of values in String for FieldValueValueTypeEnum

func GetInputLocationSourceTypeEnumStringValues 

func GetInputLocationSourceTypeEnumStringValues() []string

GetInputLocationSourceTypeEnumStringValues Enumerates the set of values in String for InputLocationSourceTypeEnum

func GetListModelsSortByEnumStringValues added in v65.41.0 

func GetListModelsSortByEnumStringValues() []string

GetListModelsSortByEnumStringValues Enumerates the set of values in String for ListModelsSortByEnum

func GetListModelsSortOrderEnumStringValues added in v65.41.0 

func GetListModelsSortOrderEnumStringValues() []string

GetListModelsSortOrderEnumStringValues Enumerates the set of values in String for ListModelsSortOrderEnum

func GetListProjectsSortByEnumStringValues added in v65.41.0 

func GetListProjectsSortByEnumStringValues() []string

GetListProjectsSortByEnumStringValues Enumerates the set of values in String for ListProjectsSortByEnum

func GetListProjectsSortOrderEnumStringValues added in v65.41.0 

func GetListProjectsSortOrderEnumStringValues() []string

GetListProjectsSortOrderEnumStringValues Enumerates the set of values in String for ListProjectsSortOrderEnum

func GetListWorkRequestErrorsSortByEnumStringValues added in v65.41.0 

func GetListWorkRequestErrorsSortByEnumStringValues() []string

GetListWorkRequestErrorsSortByEnumStringValues Enumerates the set of values in String for ListWorkRequestErrorsSortByEnum

func GetListWorkRequestErrorsSortOrderEnumStringValues added in v65.41.0 

func GetListWorkRequestErrorsSortOrderEnumStringValues() []string

GetListWorkRequestErrorsSortOrderEnumStringValues Enumerates the set of values in String for ListWorkRequestErrorsSortOrderEnum

func GetListWorkRequestLogsSortByEnumStringValues added in v65.41.0 

func GetListWorkRequestLogsSortByEnumStringValues() []string

GetListWorkRequestLogsSortByEnumStringValues Enumerates the set of values in String for ListWorkRequestLogsSortByEnum

func GetListWorkRequestLogsSortOrderEnumStringValues added in v65.41.0 

func GetListWorkRequestLogsSortOrderEnumStringValues() []string

GetListWorkRequestLogsSortOrderEnumStringValues Enumerates the set of values in String for ListWorkRequestLogsSortOrderEnum

func GetListWorkRequestsSortByEnumStringValues added in v65.41.0 

func GetListWorkRequestsSortByEnumStringValues() []string

GetListWorkRequestsSortByEnumStringValues Enumerates the set of values in String for ListWorkRequestsSortByEnum

func GetListWorkRequestsSortOrderEnumStringValues added in v65.41.0 

func GetListWorkRequestsSortOrderEnumStringValues() []string

GetListWorkRequestsSortOrderEnumStringValues Enumerates the set of values in String for ListWorkRequestsSortOrderEnum

func GetListWorkRequestsStatusEnumStringValues added in v65.41.0 

func GetListWorkRequestsStatusEnumStringValues() []string

GetListWorkRequestsStatusEnumStringValues Enumerates the set of values in String for ListWorkRequestsStatusEnum

func GetModelLifecycleStateEnumStringValues added in v65.41.0 

func GetModelLifecycleStateEnumStringValues() []string

GetModelLifecycleStateEnumStringValues Enumerates the set of values in String for ModelLifecycleStateEnum

func GetModelMetricsModelTypeEnumStringValues added in v65.41.0 

func GetModelMetricsModelTypeEnumStringValues() []string

GetModelMetricsModelTypeEnumStringValues Enumerates the set of values in String for ModelMetricsModelTypeEnum

func GetModelModelTypeEnumStringValues added in v65.41.0 

func GetModelModelTypeEnumStringValues() []string

GetModelModelTypeEnumStringValues Enumerates the set of values in String for ModelModelTypeEnum

func GetOperationStatusEnumStringValues added in v65.41.0 

func GetOperationStatusEnumStringValues() []string

GetOperationStatusEnumStringValues Enumerates the set of values in String for OperationStatusEnum

func GetOperationTypeEnumStringValues added in v65.41.0 

func GetOperationTypeEnumStringValues() []string

GetOperationTypeEnumStringValues Enumerates the set of values in String for OperationTypeEnum

func GetPatchModelOperationOperationEnumStringValues added in v65.43.0 

func GetPatchModelOperationOperationEnumStringValues() []string

GetPatchModelOperationOperationEnumStringValues Enumerates the set of values in String for PatchModelOperationOperationEnum

func GetProcessorJobLifecycleDetailsEnumStringValues 

func GetProcessorJobLifecycleDetailsEnumStringValues() []string

GetProcessorJobLifecycleDetailsEnumStringValues Enumerates the set of values in String for ProcessorJobLifecycleDetailsEnum

func GetProcessorJobLifecycleStateEnumStringValues 

func GetProcessorJobLifecycleStateEnumStringValues() []string

GetProcessorJobLifecycleStateEnumStringValues Enumerates the set of values in String for ProcessorJobLifecycleStateEnum

func GetProcessorTypeEnumStringValues 

func GetProcessorTypeEnumStringValues() []string

GetProcessorTypeEnumStringValues Enumerates the set of values in String for ProcessorTypeEnum

func GetProjectLifecycleStateEnumStringValues added in v65.41.0 

func GetProjectLifecycleStateEnumStringValues() []string

GetProjectLifecycleStateEnumStringValues Enumerates the set of values in String for ProjectLifecycleStateEnum

func GetRemoveModelLockDetailsTypeEnumStringValues added in v65.73.0 

func GetRemoveModelLockDetailsTypeEnumStringValues() []string

GetRemoveModelLockDetailsTypeEnumStringValues Enumerates the set of values in String for RemoveModelLockDetailsTypeEnum

func GetRemoveProjectLockDetailsTypeEnumStringValues added in v65.73.0 

func GetRemoveProjectLockDetailsTypeEnumStringValues() []string

GetRemoveProjectLockDetailsTypeEnumStringValues Enumerates the set of values in String for RemoveProjectLockDetailsTypeEnum

func GetResourceLockTypeEnumStringValues added in v65.73.0 

func GetResourceLockTypeEnumStringValues() []string

GetResourceLockTypeEnumStringValues Enumerates the set of values in String for ResourceLockTypeEnum

func GetSortOrderEnumStringValues added in v65.41.0 

func GetSortOrderEnumStringValues() []string

GetSortOrderEnumStringValues Enumerates the set of values in String for SortOrderEnum

func GetWorkRequestResourceMetadataKeyEnumStringValues added in v65.41.0 

func GetWorkRequestResourceMetadataKeyEnumStringValues() []string

GetWorkRequestResourceMetadataKeyEnumStringValues Enumerates the set of values in String for WorkRequestResourceMetadataKeyEnum

Types

type AIServiceDocumentClient 

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

AIServiceDocumentClient a client for AIServiceDocument

func NewAIServiceDocumentClientWithConfigurationProvider 

func NewAIServiceDocumentClientWithConfigurationProvider(configProvider common.ConfigurationProvider) (client AIServiceDocumentClient, err error)

NewAIServiceDocumentClientWithConfigurationProvider Creates a new default AIServiceDocument client with the given configuration provider. the configuration provider will be used for the default signer as well as reading the region

func NewAIServiceDocumentClientWithOboToken 

func NewAIServiceDocumentClientWithOboToken(configProvider common.ConfigurationProvider, oboToken string) (client AIServiceDocumentClient, err error)

NewAIServiceDocumentClientWithOboToken Creates a new default AIServiceDocument 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 (AIServiceDocumentClient) AddModelLock added in v65.73.0 

func (client AIServiceDocumentClient) AddModelLock(ctx context.Context, request AddModelLockRequest) (response AddModelLockResponse, err error)

AddModelLock Adds a lock to a resource.

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/aidocument/AddModelLock.go.html to see an example of how to use AddModelLock API. A default retry strategy applies to this operation AddModelLock()

func (AIServiceDocumentClient) AddProjectLock added in v65.73.0 

func (client AIServiceDocumentClient) AddProjectLock(ctx context.Context, request AddProjectLockRequest) (response AddProjectLockResponse, err error)

AddProjectLock Adds a lock to a resource.

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/aidocument/AddProjectLock.go.html to see an example of how to use AddProjectLock API. A default retry strategy applies to this operation AddProjectLock()

func (AIServiceDocumentClient) AnalyzeDocument added in v65.43.0 

func (client AIServiceDocumentClient) AnalyzeDocument(ctx context.Context, request AnalyzeDocumentRequest) (response AnalyzeDocumentResponse, err error)

AnalyzeDocument Perform different types of document analysis.

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/aidocument/AnalyzeDocument.go.html to see an example of how to use AnalyzeDocument API. A default retry strategy applies to this operation AnalyzeDocument()

func (AIServiceDocumentClient) CancelProcessorJob 

func (client AIServiceDocumentClient) CancelProcessorJob(ctx context.Context, request CancelProcessorJobRequest) (response CancelProcessorJobResponse, err error)

CancelProcessorJob Cancel a processor job.

See also

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

func (AIServiceDocumentClient) CancelWorkRequest added in v65.41.0 

func (client AIServiceDocumentClient) CancelWorkRequest(ctx context.Context, request CancelWorkRequestRequest) (response CancelWorkRequestResponse, err error)

CancelWorkRequest Cancel the work request with the given ID.

See also

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

func (AIServiceDocumentClient) ChangeModelCompartment added in v65.41.0 

func (client AIServiceDocumentClient) ChangeModelCompartment(ctx context.Context, request ChangeModelCompartmentRequest) (response ChangeModelCompartmentResponse, err error)

ChangeModelCompartment Moves a model from one compartment to another. When provided, If-Match is checked against the ETag values of the resource.

See also

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

func (AIServiceDocumentClient) ChangeProjectCompartment added in v65.41.0 

func (client AIServiceDocumentClient) ChangeProjectCompartment(ctx context.Context, request ChangeProjectCompartmentRequest) (response ChangeProjectCompartmentResponse, err error)

ChangeProjectCompartment Move a project from one compartment to another. When provided, If-Match is checked against the ETag values of the resource.

See also

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

func (*AIServiceDocumentClient) ConfigurationProvider 

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

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

func (AIServiceDocumentClient) CreateModel added in v65.41.0 

func (client AIServiceDocumentClient) CreateModel(ctx context.Context, request CreateModelRequest) (response CreateModelResponse, err error)

CreateModel Create a new model.

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/aidocument/CreateModel.go.html to see an example of how to use CreateModel API. A default retry strategy applies to this operation CreateModel()

func (AIServiceDocumentClient) CreateProcessorJob 

func (client AIServiceDocumentClient) CreateProcessorJob(ctx context.Context, request CreateProcessorJobRequest) (response CreateProcessorJobResponse, err error)

CreateProcessorJob Create a processor job for document analysis.

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/aidocument/CreateProcessorJob.go.html to see an example of how to use CreateProcessorJob API. A default retry strategy applies to this operation CreateProcessorJob()

func (AIServiceDocumentClient) CreateProject added in v65.41.0 

func (client AIServiceDocumentClient) CreateProject(ctx context.Context, request CreateProjectRequest) (response CreateProjectResponse, err error)

CreateProject Create a new project.

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/aidocument/CreateProject.go.html to see an example of how to use CreateProject API. A default retry strategy applies to this operation CreateProject()

func (AIServiceDocumentClient) DeleteModel added in v65.41.0 

func (client AIServiceDocumentClient) DeleteModel(ctx context.Context, request DeleteModelRequest) (response DeleteModelResponse, err error)

DeleteModel Delete a model by identifier.

See also

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

func (AIServiceDocumentClient) DeleteProject added in v65.41.0 

func (client AIServiceDocumentClient) DeleteProject(ctx context.Context, request DeleteProjectRequest) (response DeleteProjectResponse, err error)

DeleteProject Delete a project by identifier.

See also

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

func (AIServiceDocumentClient) GetModel added in v65.41.0 

func (client AIServiceDocumentClient) GetModel(ctx context.Context, request GetModelRequest) (response GetModelResponse, err error)

GetModel Get a model by identifier.

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/aidocument/GetModel.go.html to see an example of how to use GetModel API. A default retry strategy applies to this operation GetModel()

func (AIServiceDocumentClient) GetProcessorJob 

func (client AIServiceDocumentClient) GetProcessorJob(ctx context.Context, request GetProcessorJobRequest) (response GetProcessorJobResponse, err error)

GetProcessorJob Get the details of a processor job.

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/aidocument/GetProcessorJob.go.html to see an example of how to use GetProcessorJob API. A default retry strategy applies to this operation GetProcessorJob()

func (AIServiceDocumentClient) GetProject added in v65.41.0 

func (client AIServiceDocumentClient) GetProject(ctx context.Context, request GetProjectRequest) (response GetProjectResponse, err error)

GetProject Get a project by identifier.

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/aidocument/GetProject.go.html to see an example of how to use GetProject API. A default retry strategy applies to this operation GetProject()

func (AIServiceDocumentClient) GetWorkRequest added in v65.41.0 

func (client AIServiceDocumentClient) GetWorkRequest(ctx context.Context, request GetWorkRequestRequest) (response GetWorkRequestResponse, err error)

GetWorkRequest Gets the status of the work request with the given ID.

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/aidocument/GetWorkRequest.go.html to see an example of how to use GetWorkRequest API. A default retry strategy applies to this operation GetWorkRequest()

func (AIServiceDocumentClient) ListModels added in v65.41.0 

func (client AIServiceDocumentClient) ListModels(ctx context.Context, request ListModelsRequest) (response ListModelsResponse, err error)

ListModels Returns a list of models in a compartment.

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/aidocument/ListModels.go.html to see an example of how to use ListModels API. A default retry strategy applies to this operation ListModels()

func (AIServiceDocumentClient) ListProjects added in v65.41.0 

func (client AIServiceDocumentClient) ListProjects(ctx context.Context, request ListProjectsRequest) (response ListProjectsResponse, err error)

ListProjects Returns a list of projects.

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/aidocument/ListProjects.go.html to see an example of how to use ListProjects API. A default retry strategy applies to this operation ListProjects()

func (AIServiceDocumentClient) ListWorkRequestErrors added in v65.41.0 

func (client AIServiceDocumentClient) ListWorkRequestErrors(ctx context.Context, request ListWorkRequestErrorsRequest) (response ListWorkRequestErrorsResponse, err error)

ListWorkRequestErrors Returns a (paginated) list of errors for a given work request.

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/aidocument/ListWorkRequestErrors.go.html to see an example of how to use ListWorkRequestErrors API. A default retry strategy applies to this operation ListWorkRequestErrors()

func (AIServiceDocumentClient) ListWorkRequestLogs added in v65.41.0 

func (client AIServiceDocumentClient) ListWorkRequestLogs(ctx context.Context, request ListWorkRequestLogsRequest) (response ListWorkRequestLogsResponse, err error)

ListWorkRequestLogs Return a (paginated) list of logs for a given work request.

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/aidocument/ListWorkRequestLogs.go.html to see an example of how to use ListWorkRequestLogs API. A default retry strategy applies to this operation ListWorkRequestLogs()

func (AIServiceDocumentClient) ListWorkRequests added in v65.41.0 

func (client AIServiceDocumentClient) ListWorkRequests(ctx context.Context, request ListWorkRequestsRequest) (response ListWorkRequestsResponse, err error)

ListWorkRequests Lists the work requests in a compartment.

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/aidocument/ListWorkRequests.go.html to see an example of how to use ListWorkRequests API. A default retry strategy applies to this operation ListWorkRequests()

func (AIServiceDocumentClient) PatchModel added in v65.43.0 

func (client AIServiceDocumentClient) PatchModel(ctx context.Context, request PatchModelRequest) (response PatchModelResponse, err error)

PatchModel Updates the model metadata only selected path parameter.

See also

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

func (AIServiceDocumentClient) RemoveModelLock added in v65.73.0 

func (client AIServiceDocumentClient) RemoveModelLock(ctx context.Context, request RemoveModelLockRequest) (response RemoveModelLockResponse, err error)

RemoveModelLock Remove a lock from a resource.

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/aidocument/RemoveModelLock.go.html to see an example of how to use RemoveModelLock API. A default retry strategy applies to this operation RemoveModelLock()

func (AIServiceDocumentClient) RemoveProjectLock added in v65.73.0 

func (client AIServiceDocumentClient) RemoveProjectLock(ctx context.Context, request RemoveProjectLockRequest) (response RemoveProjectLockResponse, err error)

RemoveProjectLock Remove a lock from a resource.

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/aidocument/RemoveProjectLock.go.html to see an example of how to use RemoveProjectLock API. A default retry strategy applies to this operation RemoveProjectLock()

func (*AIServiceDocumentClient) SetRegion 

func (client *AIServiceDocumentClient) SetRegion(region string)

SetRegion overrides the region of this client.

func (AIServiceDocumentClient) UpdateModel added in v65.41.0 

func (client AIServiceDocumentClient) UpdateModel(ctx context.Context, request UpdateModelRequest) (response UpdateModelResponse, err error)

UpdateModel Updates the model metadata.

See also

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

func (AIServiceDocumentClient) UpdateProject added in v65.41.0 

func (client AIServiceDocumentClient) UpdateProject(ctx context.Context, request UpdateProjectRequest) (response UpdateProjectResponse, err error)

UpdateProject Update the project metadata.

See also

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

type ActionTypeEnum added in v65.41.0 

type ActionTypeEnum string

ActionTypeEnum Enum with underlying type: string 

const (
	ActionTypeCreated    ActionTypeEnum = "CREATED"
	ActionTypeUpdated    ActionTypeEnum = "UPDATED"
	ActionTypeDeleted    ActionTypeEnum = "DELETED"
	ActionTypeInProgress ActionTypeEnum = "IN_PROGRESS"
	ActionTypeRelated    ActionTypeEnum = "RELATED"
	ActionTypeFailed     ActionTypeEnum = "FAILED"
)

Set of constants representing the allowable values for ActionTypeEnum

func GetActionTypeEnumValues added in v65.41.0 

func GetActionTypeEnumValues() []ActionTypeEnum

GetActionTypeEnumValues Enumerates the set of values for ActionTypeEnum

func GetMappingActionTypeEnum added in v65.41.0 

func GetMappingActionTypeEnum(val string) (ActionTypeEnum, bool)

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

type AddModelLockDetails added in v65.73.0 

type AddModelLockDetails struct {

	// Type of the lock.
	Type AddModelLockDetailsTypeEnum `mandatory:"true" json:"type"`

	// The ID of the resource that is locking this resource. Indicates that deleting this resource will remove the lock.
	RelatedResourceId *string `mandatory:"false" json:"relatedResourceId"`

	// A message added by the creator of the lock. This is typically used to give an indication of why the resource is locked.
	Message *string `mandatory:"false" json:"message"`
}

AddModelLockDetails Request payload to add lock to the resource.

func (AddModelLockDetails) String added in v65.73.0 

func (m AddModelLockDetails) String() string

func (AddModelLockDetails) ValidateEnumValue added in v65.73.0 

func (m AddModelLockDetails) 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 AddModelLockDetailsTypeEnum added in v65.73.0 

type AddModelLockDetailsTypeEnum string

AddModelLockDetailsTypeEnum Enum with underlying type: string 

const (
	AddModelLockDetailsTypeFull   AddModelLockDetailsTypeEnum = "FULL"
	AddModelLockDetailsTypeDelete AddModelLockDetailsTypeEnum = "DELETE"
)

Set of constants representing the allowable values for AddModelLockDetailsTypeEnum

func GetAddModelLockDetailsTypeEnumValues added in v65.73.0 

func GetAddModelLockDetailsTypeEnumValues() []AddModelLockDetailsTypeEnum

GetAddModelLockDetailsTypeEnumValues Enumerates the set of values for AddModelLockDetailsTypeEnum

func GetMappingAddModelLockDetailsTypeEnum added in v65.73.0 

func GetMappingAddModelLockDetailsTypeEnum(val string) (AddModelLockDetailsTypeEnum, bool)

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

type AddModelLockRequest added in v65.73.0 

type AddModelLockRequest struct {

	// A unique model identifier.
	ModelId *string `mandatory:"true" contributesTo:"path" name:"modelId"`

	// Request payload to add lock to the resource.
	AddModelLockDetails `contributesTo:"body"`

	// A token that uniquely identifies a request so it can be retried in case of a timeout or
	// server error without the risk of executing that same action again. Retry tokens expire after 24
	// hours, but can be invalidated before then due to conflicting operations. For example, if a resource
	// has been deleted and purged from the system, then a retry of the original creation request
	// might be rejected.
	OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`

	// The client request ID for tracing.
	OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`

	// For optimistic concurrency control. In the PUT or DELETE call
	// for a resource, set the `if-match` parameter to the value of the
	// etag from a previous GET or POST response for that resource.
	// The resource will be updated or deleted only if the etag you
	// provide matches the resource's current etag value.
	IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`

	// Whether to override locks (if any exist).
	IsLockOverride *bool `mandatory:"false" contributesTo:"query" name:"isLockOverride"`

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

AddModelLockRequest wrapper for the AddModelLock operation

See also

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

func (AddModelLockRequest) BinaryRequestBody added in v65.73.0 

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

BinaryRequestBody implements the OCIRequest interface

func (AddModelLockRequest) HTTPRequest added in v65.73.0 

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

HTTPRequest implements the OCIRequest interface

func (AddModelLockRequest) RetryPolicy added in v65.73.0 

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

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

func (AddModelLockRequest) String added in v65.73.0 

func (request AddModelLockRequest) String() string

func (AddModelLockRequest) ValidateEnumValue added in v65.73.0 

func (request AddModelLockRequest) 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 AddModelLockResponse added in v65.73.0 

type AddModelLockResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// The Model instance
	Model `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"`
}

AddModelLockResponse wrapper for the AddModelLock operation

func (AddModelLockResponse) HTTPResponse added in v65.73.0 

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

HTTPResponse implements the OCIResponse interface

func (AddModelLockResponse) String added in v65.73.0 

func (response AddModelLockResponse) String() string

type AddProjectLockDetails added in v65.73.0 

type AddProjectLockDetails struct {

	// Type of the lock.
	Type AddProjectLockDetailsTypeEnum `mandatory:"true" json:"type"`

	// The ID of the resource that is locking this resource. Indicates that deleting this resource will remove the lock.
	RelatedResourceId *string `mandatory:"false" json:"relatedResourceId"`

	// A message added by the creator of the lock. This is typically used to give an indication of why the resource is locked.
	Message *string `mandatory:"false" json:"message"`
}

AddProjectLockDetails Request payload to add lock to the resource.

func (AddProjectLockDetails) String added in v65.73.0 

func (m AddProjectLockDetails) String() string

func (AddProjectLockDetails) ValidateEnumValue added in v65.73.0 

func (m AddProjectLockDetails) 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 AddProjectLockDetailsTypeEnum added in v65.73.0 

type AddProjectLockDetailsTypeEnum string

AddProjectLockDetailsTypeEnum Enum with underlying type: string 

const (
	AddProjectLockDetailsTypeFull   AddProjectLockDetailsTypeEnum = "FULL"
	AddProjectLockDetailsTypeDelete AddProjectLockDetailsTypeEnum = "DELETE"
)

Set of constants representing the allowable values for AddProjectLockDetailsTypeEnum

func GetAddProjectLockDetailsTypeEnumValues added in v65.73.0 

func GetAddProjectLockDetailsTypeEnumValues() []AddProjectLockDetailsTypeEnum

GetAddProjectLockDetailsTypeEnumValues Enumerates the set of values for AddProjectLockDetailsTypeEnum

func GetMappingAddProjectLockDetailsTypeEnum added in v65.73.0 

func GetMappingAddProjectLockDetailsTypeEnum(val string) (AddProjectLockDetailsTypeEnum, bool)

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

type AddProjectLockRequest added in v65.73.0 

type AddProjectLockRequest struct {

	// A unique project identifier.
	ProjectId *string `mandatory:"true" contributesTo:"path" name:"projectId"`

	// Request payload to add lock to the resource.
	AddProjectLockDetails `contributesTo:"body"`

	// A token that uniquely identifies a request so it can be retried in case of a timeout or
	// server error without the risk of executing that same action again. Retry tokens expire after 24
	// hours, but can be invalidated before then due to conflicting operations. For example, if a resource
	// has been deleted and purged from the system, then a retry of the original creation request
	// might be rejected.
	OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`

	// The client request ID for tracing.
	OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`

	// For optimistic concurrency control. In the PUT or DELETE call
	// for a resource, set the `if-match` parameter to the value of the
	// etag from a previous GET or POST response for that resource.
	// The resource will be updated or deleted only if the etag you
	// provide matches the resource's current etag value.
	IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`

	// Whether to override locks (if any exist).
	IsLockOverride *bool `mandatory:"false" contributesTo:"query" name:"isLockOverride"`

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

AddProjectLockRequest wrapper for the AddProjectLock operation

See also

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

func (AddProjectLockRequest) BinaryRequestBody added in v65.73.0 

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

BinaryRequestBody implements the OCIRequest interface

func (AddProjectLockRequest) HTTPRequest added in v65.73.0 

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

HTTPRequest implements the OCIRequest interface

func (AddProjectLockRequest) RetryPolicy added in v65.73.0 

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

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

func (AddProjectLockRequest) String added in v65.73.0 

func (request AddProjectLockRequest) String() string

func (AddProjectLockRequest) ValidateEnumValue added in v65.73.0 

func (request AddProjectLockRequest) 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 AddProjectLockResponse added in v65.73.0 

type AddProjectLockResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// The Project instance
	Project `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"`
}

AddProjectLockResponse wrapper for the AddProjectLock operation

func (AddProjectLockResponse) HTTPResponse added in v65.73.0 

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

HTTPResponse implements the OCIResponse interface

func (AddProjectLockResponse) String added in v65.73.0 

func (response AddProjectLockResponse) String() string

type AnalyzeDocumentDetails added in v65.43.0 

type AnalyzeDocumentDetails struct {

	// The types of document analysis requested.
	Features []DocumentFeature `mandatory:"true" json:"features"`

	Document DocumentDetails `mandatory:"true" json:"document"`

	// The compartment identifier.
	CompartmentId *string `mandatory:"false" json:"compartmentId"`

	OutputLocation *OutputLocation `mandatory:"false" json:"outputLocation"`

	// The document language, abbreviated according to the BCP 47 syntax.
	Language *string `mandatory:"false" json:"language"`

	// The document type.
	DocumentType DocumentTypeEnum `mandatory:"false" json:"documentType,omitempty"`

	OcrData *AnalyzeDocumentResult `mandatory:"false" json:"ocrData"`
}

AnalyzeDocumentDetails The details of how to analyze a document.

func (AnalyzeDocumentDetails) String added in v65.43.0 

func (m AnalyzeDocumentDetails) String() string

func (*AnalyzeDocumentDetails) UnmarshalJSON added in v65.43.0 

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

UnmarshalJSON unmarshals from json

func (AnalyzeDocumentDetails) ValidateEnumValue added in v65.43.0 

func (m AnalyzeDocumentDetails) 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 AnalyzeDocumentRequest added in v65.43.0 

type AnalyzeDocumentRequest struct {

	// The details of how to analyze a document.
	AnalyzeDocumentDetails `contributesTo:"body"`

	// For optimistic concurrency control. In the PUT or DELETE call
	// for a resource, set the `if-match` parameter to the value of the
	// etag from a previous GET or POST response for that resource.
	// The resource will be updated or deleted only if the etag you
	// provide matches the resource's current etag value.
	IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`

	// The client request ID for tracing.
	OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`

	// Metadata about the request. This information will not be transmitted to the service, but
	// represents information that the SDK will consume to drive retry behavior.
	RequestMetadata common.RequestMetadata
}

AnalyzeDocumentRequest wrapper for the AnalyzeDocument operation

See also

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

func (AnalyzeDocumentRequest) BinaryRequestBody added in v65.43.0 

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

BinaryRequestBody implements the OCIRequest interface

func (AnalyzeDocumentRequest) HTTPRequest added in v65.43.0 

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

HTTPRequest implements the OCIRequest interface

func (AnalyzeDocumentRequest) RetryPolicy added in v65.43.0 

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

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

func (AnalyzeDocumentRequest) String added in v65.43.0 

func (request AnalyzeDocumentRequest) String() string

func (AnalyzeDocumentRequest) ValidateEnumValue added in v65.43.0 

func (request AnalyzeDocumentRequest) 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 AnalyzeDocumentResponse added in v65.43.0 

type AnalyzeDocumentResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// The AnalyzeDocumentResult instance
	AnalyzeDocumentResult `presentIn:"body"`

	// The full URI of the resource related to the request
	ContentLocation *string `presentIn:"header" name:"content-location"`

	// The full URI of the resource related to the request
	Location *string `presentIn:"header" name:"location"`

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

AnalyzeDocumentResponse wrapper for the AnalyzeDocument operation

func (AnalyzeDocumentResponse) HTTPResponse added in v65.43.0 

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

HTTPResponse implements the OCIResponse interface

func (AnalyzeDocumentResponse) String added in v65.43.0 

func (response AnalyzeDocumentResponse) String() string

type AnalyzeDocumentResult 

type AnalyzeDocumentResult struct {
	DocumentMetadata *DocumentMetadata `mandatory:"true" json:"documentMetadata"`

	// The array of a Page.
	Pages []Page `mandatory:"true" json:"pages"`

	// An array of detected document types.
	DetectedDocumentTypes []DetectedDocumentType `mandatory:"false" json:"detectedDocumentTypes"`

	// An array of detected languages.
	DetectedLanguages []DetectedLanguage `mandatory:"false" json:"detectedLanguages"`

	// The document classification model version.
	DocumentClassificationModelVersion *string `mandatory:"false" json:"documentClassificationModelVersion"`

	// The document language classification model version.
	LanguageClassificationModelVersion *string `mandatory:"false" json:"languageClassificationModelVersion"`

	// The document text extraction model version.
	TextExtractionModelVersion *string `mandatory:"false" json:"textExtractionModelVersion"`

	// The document keyValue extraction model version.
	KeyValueExtractionModelVersion *string `mandatory:"false" json:"keyValueExtractionModelVersion"`

	// The document table extraction model version.
	TableExtractionModelVersion *string `mandatory:"false" json:"tableExtractionModelVersion"`

	// The errors encountered during document analysis.
	Errors []ProcessingError `mandatory:"false" json:"errors"`

	// The searchable PDF file that was generated.
	SearchablePdf []byte `mandatory:"false" json:"searchablePdf"`
}

AnalyzeDocumentResult The document analysis results.

func (AnalyzeDocumentResult) String 

func (m AnalyzeDocumentResult) String() string

func (AnalyzeDocumentResult) ValidateEnumValue 

func (m AnalyzeDocumentResult) 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 {

	// An array of normalized points defining the polygon's perimeter, with an implicit segment between subsequent points and between the first and last point.
	// Rectangles are defined with four points. For example, `[{"x": 0, "y": 0}, {"x": 1, "y": 0}, {"x": 1, "y": 0.5}, {"x": 0, "y": 0.5}]` represents the top half of an image.
	NormalizedVertices []NormalizedVertex `mandatory:"true" json:"normalizedVertices"`
}

BoundingPolygon The object-bounding polygon box.

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 CancelProcessorJobRequest 

type CancelProcessorJobRequest struct {

	// Processor job id.
	ProcessorJobId *string `mandatory:"true" contributesTo:"path" name:"processorJobId"`

	// For optimistic concurrency control. In the PUT or DELETE call
	// for a resource, set the `if-match` parameter to the value of the
	// etag from a previous GET or POST response for that resource.
	// The resource will be updated or deleted only if the etag you
	// provide matches the resource's current etag value.
	IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`

	// The client request ID for tracing.
	OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`

	// Metadata about the request. This information will not be transmitted to the service, but
	// represents information that the SDK will consume to drive retry behavior.
	RequestMetadata common.RequestMetadata
}

CancelProcessorJobRequest wrapper for the CancelProcessorJob operation

See also

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

func (CancelProcessorJobRequest) BinaryRequestBody 

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

BinaryRequestBody implements the OCIRequest interface

func (CancelProcessorJobRequest) HTTPRequest 

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

HTTPRequest implements the OCIRequest interface

func (CancelProcessorJobRequest) RetryPolicy 

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

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

func (CancelProcessorJobRequest) String 

func (request CancelProcessorJobRequest) String() string

func (CancelProcessorJobRequest) ValidateEnumValue 

func (request CancelProcessorJobRequest) 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 CancelProcessorJobResponse 

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

CancelProcessorJobResponse wrapper for the CancelProcessorJob operation

func (CancelProcessorJobResponse) HTTPResponse 

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

HTTPResponse implements the OCIResponse interface

func (CancelProcessorJobResponse) String 

func (response CancelProcessorJobResponse) String() string

type CancelWorkRequestRequest added in v65.41.0 

type CancelWorkRequestRequest struct {

	// The ID of the asynchronous request.
	WorkRequestId *string `mandatory:"true" contributesTo:"path" name:"workRequestId"`

	// For optimistic concurrency control. In the PUT or DELETE call
	// for a resource, set the `if-match` parameter to the value of the
	// etag from a previous GET or POST response for that resource.
	// The resource will be updated or deleted only if the etag you
	// provide matches the resource's current etag value.
	IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`

	// The client request ID for tracing.
	OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`

	// Metadata about the request. This information will not be transmitted to the service, but
	// represents information that the SDK will consume to drive retry behavior.
	RequestMetadata common.RequestMetadata
}

CancelWorkRequestRequest wrapper for the CancelWorkRequest operation

See also

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

func (CancelWorkRequestRequest) BinaryRequestBody added in v65.41.0 

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

BinaryRequestBody implements the OCIRequest interface

func (CancelWorkRequestRequest) HTTPRequest added in v65.41.0 

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

HTTPRequest implements the OCIRequest interface

func (CancelWorkRequestRequest) RetryPolicy added in v65.41.0 

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

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

func (CancelWorkRequestRequest) String added in v65.41.0 

func (request CancelWorkRequestRequest) String() string

func (CancelWorkRequestRequest) ValidateEnumValue added in v65.41.0 

func (request CancelWorkRequestRequest) 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 CancelWorkRequestResponse added in v65.41.0 

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

CancelWorkRequestResponse wrapper for the CancelWorkRequest operation

func (CancelWorkRequestResponse) HTTPResponse added in v65.41.0 

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

HTTPResponse implements the OCIResponse interface

func (CancelWorkRequestResponse) String added in v65.41.0 

func (response CancelWorkRequestResponse) String() string

type Cell 

type Cell struct {

	// The text recognized in the cell.
	Text *string `mandatory:"true" json:"text"`

	// The index of the cell inside the row.
	RowIndex *int `mandatory:"true" json:"rowIndex"`

	// The index of the cell inside the column.
	ColumnIndex *int `mandatory:"true" json:"columnIndex"`

	// The confidence score between 0 and 1.
	Confidence *float32 `mandatory:"true" json:"confidence"`

	BoundingPolygon *BoundingPolygon `mandatory:"true" json:"boundingPolygon"`

	// The words detected in the cell.
	WordIndexes []int `mandatory:"true" json:"wordIndexes"`
}

Cell A single cell in a table.

func (Cell) String 

func (m Cell) String() string

func (Cell) ValidateEnumValue 

func (m Cell) 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 ChangeModelCompartmentDetails added in v65.41.0 

type ChangeModelCompartmentDetails struct {

	// The compartment identifier.
	CompartmentId *string `mandatory:"true" json:"compartmentId"`
}

ChangeModelCompartmentDetails The compartment the model should be moved to.

func (ChangeModelCompartmentDetails) String added in v65.41.0 

func (m ChangeModelCompartmentDetails) String() string

func (ChangeModelCompartmentDetails) ValidateEnumValue added in v65.41.0 

func (m ChangeModelCompartmentDetails) 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 ChangeModelCompartmentRequest added in v65.41.0 

type ChangeModelCompartmentRequest struct {

	// A unique model identifier.
	ModelId *string `mandatory:"true" contributesTo:"path" name:"modelId"`

	// The details of the move.
	ChangeModelCompartmentDetails `contributesTo:"body"`

	// For optimistic concurrency control. In the PUT or DELETE call
	// for a resource, set the `if-match` parameter to the value of the
	// etag from a previous GET or POST response for that resource.
	// The resource will be updated or deleted only if the etag you
	// provide matches the resource's current etag value.
	IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`

	// The client request ID for tracing.
	OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`

	// Whether to override locks (if any exist).
	IsLockOverride *bool `mandatory:"false" contributesTo:"query" name:"isLockOverride"`

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

ChangeModelCompartmentRequest wrapper for the ChangeModelCompartment operation

See also

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

func (ChangeModelCompartmentRequest) BinaryRequestBody added in v65.41.0 

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

BinaryRequestBody implements the OCIRequest interface

func (ChangeModelCompartmentRequest) HTTPRequest added in v65.41.0 

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

HTTPRequest implements the OCIRequest interface

func (ChangeModelCompartmentRequest) RetryPolicy added in v65.41.0 

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

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

func (ChangeModelCompartmentRequest) String added in v65.41.0 

func (request ChangeModelCompartmentRequest) String() string

func (ChangeModelCompartmentRequest) ValidateEnumValue added in v65.41.0 

func (request ChangeModelCompartmentRequest) 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 ChangeModelCompartmentResponse added in v65.41.0 

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

ChangeModelCompartmentResponse wrapper for the ChangeModelCompartment operation

func (ChangeModelCompartmentResponse) HTTPResponse added in v65.41.0 

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

HTTPResponse implements the OCIResponse interface

func (ChangeModelCompartmentResponse) String added in v65.41.0 

func (response ChangeModelCompartmentResponse) String() string

type ChangeProjectCompartmentDetails added in v65.41.0 

type ChangeProjectCompartmentDetails struct {

	// The compartment identifier.
	CompartmentId *string `mandatory:"true" json:"compartmentId"`
}

ChangeProjectCompartmentDetails Which compartment the project should be moved to.

func (ChangeProjectCompartmentDetails) String added in v65.41.0 

func (m ChangeProjectCompartmentDetails) String() string

func (ChangeProjectCompartmentDetails) ValidateEnumValue added in v65.41.0 

func (m ChangeProjectCompartmentDetails) 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 ChangeProjectCompartmentRequest added in v65.41.0 

type ChangeProjectCompartmentRequest struct {

	// A unique project identifier.
	ProjectId *string `mandatory:"true" contributesTo:"path" name:"projectId"`

	// The deatils of the move.
	ChangeProjectCompartmentDetails `contributesTo:"body"`

	// For optimistic concurrency control. In the PUT or DELETE call
	// for a resource, set the `if-match` parameter to the value of the
	// etag from a previous GET or POST response for that resource.
	// The resource will be updated or deleted only if the etag you
	// provide matches the resource's current etag value.
	IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`

	// The client request ID for tracing.
	OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`

	// Whether to override locks (if any exist).
	IsLockOverride *bool `mandatory:"false" contributesTo:"query" name:"isLockOverride"`

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

ChangeProjectCompartmentRequest wrapper for the ChangeProjectCompartment operation

See also

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

func (ChangeProjectCompartmentRequest) BinaryRequestBody added in v65.41.0 

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

BinaryRequestBody implements the OCIRequest interface

func (ChangeProjectCompartmentRequest) HTTPRequest added in v65.41.0 

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

HTTPRequest implements the OCIRequest interface

func (ChangeProjectCompartmentRequest) RetryPolicy added in v65.41.0 

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

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

func (ChangeProjectCompartmentRequest) String added in v65.41.0 

func (request ChangeProjectCompartmentRequest) String() string

func (ChangeProjectCompartmentRequest) ValidateEnumValue added in v65.41.0 

func (request ChangeProjectCompartmentRequest) 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 ChangeProjectCompartmentResponse added in v65.41.0 

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

ChangeProjectCompartmentResponse wrapper for the ChangeProjectCompartment operation

func (ChangeProjectCompartmentResponse) HTTPResponse added in v65.41.0 

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

HTTPResponse implements the OCIResponse interface

func (ChangeProjectCompartmentResponse) String added in v65.41.0 

func (response ChangeProjectCompartmentResponse) String() string

type ComponentModel added in v65.43.0 

type ComponentModel struct {

	// The OCID (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of active custom Key Value model that need to be composed.
	ModelId *string `mandatory:"false" json:"modelId"`
}

ComponentModel The custom model selected for Composition.

func (ComponentModel) String added in v65.43.0 

func (m ComponentModel) String() string

func (ComponentModel) ValidateEnumValue added in v65.43.0 

func (m ComponentModel) 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 CreateModelDetails added in v65.41.0 

type CreateModelDetails struct {

	// The type of the Document model.
	ModelType ModelModelTypeEnum `mandatory:"true" json:"modelType"`

	// The compartment identifier.
	CompartmentId *string `mandatory:"true" json:"compartmentId"`

	// The OCID (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the project that contains the model.
	ProjectId *string `mandatory:"true" json:"projectId"`

	// A human-friendly name for the model, which can be changed.
	DisplayName *string `mandatory:"false" json:"displayName"`

	// An optional description of the model.
	Description *string `mandatory:"false" json:"description"`

	// The model version
	ModelVersion *string `mandatory:"false" json:"modelVersion"`

	// Set to true when experimenting with a new model type or dataset, so the model training is quick, with a predefined low number of passes through the training data.
	IsQuickMode *bool `mandatory:"false" json:"isQuickMode"`

	// The maximum model training time in hours, expressed as a decimal fraction.
	MaxTrainingTimeInHours *float64 `mandatory:"false" json:"maxTrainingTimeInHours"`

	TrainingDataset Dataset `mandatory:"false" json:"trainingDataset"`

	TestingDataset Dataset `mandatory:"false" json:"testingDataset"`

	ValidationDataset Dataset `mandatory:"false" json:"validationDataset"`

	// The OCID (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) list of active custom Key Value models that need to be composed.
	ComponentModels []ComponentModel `mandatory:"false" json:"componentModels"`

	// the alias name of the model.
	AliasName *string `mandatory:"false" json:"aliasName"`

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

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

CreateModelDetails The information needed to create a new model.

func (CreateModelDetails) String added in v65.41.0 

func (m CreateModelDetails) String() string

func (*CreateModelDetails) UnmarshalJSON added in v65.41.0 

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

UnmarshalJSON unmarshals from json

func (CreateModelDetails) ValidateEnumValue added in v65.41.0 

func (m CreateModelDetails) 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 CreateModelRequest added in v65.41.0 

type CreateModelRequest struct {

	// The metadata about the new model.
	CreateModelDetails `contributesTo:"body"`

	// A token that uniquely identifies a request so it can be retried in case of a timeout or
	// server error without the risk of executing that same action again. Retry tokens expire after 24
	// hours, but can be invalidated before then due to conflicting operations. For example, if a resource
	// has been deleted and purged from the system, then a retry of the original creation request
	// might be rejected.
	OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`

	// The client request ID for tracing.
	OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`

	// Metadata about the request. This information will not be transmitted to the service, but
	// represents information that the SDK will consume to drive retry behavior.
	RequestMetadata common.RequestMetadata
}

CreateModelRequest wrapper for the CreateModel operation

See also

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

func (CreateModelRequest) BinaryRequestBody added in v65.41.0 

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

BinaryRequestBody implements the OCIRequest interface

func (CreateModelRequest) HTTPRequest added in v65.41.0 

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

HTTPRequest implements the OCIRequest interface

func (CreateModelRequest) RetryPolicy added in v65.41.0 

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

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

func (CreateModelRequest) String added in v65.41.0 

func (request CreateModelRequest) String() string

func (CreateModelRequest) ValidateEnumValue added in v65.41.0 

func (request CreateModelRequest) 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 CreateModelResponse added in v65.41.0 

type CreateModelResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// The Model instance
	Model `presentIn:"body"`

	// The full URI of the resource related to the request
	ContentLocation *string `presentIn:"header" name:"content-location"`

	// The full URI of the resource related to the request
	Location *string `presentIn:"header" name:"location"`

	// A unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation.
	OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`

	// 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 optimistic concurrency control. See `if-match`.
	Etag *string `presentIn:"header" name:"etag"`
}

CreateModelResponse wrapper for the CreateModel operation

func (CreateModelResponse) HTTPResponse added in v65.41.0 

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

HTTPResponse implements the OCIResponse interface

func (CreateModelResponse) String added in v65.41.0 

func (response CreateModelResponse) String() string

type CreateProcessorJobDetails 

type CreateProcessorJobDetails struct {
	InputLocation InputLocation `mandatory:"true" json:"inputLocation"`

	OutputLocation *OutputLocation `mandatory:"true" json:"outputLocation"`

	// The compartment identifier.
	CompartmentId *string `mandatory:"true" json:"compartmentId"`

	ProcessorConfig ProcessorConfig `mandatory:"true" json:"processorConfig"`

	// The display name of the processor job.
	DisplayName *string `mandatory:"false" json:"displayName"`
}

CreateProcessorJobDetails The details used to create a processor job.

func (CreateProcessorJobDetails) String 

func (m CreateProcessorJobDetails) String() string

func (*CreateProcessorJobDetails) UnmarshalJSON 

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

UnmarshalJSON unmarshals from json

func (CreateProcessorJobDetails) ValidateEnumValue 

func (m CreateProcessorJobDetails) 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 CreateProcessorJobRequest 

type CreateProcessorJobRequest struct {

	// The details for creating the processor job.
	CreateProcessorJobDetails `contributesTo:"body"`

	// A token that uniquely identifies a request so it can be retried in case of a timeout or
	// server error without the risk of executing that same action again. Retry tokens expire after 24
	// hours, but can be invalidated before then due to conflicting operations. For example, if a resource
	// has been deleted and purged from the system, then a retry of the original creation request
	// might be rejected.
	OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`

	// The client request ID for tracing.
	OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`

	// Metadata about the request. This information will not be transmitted to the service, but
	// represents information that the SDK will consume to drive retry behavior.
	RequestMetadata common.RequestMetadata
}

CreateProcessorJobRequest wrapper for the CreateProcessorJob operation

See also

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

func (CreateProcessorJobRequest) BinaryRequestBody 

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

BinaryRequestBody implements the OCIRequest interface

func (CreateProcessorJobRequest) HTTPRequest 

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

HTTPRequest implements the OCIRequest interface

func (CreateProcessorJobRequest) RetryPolicy 

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

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

func (CreateProcessorJobRequest) String 

func (request CreateProcessorJobRequest) String() string

func (CreateProcessorJobRequest) ValidateEnumValue 

func (request CreateProcessorJobRequest) 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 CreateProcessorJobResponse 

type CreateProcessorJobResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// The ProcessorJob instance
	ProcessorJob `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 optimistic concurrency control. See `if-match`.
	Etag *string `presentIn:"header" name:"etag"`
}

CreateProcessorJobResponse wrapper for the CreateProcessorJob operation

func (CreateProcessorJobResponse) HTTPResponse 

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

HTTPResponse implements the OCIResponse interface

func (CreateProcessorJobResponse) String 

func (response CreateProcessorJobResponse) String() string

type CreateProjectDetails added in v65.41.0 

type CreateProjectDetails struct {

	// The compartment identifier.
	CompartmentId *string `mandatory:"true" json:"compartmentId"`

	// A human-friendly name for the project, that can be changed.
	DisplayName *string `mandatory:"false" json:"displayName"`

	// An optional description of the project.
	Description *string `mandatory:"false" json:"description"`

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

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

CreateProjectDetails The information needed to create a new project.

func (CreateProjectDetails) String added in v65.41.0 

func (m CreateProjectDetails) String() string

func (CreateProjectDetails) ValidateEnumValue added in v65.41.0 

func (m CreateProjectDetails) 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 CreateProjectRequest added in v65.41.0 

type CreateProjectRequest struct {

	// The new Project's details.
	CreateProjectDetails `contributesTo:"body"`

	// A token that uniquely identifies a request so it can be retried in case of a timeout or
	// server error without the risk of executing that same action again. Retry tokens expire after 24
	// hours, but can be invalidated before then due to conflicting operations. For example, if a resource
	// has been deleted and purged from the system, then a retry of the original creation request
	// might be rejected.
	OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`

	// The client request ID for tracing.
	OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`

	// Metadata about the request. This information will not be transmitted to the service, but
	// represents information that the SDK will consume to drive retry behavior.
	RequestMetadata common.RequestMetadata
}

CreateProjectRequest wrapper for the CreateProject operation

See also

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

func (CreateProjectRequest) BinaryRequestBody added in v65.41.0 

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

BinaryRequestBody implements the OCIRequest interface

func (CreateProjectRequest) HTTPRequest added in v65.41.0 

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

HTTPRequest implements the OCIRequest interface

func (CreateProjectRequest) RetryPolicy added in v65.41.0 

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

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

func (CreateProjectRequest) String added in v65.41.0 

func (request CreateProjectRequest) String() string

func (CreateProjectRequest) ValidateEnumValue added in v65.41.0 

func (request CreateProjectRequest) 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 CreateProjectResponse added in v65.41.0 

type CreateProjectResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// The Project instance
	Project `presentIn:"body"`

	// The full URI of the resource related to the request
	ContentLocation *string `presentIn:"header" name:"content-location"`

	// The full URI of the resource related to the request
	Location *string `presentIn:"header" name:"location"`

	// For optimistic concurrency control. See `if-match`.
	Etag *string `presentIn:"header" name:"etag"`

	// A unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation.
	OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`

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

CreateProjectResponse wrapper for the CreateProject operation

func (CreateProjectResponse) HTTPResponse added in v65.41.0 

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

HTTPResponse implements the OCIResponse interface

func (CreateProjectResponse) String added in v65.41.0 

func (response CreateProjectResponse) String() string

type DataScienceLabelingDataset added in v65.41.0 

type DataScienceLabelingDataset struct {

	// OCID of the Data Labeling dataset.
	DatasetId *string `mandatory:"true" json:"datasetId"`
}

DataScienceLabelingDataset The dataset created by the Data Labeling Service.

func (DataScienceLabelingDataset) MarshalJSON added in v65.41.0 

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

MarshalJSON marshals to json representation

func (DataScienceLabelingDataset) String added in v65.41.0 

func (m DataScienceLabelingDataset) String() string

func (DataScienceLabelingDataset) ValidateEnumValue added in v65.41.0 

func (m DataScienceLabelingDataset) 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 Dataset added in v65.41.0 

type Dataset interface {
}

Dataset The base entity which is the input for creating and training a model.

type DatasetDatasetTypeEnum added in v65.41.0 

type DatasetDatasetTypeEnum string

DatasetDatasetTypeEnum Enum with underlying type: string 

const (
	DatasetDatasetTypeDataScienceLabeling DatasetDatasetTypeEnum = "DATA_SCIENCE_LABELING"
	DatasetDatasetTypeObjectStorage       DatasetDatasetTypeEnum = "OBJECT_STORAGE"
)

Set of constants representing the allowable values for DatasetDatasetTypeEnum

func GetDatasetDatasetTypeEnumValues added in v65.41.0 

func GetDatasetDatasetTypeEnumValues() []DatasetDatasetTypeEnum

GetDatasetDatasetTypeEnumValues Enumerates the set of values for DatasetDatasetTypeEnum

func GetMappingDatasetDatasetTypeEnum added in v65.41.0 

func GetMappingDatasetDatasetTypeEnum(val string) (DatasetDatasetTypeEnum, bool)

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

type DatasetSummary added in v65.41.0 

type DatasetSummary struct {

	// Number of samples used for training the model.
	TrainingSampleCount *int `mandatory:"false" json:"trainingSampleCount"`

	// Number of samples used for validating the model.
	ValidationSampleCount *int `mandatory:"false" json:"validationSampleCount"`

	// Number of samples used for testing the model.
	TestSampleCount *int `mandatory:"false" json:"testSampleCount"`
}

DatasetSummary Summary of count of samples used during model training.

func (DatasetSummary) String added in v65.41.0 

func (m DatasetSummary) String() string

func (DatasetSummary) ValidateEnumValue added in v65.41.0 

func (m DatasetSummary) 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 DeleteModelRequest added in v65.41.0 

type DeleteModelRequest struct {

	// A unique model identifier.
	ModelId *string `mandatory:"true" contributesTo:"path" name:"modelId"`

	// For optimistic concurrency control. In the PUT or DELETE call
	// for a resource, set the `if-match` parameter to the value of the
	// etag from a previous GET or POST response for that resource.
	// The resource will be updated or deleted only if the etag you
	// provide matches the resource's current etag value.
	IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`

	// The client request ID for tracing.
	OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`

	// Whether to override locks (if any exist).
	IsLockOverride *bool `mandatory:"false" contributesTo:"query" name:"isLockOverride"`

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

DeleteModelRequest wrapper for the DeleteModel operation

See also

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

func (DeleteModelRequest) BinaryRequestBody added in v65.41.0 

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

BinaryRequestBody implements the OCIRequest interface

func (DeleteModelRequest) HTTPRequest added in v65.41.0 

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

HTTPRequest implements the OCIRequest interface

func (DeleteModelRequest) RetryPolicy added in v65.41.0 

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

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

func (DeleteModelRequest) String added in v65.41.0 

func (request DeleteModelRequest) String() string

func (DeleteModelRequest) ValidateEnumValue added in v65.41.0 

func (request DeleteModelRequest) 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 DeleteModelResponse added in v65.41.0 

type DeleteModelResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// A unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation.
	OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`

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

DeleteModelResponse wrapper for the DeleteModel operation

func (DeleteModelResponse) HTTPResponse added in v65.41.0 

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

HTTPResponse implements the OCIResponse interface

func (DeleteModelResponse) String added in v65.41.0 

func (response DeleteModelResponse) String() string

type DeleteProjectRequest added in v65.41.0 

type DeleteProjectRequest struct {

	// A unique project identifier.
	ProjectId *string `mandatory:"true" contributesTo:"path" name:"projectId"`

	// For optimistic concurrency control. In the PUT or DELETE call
	// for a resource, set the `if-match` parameter to the value of the
	// etag from a previous GET or POST response for that resource.
	// The resource will be updated or deleted only if the etag you
	// provide matches the resource's current etag value.
	IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`

	// The client request ID for tracing.
	OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`

	// Whether to override locks (if any exist).
	IsLockOverride *bool `mandatory:"false" contributesTo:"query" name:"isLockOverride"`

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

DeleteProjectRequest wrapper for the DeleteProject operation

See also

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

func (DeleteProjectRequest) BinaryRequestBody added in v65.41.0 

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

BinaryRequestBody implements the OCIRequest interface

func (DeleteProjectRequest) HTTPRequest added in v65.41.0 

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

HTTPRequest implements the OCIRequest interface

func (DeleteProjectRequest) RetryPolicy added in v65.41.0 

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

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

func (DeleteProjectRequest) String added in v65.41.0 

func (request DeleteProjectRequest) String() string

func (DeleteProjectRequest) ValidateEnumValue added in v65.41.0 

func (request DeleteProjectRequest) 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 DeleteProjectResponse added in v65.41.0 

type DeleteProjectResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// A unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation.
	OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`

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

DeleteProjectResponse wrapper for the DeleteProject operation

func (DeleteProjectResponse) HTTPResponse added in v65.41.0 

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

HTTPResponse implements the OCIResponse interface

func (DeleteProjectResponse) String added in v65.41.0 

func (response DeleteProjectResponse) String() string

type DetectedDocumentType 

type DetectedDocumentType struct {

	// The document type.
	DocumentType *string `mandatory:"true" json:"documentType"`

	// The confidence score between 0 and 1.
	Confidence *float32 `mandatory:"true" json:"confidence"`
}

DetectedDocumentType The detected document type.

func (DetectedDocumentType) String 

func (m DetectedDocumentType) String() string

func (DetectedDocumentType) ValidateEnumValue 

func (m DetectedDocumentType) 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 DetectedLanguage 

type DetectedLanguage struct {

	// The document language, abbreviated according to the BCP 47 syntax.
	Language *string `mandatory:"true" json:"language"`

	// The confidence score between 0 and 1.
	Confidence *float32 `mandatory:"true" json:"confidence"`
}

DetectedLanguage The language detected in a document.

func (DetectedLanguage) String 

func (m DetectedLanguage) String() string

func (DetectedLanguage) ValidateEnumValue 

func (m DetectedLanguage) 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 Dimensions 

type Dimensions struct {

	// the width of a page.
	Width *float64 `mandatory:"true" json:"width"`

	// The height of a page.
	Height *float64 `mandatory:"true" json:"height"`

	// The unit of length.
	Unit DimensionsUnitEnum `mandatory:"true" json:"unit"`
}

Dimensions The width and height of a page.

func (Dimensions) String 

func (m Dimensions) String() string

func (Dimensions) ValidateEnumValue 

func (m Dimensions) 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 DimensionsUnitEnum 

type DimensionsUnitEnum string

DimensionsUnitEnum Enum with underlying type: string 

const (
	DimensionsUnitPixel DimensionsUnitEnum = "PIXEL"
	DimensionsUnitInch  DimensionsUnitEnum = "INCH"
)

Set of constants representing the allowable values for DimensionsUnitEnum

func GetDimensionsUnitEnumValues 

func GetDimensionsUnitEnumValues() []DimensionsUnitEnum

GetDimensionsUnitEnumValues Enumerates the set of values for DimensionsUnitEnum

func GetMappingDimensionsUnitEnum 

func GetMappingDimensionsUnitEnum(val string) (DimensionsUnitEnum, bool)

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

type DocumentClassificationConfidenceEntry added in v65.41.0 

type DocumentClassificationConfidenceEntry struct {

	// Threshold used to calculate precision and recall.
	Threshold *float32 `mandatory:"true" json:"threshold"`

	// Precision under the threshold
	Precision *float32 `mandatory:"true" json:"precision"`

	// Recall under the threshold
	Recall *float32 `mandatory:"true" json:"recall"`

	// f1Score under the threshold
	F1Score *float32 `mandatory:"true" json:"f1Score"`
}

DocumentClassificationConfidenceEntry Confidence Entry.

func (DocumentClassificationConfidenceEntry) String added in v65.41.0 

func (m DocumentClassificationConfidenceEntry) String() string

func (DocumentClassificationConfidenceEntry) ValidateEnumValue added in v65.41.0 

func (m DocumentClassificationConfidenceEntry) 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 DocumentClassificationFeature 

type DocumentClassificationFeature struct {

	// The maximum number of results to return.
	MaxResults *int `mandatory:"false" json:"maxResults"`

	// The custom model ID.
	ModelId *string `mandatory:"false" json:"modelId"`
}

DocumentClassificationFeature Identifying the document type.

func (DocumentClassificationFeature) MarshalJSON 

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

MarshalJSON marshals to json representation

func (DocumentClassificationFeature) String 

func (m DocumentClassificationFeature) String() string

func (DocumentClassificationFeature) ValidateEnumValue 

func (m DocumentClassificationFeature) 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 DocumentClassificationLabelMetricsReport added in v65.41.0 

type DocumentClassificationLabelMetricsReport struct {

	// Mean average precision under different thresholds
	MeanAveragePrecision *float32 `mandatory:"true" json:"meanAveragePrecision"`

	// List of document classification confidence report.
	ConfidenceEntries []DocumentClassificationConfidenceEntry `mandatory:"true" json:"confidenceEntries"`

	// Label name
	Label *string `mandatory:"false" json:"label"`
}

DocumentClassificationLabelMetricsReport Label Metrics report for Document Classification Model.

func (DocumentClassificationLabelMetricsReport) String added in v65.41.0 

func (m DocumentClassificationLabelMetricsReport) String() string

func (DocumentClassificationLabelMetricsReport) ValidateEnumValue added in v65.41.0 

func (m DocumentClassificationLabelMetricsReport) 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 DocumentClassificationModelMetrics added in v65.41.0 

type DocumentClassificationModelMetrics struct {

	// List of metrics entries per label.
	LabelMetricsReport []DocumentClassificationLabelMetricsReport `mandatory:"true" json:"labelMetricsReport"`

	OverallMetricsReport *DocumentClassificationOverallMetricsReport `mandatory:"true" json:"overallMetricsReport"`

	DatasetSummary *DatasetSummary `mandatory:"false" json:"datasetSummary"`
}

DocumentClassificationModelMetrics Metrics for Document Classification Model.

func (DocumentClassificationModelMetrics) GetDatasetSummary added in v65.41.0 

func (m DocumentClassificationModelMetrics) GetDatasetSummary() *DatasetSummary

GetDatasetSummary returns DatasetSummary

func (DocumentClassificationModelMetrics) MarshalJSON added in v65.41.0 

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

MarshalJSON marshals to json representation

func (DocumentClassificationModelMetrics) String added in v65.41.0 

func (m DocumentClassificationModelMetrics) String() string

func (DocumentClassificationModelMetrics) ValidateEnumValue added in v65.41.0 

func (m DocumentClassificationModelMetrics) 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 DocumentClassificationOverallMetricsReport added in v65.41.0 

type DocumentClassificationOverallMetricsReport struct {

	// Mean average precision under different thresholds
	MeanAveragePrecision *float32 `mandatory:"true" json:"meanAveragePrecision"`

	// List of document classification confidence report.
	ConfidenceEntries []DocumentClassificationConfidenceEntry `mandatory:"true" json:"confidenceEntries"`
}

DocumentClassificationOverallMetricsReport Overall Metrics report for Document Classification Model.

func (DocumentClassificationOverallMetricsReport) String added in v65.41.0 

func (m DocumentClassificationOverallMetricsReport) String() string

func (DocumentClassificationOverallMetricsReport) ValidateEnumValue added in v65.41.0 

func (m DocumentClassificationOverallMetricsReport) 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 DocumentDetails added in v65.43.0 

type DocumentDetails interface {
}

DocumentDetails The details of a document to analyze.

type DocumentDetailsSourceEnum added in v65.43.0 

type DocumentDetailsSourceEnum string

DocumentDetailsSourceEnum Enum with underlying type: string 

const (
	DocumentDetailsSourceInline        DocumentDetailsSourceEnum = "INLINE"
	DocumentDetailsSourceObjectStorage DocumentDetailsSourceEnum = "OBJECT_STORAGE"
)

Set of constants representing the allowable values for DocumentDetailsSourceEnum

func GetDocumentDetailsSourceEnumValues added in v65.43.0 

func GetDocumentDetailsSourceEnumValues() []DocumentDetailsSourceEnum

GetDocumentDetailsSourceEnumValues Enumerates the set of values for DocumentDetailsSourceEnum

func GetMappingDocumentDetailsSourceEnum added in v65.43.0 

func GetMappingDocumentDetailsSourceEnum(val string) (DocumentDetailsSourceEnum, bool)

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

type DocumentFeature 

type DocumentFeature interface {
}

DocumentFeature The type of document analysis.

type DocumentFeatureFeatureTypeEnum 

type DocumentFeatureFeatureTypeEnum string

DocumentFeatureFeatureTypeEnum Enum with underlying type: string 

const (
	DocumentFeatureFeatureTypeLanguageClassification DocumentFeatureFeatureTypeEnum = "LANGUAGE_CLASSIFICATION"
	DocumentFeatureFeatureTypeTextExtraction         DocumentFeatureFeatureTypeEnum = "TEXT_EXTRACTION"
	DocumentFeatureFeatureTypeTableExtraction        DocumentFeatureFeatureTypeEnum = "TABLE_EXTRACTION"
	DocumentFeatureFeatureTypeKeyValueExtraction     DocumentFeatureFeatureTypeEnum = "KEY_VALUE_EXTRACTION"
	DocumentFeatureFeatureTypeDocumentClassification DocumentFeatureFeatureTypeEnum = "DOCUMENT_CLASSIFICATION"
)

Set of constants representing the allowable values for DocumentFeatureFeatureTypeEnum

func GetDocumentFeatureFeatureTypeEnumValues 

func GetDocumentFeatureFeatureTypeEnumValues() []DocumentFeatureFeatureTypeEnum

GetDocumentFeatureFeatureTypeEnumValues Enumerates the set of values for DocumentFeatureFeatureTypeEnum

func GetMappingDocumentFeatureFeatureTypeEnum 

func GetMappingDocumentFeatureFeatureTypeEnum(val string) (DocumentFeatureFeatureTypeEnum, bool)

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

type DocumentField 

type DocumentField struct {

	// The field type.
	FieldType DocumentFieldFieldTypeEnum `mandatory:"true" json:"fieldType"`

	FieldValue FieldValue `mandatory:"true" json:"fieldValue"`

	FieldLabel *FieldLabel `mandatory:"false" json:"fieldLabel"`

	FieldName *FieldName `mandatory:"false" json:"fieldName"`
}

DocumentField Form field.

func (DocumentField) String 

func (m DocumentField) String() string

func (*DocumentField) UnmarshalJSON 

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

UnmarshalJSON unmarshals from json

func (DocumentField) ValidateEnumValue 

func (m DocumentField) 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 DocumentFieldFieldTypeEnum 

type DocumentFieldFieldTypeEnum string

DocumentFieldFieldTypeEnum Enum with underlying type: string 

const (
	DocumentFieldFieldTypeLineItemGroup DocumentFieldFieldTypeEnum = "LINE_ITEM_GROUP"
	DocumentFieldFieldTypeLineItem      DocumentFieldFieldTypeEnum = "LINE_ITEM"
	DocumentFieldFieldTypeLineItemField DocumentFieldFieldTypeEnum = "LINE_ITEM_FIELD"
	DocumentFieldFieldTypeKeyValue      DocumentFieldFieldTypeEnum = "KEY_VALUE"
)

Set of constants representing the allowable values for DocumentFieldFieldTypeEnum

func GetDocumentFieldFieldTypeEnumValues 

func GetDocumentFieldFieldTypeEnumValues() []DocumentFieldFieldTypeEnum

GetDocumentFieldFieldTypeEnumValues Enumerates the set of values for DocumentFieldFieldTypeEnum

func GetMappingDocumentFieldFieldTypeEnum 

func GetMappingDocumentFieldFieldTypeEnum(val string) (DocumentFieldFieldTypeEnum, bool)

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

type DocumentKeyValueExtractionFeature 

type DocumentKeyValueExtractionFeature struct {

	// The custom model ID.
	ModelId *string `mandatory:"false" json:"modelId"`
}

DocumentKeyValueExtractionFeature Extracting form fields.

func (DocumentKeyValueExtractionFeature) MarshalJSON 

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

MarshalJSON marshals to json representation

func (DocumentKeyValueExtractionFeature) String 

func (m DocumentKeyValueExtractionFeature) String() string

func (DocumentKeyValueExtractionFeature) ValidateEnumValue 

func (m DocumentKeyValueExtractionFeature) 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 DocumentLanguageClassificationFeature 

type DocumentLanguageClassificationFeature struct {

	// The maximum number of results to return.
	MaxResults *int `mandatory:"false" json:"maxResults"`
}

DocumentLanguageClassificationFeature Detecting the language of the document.

func (DocumentLanguageClassificationFeature) MarshalJSON 

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

MarshalJSON marshals to json representation

func (DocumentLanguageClassificationFeature) String 

func (m DocumentLanguageClassificationFeature) String() string

func (DocumentLanguageClassificationFeature) ValidateEnumValue 

func (m DocumentLanguageClassificationFeature) 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 {

	// Teh number of pages in the document.
	PageCount *int `mandatory:"true" json:"pageCount"`

	// The result data format.
	MimeType *string `mandatory:"true" json:"mimeType"`
}

DocumentMetadata The document information.

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 DocumentTableExtractionFeature 

type DocumentTableExtractionFeature struct {
}

DocumentTableExtractionFeature Detecting and extracting data in tables.

func (DocumentTableExtractionFeature) MarshalJSON 

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

MarshalJSON marshals to json representation

func (DocumentTableExtractionFeature) String 

func (m DocumentTableExtractionFeature) String() string

func (DocumentTableExtractionFeature) ValidateEnumValue 

func (m DocumentTableExtractionFeature) 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 DocumentTextExtractionFeature 

type DocumentTextExtractionFeature struct {

	// Whether or not to generate a searchable PDF file.
	GenerateSearchablePdf *bool `mandatory:"false" json:"generateSearchablePdf"`
}

DocumentTextExtractionFeature Text recognition

func (DocumentTextExtractionFeature) MarshalJSON 

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

MarshalJSON marshals to json representation

func (DocumentTextExtractionFeature) String 

func (m DocumentTextExtractionFeature) String() string

func (DocumentTextExtractionFeature) ValidateEnumValue 

func (m DocumentTextExtractionFeature) 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 DocumentTypeEnum 

type DocumentTypeEnum string

DocumentTypeEnum Enum with underlying type: string 

const (
	DocumentTypeInvoice           DocumentTypeEnum = "INVOICE"
	DocumentTypeReceipt           DocumentTypeEnum = "RECEIPT"
	DocumentTypeResume            DocumentTypeEnum = "RESUME"
	DocumentTypeTaxForm           DocumentTypeEnum = "TAX_FORM"
	DocumentTypeDriverLicense     DocumentTypeEnum = "DRIVER_LICENSE"
	DocumentTypePassport          DocumentTypeEnum = "PASSPORT"
	DocumentTypeBankStatement     DocumentTypeEnum = "BANK_STATEMENT"
	DocumentTypeCheck             DocumentTypeEnum = "CHECK"
	DocumentTypePayslip           DocumentTypeEnum = "PAYSLIP"
	DocumentTypeOthers            DocumentTypeEnum = "OTHERS"
	DocumentTypeHealthInsuranceId DocumentTypeEnum = "HEALTH_INSURANCE_ID"
)

Set of constants representing the allowable values for DocumentTypeEnum

func GetDocumentTypeEnumValues 

func GetDocumentTypeEnumValues() []DocumentTypeEnum

GetDocumentTypeEnumValues Enumerates the set of values for DocumentTypeEnum

func GetMappingDocumentTypeEnum 

func GetMappingDocumentTypeEnum(val string) (DocumentTypeEnum, bool)

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

type FieldLabel 

type FieldLabel struct {

	// The name of the field label.
	Name *string `mandatory:"true" json:"name"`

	// The confidence score between 0 and 1.
	Confidence *float32 `mandatory:"false" json:"confidence"`
}

FieldLabel The label in a field.

func (FieldLabel) String 

func (m FieldLabel) String() string

func (FieldLabel) ValidateEnumValue 

func (m FieldLabel) 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 FieldName 

type FieldName struct {

	// The name of the field.
	Name *string `mandatory:"true" json:"name"`

	// The confidence score between 0 and 1.
	Confidence *float32 `mandatory:"false" json:"confidence"`

	BoundingPolygon *BoundingPolygon `mandatory:"false" json:"boundingPolygon"`

	// The indexes of the words in the field name.
	WordIndexes []int `mandatory:"false" json:"wordIndexes"`
}

FieldName The name of a form field.

func (FieldName) String 

func (m FieldName) String() string

func (FieldName) ValidateEnumValue 

func (m FieldName) 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 FieldValue 

type FieldValue interface {

	// The confidence score between 0 and 1.
	GetConfidence() *float32

	GetBoundingPolygon() *BoundingPolygon

	// The indexes of the words in the field value.
	GetWordIndexes() []int

	// The detected text of a field.
	GetText() *string
}

FieldValue The value of a form field.

type FieldValueValueTypeEnum 

type FieldValueValueTypeEnum string

FieldValueValueTypeEnum Enum with underlying type: string 

const (
	FieldValueValueTypeString      FieldValueValueTypeEnum = "STRING"
	FieldValueValueTypeDate        FieldValueValueTypeEnum = "DATE"
	FieldValueValueTypeTime        FieldValueValueTypeEnum = "TIME"
	FieldValueValueTypePhoneNumber FieldValueValueTypeEnum = "PHONE_NUMBER"
	FieldValueValueTypeNumber      FieldValueValueTypeEnum = "NUMBER"
	FieldValueValueTypeInteger     FieldValueValueTypeEnum = "INTEGER"
	FieldValueValueTypeArray       FieldValueValueTypeEnum = "ARRAY"
)

Set of constants representing the allowable values for FieldValueValueTypeEnum

func GetFieldValueValueTypeEnumValues 

func GetFieldValueValueTypeEnumValues() []FieldValueValueTypeEnum

GetFieldValueValueTypeEnumValues Enumerates the set of values for FieldValueValueTypeEnum

func GetMappingFieldValueValueTypeEnum 

func GetMappingFieldValueValueTypeEnum(val string) (FieldValueValueTypeEnum, bool)

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

type GeneralProcessorConfig 

type GeneralProcessorConfig struct {

	// The types of document analysis requested.
	Features []DocumentFeature `mandatory:"true" json:"features"`

	// Whether or not to generate a ZIP file containing the results.
	IsZipOutputEnabled *bool `mandatory:"false" json:"isZipOutputEnabled"`

	// The document language, abbreviated according to the BCP 47 Language-Tag syntax.
	Language *string `mandatory:"false" json:"language"`

	// The document type.
	DocumentType DocumentTypeEnum `mandatory:"false" json:"documentType,omitempty"`
}

GeneralProcessorConfig The configuration of a general processor.

func (GeneralProcessorConfig) MarshalJSON 

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

MarshalJSON marshals to json representation

func (GeneralProcessorConfig) String 

func (m GeneralProcessorConfig) String() string

func (*GeneralProcessorConfig) UnmarshalJSON 

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

UnmarshalJSON unmarshals from json

func (GeneralProcessorConfig) ValidateEnumValue 

func (m GeneralProcessorConfig) 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 GetModelRequest added in v65.41.0 

type GetModelRequest struct {

	// A unique model identifier.
	ModelId *string `mandatory:"true" contributesTo:"path" name:"modelId"`

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

GetModelRequest wrapper for the GetModel operation

See also

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

func (GetModelRequest) BinaryRequestBody added in v65.41.0 

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

BinaryRequestBody implements the OCIRequest interface

func (GetModelRequest) HTTPRequest added in v65.41.0 

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

HTTPRequest implements the OCIRequest interface

func (GetModelRequest) RetryPolicy added in v65.41.0 

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

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

func (GetModelRequest) String added in v65.41.0 

func (request GetModelRequest) String() string

func (GetModelRequest) ValidateEnumValue added in v65.41.0 

func (request GetModelRequest) 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 GetModelResponse added in v65.41.0 

type GetModelResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// The Model instance
	Model `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"`
}

GetModelResponse wrapper for the GetModel operation

func (GetModelResponse) HTTPResponse added in v65.41.0 

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

HTTPResponse implements the OCIResponse interface

func (GetModelResponse) String added in v65.41.0 

func (response GetModelResponse) String() string

type GetProcessorJobRequest 

type GetProcessorJobRequest struct {

	// Processor job id.
	ProcessorJobId *string `mandatory:"true" contributesTo:"path" name:"processorJobId"`

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

GetProcessorJobRequest wrapper for the GetProcessorJob operation

See also

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

func (GetProcessorJobRequest) BinaryRequestBody 

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

BinaryRequestBody implements the OCIRequest interface

func (GetProcessorJobRequest) HTTPRequest 

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

HTTPRequest implements the OCIRequest interface

func (GetProcessorJobRequest) RetryPolicy 

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

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

func (GetProcessorJobRequest) String 

func (request GetProcessorJobRequest) String() string

func (GetProcessorJobRequest) ValidateEnumValue 

func (request GetProcessorJobRequest) 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 GetProcessorJobResponse 

type GetProcessorJobResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// The ProcessorJob instance
	ProcessorJob `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"`
}

GetProcessorJobResponse wrapper for the GetProcessorJob operation

func (GetProcessorJobResponse) HTTPResponse 

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

HTTPResponse implements the OCIResponse interface

func (GetProcessorJobResponse) String 

func (response GetProcessorJobResponse) String() string

type GetProjectRequest added in v65.41.0 

type GetProjectRequest struct {

	// A unique project identifier.
	ProjectId *string `mandatory:"true" contributesTo:"path" name:"projectId"`

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

GetProjectRequest wrapper for the GetProject operation

See also

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

func (GetProjectRequest) BinaryRequestBody added in v65.41.0 

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

BinaryRequestBody implements the OCIRequest interface

func (GetProjectRequest) HTTPRequest added in v65.41.0 

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

HTTPRequest implements the OCIRequest interface

func (GetProjectRequest) RetryPolicy added in v65.41.0 

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

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

func (GetProjectRequest) String added in v65.41.0 

func (request GetProjectRequest) String() string

func (GetProjectRequest) ValidateEnumValue added in v65.41.0 

func (request GetProjectRequest) 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 GetProjectResponse added in v65.41.0 

type GetProjectResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// The Project instance
	Project `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"`
}

GetProjectResponse wrapper for the GetProject operation

func (GetProjectResponse) HTTPResponse added in v65.41.0 

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

HTTPResponse implements the OCIResponse interface

func (GetProjectResponse) String added in v65.41.0 

func (response GetProjectResponse) String() string

type GetWorkRequestRequest added in v65.41.0 

type GetWorkRequestRequest struct {

	// The ID of the asynchronous request.
	WorkRequestId *string `mandatory:"true" contributesTo:"path" name:"workRequestId"`

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

GetWorkRequestRequest wrapper for the GetWorkRequest operation

See also

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

func (GetWorkRequestRequest) BinaryRequestBody added in v65.41.0 

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

BinaryRequestBody implements the OCIRequest interface

func (GetWorkRequestRequest) HTTPRequest added in v65.41.0 

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

HTTPRequest implements the OCIRequest interface

func (GetWorkRequestRequest) RetryPolicy added in v65.41.0 

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

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

func (GetWorkRequestRequest) String added in v65.41.0 

func (request GetWorkRequestRequest) String() string

func (GetWorkRequestRequest) ValidateEnumValue added in v65.41.0 

func (request GetWorkRequestRequest) 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 GetWorkRequestResponse added in v65.41.0 

type GetWorkRequestResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// The WorkRequest instance
	WorkRequest `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"`

	// A decimal number representing the number of seconds the client should wait before polling this endpoint again.
	RetryAfter *int `presentIn:"header" name:"retry-after"`
}

GetWorkRequestResponse wrapper for the GetWorkRequest operation

func (GetWorkRequestResponse) HTTPResponse added in v65.41.0 

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

HTTPResponse implements the OCIResponse interface

func (GetWorkRequestResponse) String added in v65.41.0 

func (response GetWorkRequestResponse) String() string

type InlineDocumentContent 

type InlineDocumentContent struct {

	// Raw document data with Base64 encoding.
	Data []byte `mandatory:"true" json:"data"`
}

InlineDocumentContent The content of an inline document.

func (InlineDocumentContent) MarshalJSON 

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

MarshalJSON marshals to json representation

func (InlineDocumentContent) String 

func (m InlineDocumentContent) String() string

func (InlineDocumentContent) ValidateEnumValue 

func (m InlineDocumentContent) 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 InlineDocumentDetails added in v65.43.0 

type InlineDocumentDetails struct {

	// Raw document data with Base64 encoding.
	Data []byte `mandatory:"true" json:"data"`
}

InlineDocumentDetails The document incorporated in the request payload.

func (InlineDocumentDetails) MarshalJSON added in v65.43.0 

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

MarshalJSON marshals to json representation

func (InlineDocumentDetails) String added in v65.43.0 

func (m InlineDocumentDetails) String() string

func (InlineDocumentDetails) ValidateEnumValue added in v65.43.0 

func (m InlineDocumentDetails) 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 InputLocation 

type InputLocation interface {
}

InputLocation The location of the inputs.

type InputLocationSourceTypeEnum 

type InputLocationSourceTypeEnum string

InputLocationSourceTypeEnum Enum with underlying type: string 

const (
	InputLocationSourceTypeObjectStorageLocations InputLocationSourceTypeEnum = "OBJECT_STORAGE_LOCATIONS"
	InputLocationSourceTypeInlineDocumentContent  InputLocationSourceTypeEnum = "INLINE_DOCUMENT_CONTENT"
)

Set of constants representing the allowable values for InputLocationSourceTypeEnum

func GetInputLocationSourceTypeEnumValues 

func GetInputLocationSourceTypeEnumValues() []InputLocationSourceTypeEnum

GetInputLocationSourceTypeEnumValues Enumerates the set of values for InputLocationSourceTypeEnum

func GetMappingInputLocationSourceTypeEnum 

func GetMappingInputLocationSourceTypeEnum(val string) (InputLocationSourceTypeEnum, bool)

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

type KeyValueDetectionConfidenceEntry added in v65.41.0 

type KeyValueDetectionConfidenceEntry struct {

	// Threshold used to calculate precision and recall.
	Threshold *float32 `mandatory:"true" json:"threshold"`

	// Precision under the threshold
	Precision *float32 `mandatory:"true" json:"precision"`

	// Recall under the threshold
	Recall *float32 `mandatory:"true" json:"recall"`

	// f1Score under the threshold
	F1Score *float32 `mandatory:"true" json:"f1Score"`

	// accuracy under the threshold
	Accuracy *float32 `mandatory:"true" json:"accuracy"`
}

KeyValueDetectionConfidenceEntry Key Value Detection Confidence Entry.

func (KeyValueDetectionConfidenceEntry) String added in v65.41.0 

func (m KeyValueDetectionConfidenceEntry) String() string

func (KeyValueDetectionConfidenceEntry) ValidateEnumValue added in v65.41.0 

func (m KeyValueDetectionConfidenceEntry) 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 KeyValueDetectionLabelMetricsReport added in v65.41.0 

type KeyValueDetectionLabelMetricsReport struct {

	// Mean average precision under different thresholds
	MeanAveragePrecision *float32 `mandatory:"true" json:"meanAveragePrecision"`

	// List of key value detection confidence report.
	ConfidenceEntries []KeyValueDetectionConfidenceEntry `mandatory:"true" json:"confidenceEntries"`

	// Total test documents in the label.
	DocumentCount *int `mandatory:"false" json:"documentCount"`

	// Label name
	Label *string `mandatory:"false" json:"label"`
}

KeyValueDetectionLabelMetricsReport Label Metrics report for Key Value Detection Model.

func (KeyValueDetectionLabelMetricsReport) String added in v65.41.0 

func (m KeyValueDetectionLabelMetricsReport) String() string

func (KeyValueDetectionLabelMetricsReport) ValidateEnumValue added in v65.41.0 

func (m KeyValueDetectionLabelMetricsReport) 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 KeyValueDetectionModelMetrics added in v65.41.0 

type KeyValueDetectionModelMetrics struct {

	// List of metrics entries per label.
	LabelMetricsReport []KeyValueDetectionLabelMetricsReport `mandatory:"true" json:"labelMetricsReport"`

	OverallMetricsReport *KeyValueDetectionOverallMetricsReport `mandatory:"true" json:"overallMetricsReport"`

	DatasetSummary *DatasetSummary `mandatory:"false" json:"datasetSummary"`
}

KeyValueDetectionModelMetrics Metrics for Document Key Value Detection Model.

func (KeyValueDetectionModelMetrics) GetDatasetSummary added in v65.41.0 

func (m KeyValueDetectionModelMetrics) GetDatasetSummary() *DatasetSummary

GetDatasetSummary returns DatasetSummary

func (KeyValueDetectionModelMetrics) MarshalJSON added in v65.41.0 

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

MarshalJSON marshals to json representation

func (KeyValueDetectionModelMetrics) String added in v65.41.0 

func (m KeyValueDetectionModelMetrics) String() string

func (KeyValueDetectionModelMetrics) ValidateEnumValue added in v65.41.0 

func (m KeyValueDetectionModelMetrics) 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 KeyValueDetectionOverallMetricsReport added in v65.41.0 

type KeyValueDetectionOverallMetricsReport struct {

	// Mean average precision under different thresholds
	MeanAveragePrecision *float32 `mandatory:"true" json:"meanAveragePrecision"`

	// List of key value detection confidence report.
	ConfidenceEntries []KeyValueDetectionConfidenceEntry `mandatory:"true" json:"confidenceEntries"`

	// Total test documents in the label.
	DocumentCount *int `mandatory:"false" json:"documentCount"`
}

KeyValueDetectionOverallMetricsReport Overall Metrics report for Key Value Detection Model.

func (KeyValueDetectionOverallMetricsReport) String added in v65.41.0 

func (m KeyValueDetectionOverallMetricsReport) String() string

func (KeyValueDetectionOverallMetricsReport) ValidateEnumValue added in v65.41.0 

func (m KeyValueDetectionOverallMetricsReport) 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 Line 

type Line struct {

	// The text recognized.
	Text *string `mandatory:"true" json:"text"`

	// The confidence score between 0 and 1.
	Confidence *float32 `mandatory:"true" json:"confidence"`

	BoundingPolygon *BoundingPolygon `mandatory:"true" json:"boundingPolygon"`

	// The array of words.
	WordIndexes []int `mandatory:"true" json:"wordIndexes"`
}

Line The line of text.

func (Line) String 

func (m Line) String() string

func (Line) ValidateEnumValue 

func (m Line) 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 ListModelsRequest added in v65.41.0 

type ListModelsRequest struct {

	// The ID of the compartment in which to list resources.
	CompartmentId *string `mandatory:"false" contributesTo:"query" name:"compartmentId"`

	// The ID of the project for which to list the objects.
	ProjectId *string `mandatory:"false" contributesTo:"query" name:"projectId"`

	// The filter to match models with the given lifecycleState.
	LifecycleState ModelLifecycleStateEnum `mandatory:"false" contributesTo:"query" name:"lifecycleState" omitEmpty:"true"`

	// A filter to return only resources that match the entire display name given.
	DisplayName *string `mandatory:"false" contributesTo:"query" name:"displayName"`

	// The filter to find the model with the given identifier.
	Id *string `mandatory:"false" contributesTo:"query" name:"id"`

	// The maximum number of items to return.
	Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`

	// The position at which to start retrieving results. This must come from the `opc-next-page` header field of a previous response.
	Page *string `mandatory:"false" contributesTo:"query" name:"page"`

	// The sort order to use, either 'ASC' or 'DESC'.
	SortOrder ListModelsSortOrderEnum `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 displayName is ascending.
	SortBy ListModelsSortByEnum `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
}

ListModelsRequest wrapper for the ListModels operation

See also

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

func (ListModelsRequest) BinaryRequestBody added in v65.41.0 

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

BinaryRequestBody implements the OCIRequest interface

func (ListModelsRequest) HTTPRequest added in v65.41.0 

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

HTTPRequest implements the OCIRequest interface

func (ListModelsRequest) RetryPolicy added in v65.41.0 

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

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

func (ListModelsRequest) String added in v65.41.0 

func (request ListModelsRequest) String() string

func (ListModelsRequest) ValidateEnumValue added in v65.41.0 

func (request ListModelsRequest) 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 ListModelsResponse added in v65.41.0 

type ListModelsResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// A list of ModelCollection instances
	ModelCollection `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 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"`
}

ListModelsResponse wrapper for the ListModels operation

func (ListModelsResponse) HTTPResponse added in v65.41.0 

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

HTTPResponse implements the OCIResponse interface

func (ListModelsResponse) String added in v65.41.0 

func (response ListModelsResponse) String() string

type ListModelsSortByEnum added in v65.41.0 

type ListModelsSortByEnum string

ListModelsSortByEnum Enum with underlying type: string 

const (
	ListModelsSortByTimecreated ListModelsSortByEnum = "timeCreated"
	ListModelsSortByDisplayname ListModelsSortByEnum = "displayName"
)

Set of constants representing the allowable values for ListModelsSortByEnum

func GetListModelsSortByEnumValues added in v65.41.0 

func GetListModelsSortByEnumValues() []ListModelsSortByEnum

GetListModelsSortByEnumValues Enumerates the set of values for ListModelsSortByEnum

func GetMappingListModelsSortByEnum added in v65.41.0 

func GetMappingListModelsSortByEnum(val string) (ListModelsSortByEnum, bool)

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

type ListModelsSortOrderEnum added in v65.41.0 

type ListModelsSortOrderEnum string

ListModelsSortOrderEnum Enum with underlying type: string 

const (
	ListModelsSortOrderAsc  ListModelsSortOrderEnum = "ASC"
	ListModelsSortOrderDesc ListModelsSortOrderEnum = "DESC"
)

Set of constants representing the allowable values for ListModelsSortOrderEnum

func GetListModelsSortOrderEnumValues added in v65.41.0 

func GetListModelsSortOrderEnumValues() []ListModelsSortOrderEnum

GetListModelsSortOrderEnumValues Enumerates the set of values for ListModelsSortOrderEnum

func GetMappingListModelsSortOrderEnum added in v65.41.0 

func GetMappingListModelsSortOrderEnum(val string) (ListModelsSortOrderEnum, bool)

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

type ListProjectsRequest added in v65.41.0 

type ListProjectsRequest struct {

	// The ID of the compartment in which to list resources.
	CompartmentId *string `mandatory:"false" contributesTo:"query" name:"compartmentId"`

	// The filter to match projects with the given lifecycleState.
	LifecycleState ProjectLifecycleStateEnum `mandatory:"false" contributesTo:"query" name:"lifecycleState" omitEmpty:"true"`

	// A filter to return only resources that match the entire display name given.
	DisplayName *string `mandatory:"false" contributesTo:"query" name:"displayName"`

	// The filter to find the project with the given identifier.
	Id *string `mandatory:"false" contributesTo:"query" name:"id"`

	// The maximum number of items to return.
	Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`

	// The position at which to start retrieving results. This must come from the `opc-next-page` header field of a previous response.
	Page *string `mandatory:"false" contributesTo:"query" name:"page"`

	// The sort order to use, either 'ASC' or 'DESC'.
	SortOrder ListProjectsSortOrderEnum `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 displayName is ascending.
	SortBy ListProjectsSortByEnum `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
}

ListProjectsRequest wrapper for the ListProjects operation

See also

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

func (ListProjectsRequest) BinaryRequestBody added in v65.41.0 

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

BinaryRequestBody implements the OCIRequest interface

func (ListProjectsRequest) HTTPRequest added in v65.41.0 

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

HTTPRequest implements the OCIRequest interface

func (ListProjectsRequest) RetryPolicy added in v65.41.0 

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

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

func (ListProjectsRequest) String added in v65.41.0 

func (request ListProjectsRequest) String() string

func (ListProjectsRequest) ValidateEnumValue added in v65.41.0 

func (request ListProjectsRequest) 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 ListProjectsResponse added in v65.41.0 

type ListProjectsResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// A list of ProjectCollection instances
	ProjectCollection `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 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"`
}

ListProjectsResponse wrapper for the ListProjects operation

func (ListProjectsResponse) HTTPResponse added in v65.41.0 

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

HTTPResponse implements the OCIResponse interface

func (ListProjectsResponse) String added in v65.41.0 

func (response ListProjectsResponse) String() string

type ListProjectsSortByEnum added in v65.41.0 

type ListProjectsSortByEnum string

ListProjectsSortByEnum Enum with underlying type: string 

const (
	ListProjectsSortByTimecreated ListProjectsSortByEnum = "timeCreated"
	ListProjectsSortByDisplayname ListProjectsSortByEnum = "displayName"
)

Set of constants representing the allowable values for ListProjectsSortByEnum

func GetListProjectsSortByEnumValues added in v65.41.0 

func GetListProjectsSortByEnumValues() []ListProjectsSortByEnum

GetListProjectsSortByEnumValues Enumerates the set of values for ListProjectsSortByEnum

func GetMappingListProjectsSortByEnum added in v65.41.0 

func GetMappingListProjectsSortByEnum(val string) (ListProjectsSortByEnum, bool)

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

type ListProjectsSortOrderEnum added in v65.41.0 

type ListProjectsSortOrderEnum string

ListProjectsSortOrderEnum Enum with underlying type: string 

const (
	ListProjectsSortOrderAsc  ListProjectsSortOrderEnum = "ASC"
	ListProjectsSortOrderDesc ListProjectsSortOrderEnum = "DESC"
)

Set of constants representing the allowable values for ListProjectsSortOrderEnum

func GetListProjectsSortOrderEnumValues added in v65.41.0 

func GetListProjectsSortOrderEnumValues() []ListProjectsSortOrderEnum

GetListProjectsSortOrderEnumValues Enumerates the set of values for ListProjectsSortOrderEnum

func GetMappingListProjectsSortOrderEnum added in v65.41.0 

func GetMappingListProjectsSortOrderEnum(val string) (ListProjectsSortOrderEnum, bool)

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

type ListWorkRequestErrorsRequest added in v65.41.0 

type ListWorkRequestErrorsRequest struct {

	// The ID of the asynchronous request.
	WorkRequestId *string `mandatory:"true" contributesTo:"path" name:"workRequestId"`

	// The client request ID for tracing.
	OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`

	// The position at which to start retrieving results. This must come from the `opc-next-page` header field of a previous response.
	Page *string `mandatory:"false" contributesTo:"query" name:"page"`

	// The maximum number of items to return.
	Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`

	// The field to sort by. Only one sort order may be provided. The default order for timeAccepted is descending.
	SortBy ListWorkRequestErrorsSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`

	// The sort order to use, either 'ASC' or 'DESC'.
	SortOrder ListWorkRequestErrorsSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"`

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

ListWorkRequestErrorsRequest wrapper for the ListWorkRequestErrors operation

See also

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

func (ListWorkRequestErrorsRequest) BinaryRequestBody added in v65.41.0 

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

BinaryRequestBody implements the OCIRequest interface

func (ListWorkRequestErrorsRequest) HTTPRequest added in v65.41.0 

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

HTTPRequest implements the OCIRequest interface

func (ListWorkRequestErrorsRequest) RetryPolicy added in v65.41.0 

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

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

func (ListWorkRequestErrorsRequest) String added in v65.41.0 

func (request ListWorkRequestErrorsRequest) String() string

func (ListWorkRequestErrorsRequest) ValidateEnumValue added in v65.41.0 

func (request ListWorkRequestErrorsRequest) 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 ListWorkRequestErrorsResponse added in v65.41.0 

type ListWorkRequestErrorsResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// A list of WorkRequestErrorCollection instances
	WorkRequestErrorCollection `presentIn:"body"`

	// For pagination of a list of items. When paging through a list, if this header appears in the response,
	// then a partial list might have been returned. Include this value as the `page` parameter for the
	// subsequent GET request to get the next batch of items.
	OpcNextPage *string `presentIn:"header" name:"opc-next-page"`

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

ListWorkRequestErrorsResponse wrapper for the ListWorkRequestErrors operation

func (ListWorkRequestErrorsResponse) HTTPResponse added in v65.41.0 

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

HTTPResponse implements the OCIResponse interface

func (ListWorkRequestErrorsResponse) String added in v65.41.0 

func (response ListWorkRequestErrorsResponse) String() string

type ListWorkRequestErrorsSortByEnum added in v65.41.0 

type ListWorkRequestErrorsSortByEnum string

ListWorkRequestErrorsSortByEnum Enum with underlying type: string 

const (
	ListWorkRequestErrorsSortByTimeaccepted ListWorkRequestErrorsSortByEnum = "timeAccepted"
)

Set of constants representing the allowable values for ListWorkRequestErrorsSortByEnum

func GetListWorkRequestErrorsSortByEnumValues added in v65.41.0 

func GetListWorkRequestErrorsSortByEnumValues() []ListWorkRequestErrorsSortByEnum

GetListWorkRequestErrorsSortByEnumValues Enumerates the set of values for ListWorkRequestErrorsSortByEnum

func GetMappingListWorkRequestErrorsSortByEnum added in v65.41.0 

func GetMappingListWorkRequestErrorsSortByEnum(val string) (ListWorkRequestErrorsSortByEnum, bool)

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

type ListWorkRequestErrorsSortOrderEnum added in v65.41.0 

type ListWorkRequestErrorsSortOrderEnum string

ListWorkRequestErrorsSortOrderEnum Enum with underlying type: string 

const (
	ListWorkRequestErrorsSortOrderAsc  ListWorkRequestErrorsSortOrderEnum = "ASC"
	ListWorkRequestErrorsSortOrderDesc ListWorkRequestErrorsSortOrderEnum = "DESC"
)

Set of constants representing the allowable values for ListWorkRequestErrorsSortOrderEnum

func GetListWorkRequestErrorsSortOrderEnumValues added in v65.41.0 

func GetListWorkRequestErrorsSortOrderEnumValues() []ListWorkRequestErrorsSortOrderEnum

GetListWorkRequestErrorsSortOrderEnumValues Enumerates the set of values for ListWorkRequestErrorsSortOrderEnum

func GetMappingListWorkRequestErrorsSortOrderEnum added in v65.41.0 

func GetMappingListWorkRequestErrorsSortOrderEnum(val string) (ListWorkRequestErrorsSortOrderEnum, bool)

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

type ListWorkRequestLogsRequest added in v65.41.0 

type ListWorkRequestLogsRequest struct {

	// The ID of the asynchronous request.
	WorkRequestId *string `mandatory:"true" contributesTo:"path" name:"workRequestId"`

	// The client request ID for tracing.
	OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`

	// The position at which to start retrieving results. This must come from the `opc-next-page` header field of a previous response.
	Page *string `mandatory:"false" contributesTo:"query" name:"page"`

	// The maximum number of items to return.
	Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`

	// The field to sort by. Only one sort order may be provided. The default order for timeAccepted is descending.
	SortBy ListWorkRequestLogsSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`

	// The sort order to use, either 'ASC' or 'DESC'.
	SortOrder ListWorkRequestLogsSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"`

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

ListWorkRequestLogsRequest wrapper for the ListWorkRequestLogs operation

See also

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

func (ListWorkRequestLogsRequest) BinaryRequestBody added in v65.41.0 

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

BinaryRequestBody implements the OCIRequest interface

func (ListWorkRequestLogsRequest) HTTPRequest added in v65.41.0 

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

HTTPRequest implements the OCIRequest interface

func (ListWorkRequestLogsRequest) RetryPolicy added in v65.41.0 

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

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

func (ListWorkRequestLogsRequest) String added in v65.41.0 

func (request ListWorkRequestLogsRequest) String() string

func (ListWorkRequestLogsRequest) ValidateEnumValue added in v65.41.0 

func (request ListWorkRequestLogsRequest) 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 ListWorkRequestLogsResponse added in v65.41.0 

type ListWorkRequestLogsResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// A list of WorkRequestLogEntryCollection instances
	WorkRequestLogEntryCollection `presentIn:"body"`

	// For pagination of a list of items. When paging through a list, if this header appears in the response,
	// then a partial list might have been returned. Include this value as the `page` parameter for the
	// subsequent GET request to get the next batch of items.
	OpcNextPage *string `presentIn:"header" name:"opc-next-page"`

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

ListWorkRequestLogsResponse wrapper for the ListWorkRequestLogs operation

func (ListWorkRequestLogsResponse) HTTPResponse added in v65.41.0 

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

HTTPResponse implements the OCIResponse interface

func (ListWorkRequestLogsResponse) String added in v65.41.0 

func (response ListWorkRequestLogsResponse) String() string

type ListWorkRequestLogsSortByEnum added in v65.41.0 

type ListWorkRequestLogsSortByEnum string

ListWorkRequestLogsSortByEnum Enum with underlying type: string 

const (
	ListWorkRequestLogsSortByTimeaccepted ListWorkRequestLogsSortByEnum = "timeAccepted"
)

Set of constants representing the allowable values for ListWorkRequestLogsSortByEnum

func GetListWorkRequestLogsSortByEnumValues added in v65.41.0 

func GetListWorkRequestLogsSortByEnumValues() []ListWorkRequestLogsSortByEnum

GetListWorkRequestLogsSortByEnumValues Enumerates the set of values for ListWorkRequestLogsSortByEnum

func GetMappingListWorkRequestLogsSortByEnum added in v65.41.0 

func GetMappingListWorkRequestLogsSortByEnum(val string) (ListWorkRequestLogsSortByEnum, bool)

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

type ListWorkRequestLogsSortOrderEnum added in v65.41.0 

type ListWorkRequestLogsSortOrderEnum string

ListWorkRequestLogsSortOrderEnum Enum with underlying type: string 

const (
	ListWorkRequestLogsSortOrderAsc  ListWorkRequestLogsSortOrderEnum = "ASC"
	ListWorkRequestLogsSortOrderDesc ListWorkRequestLogsSortOrderEnum = "DESC"
)

Set of constants representing the allowable values for ListWorkRequestLogsSortOrderEnum

func GetListWorkRequestLogsSortOrderEnumValues added in v65.41.0 

func GetListWorkRequestLogsSortOrderEnumValues() []ListWorkRequestLogsSortOrderEnum

GetListWorkRequestLogsSortOrderEnumValues Enumerates the set of values for ListWorkRequestLogsSortOrderEnum

func GetMappingListWorkRequestLogsSortOrderEnum added in v65.41.0 

func GetMappingListWorkRequestLogsSortOrderEnum(val string) (ListWorkRequestLogsSortOrderEnum, bool)

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

type ListWorkRequestsRequest added in v65.41.0 

type ListWorkRequestsRequest struct {

	// The ID of the compartment in which to list resources.
	CompartmentId *string `mandatory:"false" contributesTo:"query" name:"compartmentId"`

	// The ID of the asynchronous work request.
	WorkRequestId *string `mandatory:"false" contributesTo:"query" name:"workRequestId"`

	// A filter to return only resources whose lifecycleState matches the given OperationStatus.
	Status ListWorkRequestsStatusEnum `mandatory:"false" contributesTo:"query" name:"status" omitEmpty:"true"`

	// The ID of the resource affected by the work request.
	ResourceId *string `mandatory:"false" contributesTo:"query" name:"resourceId"`

	// The client request ID for tracing.
	OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`

	// The position at which to start retrieving results. This must come from the `opc-next-page` header field of a previous response.
	Page *string `mandatory:"false" contributesTo:"query" name:"page"`

	// The maximum number of items to return.
	Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`

	// The sort order to use, either 'ASC' or 'DESC'.
	SortOrder ListWorkRequestsSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"`

	// The field to sort by. Only one sort order may be provided. The default order for timeAccepted is descending.
	SortBy ListWorkRequestsSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`

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

ListWorkRequestsRequest wrapper for the ListWorkRequests operation

See also

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

func (ListWorkRequestsRequest) BinaryRequestBody added in v65.41.0 

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

BinaryRequestBody implements the OCIRequest interface

func (ListWorkRequestsRequest) HTTPRequest added in v65.41.0 

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

HTTPRequest implements the OCIRequest interface

func (ListWorkRequestsRequest) RetryPolicy added in v65.41.0 

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

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

func (ListWorkRequestsRequest) String added in v65.41.0 

func (request ListWorkRequestsRequest) String() string

func (ListWorkRequestsRequest) ValidateEnumValue added in v65.41.0 

func (request ListWorkRequestsRequest) 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 ListWorkRequestsResponse added in v65.41.0 

type ListWorkRequestsResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// A list of WorkRequestSummaryCollection instances
	WorkRequestSummaryCollection `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 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"`
}

ListWorkRequestsResponse wrapper for the ListWorkRequests operation

func (ListWorkRequestsResponse) HTTPResponse added in v65.41.0 

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

HTTPResponse implements the OCIResponse interface

func (ListWorkRequestsResponse) String added in v65.41.0 

func (response ListWorkRequestsResponse) String() string

type ListWorkRequestsSortByEnum added in v65.41.0 

type ListWorkRequestsSortByEnum string

ListWorkRequestsSortByEnum Enum with underlying type: string 

const (
	ListWorkRequestsSortByTimeaccepted ListWorkRequestsSortByEnum = "timeAccepted"
)

Set of constants representing the allowable values for ListWorkRequestsSortByEnum

func GetListWorkRequestsSortByEnumValues added in v65.41.0 

func GetListWorkRequestsSortByEnumValues() []ListWorkRequestsSortByEnum

GetListWorkRequestsSortByEnumValues Enumerates the set of values for ListWorkRequestsSortByEnum

func GetMappingListWorkRequestsSortByEnum added in v65.41.0 

func GetMappingListWorkRequestsSortByEnum(val string) (ListWorkRequestsSortByEnum, bool)

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

type ListWorkRequestsSortOrderEnum added in v65.41.0 

type ListWorkRequestsSortOrderEnum string

ListWorkRequestsSortOrderEnum Enum with underlying type: string 

const (
	ListWorkRequestsSortOrderAsc  ListWorkRequestsSortOrderEnum = "ASC"
	ListWorkRequestsSortOrderDesc ListWorkRequestsSortOrderEnum = "DESC"
)

Set of constants representing the allowable values for ListWorkRequestsSortOrderEnum

func GetListWorkRequestsSortOrderEnumValues added in v65.41.0 

func GetListWorkRequestsSortOrderEnumValues() []ListWorkRequestsSortOrderEnum

GetListWorkRequestsSortOrderEnumValues Enumerates the set of values for ListWorkRequestsSortOrderEnum

func GetMappingListWorkRequestsSortOrderEnum added in v65.41.0 

func GetMappingListWorkRequestsSortOrderEnum(val string) (ListWorkRequestsSortOrderEnum, bool)

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

type ListWorkRequestsStatusEnum added in v65.41.0 

type ListWorkRequestsStatusEnum string

ListWorkRequestsStatusEnum Enum with underlying type: string 

const (
	ListWorkRequestsStatusAccepted   ListWorkRequestsStatusEnum = "ACCEPTED"
	ListWorkRequestsStatusInProgress ListWorkRequestsStatusEnum = "IN_PROGRESS"
	ListWorkRequestsStatusWaiting    ListWorkRequestsStatusEnum = "WAITING"
	ListWorkRequestsStatusFailed     ListWorkRequestsStatusEnum = "FAILED"
	ListWorkRequestsStatusSucceeded  ListWorkRequestsStatusEnum = "SUCCEEDED"
	ListWorkRequestsStatusCanceling  ListWorkRequestsStatusEnum = "CANCELING"
	ListWorkRequestsStatusCanceled   ListWorkRequestsStatusEnum = "CANCELED"
)

Set of constants representing the allowable values for ListWorkRequestsStatusEnum

func GetListWorkRequestsStatusEnumValues added in v65.41.0 

func GetListWorkRequestsStatusEnumValues() []ListWorkRequestsStatusEnum

GetListWorkRequestsStatusEnumValues Enumerates the set of values for ListWorkRequestsStatusEnum

func GetMappingListWorkRequestsStatusEnum added in v65.41.0 

func GetMappingListWorkRequestsStatusEnum(val string) (ListWorkRequestsStatusEnum, bool)

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

type Model added in v65.41.0 

type Model struct {

	// A unique identifier that is immutable after creation.
	Id *string `mandatory:"true" json:"id"`

	// The compartment identifier.
	CompartmentId *string `mandatory:"true" json:"compartmentId"`

	// The type of the Document model.
	ModelType ModelModelTypeEnum `mandatory:"true" json:"modelType"`

	// The version of the model.
	ModelVersion *string `mandatory:"true" json:"modelVersion"`

	// The OCID (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the project that contains the model.
	ProjectId *string `mandatory:"true" json:"projectId"`

	// When the model was created, as an RFC3339 datetime string.
	TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`

	// The current state of the model.
	LifecycleState ModelLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`

	// A human-friendly name for the model, which can be changed.
	DisplayName *string `mandatory:"false" json:"displayName"`

	// An optional description of the model.
	Description *string `mandatory:"false" json:"description"`

	// The tenancy id of the model.
	TenancyId *string `mandatory:"false" json:"tenancyId"`

	// the alias name of the model.
	AliasName *string `mandatory:"false" json:"aliasName"`

	// The collection of labels used to train the custom model.
	Labels []string `mandatory:"false" json:"labels"`

	// Set to true when experimenting with a new model type or dataset, so model training is quick, with a predefined low number of passes through the training data.
	IsQuickMode *bool `mandatory:"false" json:"isQuickMode"`

	// The maximum model training time in hours, expressed as a decimal fraction.
	MaxTrainingTimeInHours *float64 `mandatory:"false" json:"maxTrainingTimeInHours"`

	// The total hours actually used for model training.
	TrainedTimeInHours *float64 `mandatory:"false" json:"trainedTimeInHours"`

	TrainingDataset Dataset `mandatory:"false" json:"trainingDataset"`

	TestingDataset Dataset `mandatory:"false" json:"testingDataset"`

	ValidationDataset Dataset `mandatory:"false" json:"validationDataset"`

	// The OCID (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) collection of active custom Key Value models that need to be composed.
	ComponentModels []ComponentModel `mandatory:"false" json:"componentModels"`

	// Set to true when the model is created by using multiple key value extraction models.
	IsComposedModel *bool `mandatory:"false" json:"isComposedModel"`

	// When the model was updated, as an RFC3339 datetime string.
	TimeUpdated *common.SDKTime `mandatory:"false" json:"timeUpdated"`

	// A message describing the current state in more detail, that can provide actionable information if training failed.
	LifecycleDetails *string `mandatory:"false" json:"lifecycleDetails"`

	Metrics ModelMetrics `mandatory:"false" json:"metrics"`

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

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

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

	// Locks associated with this resource.
	Locks []ResourceLock `mandatory:"false" json:"locks"`
}

Model Machine-learned Model.

func (Model) String added in v65.41.0 

func (m Model) String() string

func (*Model) UnmarshalJSON added in v65.41.0 

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

UnmarshalJSON unmarshals from json

func (Model) ValidateEnumValue added in v65.41.0 

func (m Model) 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 ModelCollection added in v65.41.0 

type ModelCollection struct {

	// A list of models.
	Items []ModelSummary `mandatory:"true" json:"items"`
}

ModelCollection The results of a model search.

func (ModelCollection) String added in v65.41.0 

func (m ModelCollection) String() string

func (ModelCollection) ValidateEnumValue added in v65.41.0 

func (m ModelCollection) 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 ModelLifecycleStateEnum added in v65.41.0 

type ModelLifecycleStateEnum string

ModelLifecycleStateEnum Enum with underlying type: string 

const (
	ModelLifecycleStateCreating ModelLifecycleStateEnum = "CREATING"
	ModelLifecycleStateUpdating ModelLifecycleStateEnum = "UPDATING"
	ModelLifecycleStateActive   ModelLifecycleStateEnum = "ACTIVE"
	ModelLifecycleStateDeleting ModelLifecycleStateEnum = "DELETING"
	ModelLifecycleStateDeleted  ModelLifecycleStateEnum = "DELETED"
	ModelLifecycleStateFailed   ModelLifecycleStateEnum = "FAILED"
)

Set of constants representing the allowable values for ModelLifecycleStateEnum

func GetMappingModelLifecycleStateEnum added in v65.41.0 

func GetMappingModelLifecycleStateEnum(val string) (ModelLifecycleStateEnum, bool)

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

func GetModelLifecycleStateEnumValues added in v65.41.0 

func GetModelLifecycleStateEnumValues() []ModelLifecycleStateEnum

GetModelLifecycleStateEnumValues Enumerates the set of values for ModelLifecycleStateEnum

type ModelMetrics added in v65.41.0 

type ModelMetrics interface {
	GetDatasetSummary() *DatasetSummary
}

ModelMetrics Trained Model Metrics.

type ModelMetricsModelTypeEnum added in v65.41.0 

type ModelMetricsModelTypeEnum string

ModelMetricsModelTypeEnum Enum with underlying type: string 

const (
	ModelMetricsModelTypeKeyValueExtraction     ModelMetricsModelTypeEnum = "KEY_VALUE_EXTRACTION"
	ModelMetricsModelTypeDocumentClassification ModelMetricsModelTypeEnum = "DOCUMENT_CLASSIFICATION"
)

Set of constants representing the allowable values for ModelMetricsModelTypeEnum

func GetMappingModelMetricsModelTypeEnum added in v65.41.0 

func GetMappingModelMetricsModelTypeEnum(val string) (ModelMetricsModelTypeEnum, bool)

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

func GetModelMetricsModelTypeEnumValues added in v65.41.0 

func GetModelMetricsModelTypeEnumValues() []ModelMetricsModelTypeEnum

GetModelMetricsModelTypeEnumValues Enumerates the set of values for ModelMetricsModelTypeEnum

type ModelModelTypeEnum added in v65.41.0 

type ModelModelTypeEnum string

ModelModelTypeEnum Enum with underlying type: string 

const (
	ModelModelTypeKeyValueExtraction     ModelModelTypeEnum = "KEY_VALUE_EXTRACTION"
	ModelModelTypeDocumentClassification ModelModelTypeEnum = "DOCUMENT_CLASSIFICATION"
)

Set of constants representing the allowable values for ModelModelTypeEnum

func GetMappingModelModelTypeEnum added in v65.41.0 

func GetMappingModelModelTypeEnum(val string) (ModelModelTypeEnum, bool)

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

func GetModelModelTypeEnumValues added in v65.41.0 

func GetModelModelTypeEnumValues() []ModelModelTypeEnum

GetModelModelTypeEnumValues Enumerates the set of values for ModelModelTypeEnum

type ModelSummary added in v65.41.0 

type ModelSummary struct {

	// A unique identifier that is immutable after creation.
	Id *string `mandatory:"true" json:"id"`

	// The compartment identifier.
	CompartmentId *string `mandatory:"true" json:"compartmentId"`

	// The type of the Document model.
	ModelType ModelModelTypeEnum `mandatory:"true" json:"modelType"`

	// The version of the model.
	ModelVersion *string `mandatory:"true" json:"modelVersion"`

	// The OCID (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the project that contains the model.
	ProjectId *string `mandatory:"true" json:"projectId"`

	// When the model was created, as an RFC3339 datetime string.
	TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`

	// The current state of the model.
	LifecycleState ModelLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`

	// A human-friendly name for the model, which can be changed.
	DisplayName *string `mandatory:"false" json:"displayName"`

	// An optional description of the model.
	Description *string `mandatory:"false" json:"description"`

	// When the model was modified, as an RFC3339 datetime string.
	TimeUpdated *common.SDKTime `mandatory:"false" json:"timeUpdated"`

	// A message describing the current state in more detail, that can provide actionable information if training failed.
	LifecycleDetails *string `mandatory:"false" json:"lifecycleDetails"`

	// The precision of the trained model.
	Precision *float32 `mandatory:"false" json:"precision"`

	// The tenancy id of the model.
	TenancyId *string `mandatory:"false" json:"tenancyId"`

	// the alias name of the model.
	AliasName *string `mandatory:"false" json:"aliasName"`

	TrainingDataset Dataset `mandatory:"false" json:"trainingDataset"`

	TestingDataset Dataset `mandatory:"false" json:"testingDataset"`

	ValidationDataset Dataset `mandatory:"false" json:"validationDataset"`

	// The OCID (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) list of active custom Key Value models that need to be composed.
	ComponentModels []ComponentModel `mandatory:"false" json:"componentModels"`

	// Set to true when the model is created by using multiple key value extraction models.
	IsComposedModel *bool `mandatory:"false" json:"isComposedModel"`

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

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

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

	// Locks associated with this resource.
	Locks []ResourceLock `mandatory:"false" json:"locks"`
}

ModelSummary The metadata about the model.

func (ModelSummary) String added in v65.41.0 

func (m ModelSummary) String() string

func (*ModelSummary) UnmarshalJSON added in v65.41.0 

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

UnmarshalJSON unmarshals from json

func (ModelSummary) ValidateEnumValue added in v65.41.0 

func (m ModelSummary) 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 NormalizedVertex 

type NormalizedVertex struct {

	// The X-axis normalized coordinate.
	X *float64 `mandatory:"true" json:"x"`

	// The Y-axis normalized coordinate.
	Y *float64 `mandatory:"true" json:"y"`
}

NormalizedVertex An (x, y) coordinate in the image with dimensions normalized from zero to one. The origin is at top left, with the positive x-axis pointing right and the positive y-axis pointing down. The bottom right corner is at (1, 1).

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 ObjectLocation 

type ObjectLocation struct {

	// The Object Storage namespace name.
	NamespaceName *string `mandatory:"true" json:"namespaceName"`

	// The Object Storage bucket name.
	BucketName *string `mandatory:"true" json:"bucketName"`

	// The Object Storage object name.
	ObjectName *string `mandatory:"true" json:"objectName"`
}

ObjectLocation A location in Object Storage that is uniquely identified by namespace name, bucket name and object name.

func (ObjectLocation) String 

func (m ObjectLocation) String() string

func (ObjectLocation) ValidateEnumValue 

func (m ObjectLocation) 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 ObjectStorageDataset added in v65.41.0 

type ObjectStorageDataset struct {

	// The namespace name of the Object Storage bucket that contains the input data file.
	NamespaceName *string `mandatory:"true" json:"namespaceName"`

	// The name of the Object Storage bucket that contains the input data file.
	BucketName *string `mandatory:"true" json:"bucketName"`

	// The object name of the input data file.
	ObjectName *string `mandatory:"true" json:"objectName"`
}

ObjectStorageDataset The dataset that resides in Object Storage.

func (ObjectStorageDataset) MarshalJSON added in v65.41.0 

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

MarshalJSON marshals to json representation

func (ObjectStorageDataset) String added in v65.41.0 

func (m ObjectStorageDataset) String() string

func (ObjectStorageDataset) ValidateEnumValue added in v65.41.0 

func (m ObjectStorageDataset) 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 ObjectStorageDocumentDetails added in v65.43.0 

type ObjectStorageDocumentDetails struct {

	// The Object Storage namespace.
	NamespaceName *string `mandatory:"true" json:"namespaceName"`

	// The Object Storage bucket name.
	BucketName *string `mandatory:"true" json:"bucketName"`

	// The Object Storage object name.
	ObjectName *string `mandatory:"true" json:"objectName"`
}

ObjectStorageDocumentDetails A document in OCI Object Storage.

func (ObjectStorageDocumentDetails) MarshalJSON added in v65.43.0 

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

MarshalJSON marshals to json representation

func (ObjectStorageDocumentDetails) String added in v65.43.0 

func (m ObjectStorageDocumentDetails) String() string

func (ObjectStorageDocumentDetails) ValidateEnumValue added in v65.43.0 

func (m ObjectStorageDocumentDetails) 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 ObjectStorageLocations 

type ObjectStorageLocations struct {

	// The list of ObjectLocations.
	ObjectLocations []ObjectLocation `mandatory:"true" json:"objectLocations"`
}

ObjectStorageLocations A list of object locations in Object Storage.

func (ObjectStorageLocations) MarshalJSON 

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

MarshalJSON marshals to json representation

func (ObjectStorageLocations) String 

func (m ObjectStorageLocations) String() string

func (ObjectStorageLocations) ValidateEnumValue 

func (m ObjectStorageLocations) 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 OperationStatusEnum added in v65.41.0 

type OperationStatusEnum string

OperationStatusEnum Enum with underlying type: string 

const (
	OperationStatusAccepted   OperationStatusEnum = "ACCEPTED"
	OperationStatusInProgress OperationStatusEnum = "IN_PROGRESS"
	OperationStatusWaiting    OperationStatusEnum = "WAITING"
	OperationStatusFailed     OperationStatusEnum = "FAILED"
	OperationStatusSucceeded  OperationStatusEnum = "SUCCEEDED"
	OperationStatusCanceling  OperationStatusEnum = "CANCELING"
	OperationStatusCanceled   OperationStatusEnum = "CANCELED"
)

Set of constants representing the allowable values for OperationStatusEnum

func GetMappingOperationStatusEnum added in v65.41.0 

func GetMappingOperationStatusEnum(val string) (OperationStatusEnum, bool)

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

func GetOperationStatusEnumValues added in v65.41.0 

func GetOperationStatusEnumValues() []OperationStatusEnum

GetOperationStatusEnumValues Enumerates the set of values for OperationStatusEnum

type OperationTypeEnum added in v65.41.0 

type OperationTypeEnum string

OperationTypeEnum Enum with underlying type: string 

const (
	OperationTypeCreateProject OperationTypeEnum = "CREATE_PROJECT"
	OperationTypeUpdateProject OperationTypeEnum = "UPDATE_PROJECT"
	OperationTypeDeleteProject OperationTypeEnum = "DELETE_PROJECT"
	OperationTypeMoveProject   OperationTypeEnum = "MOVE_PROJECT"
	OperationTypeCreateModel   OperationTypeEnum = "CREATE_MODEL"
	OperationTypeUpdateModel   OperationTypeEnum = "UPDATE_MODEL"
	OperationTypeDeleteModel   OperationTypeEnum = "DELETE_MODEL"
	OperationTypeMoveModel     OperationTypeEnum = "MOVE_MODEL"
	OperationTypeComposeModel  OperationTypeEnum = "COMPOSE_MODEL"
)

Set of constants representing the allowable values for OperationTypeEnum

func GetMappingOperationTypeEnum added in v65.41.0 

func GetMappingOperationTypeEnum(val string) (OperationTypeEnum, bool)

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

func GetOperationTypeEnumValues added in v65.41.0 

func GetOperationTypeEnumValues() []OperationTypeEnum

GetOperationTypeEnumValues Enumerates the set of values for OperationTypeEnum

type OutputLocation 

type OutputLocation struct {

	// The Object Storage namespace.
	NamespaceName *string `mandatory:"true" json:"namespaceName"`

	// The Object Storage bucket name.
	BucketName *string `mandatory:"true" json:"bucketName"`

	// The Object Storage folder name.
	Prefix *string `mandatory:"true" json:"prefix"`
}

OutputLocation The Object Storage Location.

func (OutputLocation) String 

func (m OutputLocation) String() string

func (OutputLocation) ValidateEnumValue 

func (m OutputLocation) 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 Page 

type Page struct {

	// The document page number.
	PageNumber *int `mandatory:"true" json:"pageNumber"`

	Dimensions *Dimensions `mandatory:"false" json:"dimensions"`

	// An array of detected document types.
	DetectedDocumentTypes []DetectedDocumentType `mandatory:"false" json:"detectedDocumentTypes"`

	// An array of detected languages.
	DetectedLanguages []DetectedLanguage `mandatory:"false" json:"detectedLanguages"`

	// The words detected on the page.
	Words []Word `mandatory:"false" json:"words"`

	// The lines of text detected on the page.
	Lines []Line `mandatory:"false" json:"lines"`

	// The tables detected on the page.
	Tables []Table `mandatory:"false" json:"tables"`

	// The form fields detected on the page.
	DocumentFields []DocumentField `mandatory:"false" json:"documentFields"`
}

Page One page document analysis result.

func (Page) String 

func (m Page) String() string

func (Page) ValidateEnumValue 

func (m Page) 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 PatchModelDetails added in v65.43.0 

type PatchModelDetails struct {

	// A list of patch operations for model.
	Operations []PatchModelOperation `mandatory:"false" json:"operations"`
}

PatchModelDetails The model parameters to be updated using patch operation.

func (PatchModelDetails) String added in v65.43.0 

func (m PatchModelDetails) String() string

func (PatchModelDetails) ValidateEnumValue added in v65.43.0 

func (m PatchModelDetails) 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 PatchModelOperation added in v65.43.0 

type PatchModelOperation struct {

	// The parameter of the resource to be changed.
	Path *string `mandatory:"false" json:"path"`

	// The value of the parameter to be updated.
	Value *string `mandatory:"false" json:"value"`

	// The value of the parameter to be updated.
	Operation PatchModelOperationOperationEnum `mandatory:"false" json:"operation,omitempty"`
}

PatchModelOperation The metadata which can be edited after model creation.

func (PatchModelOperation) String added in v65.43.0 

func (m PatchModelOperation) String() string

func (PatchModelOperation) ValidateEnumValue added in v65.43.0 

func (m PatchModelOperation) 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 PatchModelOperationOperationEnum added in v65.43.0 

type PatchModelOperationOperationEnum string

PatchModelOperationOperationEnum Enum with underlying type: string 

const (
	PatchModelOperationOperationDelete  PatchModelOperationOperationEnum = "DELETE"
	PatchModelOperationOperationAdd     PatchModelOperationOperationEnum = "ADD"
	PatchModelOperationOperationReplace PatchModelOperationOperationEnum = "REPLACE"
)

Set of constants representing the allowable values for PatchModelOperationOperationEnum

func GetMappingPatchModelOperationOperationEnum added in v65.43.0 

func GetMappingPatchModelOperationOperationEnum(val string) (PatchModelOperationOperationEnum, bool)

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

func GetPatchModelOperationOperationEnumValues added in v65.43.0 

func GetPatchModelOperationOperationEnumValues() []PatchModelOperationOperationEnum

GetPatchModelOperationOperationEnumValues Enumerates the set of values for PatchModelOperationOperationEnum

type PatchModelRequest added in v65.43.0 

type PatchModelRequest struct {

	// A unique model identifier.
	ModelId *string `mandatory:"true" contributesTo:"path" name:"modelId"`

	// The model metadata to be updated.
	PatchModelDetails `contributesTo:"body"`

	// For optimistic concurrency control. In the PUT or DELETE call
	// for a resource, set the `if-match` parameter to the value of the
	// etag from a previous GET or POST response for that resource.
	// The resource will be updated or deleted only if the etag you
	// provide matches the resource's current etag value.
	IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`

	// The client request ID for tracing.
	OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`

	// Metadata about the request. This information will not be transmitted to the service, but
	// represents information that the SDK will consume to drive retry behavior.
	RequestMetadata common.RequestMetadata
}

PatchModelRequest wrapper for the PatchModel operation

See also

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

func (PatchModelRequest) BinaryRequestBody added in v65.43.0 

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

BinaryRequestBody implements the OCIRequest interface

func (PatchModelRequest) HTTPRequest added in v65.43.0 

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

HTTPRequest implements the OCIRequest interface

func (PatchModelRequest) RetryPolicy added in v65.43.0 

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

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

func (PatchModelRequest) String added in v65.43.0 

func (request PatchModelRequest) String() string

func (PatchModelRequest) ValidateEnumValue added in v65.43.0 

func (request PatchModelRequest) 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 PatchModelResponse added in v65.43.0 

type PatchModelResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// The PatchResponseMessage instance
	PatchResponseMessage `presentIn:"body"`

	// A unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation.
	OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`

	// 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 optimistic concurrency control. See `if-match`.
	Etag *string `presentIn:"header" name:"etag"`
}

PatchModelResponse wrapper for the PatchModel operation

func (PatchModelResponse) HTTPResponse added in v65.43.0 

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

HTTPResponse implements the OCIResponse interface

func (PatchModelResponse) String added in v65.43.0 

func (response PatchModelResponse) String() string

type PatchResponseMessage added in v65.43.0 

type PatchResponseMessage struct {

	// The response message containing details of operation.
	Message *string `mandatory:"true" json:"message"`

	// Model ID representing the conflicting patch operation.
	ModelId *string `mandatory:"false" json:"modelId"`

	// Compartment ID representing the conflicting Model Compartment.
	CompartmentId *string `mandatory:"false" json:"compartmentId"`
}

PatchResponseMessage The response containing the details of the patch operation status.

func (PatchResponseMessage) String added in v65.43.0 

func (m PatchResponseMessage) String() string

func (PatchResponseMessage) ValidateEnumValue added in v65.43.0 

func (m PatchResponseMessage) 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 ProcessingError 

type ProcessingError struct {

	// The error code.
	Code *string `mandatory:"true" json:"code"`

	// The error message.
	Message *string `mandatory:"true" json:"message"`
}

ProcessingError The error in document processing.

func (ProcessingError) String 

func (m ProcessingError) String() string

func (ProcessingError) ValidateEnumValue 

func (m ProcessingError) 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 ProcessorConfig 

type ProcessorConfig interface {
}

ProcessorConfig The configuration of a processor.

type ProcessorJob 

type ProcessorJob struct {

	// The id of the processor job.
	Id *string `mandatory:"true" json:"id"`

	// The compartment identifier.
	CompartmentId *string `mandatory:"true" json:"compartmentId"`

	ProcessorConfig ProcessorConfig `mandatory:"true" json:"processorConfig"`

	// The job acceptance time.
	TimeAccepted *common.SDKTime `mandatory:"true" json:"timeAccepted"`

	OutputLocation *OutputLocation `mandatory:"true" json:"outputLocation"`

	// The current state of the processor job.
	LifecycleState ProcessorJobLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`

	// The display name of the processor job.
	DisplayName *string `mandatory:"false" json:"displayName"`

	InputLocation InputLocation `mandatory:"false" json:"inputLocation"`

	// The job start time.
	TimeStarted *common.SDKTime `mandatory:"false" json:"timeStarted"`

	// The job finish time.
	TimeFinished *common.SDKTime `mandatory:"false" json:"timeFinished"`

	// How much progress the operation has made, compared to the total amount of work to be performed.
	PercentComplete *float32 `mandatory:"false" json:"percentComplete"`

	// The detailed status of FAILED state.
	LifecycleDetails ProcessorJobLifecycleDetailsEnum `mandatory:"false" json:"lifecycleDetails,omitempty"`
}

ProcessorJob Details of a processor job.

func (ProcessorJob) String 

func (m ProcessorJob) String() string

func (*ProcessorJob) UnmarshalJSON 

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

UnmarshalJSON unmarshals from json

func (ProcessorJob) ValidateEnumValue 

func (m ProcessorJob) 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 ProcessorJobLifecycleDetailsEnum 

type ProcessorJobLifecycleDetailsEnum string

ProcessorJobLifecycleDetailsEnum Enum with underlying type: string 

const (
	ProcessorJobLifecycleDetailsPartiallySucceeded ProcessorJobLifecycleDetailsEnum = "PARTIALLY_SUCCEEDED"
	ProcessorJobLifecycleDetailsCompletelyFailed   ProcessorJobLifecycleDetailsEnum = "COMPLETELY_FAILED"
)

Set of constants representing the allowable values for ProcessorJobLifecycleDetailsEnum

func GetMappingProcessorJobLifecycleDetailsEnum 

func GetMappingProcessorJobLifecycleDetailsEnum(val string) (ProcessorJobLifecycleDetailsEnum, bool)

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

func GetProcessorJobLifecycleDetailsEnumValues 

func GetProcessorJobLifecycleDetailsEnumValues() []ProcessorJobLifecycleDetailsEnum

GetProcessorJobLifecycleDetailsEnumValues Enumerates the set of values for ProcessorJobLifecycleDetailsEnum

type ProcessorJobLifecycleStateEnum 

type ProcessorJobLifecycleStateEnum string

ProcessorJobLifecycleStateEnum Enum with underlying type: string 

const (
	ProcessorJobLifecycleStateSucceeded  ProcessorJobLifecycleStateEnum = "SUCCEEDED"
	ProcessorJobLifecycleStateFailed     ProcessorJobLifecycleStateEnum = "FAILED"
	ProcessorJobLifecycleStateAccepted   ProcessorJobLifecycleStateEnum = "ACCEPTED"
	ProcessorJobLifecycleStateCanceled   ProcessorJobLifecycleStateEnum = "CANCELED"
	ProcessorJobLifecycleStateInProgress ProcessorJobLifecycleStateEnum = "IN_PROGRESS"
	ProcessorJobLifecycleStateCanceling  ProcessorJobLifecycleStateEnum = "CANCELING"
)

Set of constants representing the allowable values for ProcessorJobLifecycleStateEnum

func GetMappingProcessorJobLifecycleStateEnum 

func GetMappingProcessorJobLifecycleStateEnum(val string) (ProcessorJobLifecycleStateEnum, bool)

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

func GetProcessorJobLifecycleStateEnumValues 

func GetProcessorJobLifecycleStateEnumValues() []ProcessorJobLifecycleStateEnum

GetProcessorJobLifecycleStateEnumValues Enumerates the set of values for ProcessorJobLifecycleStateEnum

type ProcessorTypeEnum 

type ProcessorTypeEnum string

ProcessorTypeEnum Enum with underlying type: string 

const (
	ProcessorTypeGeneral ProcessorTypeEnum = "GENERAL"
)

Set of constants representing the allowable values for ProcessorTypeEnum

func GetMappingProcessorTypeEnum 

func GetMappingProcessorTypeEnum(val string) (ProcessorTypeEnum, bool)

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

func GetProcessorTypeEnumValues 

func GetProcessorTypeEnumValues() []ProcessorTypeEnum

GetProcessorTypeEnumValues Enumerates the set of values for ProcessorTypeEnum

type Project added in v65.41.0 

type Project struct {

	// A unique identifier that is immutable after creation.
	Id *string `mandatory:"true" json:"id"`

	// The compartment identifier.
	CompartmentId *string `mandatory:"true" json:"compartmentId"`

	// When the project was created, as an RFC3339 datetime string.
	TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`

	// The current state of the project.
	LifecycleState ProjectLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`

	// A human-friendly name for the project, which can be changed.
	DisplayName *string `mandatory:"false" json:"displayName"`

	// An optional description of the project.
	Description *string `mandatory:"false" json:"description"`

	// When the project was updated, as an RFC3339 datetime string.
	TimeUpdated *common.SDKTime `mandatory:"false" json:"timeUpdated"`

	// A message describing the current state in more detail, that can provide actionable information if creation failed.
	LifecycleDetails *string `mandatory:"false" json:"lifecycleDetails"`

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

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

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

	// Locks associated with this resource.
	Locks []ResourceLock `mandatory:"false" json:"locks"`
}

Project A Document Project containing models.

func (Project) String added in v65.41.0 

func (m Project) String() string

func (Project) ValidateEnumValue added in v65.41.0 

func (m Project) 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 ProjectCollection added in v65.41.0 

type ProjectCollection struct {

	// List of projects.
	Items []ProjectSummary `mandatory:"true" json:"items"`
}

ProjectCollection The results of a project search.

func (ProjectCollection) String added in v65.41.0 

func (m ProjectCollection) String() string

func (ProjectCollection) ValidateEnumValue added in v65.41.0 

func (m ProjectCollection) 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 ProjectLifecycleStateEnum added in v65.41.0 

type ProjectLifecycleStateEnum string

ProjectLifecycleStateEnum Enum with underlying type: string 

const (
	ProjectLifecycleStateCreating ProjectLifecycleStateEnum = "CREATING"
	ProjectLifecycleStateUpdating ProjectLifecycleStateEnum = "UPDATING"
	ProjectLifecycleStateActive   ProjectLifecycleStateEnum = "ACTIVE"
	ProjectLifecycleStateDeleting ProjectLifecycleStateEnum = "DELETING"
	ProjectLifecycleStateDeleted  ProjectLifecycleStateEnum = "DELETED"
	ProjectLifecycleStateFailed   ProjectLifecycleStateEnum = "FAILED"
)

Set of constants representing the allowable values for ProjectLifecycleStateEnum

func GetMappingProjectLifecycleStateEnum added in v65.41.0 

func GetMappingProjectLifecycleStateEnum(val string) (ProjectLifecycleStateEnum, bool)

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

func GetProjectLifecycleStateEnumValues added in v65.41.0 

func GetProjectLifecycleStateEnumValues() []ProjectLifecycleStateEnum

GetProjectLifecycleStateEnumValues Enumerates the set of values for ProjectLifecycleStateEnum

type ProjectSummary added in v65.41.0 

type ProjectSummary struct {

	// A unique identifier that is immutable after creation.
	Id *string `mandatory:"true" json:"id"`

	// The compartment identifier.
	CompartmentId *string `mandatory:"true" json:"compartmentId"`

	// When the project was created, as an RFC3339 datetime string.
	TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`

	// The current state of the project.
	LifecycleState ProjectLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`

	// A human-friendly name for the project, that can be changed.
	DisplayName *string `mandatory:"false" json:"displayName"`

	// An optional description of the project.
	Description *string `mandatory:"false" json:"description"`

	// When the project was created, as an RFC3339 datetime string.
	TimeUpdated *common.SDKTime `mandatory:"false" json:"timeUpdated"`

	// A message describing the current state in more detail, that can provide actionable information if creation failed.
	LifecycleDetails *string `mandatory:"false" json:"lifecycleDetails"`

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

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

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

ProjectSummary the metadata about the project.

func (ProjectSummary) String added in v65.41.0 

func (m ProjectSummary) String() string

func (ProjectSummary) ValidateEnumValue added in v65.41.0 

func (m ProjectSummary) 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 RemoveModelLockDetails added in v65.73.0 

type RemoveModelLockDetails struct {

	// Type of the lock.
	Type RemoveModelLockDetailsTypeEnum `mandatory:"true" json:"type"`
}

RemoveModelLockDetails Request payload to remove lock to the resource.

func (RemoveModelLockDetails) String added in v65.73.0 

func (m RemoveModelLockDetails) String() string

func (RemoveModelLockDetails) ValidateEnumValue added in v65.73.0 

func (m RemoveModelLockDetails) 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 RemoveModelLockDetailsTypeEnum added in v65.73.0 

type RemoveModelLockDetailsTypeEnum string

RemoveModelLockDetailsTypeEnum Enum with underlying type: string 

const (
	RemoveModelLockDetailsTypeFull   RemoveModelLockDetailsTypeEnum = "FULL"
	RemoveModelLockDetailsTypeDelete RemoveModelLockDetailsTypeEnum = "DELETE"
)

Set of constants representing the allowable values for RemoveModelLockDetailsTypeEnum

func GetMappingRemoveModelLockDetailsTypeEnum added in v65.73.0 

func GetMappingRemoveModelLockDetailsTypeEnum(val string) (RemoveModelLockDetailsTypeEnum, bool)

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

func GetRemoveModelLockDetailsTypeEnumValues added in v65.73.0 

func GetRemoveModelLockDetailsTypeEnumValues() []RemoveModelLockDetailsTypeEnum

GetRemoveModelLockDetailsTypeEnumValues Enumerates the set of values for RemoveModelLockDetailsTypeEnum

type RemoveModelLockRequest added in v65.73.0 

type RemoveModelLockRequest struct {

	// A unique model identifier.
	ModelId *string `mandatory:"true" contributesTo:"path" name:"modelId"`

	// Request payload to remove lock to the resource.
	RemoveModelLockDetails `contributesTo:"body"`

	// A token that uniquely identifies a request so it can be retried in case of a timeout or
	// server error without the risk of executing that same action again. Retry tokens expire after 24
	// hours, but can be invalidated before then due to conflicting operations. For example, if a resource
	// has been deleted and purged from the system, then a retry of the original creation request
	// might be rejected.
	OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`

	// The client request ID for tracing.
	OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`

	// For optimistic concurrency control. In the PUT or DELETE call
	// for a resource, set the `if-match` parameter to the value of the
	// etag from a previous GET or POST response for that resource.
	// The resource will be updated or deleted only if the etag you
	// provide matches the resource's current etag value.
	IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`

	// Whether to override locks (if any exist).
	IsLockOverride *bool `mandatory:"false" contributesTo:"query" name:"isLockOverride"`

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

RemoveModelLockRequest wrapper for the RemoveModelLock operation

See also

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

func (RemoveModelLockRequest) BinaryRequestBody added in v65.73.0 

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

BinaryRequestBody implements the OCIRequest interface

func (RemoveModelLockRequest) HTTPRequest added in v65.73.0 

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

HTTPRequest implements the OCIRequest interface

func (RemoveModelLockRequest) RetryPolicy added in v65.73.0 

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

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

func (RemoveModelLockRequest) String added in v65.73.0 

func (request RemoveModelLockRequest) String() string

func (RemoveModelLockRequest) ValidateEnumValue added in v65.73.0 

func (request RemoveModelLockRequest) 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 RemoveModelLockResponse added in v65.73.0 

type RemoveModelLockResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// The Model instance
	Model `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"`
}

RemoveModelLockResponse wrapper for the RemoveModelLock operation

func (RemoveModelLockResponse) HTTPResponse added in v65.73.0 

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

HTTPResponse implements the OCIResponse interface

func (RemoveModelLockResponse) String added in v65.73.0 

func (response RemoveModelLockResponse) String() string

type RemoveProjectLockDetails added in v65.73.0 

type RemoveProjectLockDetails struct {

	// Type of the lock.
	Type RemoveProjectLockDetailsTypeEnum `mandatory:"true" json:"type"`
}

RemoveProjectLockDetails Request payload to remove lock to the resource.

func (RemoveProjectLockDetails) String added in v65.73.0 

func (m RemoveProjectLockDetails) String() string

func (RemoveProjectLockDetails) ValidateEnumValue added in v65.73.0 

func (m RemoveProjectLockDetails) 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 RemoveProjectLockDetailsTypeEnum added in v65.73.0 

type RemoveProjectLockDetailsTypeEnum string

RemoveProjectLockDetailsTypeEnum Enum with underlying type: string 

const (
	RemoveProjectLockDetailsTypeFull   RemoveProjectLockDetailsTypeEnum = "FULL"
	RemoveProjectLockDetailsTypeDelete RemoveProjectLockDetailsTypeEnum = "DELETE"
)

Set of constants representing the allowable values for RemoveProjectLockDetailsTypeEnum

func GetMappingRemoveProjectLockDetailsTypeEnum added in v65.73.0 

func GetMappingRemoveProjectLockDetailsTypeEnum(val string) (RemoveProjectLockDetailsTypeEnum, bool)

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

func GetRemoveProjectLockDetailsTypeEnumValues added in v65.73.0 

func GetRemoveProjectLockDetailsTypeEnumValues() []RemoveProjectLockDetailsTypeEnum

GetRemoveProjectLockDetailsTypeEnumValues Enumerates the set of values for RemoveProjectLockDetailsTypeEnum

type RemoveProjectLockRequest added in v65.73.0 

type RemoveProjectLockRequest struct {

	// A unique project identifier.
	ProjectId *string `mandatory:"true" contributesTo:"path" name:"projectId"`

	// Request payload to remove lock to the resource.
	RemoveProjectLockDetails `contributesTo:"body"`

	// A token that uniquely identifies a request so it can be retried in case of a timeout or
	// server error without the risk of executing that same action again. Retry tokens expire after 24
	// hours, but can be invalidated before then due to conflicting operations. For example, if a resource
	// has been deleted and purged from the system, then a retry of the original creation request
	// might be rejected.
	OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`

	// The client request ID for tracing.
	OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`

	// For optimistic concurrency control. In the PUT or DELETE call
	// for a resource, set the `if-match` parameter to the value of the
	// etag from a previous GET or POST response for that resource.
	// The resource will be updated or deleted only if the etag you
	// provide matches the resource's current etag value.
	IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`

	// Whether to override locks (if any exist).
	IsLockOverride *bool `mandatory:"false" contributesTo:"query" name:"isLockOverride"`

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

RemoveProjectLockRequest wrapper for the RemoveProjectLock operation

See also

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

func (RemoveProjectLockRequest) BinaryRequestBody added in v65.73.0 

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

BinaryRequestBody implements the OCIRequest interface

func (RemoveProjectLockRequest) HTTPRequest added in v65.73.0 

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

HTTPRequest implements the OCIRequest interface

func (RemoveProjectLockRequest) RetryPolicy added in v65.73.0 

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

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

func (RemoveProjectLockRequest) String added in v65.73.0 

func (request RemoveProjectLockRequest) String() string

func (RemoveProjectLockRequest) ValidateEnumValue added in v65.73.0 

func (request RemoveProjectLockRequest) 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 RemoveProjectLockResponse added in v65.73.0 

type RemoveProjectLockResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// The Project instance
	Project `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"`
}

RemoveProjectLockResponse wrapper for the RemoveProjectLock operation

func (RemoveProjectLockResponse) HTTPResponse added in v65.73.0 

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

HTTPResponse implements the OCIResponse interface

func (RemoveProjectLockResponse) String added in v65.73.0 

func (response RemoveProjectLockResponse) String() string

type ResourceLock added in v65.73.0 

type ResourceLock struct {

	// Lock type.
	Type ResourceLockTypeEnum `mandatory:"true" json:"type"`

	// The lock compartment ID.
	CompartmentId *string `mandatory:"true" json:"compartmentId"`

	// The resource ID that is locking this resource. Indicates that deleting this resource removes the lock.
	RelatedResourceId *string `mandatory:"false" json:"relatedResourceId"`

	// A message added by the lock creator. The message typically gives an
	// indication of why the resource is locked.
	Message *string `mandatory:"false" json:"message"`

	// Indicates when the lock was created, in the format defined by RFC 3339.
	TimeCreated *common.SDKTime `mandatory:"false" json:"timeCreated"`
}

ResourceLock Resource locks prevent certain APIs from being called for the resource. A full lock prevents both updating and deleting the resource. A lock delete prevents deleting the resource.

func (ResourceLock) String added in v65.73.0 

func (m ResourceLock) String() string

func (ResourceLock) ValidateEnumValue added in v65.73.0 

func (m ResourceLock) 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 ResourceLockTypeEnum added in v65.73.0 

type ResourceLockTypeEnum string

ResourceLockTypeEnum Enum with underlying type: string 

const (
	ResourceLockTypeFull   ResourceLockTypeEnum = "FULL"
	ResourceLockTypeDelete ResourceLockTypeEnum = "DELETE"
)

Set of constants representing the allowable values for ResourceLockTypeEnum

func GetMappingResourceLockTypeEnum added in v65.73.0 

func GetMappingResourceLockTypeEnum(val string) (ResourceLockTypeEnum, bool)

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

func GetResourceLockTypeEnumValues added in v65.73.0 

func GetResourceLockTypeEnumValues() []ResourceLockTypeEnum

GetResourceLockTypeEnumValues Enumerates the set of values for ResourceLockTypeEnum

type SortOrderEnum added in v65.41.0 

type SortOrderEnum string

SortOrderEnum Enum with underlying type: string 

const (
	SortOrderAsc  SortOrderEnum = "ASC"
	SortOrderDesc SortOrderEnum = "DESC"
)

Set of constants representing the allowable values for SortOrderEnum

func GetMappingSortOrderEnum added in v65.41.0 

func GetMappingSortOrderEnum(val string) (SortOrderEnum, bool)

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

func GetSortOrderEnumValues added in v65.41.0 

func GetSortOrderEnumValues() []SortOrderEnum

GetSortOrderEnumValues Enumerates the set of values for SortOrderEnum

type Table 

type Table struct {

	// The number of rows.
	RowCount *int `mandatory:"true" json:"rowCount"`

	// The number of columns.
	ColumnCount *int `mandatory:"true" json:"columnCount"`

	// The header rows.
	HeaderRows []TableRow `mandatory:"true" json:"headerRows"`

	// The body rows.
	BodyRows []TableRow `mandatory:"true" json:"bodyRows"`

	// the footer rows.
	FooterRows []TableRow `mandatory:"true" json:"footerRows"`

	// The confidence score between 0 and 1.
	Confidence *float32 `mandatory:"true" json:"confidence"`

	BoundingPolygon *BoundingPolygon `mandatory:"true" json:"boundingPolygon"`
}

Table The table extracted from a document.

func (Table) String 

func (m Table) String() string

func (Table) ValidateEnumValue 

func (m Table) 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 TableRow 

type TableRow struct {

	// The cells in the row.
	Cells []Cell `mandatory:"true" json:"cells"`
}

TableRow A single row in a table.

func (TableRow) String 

func (m TableRow) String() string

func (TableRow) ValidateEnumValue 

func (m TableRow) 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 UpdateModelDetails added in v65.41.0 

type UpdateModelDetails struct {

	// A human-friendly name of the model, which can be changed.
	DisplayName *string `mandatory:"false" json:"displayName"`

	// An optional description of the model.
	Description *string `mandatory:"false" json:"description"`

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

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

UpdateModelDetails The metadata which can be edited after model creation.

func (UpdateModelDetails) String added in v65.41.0 

func (m UpdateModelDetails) String() string

func (UpdateModelDetails) ValidateEnumValue added in v65.41.0 

func (m UpdateModelDetails) 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 UpdateModelRequest added in v65.41.0 

type UpdateModelRequest struct {

	// A unique model identifier.
	ModelId *string `mandatory:"true" contributesTo:"path" name:"modelId"`

	// The model metadata to be updated.
	UpdateModelDetails `contributesTo:"body"`

	// For optimistic concurrency control. In the PUT or DELETE call
	// for a resource, set the `if-match` parameter to the value of the
	// etag from a previous GET or POST response for that resource.
	// The resource will be updated or deleted only if the etag you
	// provide matches the resource's current etag value.
	IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`

	// The client request ID for tracing.
	OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`

	// Whether to override locks (if any exist).
	IsLockOverride *bool `mandatory:"false" contributesTo:"query" name:"isLockOverride"`

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

UpdateModelRequest wrapper for the UpdateModel operation

See also

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

func (UpdateModelRequest) BinaryRequestBody added in v65.41.0 

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

BinaryRequestBody implements the OCIRequest interface

func (UpdateModelRequest) HTTPRequest added in v65.41.0 

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

HTTPRequest implements the OCIRequest interface

func (UpdateModelRequest) RetryPolicy added in v65.41.0 

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

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

func (UpdateModelRequest) String added in v65.41.0 

func (request UpdateModelRequest) String() string

func (UpdateModelRequest) ValidateEnumValue added in v65.41.0 

func (request UpdateModelRequest) 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 UpdateModelResponse added in v65.41.0 

type UpdateModelResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// A unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation.
	OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`

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

UpdateModelResponse wrapper for the UpdateModel operation

func (UpdateModelResponse) HTTPResponse added in v65.41.0 

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

HTTPResponse implements the OCIResponse interface

func (UpdateModelResponse) String added in v65.41.0 

func (response UpdateModelResponse) String() string

type UpdateProjectDetails added in v65.41.0 

type UpdateProjectDetails struct {

	// A human-friendly name for the project, that can be changed.
	DisplayName *string `mandatory:"false" json:"displayName"`

	// An optional description of the project.
	Description *string `mandatory:"false" json:"description"`

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

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

UpdateProjectDetails The metadata that can be edited after project creation.

func (UpdateProjectDetails) String added in v65.41.0 

func (m UpdateProjectDetails) String() string

func (UpdateProjectDetails) ValidateEnumValue added in v65.41.0 

func (m UpdateProjectDetails) 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 UpdateProjectRequest added in v65.41.0 

type UpdateProjectRequest struct {

	// A unique project identifier.
	ProjectId *string `mandatory:"true" contributesTo:"path" name:"projectId"`

	// The project metadata to be updated.
	UpdateProjectDetails `contributesTo:"body"`

	// For optimistic concurrency control. In the PUT or DELETE call
	// for a resource, set the `if-match` parameter to the value of the
	// etag from a previous GET or POST response for that resource.
	// The resource will be updated or deleted only if the etag you
	// provide matches the resource's current etag value.
	IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`

	// The client request ID for tracing.
	OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`

	// Whether to override locks (if any exist).
	IsLockOverride *bool `mandatory:"false" contributesTo:"query" name:"isLockOverride"`

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

UpdateProjectRequest wrapper for the UpdateProject operation

See also

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

func (UpdateProjectRequest) BinaryRequestBody added in v65.41.0 

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

BinaryRequestBody implements the OCIRequest interface

func (UpdateProjectRequest) HTTPRequest added in v65.41.0 

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

HTTPRequest implements the OCIRequest interface

func (UpdateProjectRequest) RetryPolicy added in v65.41.0 

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

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

func (UpdateProjectRequest) String added in v65.41.0 

func (request UpdateProjectRequest) String() string

func (UpdateProjectRequest) ValidateEnumValue added in v65.41.0 

func (request UpdateProjectRequest) 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 UpdateProjectResponse added in v65.41.0 

type UpdateProjectResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// A unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation.
	OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`

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

UpdateProjectResponse wrapper for the UpdateProject operation

func (UpdateProjectResponse) HTTPResponse added in v65.41.0 

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

HTTPResponse implements the OCIResponse interface

func (UpdateProjectResponse) String added in v65.41.0 

func (response UpdateProjectResponse) String() string

type ValueArray 

type ValueArray struct {

	// The confidence score between 0 and 1.
	Confidence *float32 `mandatory:"true" json:"confidence"`

	BoundingPolygon *BoundingPolygon `mandatory:"true" json:"boundingPolygon"`

	// The indexes of the words in the field value.
	WordIndexes []int `mandatory:"true" json:"wordIndexes"`

	// The array of values.
	Items []DocumentField `mandatory:"true" json:"items"`

	// The detected text of a field.
	Text *string `mandatory:"false" json:"text"`
}

ValueArray The array of field values.

func (ValueArray) GetBoundingPolygon 

func (m ValueArray) GetBoundingPolygon() *BoundingPolygon

GetBoundingPolygon returns BoundingPolygon

func (ValueArray) GetConfidence 

func (m ValueArray) GetConfidence() *float32

GetConfidence returns Confidence

func (ValueArray) GetText 

func (m ValueArray) GetText() *string

GetText returns Text

func (ValueArray) GetWordIndexes 

func (m ValueArray) GetWordIndexes() []int

GetWordIndexes returns WordIndexes

func (ValueArray) MarshalJSON 

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

MarshalJSON marshals to json representation

func (ValueArray) String 

func (m ValueArray) String() string

func (ValueArray) ValidateEnumValue 

func (m ValueArray) 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 ValueDate 

type ValueDate struct {

	// The confidence score between 0 and 1.
	Confidence *float32 `mandatory:"true" json:"confidence"`

	BoundingPolygon *BoundingPolygon `mandatory:"true" json:"boundingPolygon"`

	// The indexes of the words in the field value.
	WordIndexes []int `mandatory:"true" json:"wordIndexes"`

	// The date field value as yyyy-mm-dd.
	Value *common.SDKTime `mandatory:"true" json:"value"`

	// The detected text of a field.
	Text *string `mandatory:"false" json:"text"`
}

ValueDate The date field value.

func (ValueDate) GetBoundingPolygon 

func (m ValueDate) GetBoundingPolygon() *BoundingPolygon

GetBoundingPolygon returns BoundingPolygon

func (ValueDate) GetConfidence 

func (m ValueDate) GetConfidence() *float32

GetConfidence returns Confidence

func (ValueDate) GetText 

func (m ValueDate) GetText() *string

GetText returns Text

func (ValueDate) GetWordIndexes 

func (m ValueDate) GetWordIndexes() []int

GetWordIndexes returns WordIndexes

func (ValueDate) MarshalJSON 

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

MarshalJSON marshals to json representation

func (ValueDate) String 

func (m ValueDate) String() string

func (ValueDate) ValidateEnumValue 

func (m ValueDate) 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 ValueInteger 

type ValueInteger struct {

	// The confidence score between 0 and 1.
	Confidence *float32 `mandatory:"true" json:"confidence"`

	BoundingPolygon *BoundingPolygon `mandatory:"true" json:"boundingPolygon"`

	// The indexes of the words in the field value.
	WordIndexes []int `mandatory:"true" json:"wordIndexes"`

	// The integer value.
	Value *int `mandatory:"true" json:"value"`

	// The detected text of a field.
	Text *string `mandatory:"false" json:"text"`
}

ValueInteger The integer field value.

func (ValueInteger) GetBoundingPolygon 

func (m ValueInteger) GetBoundingPolygon() *BoundingPolygon

GetBoundingPolygon returns BoundingPolygon

func (ValueInteger) GetConfidence 

func (m ValueInteger) GetConfidence() *float32

GetConfidence returns Confidence

func (ValueInteger) GetText 

func (m ValueInteger) GetText() *string

GetText returns Text

func (ValueInteger) GetWordIndexes 

func (m ValueInteger) GetWordIndexes() []int

GetWordIndexes returns WordIndexes

func (ValueInteger) MarshalJSON 

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

MarshalJSON marshals to json representation

func (ValueInteger) String 

func (m ValueInteger) String() string

func (ValueInteger) ValidateEnumValue 

func (m ValueInteger) 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 ValueNumber 

type ValueNumber struct {

	// The confidence score between 0 and 1.
	Confidence *float32 `mandatory:"true" json:"confidence"`

	BoundingPolygon *BoundingPolygon `mandatory:"true" json:"boundingPolygon"`

	// The indexes of the words in the field value.
	WordIndexes []int `mandatory:"true" json:"wordIndexes"`

	// The number value.
	Value *float32 `mandatory:"true" json:"value"`

	// The detected text of a field.
	Text *string `mandatory:"false" json:"text"`
}

ValueNumber The floating point number field value.

func (ValueNumber) GetBoundingPolygon 

func (m ValueNumber) GetBoundingPolygon() *BoundingPolygon

GetBoundingPolygon returns BoundingPolygon

func (ValueNumber) GetConfidence 

func (m ValueNumber) GetConfidence() *float32

GetConfidence returns Confidence

func (ValueNumber) GetText 

func (m ValueNumber) GetText() *string

GetText returns Text

func (ValueNumber) GetWordIndexes 

func (m ValueNumber) GetWordIndexes() []int

GetWordIndexes returns WordIndexes

func (ValueNumber) MarshalJSON 

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

MarshalJSON marshals to json representation

func (ValueNumber) String 

func (m ValueNumber) String() string

func (ValueNumber) ValidateEnumValue 

func (m ValueNumber) 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 ValuePhoneNumber 

type ValuePhoneNumber struct {

	// The confidence score between 0 and 1.
	Confidence *float32 `mandatory:"true" json:"confidence"`

	BoundingPolygon *BoundingPolygon `mandatory:"true" json:"boundingPolygon"`

	// The indexes of the words in the field value.
	WordIndexes []int `mandatory:"true" json:"wordIndexes"`

	// The phone number field value.
	Value *string `mandatory:"true" json:"value"`

	// The detected text of a field.
	Text *string `mandatory:"false" json:"text"`
}

ValuePhoneNumber The phone number field value.

func (ValuePhoneNumber) GetBoundingPolygon 

func (m ValuePhoneNumber) GetBoundingPolygon() *BoundingPolygon

GetBoundingPolygon returns BoundingPolygon

func (ValuePhoneNumber) GetConfidence 

func (m ValuePhoneNumber) GetConfidence() *float32

GetConfidence returns Confidence

func (ValuePhoneNumber) GetText 

func (m ValuePhoneNumber) GetText() *string

GetText returns Text

func (ValuePhoneNumber) GetWordIndexes 

func (m ValuePhoneNumber) GetWordIndexes() []int

GetWordIndexes returns WordIndexes

func (ValuePhoneNumber) MarshalJSON 

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

MarshalJSON marshals to json representation

func (ValuePhoneNumber) String 

func (m ValuePhoneNumber) String() string

func (ValuePhoneNumber) ValidateEnumValue 

func (m ValuePhoneNumber) 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 ValueString 

type ValueString struct {

	// The confidence score between 0 and 1.
	Confidence *float32 `mandatory:"true" json:"confidence"`

	BoundingPolygon *BoundingPolygon `mandatory:"true" json:"boundingPolygon"`

	// The indexes of the words in the field value.
	WordIndexes []int `mandatory:"true" json:"wordIndexes"`

	// The string text.
	Value *string `mandatory:"true" json:"value"`

	// The detected text of a field.
	Text *string `mandatory:"false" json:"text"`
}

ValueString The string field value.

func (ValueString) GetBoundingPolygon 

func (m ValueString) GetBoundingPolygon() *BoundingPolygon

GetBoundingPolygon returns BoundingPolygon

func (ValueString) GetConfidence 

func (m ValueString) GetConfidence() *float32

GetConfidence returns Confidence

func (ValueString) GetText 

func (m ValueString) GetText() *string

GetText returns Text

func (ValueString) GetWordIndexes 

func (m ValueString) GetWordIndexes() []int

GetWordIndexes returns WordIndexes

func (ValueString) MarshalJSON 

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

MarshalJSON marshals to json representation

func (ValueString) String 

func (m ValueString) String() string

func (ValueString) ValidateEnumValue 

func (m ValueString) 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 ValueTime 

type ValueTime struct {

	// The confidence score between 0 and 1.
	Confidence *float32 `mandatory:"true" json:"confidence"`

	BoundingPolygon *BoundingPolygon `mandatory:"true" json:"boundingPolygon"`

	// The indexes of the words in the field value.
	WordIndexes []int `mandatory:"true" json:"wordIndexes"`

	// The time field value as yyyy-mm-dd hh-mm-ss.
	Value *common.SDKTime `mandatory:"true" json:"value"`

	// The detected text of a field.
	Text *string `mandatory:"false" json:"text"`
}

ValueTime The time field value.

func (ValueTime) GetBoundingPolygon 

func (m ValueTime) GetBoundingPolygon() *BoundingPolygon

GetBoundingPolygon returns BoundingPolygon

func (ValueTime) GetConfidence 

func (m ValueTime) GetConfidence() *float32

GetConfidence returns Confidence

func (ValueTime) GetText 

func (m ValueTime) GetText() *string

GetText returns Text

func (ValueTime) GetWordIndexes 

func (m ValueTime) GetWordIndexes() []int

GetWordIndexes returns WordIndexes

func (ValueTime) MarshalJSON 

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

MarshalJSON marshals to json representation

func (ValueTime) String 

func (m ValueTime) String() string

func (ValueTime) ValidateEnumValue 

func (m ValueTime) 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 Word 

type Word struct {

	// The string of text characters in the word.
	Text *string `mandatory:"true" json:"text"`

	// the confidence score between 0 and 1.
	Confidence *float32 `mandatory:"true" json:"confidence"`

	BoundingPolygon *BoundingPolygon `mandatory:"true" json:"boundingPolygon"`
}

Word A single word.

func (Word) String 

func (m Word) String() string

func (Word) ValidateEnumValue 

func (m Word) 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 WorkRequest added in v65.41.0 

type WorkRequest struct {

	// The type of work request.
	OperationType OperationTypeEnum `mandatory:"true" json:"operationType"`

	// The status of the current work request.
	Status OperationStatusEnum `mandatory:"true" json:"status"`

	// The ID of the work request.
	Id *string `mandatory:"true" json:"id"`

	// The compartment identifier.
	CompartmentId *string `mandatory:"true" json:"compartmentId"`

	// The resources affected by this work request.
	Resources []WorkRequestResource `mandatory:"true" json:"resources"`

	// The percentage of the request completed.
	PercentComplete *float32 `mandatory:"true" json:"percentComplete"`

	// The date and time the request was created, as described in
	// RFC 3339 (https://tools.ietf.org/rfc/rfc3339), section 14.29.
	TimeAccepted *common.SDKTime `mandatory:"true" json:"timeAccepted"`

	// The date and time the request was started, as described in RFC 3339 (https://tools.ietf.org/rfc/rfc3339),
	// section 14.29.
	TimeStarted *common.SDKTime `mandatory:"false" json:"timeStarted"`

	// The date and time the object was finished, as described in RFC 3339 (https://tools.ietf.org/rfc/rfc3339).
	TimeFinished *common.SDKTime `mandatory:"false" json:"timeFinished"`
}

WorkRequest The workrequest status details.

func (WorkRequest) String added in v65.41.0 

func (m WorkRequest) String() string

func (WorkRequest) ValidateEnumValue added in v65.41.0 

func (m WorkRequest) 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 WorkRequestError added in v65.41.0 

type WorkRequestError struct {

	// A machine-usable code for the error that occured. Error codes are listed on
	// (https://docs.cloud.oracle.com/Content/API/References/apierrors.htm).
	Code *string `mandatory:"true" json:"code"`

	// A human-readable description of the issue encountered.
	Message *string `mandatory:"true" json:"message"`

	// When the error occured, as an RFC3339 formatted datetime.
	Timestamp *common.SDKTime `mandatory:"true" json:"timestamp"`
}

WorkRequestError An error encountered while executing a work request.

func (WorkRequestError) String added in v65.41.0 

func (m WorkRequestError) String() string

func (WorkRequestError) ValidateEnumValue added in v65.41.0 

func (m WorkRequestError) 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 WorkRequestErrorCollection added in v65.41.0 

type WorkRequestErrorCollection struct {

	// the list of workRequestError objects.
	Items []WorkRequestError `mandatory:"true" json:"items"`
}

WorkRequestErrorCollection The results of a workRequestError search.

func (WorkRequestErrorCollection) String added in v65.41.0 

func (m WorkRequestErrorCollection) String() string

func (WorkRequestErrorCollection) ValidateEnumValue added in v65.41.0 

func (m WorkRequestErrorCollection) 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 WorkRequestLogEntry added in v65.41.0 

type WorkRequestLogEntry struct {

	// A human-readable log message.
	Message *string `mandatory:"true" json:"message"`

	// When the log message was written, as an RFC3339 formatted datetime.
	Timestamp *common.SDKTime `mandatory:"true" json:"timestamp"`
}

WorkRequestLogEntry A log message from the execution of a work request.

func (WorkRequestLogEntry) String added in v65.41.0 

func (m WorkRequestLogEntry) String() string

func (WorkRequestLogEntry) ValidateEnumValue added in v65.41.0 

func (m WorkRequestLogEntry) 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 WorkRequestLogEntryCollection added in v65.41.0 

type WorkRequestLogEntryCollection struct {

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

WorkRequestLogEntryCollection The results of a workRequestLog search.

func (WorkRequestLogEntryCollection) String added in v65.41.0 

func (m WorkRequestLogEntryCollection) String() string

func (WorkRequestLogEntryCollection) ValidateEnumValue added in v65.41.0 

func (m WorkRequestLogEntryCollection) 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 WorkRequestResource added in v65.41.0 

type WorkRequestResource struct {

	// The resource type the work request affects.
	EntityType *string `mandatory:"true" json:"entityType"`

	// The way in which this resource is affected by the work tracked in the work request.
	// A resource being created, updated, or deleted remains in the IN_PROGRESS state until
	// the work is complete for. At that point, it transitions to CREATED, UPDATED,
	// or DELETED, as appropriate.
	ActionType ActionTypeEnum `mandatory:"true" json:"actionType"`

	// The identifier of the resource the work request affects.
	Identifier *string `mandatory:"true" json:"identifier"`

	// The URI path that the user can do a GET on to access the resource metadata.
	EntityUri *string `mandatory:"false" json:"entityUri"`

	// Additional information that helps to explain the resource.
	Metadata map[string]string `mandatory:"false" json:"metadata"`
}

WorkRequestResource A resource created, or operated on, by a work request.

func (WorkRequestResource) String added in v65.41.0 

func (m WorkRequestResource) String() string

func (WorkRequestResource) ValidateEnumValue added in v65.41.0 

func (m WorkRequestResource) 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 WorkRequestResourceMetadataKeyEnum added in v65.41.0 

type WorkRequestResourceMetadataKeyEnum string

WorkRequestResourceMetadataKeyEnum Enum with underlying type: string 

const (
	WorkRequestResourceMetadataKeyIsDryRun    WorkRequestResourceMetadataKeyEnum = "IS_DRY_RUN"
	WorkRequestResourceMetadataKeyDisplayName WorkRequestResourceMetadataKeyEnum = "DISPLAY_NAME"
)

Set of constants representing the allowable values for WorkRequestResourceMetadataKeyEnum

func GetMappingWorkRequestResourceMetadataKeyEnum added in v65.41.0 

func GetMappingWorkRequestResourceMetadataKeyEnum(val string) (WorkRequestResourceMetadataKeyEnum, bool)

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

func GetWorkRequestResourceMetadataKeyEnumValues added in v65.41.0 

func GetWorkRequestResourceMetadataKeyEnumValues() []WorkRequestResourceMetadataKeyEnum

GetWorkRequestResourceMetadataKeyEnumValues Enumerates the set of values for WorkRequestResourceMetadataKeyEnum

type WorkRequestSummary added in v65.41.0 

type WorkRequestSummary struct {

	// The type of the work request.
	OperationType OperationTypeEnum `mandatory:"true" json:"operationType"`

	// The status of the current work request.
	Status OperationStatusEnum `mandatory:"true" json:"status"`

	// The ID of the work request.
	Id *string `mandatory:"true" json:"id"`

	// The compartment identifier.
	CompartmentId *string `mandatory:"true" json:"compartmentId"`

	// The resources affected by this work request.
	Resources []WorkRequestResource `mandatory:"true" json:"resources"`

	// The percentage of the request completed.
	PercentComplete *float32 `mandatory:"true" json:"percentComplete"`

	// The date and time the request was created, as described in
	// RFC 3339 (https://tools.ietf.org/rfc/rfc3339), section 14.29.
	TimeAccepted *common.SDKTime `mandatory:"true" json:"timeAccepted"`

	// The date and time the request was started, as described in RFC 3339 (https://tools.ietf.org/rfc/rfc3339),
	// section 14.29.
	TimeStarted *common.SDKTime `mandatory:"false" json:"timeStarted"`

	// The date and time the object was finished, as described in RFC 3339 (https://tools.ietf.org/rfc/rfc3339).
	TimeFinished *common.SDKTime `mandatory:"false" json:"timeFinished"`
}

WorkRequestSummary A summary of the status of a work request.

func (WorkRequestSummary) String added in v65.41.0 

func (m WorkRequestSummary) String() string

func (WorkRequestSummary) ValidateEnumValue added in v65.41.0 

func (m WorkRequestSummary) 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 WorkRequestSummaryCollection added in v65.41.0 

type WorkRequestSummaryCollection struct {

	// The list of workRequestSummary objects.
	Items []WorkRequestSummary `mandatory:"true" json:"items"`
}

WorkRequestSummaryCollection The results of a workRequest search.

func (WorkRequestSummaryCollection) String added in v65.41.0 

func (m WorkRequestSummaryCollection) String() string

func (WorkRequestSummaryCollection) ValidateEnumValue added in v65.41.0 

func (m WorkRequestSummaryCollection) 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

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.