aivision

package
v65.45.0 Latest Latest
Warning

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

 Go to latest Published: Jul 25, 2023 License: Apache-2.0, UPL-1.0 Imports: 7 Imported by: 1

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func GetActionTypeEnumStringValues 

func GetActionTypeEnumStringValues() []string

GetActionTypeEnumStringValues Enumerates the set of values in String for ActionTypeEnum

func GetDatasetDatasetTypeEnumStringValues 

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 

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 GetDocumentJobLifecycleDetailsEnumStringValues 

func GetDocumentJobLifecycleDetailsEnumStringValues() []string

GetDocumentJobLifecycleDetailsEnumStringValues Enumerates the set of values in String for DocumentJobLifecycleDetailsEnum

func GetDocumentJobLifecycleStateEnumStringValues 

func GetDocumentJobLifecycleStateEnumStringValues() []string

GetDocumentJobLifecycleStateEnumStringValues Enumerates the set of values in String for DocumentJobLifecycleStateEnum

func GetDocumentLanguageEnumStringValues 

func GetDocumentLanguageEnumStringValues() []string

GetDocumentLanguageEnumStringValues Enumerates the set of values in String for DocumentLanguageEnum

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 GetImageDetailsSourceEnumStringValues 

func GetImageDetailsSourceEnumStringValues() []string

GetImageDetailsSourceEnumStringValues Enumerates the set of values in String for ImageDetailsSourceEnum

func GetImageFeatureFeatureTypeEnumStringValues 

func GetImageFeatureFeatureTypeEnumStringValues() []string

GetImageFeatureFeatureTypeEnumStringValues Enumerates the set of values in String for ImageFeatureFeatureTypeEnum

func GetImageJobLifecycleDetailsEnumStringValues 

func GetImageJobLifecycleDetailsEnumStringValues() []string

GetImageJobLifecycleDetailsEnumStringValues Enumerates the set of values in String for ImageJobLifecycleDetailsEnum

func GetImageJobLifecycleStateEnumStringValues 

func GetImageJobLifecycleStateEnumStringValues() []string

GetImageJobLifecycleStateEnumStringValues Enumerates the set of values in String for ImageJobLifecycleStateEnum

func GetInputLocationSourceTypeEnumStringValues 

func GetInputLocationSourceTypeEnumStringValues() []string

GetInputLocationSourceTypeEnumStringValues Enumerates the set of values in String for InputLocationSourceTypeEnum

func GetListModelsSortByEnumStringValues 

func GetListModelsSortByEnumStringValues() []string

GetListModelsSortByEnumStringValues Enumerates the set of values in String for ListModelsSortByEnum

func GetListModelsSortOrderEnumStringValues 

func GetListModelsSortOrderEnumStringValues() []string

GetListModelsSortOrderEnumStringValues Enumerates the set of values in String for ListModelsSortOrderEnum

func GetListProjectsSortByEnumStringValues 

func GetListProjectsSortByEnumStringValues() []string

GetListProjectsSortByEnumStringValues Enumerates the set of values in String for ListProjectsSortByEnum

func GetListProjectsSortOrderEnumStringValues 

func GetListProjectsSortOrderEnumStringValues() []string

GetListProjectsSortOrderEnumStringValues Enumerates the set of values in String for ListProjectsSortOrderEnum

func GetListWorkRequestErrorsSortByEnumStringValues 

func GetListWorkRequestErrorsSortByEnumStringValues() []string

GetListWorkRequestErrorsSortByEnumStringValues Enumerates the set of values in String for ListWorkRequestErrorsSortByEnum

func GetListWorkRequestErrorsSortOrderEnumStringValues 

func GetListWorkRequestErrorsSortOrderEnumStringValues() []string

GetListWorkRequestErrorsSortOrderEnumStringValues Enumerates the set of values in String for ListWorkRequestErrorsSortOrderEnum

func GetListWorkRequestLogsSortByEnumStringValues 

func GetListWorkRequestLogsSortByEnumStringValues() []string

GetListWorkRequestLogsSortByEnumStringValues Enumerates the set of values in String for ListWorkRequestLogsSortByEnum

func GetListWorkRequestLogsSortOrderEnumStringValues 

func GetListWorkRequestLogsSortOrderEnumStringValues() []string

GetListWorkRequestLogsSortOrderEnumStringValues Enumerates the set of values in String for ListWorkRequestLogsSortOrderEnum

func GetListWorkRequestsSortByEnumStringValues 

func GetListWorkRequestsSortByEnumStringValues() []string

GetListWorkRequestsSortByEnumStringValues Enumerates the set of values in String for ListWorkRequestsSortByEnum

func GetListWorkRequestsSortOrderEnumStringValues 

func GetListWorkRequestsSortOrderEnumStringValues() []string

GetListWorkRequestsSortOrderEnumStringValues Enumerates the set of values in String for ListWorkRequestsSortOrderEnum

func GetListWorkRequestsStatusEnumStringValues 

func GetListWorkRequestsStatusEnumStringValues() []string

GetListWorkRequestsStatusEnumStringValues Enumerates the set of values in String for ListWorkRequestsStatusEnum

func GetModelLifecycleStateEnumStringValues 

func GetModelLifecycleStateEnumStringValues() []string

GetModelLifecycleStateEnumStringValues Enumerates the set of values in String for ModelLifecycleStateEnum

func GetModelModelTypeEnumStringValues 

func GetModelModelTypeEnumStringValues() []string

GetModelModelTypeEnumStringValues Enumerates the set of values in String for ModelModelTypeEnum

func GetOperationStatusEnumStringValues 

func GetOperationStatusEnumStringValues() []string

GetOperationStatusEnumStringValues Enumerates the set of values in String for OperationStatusEnum

func GetOperationTypeEnumStringValues 

func GetOperationTypeEnumStringValues() []string

GetOperationTypeEnumStringValues Enumerates the set of values in String for OperationTypeEnum

func GetProjectLifecycleStateEnumStringValues 

func GetProjectLifecycleStateEnumStringValues() []string

GetProjectLifecycleStateEnumStringValues Enumerates the set of values in String for ProjectLifecycleStateEnum

func GetSortOrderEnumStringValues 

func GetSortOrderEnumStringValues() []string

GetSortOrderEnumStringValues Enumerates the set of values in String for SortOrderEnum

Types

type AIServiceVisionClient 

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

AIServiceVisionClient a client for AIServiceVision

func NewAIServiceVisionClientWithConfigurationProvider 

func NewAIServiceVisionClientWithConfigurationProvider(configProvider common.ConfigurationProvider) (client AIServiceVisionClient, err error)

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

func NewAIServiceVisionClientWithOboToken 

func NewAIServiceVisionClientWithOboToken(configProvider common.ConfigurationProvider, oboToken string) (client AIServiceVisionClient, err error)

NewAIServiceVisionClientWithOboToken Creates a new default AIServiceVision 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 (AIServiceVisionClient) AnalyzeDocument 

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

AnalyzeDocument Perform different types of image analysis.

See also

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

func (AIServiceVisionClient) AnalyzeImage 

func (client AIServiceVisionClient) AnalyzeImage(ctx context.Context, request AnalyzeImageRequest) (response AnalyzeImageResponse, err error)

AnalyzeImage Perform different types of image analysis.

See also

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

func (AIServiceVisionClient) CancelDocumentJob 

func (client AIServiceVisionClient) CancelDocumentJob(ctx context.Context, request CancelDocumentJobRequest) (response CancelDocumentJobResponse, err error)

CancelDocumentJob Cancel a document batch job.

See also

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

func (AIServiceVisionClient) CancelImageJob 

func (client AIServiceVisionClient) CancelImageJob(ctx context.Context, request CancelImageJobRequest) (response CancelImageJobResponse, err error)

CancelImageJob Cancel an image batch job.

See also

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

func (AIServiceVisionClient) CancelWorkRequest 

func (client AIServiceVisionClient) 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/aivision/CancelWorkRequest.go.html to see an example of how to use CancelWorkRequest API.

func (AIServiceVisionClient) ChangeModelCompartment 

func (client AIServiceVisionClient) 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/aivision/ChangeModelCompartment.go.html to see an example of how to use ChangeModelCompartment API.

func (AIServiceVisionClient) ChangeProjectCompartment 

func (client AIServiceVisionClient) 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/aivision/ChangeProjectCompartment.go.html to see an example of how to use ChangeProjectCompartment API.

func (*AIServiceVisionClient) ConfigurationProvider 

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

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

func (AIServiceVisionClient) CreateDocumentJob 

func (client AIServiceVisionClient) CreateDocumentJob(ctx context.Context, request CreateDocumentJobRequest) (response CreateDocumentJobResponse, err error)

CreateDocumentJob Create a document analysis batch job.

See also

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

func (AIServiceVisionClient) CreateImageJob 

func (client AIServiceVisionClient) CreateImageJob(ctx context.Context, request CreateImageJobRequest) (response CreateImageJobResponse, err error)

CreateImageJob Create an image analysis batch job.

See also

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

func (AIServiceVisionClient) CreateModel 

func (client AIServiceVisionClient) 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/aivision/CreateModel.go.html to see an example of how to use CreateModel API.

func (AIServiceVisionClient) CreateProject 

func (client AIServiceVisionClient) 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/aivision/CreateProject.go.html to see an example of how to use CreateProject API.

func (AIServiceVisionClient) DeleteModel 

func (client AIServiceVisionClient) 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/aivision/DeleteModel.go.html to see an example of how to use DeleteModel API.

func (AIServiceVisionClient) DeleteProject 

func (client AIServiceVisionClient) 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/aivision/DeleteProject.go.html to see an example of how to use DeleteProject API.

func (AIServiceVisionClient) GetDocumentJob 

func (client AIServiceVisionClient) GetDocumentJob(ctx context.Context, request GetDocumentJobRequest) (response GetDocumentJobResponse, err error)

GetDocumentJob Get details of a document batch job.

See also

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

func (AIServiceVisionClient) GetImageJob 

func (client AIServiceVisionClient) GetImageJob(ctx context.Context, request GetImageJobRequest) (response GetImageJobResponse, err error)

GetImageJob Get details of an image batch job.

See also

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

func (AIServiceVisionClient) GetModel 

func (client AIServiceVisionClient) 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/aivision/GetModel.go.html to see an example of how to use GetModel API.

func (AIServiceVisionClient) GetProject 

func (client AIServiceVisionClient) 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/aivision/GetProject.go.html to see an example of how to use GetProject API.

func (AIServiceVisionClient) GetWorkRequest 

func (client AIServiceVisionClient) 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/aivision/GetWorkRequest.go.html to see an example of how to use GetWorkRequest API.

func (AIServiceVisionClient) ListModels 

func (client AIServiceVisionClient) 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/aivision/ListModels.go.html to see an example of how to use ListModels API.

func (AIServiceVisionClient) ListProjects 

func (client AIServiceVisionClient) 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/aivision/ListProjects.go.html to see an example of how to use ListProjects API.

func (AIServiceVisionClient) ListWorkRequestErrors 

func (client AIServiceVisionClient) 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/aivision/ListWorkRequestErrors.go.html to see an example of how to use ListWorkRequestErrors API.

func (AIServiceVisionClient) ListWorkRequestLogs 

func (client AIServiceVisionClient) 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/aivision/ListWorkRequestLogs.go.html to see an example of how to use ListWorkRequestLogs API.

func (AIServiceVisionClient) ListWorkRequests 

func (client AIServiceVisionClient) 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/aivision/ListWorkRequests.go.html to see an example of how to use ListWorkRequests API.

func (*AIServiceVisionClient) SetRegion 

func (client *AIServiceVisionClient) SetRegion(region string)

SetRegion overrides the region of this client.

func (AIServiceVisionClient) UpdateModel 

func (client AIServiceVisionClient) 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/aivision/UpdateModel.go.html to see an example of how to use UpdateModel API.

func (AIServiceVisionClient) UpdateProject 

func (client AIServiceVisionClient) 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/aivision/UpdateProject.go.html to see an example of how to use UpdateProject API.

type ActionTypeEnum 

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 

func GetActionTypeEnumValues() []ActionTypeEnum

GetActionTypeEnumValues Enumerates the set of values for ActionTypeEnum

func GetMappingActionTypeEnum 

func GetMappingActionTypeEnum(val string) (ActionTypeEnum, bool)

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

type AnalyzeDocumentDetails 

type AnalyzeDocumentDetails struct {

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

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

	// The OCID of the compartment that calls the API.
	CompartmentId *string `mandatory:"false" json:"compartmentId"`

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

	// The document language, abbreviated according to ISO 639-2.
	Language DocumentLanguageEnum `mandatory:"false" json:"language,omitempty"`

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

AnalyzeDocumentDetails The details of how to analyze a document.

func (AnalyzeDocumentDetails) String 

func (m AnalyzeDocumentDetails) String() string

func (*AnalyzeDocumentDetails) UnmarshalJSON 

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

UnmarshalJSON unmarshals from json

func (AnalyzeDocumentDetails) ValidateEnumValue 

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 

type AnalyzeDocumentRequest struct {

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

	// 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/aivision/AnalyzeDocument.go.html to see an example of how to use AnalyzeDocumentRequest.

func (AnalyzeDocumentRequest) BinaryRequestBody 

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

BinaryRequestBody implements the OCIRequest interface

func (AnalyzeDocumentRequest) HTTPRequest 

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 

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

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

func (AnalyzeDocumentRequest) String 

func (request AnalyzeDocumentRequest) String() string

func (AnalyzeDocumentRequest) ValidateEnumValue 

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 

type AnalyzeDocumentResponse struct {

	// The underlying http response
	RawResponse *http.Response

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

AnalyzeDocumentResponse wrapper for the AnalyzeDocument operation

func (AnalyzeDocumentResponse) HTTPResponse 

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

HTTPResponse implements the OCIResponse interface

func (AnalyzeDocumentResponse) String 

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 detection model version.
	TextDetectionModelVersion *string `mandatory:"false" json:"textDetectionModelVersion"`

	// The document keyValue detection model version.
	KeyValueDetectionModelVersion *string `mandatory:"false" json:"keyValueDetectionModelVersion"`

	// The document table detection model version.
	TableDetectionModelVersion *string `mandatory:"false" json:"tableDetectionModelVersion"`

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

type AnalyzeImageDetails struct {

	// The types of image analysis.
	Features []ImageFeature `mandatory:"true" json:"features"`

	Image ImageDetails `mandatory:"true" json:"image"`

	// The OCID of the compartment that calls the API.
	CompartmentId *string `mandatory:"false" json:"compartmentId"`
}

AnalyzeImageDetails The details of how to analyze an image.

func (AnalyzeImageDetails) String 

func (m AnalyzeImageDetails) String() string

func (*AnalyzeImageDetails) UnmarshalJSON 

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

UnmarshalJSON unmarshals from json

func (AnalyzeImageDetails) ValidateEnumValue 

func (m AnalyzeImageDetails) 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 AnalyzeImageRequest 

type AnalyzeImageRequest struct {

	// Details about how to analyze an image.
	AnalyzeImageDetails `contributesTo:"body"`

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

AnalyzeImageRequest wrapper for the AnalyzeImage operation

See also

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

func (AnalyzeImageRequest) BinaryRequestBody 

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

BinaryRequestBody implements the OCIRequest interface

func (AnalyzeImageRequest) HTTPRequest 

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

HTTPRequest implements the OCIRequest interface

func (AnalyzeImageRequest) RetryPolicy 

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

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

func (AnalyzeImageRequest) String 

func (request AnalyzeImageRequest) String() string

func (AnalyzeImageRequest) ValidateEnumValue 

func (request AnalyzeImageRequest) 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 AnalyzeImageResponse 

type AnalyzeImageResponse struct {

	// The underlying http response
	RawResponse *http.Response

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

AnalyzeImageResponse wrapper for the AnalyzeImage operation

func (AnalyzeImageResponse) HTTPResponse 

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

HTTPResponse implements the OCIResponse interface

func (AnalyzeImageResponse) String 

func (response AnalyzeImageResponse) String() string

type AnalyzeImageResult 

type AnalyzeImageResult struct {

	// The detected objects.
	ImageObjects []ImageObject `mandatory:"false" json:"imageObjects"`

	// The image classification labels.
	Labels []Label `mandatory:"false" json:"labels"`

	// The ontologyClasses of image labels.
	OntologyClasses []OntologyClass `mandatory:"false" json:"ontologyClasses"`

	ImageText *ImageText `mandatory:"false" json:"imageText"`

	// The image classification model version.
	ImageClassificationModelVersion *string `mandatory:"false" json:"imageClassificationModelVersion"`

	// The object detection model version.
	ObjectDetectionModelVersion *string `mandatory:"false" json:"objectDetectionModelVersion"`

	// The text detection model version.
	TextDetectionModelVersion *string `mandatory:"false" json:"textDetectionModelVersion"`

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

AnalyzeImageResult The image analysis results.

func (AnalyzeImageResult) String 

func (m AnalyzeImageResult) String() string

func (AnalyzeImageResult) ValidateEnumValue 

func (m AnalyzeImageResult) 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 CancelDocumentJobRequest 

type CancelDocumentJobRequest struct {

	// Document job id.
	DocumentJobId *string `mandatory:"true" contributesTo:"path" name:"documentJobId"`

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

CancelDocumentJobRequest wrapper for the CancelDocumentJob operation

See also

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

func (CancelDocumentJobRequest) BinaryRequestBody 

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

BinaryRequestBody implements the OCIRequest interface

func (CancelDocumentJobRequest) HTTPRequest 

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

HTTPRequest implements the OCIRequest interface

func (CancelDocumentJobRequest) RetryPolicy 

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

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

func (CancelDocumentJobRequest) String 

func (request CancelDocumentJobRequest) String() string

func (CancelDocumentJobRequest) ValidateEnumValue 

func (request CancelDocumentJobRequest) 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 CancelDocumentJobResponse 

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

CancelDocumentJobResponse wrapper for the CancelDocumentJob operation

func (CancelDocumentJobResponse) HTTPResponse 

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

HTTPResponse implements the OCIResponse interface

func (CancelDocumentJobResponse) String 

func (response CancelDocumentJobResponse) String() string

type CancelImageJobRequest 

type CancelImageJobRequest struct {

	// Image job id.
	ImageJobId *string `mandatory:"true" contributesTo:"path" name:"imageJobId"`

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

CancelImageJobRequest wrapper for the CancelImageJob operation

See also

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

func (CancelImageJobRequest) BinaryRequestBody 

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

BinaryRequestBody implements the OCIRequest interface

func (CancelImageJobRequest) HTTPRequest 

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

HTTPRequest implements the OCIRequest interface

func (CancelImageJobRequest) RetryPolicy 

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

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

func (CancelImageJobRequest) String 

func (request CancelImageJobRequest) String() string

func (CancelImageJobRequest) ValidateEnumValue 

func (request CancelImageJobRequest) 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 CancelImageJobResponse 

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

CancelImageJobResponse wrapper for the CancelImageJob operation

func (CancelImageJobResponse) HTTPResponse 

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

HTTPResponse implements the OCIResponse interface

func (CancelImageJobResponse) String 

func (response CancelImageJobResponse) String() string

type CancelWorkRequestRequest 

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/aivision/CancelWorkRequest.go.html to see an example of how to use CancelWorkRequestRequest.

func (CancelWorkRequestRequest) BinaryRequestBody 

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

BinaryRequestBody implements the OCIRequest interface

func (CancelWorkRequestRequest) HTTPRequest 

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 

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

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

func (CancelWorkRequestRequest) String 

func (request CancelWorkRequestRequest) String() string

func (CancelWorkRequestRequest) ValidateEnumValue 

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 

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 

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

HTTPResponse implements the OCIResponse interface

func (CancelWorkRequestResponse) String 

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 

type ChangeModelCompartmentDetails struct {

	// The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the compartment
	// into which the model should be moved.
	CompartmentId *string `mandatory:"true" json:"compartmentId"`
}

ChangeModelCompartmentDetails The compartment the model should be moved to.

func (ChangeModelCompartmentDetails) String 

func (m ChangeModelCompartmentDetails) String() string

func (ChangeModelCompartmentDetails) ValidateEnumValue 

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 

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

	// 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/aivision/ChangeModelCompartment.go.html to see an example of how to use ChangeModelCompartmentRequest.

func (ChangeModelCompartmentRequest) BinaryRequestBody 

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

BinaryRequestBody implements the OCIRequest interface

func (ChangeModelCompartmentRequest) HTTPRequest 

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 

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

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

func (ChangeModelCompartmentRequest) String 

func (request ChangeModelCompartmentRequest) String() string

func (ChangeModelCompartmentRequest) ValidateEnumValue 

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 

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 

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

HTTPResponse implements the OCIResponse interface

func (ChangeModelCompartmentResponse) String 

func (response ChangeModelCompartmentResponse) String() string

type ChangeProjectCompartmentDetails 

type ChangeProjectCompartmentDetails struct {

	// The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the compartment
	// into which the project should be moved.
	CompartmentId *string `mandatory:"true" json:"compartmentId"`
}

ChangeProjectCompartmentDetails Which compartment the project should be moved to.

func (ChangeProjectCompartmentDetails) String 

func (m ChangeProjectCompartmentDetails) String() string

func (ChangeProjectCompartmentDetails) ValidateEnumValue 

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 

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

	// 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/aivision/ChangeProjectCompartment.go.html to see an example of how to use ChangeProjectCompartmentRequest.

func (ChangeProjectCompartmentRequest) BinaryRequestBody 

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

BinaryRequestBody implements the OCIRequest interface

func (ChangeProjectCompartmentRequest) HTTPRequest 

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 

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

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

func (ChangeProjectCompartmentRequest) String 

func (request ChangeProjectCompartmentRequest) String() string

func (ChangeProjectCompartmentRequest) ValidateEnumValue 

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 

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 

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

HTTPResponse implements the OCIResponse interface

func (ChangeProjectCompartmentResponse) String 

func (response ChangeProjectCompartmentResponse) String() string

type CreateDocumentJobDetails 

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

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

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

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

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

	// The language of the document, abbreviated according to ISO 639-2.
	Language DocumentLanguageEnum `mandatory:"false" json:"language,omitempty"`

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

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

CreateDocumentJobDetails The batch document analysis details.

func (CreateDocumentJobDetails) String 

func (m CreateDocumentJobDetails) String() string

func (*CreateDocumentJobDetails) UnmarshalJSON 

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

UnmarshalJSON unmarshals from json

func (CreateDocumentJobDetails) ValidateEnumValue 

func (m CreateDocumentJobDetails) 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 CreateDocumentJobRequest 

type CreateDocumentJobRequest struct {

	// The details of the batch document analysis.
	CreateDocumentJobDetails `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
}

CreateDocumentJobRequest wrapper for the CreateDocumentJob operation

See also

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

func (CreateDocumentJobRequest) BinaryRequestBody 

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

BinaryRequestBody implements the OCIRequest interface

func (CreateDocumentJobRequest) HTTPRequest 

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

HTTPRequest implements the OCIRequest interface

func (CreateDocumentJobRequest) RetryPolicy 

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

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

func (CreateDocumentJobRequest) String 

func (request CreateDocumentJobRequest) String() string

func (CreateDocumentJobRequest) ValidateEnumValue 

func (request CreateDocumentJobRequest) 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 CreateDocumentJobResponse 

type CreateDocumentJobResponse struct {

	// The underlying http response
	RawResponse *http.Response

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

CreateDocumentJobResponse wrapper for the CreateDocumentJob operation

func (CreateDocumentJobResponse) HTTPResponse 

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

HTTPResponse implements the OCIResponse interface

func (CreateDocumentJobResponse) String 

func (response CreateDocumentJobResponse) String() string

type CreateImageJobDetails 

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

	// The list of requested image analysis types.
	Features []ImageFeature `mandatory:"true" json:"features"`

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

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

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

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

CreateImageJobDetails The details of the batch image analysis.

func (CreateImageJobDetails) String 

func (m CreateImageJobDetails) String() string

func (*CreateImageJobDetails) UnmarshalJSON 

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

UnmarshalJSON unmarshals from json

func (CreateImageJobDetails) ValidateEnumValue 

func (m CreateImageJobDetails) 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 CreateImageJobRequest 

type CreateImageJobRequest struct {

	// The details of the batch image analysis.
	CreateImageJobDetails `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
}

CreateImageJobRequest wrapper for the CreateImageJob operation

See also

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

func (CreateImageJobRequest) BinaryRequestBody 

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

BinaryRequestBody implements the OCIRequest interface

func (CreateImageJobRequest) HTTPRequest 

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

HTTPRequest implements the OCIRequest interface

func (CreateImageJobRequest) RetryPolicy 

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

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

func (CreateImageJobRequest) String 

func (request CreateImageJobRequest) String() string

func (CreateImageJobRequest) ValidateEnumValue 

func (request CreateImageJobRequest) 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 CreateImageJobResponse 

type CreateImageJobResponse struct {

	// The underlying http response
	RawResponse *http.Response

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

CreateImageJobResponse wrapper for the CreateImageJob operation

func (CreateImageJobResponse) HTTPResponse 

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

HTTPResponse implements the OCIResponse interface

func (CreateImageJobResponse) String 

func (response CreateImageJobResponse) String() string

type CreateModelDetails 

type CreateModelDetails struct {

	// Which type of Vision model this is.
	ModelType ModelModelTypeEnum `mandatory:"true" json:"modelType"`

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

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

	// 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 duration in hours, expressed as a decimal fraction.
	MaxTrainingDurationInHours *float64 `mandatory:"false" json:"maxTrainingDurationInHours"`

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

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

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

func (m CreateModelDetails) String() string

func (*CreateModelDetails) UnmarshalJSON 

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

UnmarshalJSON unmarshals from json

func (CreateModelDetails) ValidateEnumValue 

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 

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/aivision/CreateModel.go.html to see an example of how to use CreateModelRequest.

func (CreateModelRequest) BinaryRequestBody 

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

BinaryRequestBody implements the OCIRequest interface

func (CreateModelRequest) HTTPRequest 

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 

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

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

func (CreateModelRequest) String 

func (request CreateModelRequest) String() string

func (CreateModelRequest) ValidateEnumValue 

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 

type CreateModelResponse struct {

	// The underlying http response
	RawResponse *http.Response

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

CreateModelResponse wrapper for the CreateModel operation

func (CreateModelResponse) HTTPResponse 

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

HTTPResponse implements the OCIResponse interface

func (CreateModelResponse) String 

func (response CreateModelResponse) String() string

type CreateProjectDetails 

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 

func (m CreateProjectDetails) String() string

func (CreateProjectDetails) ValidateEnumValue 

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 

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/aivision/CreateProject.go.html to see an example of how to use CreateProjectRequest.

func (CreateProjectRequest) BinaryRequestBody 

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

BinaryRequestBody implements the OCIRequest interface

func (CreateProjectRequest) HTTPRequest 

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 

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

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

func (CreateProjectRequest) String 

func (request CreateProjectRequest) String() string

func (CreateProjectRequest) ValidateEnumValue 

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 

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

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

HTTPResponse implements the OCIResponse interface

func (CreateProjectResponse) String 

func (response CreateProjectResponse) String() string

type DataScienceLabelingDataset 

type DataScienceLabelingDataset struct {

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

DataScienceLabelingDataset The dataset created by the Data Labeling Service.

func (DataScienceLabelingDataset) MarshalJSON 

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

MarshalJSON marshals to json representation

func (DataScienceLabelingDataset) String 

func (m DataScienceLabelingDataset) String() string

func (DataScienceLabelingDataset) ValidateEnumValue 

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 

type Dataset interface {
}

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

type DatasetDatasetTypeEnum 

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 

func GetDatasetDatasetTypeEnumValues() []DatasetDatasetTypeEnum

GetDatasetDatasetTypeEnumValues Enumerates the set of values for DatasetDatasetTypeEnum

func GetMappingDatasetDatasetTypeEnum 

func GetMappingDatasetDatasetTypeEnum(val string) (DatasetDatasetTypeEnum, bool)

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

type DeleteModelRequest 

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

	// 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/aivision/DeleteModel.go.html to see an example of how to use DeleteModelRequest.

func (DeleteModelRequest) BinaryRequestBody 

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

BinaryRequestBody implements the OCIRequest interface

func (DeleteModelRequest) HTTPRequest 

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 

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

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

func (DeleteModelRequest) String 

func (request DeleteModelRequest) String() string

func (DeleteModelRequest) ValidateEnumValue 

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 

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 

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

HTTPResponse implements the OCIResponse interface

func (DeleteModelResponse) String 

func (response DeleteModelResponse) String() string

type DeleteProjectRequest 

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

	// 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/aivision/DeleteProject.go.html to see an example of how to use DeleteProjectRequest.

func (DeleteProjectRequest) BinaryRequestBody 

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

BinaryRequestBody implements the OCIRequest interface

func (DeleteProjectRequest) HTTPRequest 

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 

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

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

func (DeleteProjectRequest) String 

func (request DeleteProjectRequest) String() string

func (DeleteProjectRequest) ValidateEnumValue 

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 

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 

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

HTTPResponse implements the OCIResponse interface

func (DeleteProjectResponse) String 

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 language of the document, abbreviated according to ISO 639-2.
	LanguageCode DocumentLanguageEnum `mandatory:"true" json:"languageCode"`

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

type DocumentDetails interface {
}

DocumentDetails The details of a document to analyze.

type DocumentDetailsSourceEnum 

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 

func GetDocumentDetailsSourceEnumValues() []DocumentDetailsSourceEnum

GetDocumentDetailsSourceEnumValues Enumerates the set of values for DocumentDetailsSourceEnum

func GetMappingDocumentDetailsSourceEnum 

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"
	DocumentFeatureFeatureTypeTextDetection          DocumentFeatureFeatureTypeEnum = "TEXT_DETECTION"
	DocumentFeatureFeatureTypeTableDetection         DocumentFeatureFeatureTypeEnum = "TABLE_DETECTION"
	DocumentFeatureFeatureTypeKeyValueDetection      DocumentFeatureFeatureTypeEnum = "KEY_VALUE_DETECTION"
	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 DocumentJob 

type DocumentJob struct {

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

	// The OCID of the compartment that starts the job.
	CompartmentId *string `mandatory:"true" json:"compartmentId"`

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

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

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

	// The current state of the batch document job.
	LifecycleState DocumentJobLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`

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

	// The document language, abbreviated according to ISO 639-2.
	Language DocumentLanguageEnum `mandatory:"false" json:"language,omitempty"`

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

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

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

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

DocumentJob The job details for a batch document analysis.

func (DocumentJob) String 

func (m DocumentJob) String() string

func (*DocumentJob) UnmarshalJSON 

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

UnmarshalJSON unmarshals from json

func (DocumentJob) ValidateEnumValue 

func (m DocumentJob) 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 DocumentJobLifecycleDetailsEnum 

type DocumentJobLifecycleDetailsEnum string

DocumentJobLifecycleDetailsEnum Enum with underlying type: string 

const (
	DocumentJobLifecycleDetailsPartiallySucceeded DocumentJobLifecycleDetailsEnum = "PARTIALLY_SUCCEEDED"
	DocumentJobLifecycleDetailsCompletelyFailed   DocumentJobLifecycleDetailsEnum = "COMPLETELY_FAILED"
)

Set of constants representing the allowable values for DocumentJobLifecycleDetailsEnum

func GetDocumentJobLifecycleDetailsEnumValues 

func GetDocumentJobLifecycleDetailsEnumValues() []DocumentJobLifecycleDetailsEnum

GetDocumentJobLifecycleDetailsEnumValues Enumerates the set of values for DocumentJobLifecycleDetailsEnum

func GetMappingDocumentJobLifecycleDetailsEnum 

func GetMappingDocumentJobLifecycleDetailsEnum(val string) (DocumentJobLifecycleDetailsEnum, bool)

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

type DocumentJobLifecycleStateEnum 

type DocumentJobLifecycleStateEnum string

DocumentJobLifecycleStateEnum Enum with underlying type: string 

const (
	DocumentJobLifecycleStateSucceeded  DocumentJobLifecycleStateEnum = "SUCCEEDED"
	DocumentJobLifecycleStateFailed     DocumentJobLifecycleStateEnum = "FAILED"
	DocumentJobLifecycleStateAccepted   DocumentJobLifecycleStateEnum = "ACCEPTED"
	DocumentJobLifecycleStateCanceled   DocumentJobLifecycleStateEnum = "CANCELED"
	DocumentJobLifecycleStateInProgress DocumentJobLifecycleStateEnum = "IN_PROGRESS"
	DocumentJobLifecycleStateCanceling  DocumentJobLifecycleStateEnum = "CANCELING"
)

Set of constants representing the allowable values for DocumentJobLifecycleStateEnum

func GetDocumentJobLifecycleStateEnumValues 

func GetDocumentJobLifecycleStateEnumValues() []DocumentJobLifecycleStateEnum

GetDocumentJobLifecycleStateEnumValues Enumerates the set of values for DocumentJobLifecycleStateEnum

func GetMappingDocumentJobLifecycleStateEnum 

func GetMappingDocumentJobLifecycleStateEnum(val string) (DocumentJobLifecycleStateEnum, bool)

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

type DocumentKeyValueDetectionFeature 

type DocumentKeyValueDetectionFeature struct {
}

DocumentKeyValueDetectionFeature Extracting form fields.

func (DocumentKeyValueDetectionFeature) MarshalJSON 

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

MarshalJSON marshals to json representation

func (DocumentKeyValueDetectionFeature) String 

func (m DocumentKeyValueDetectionFeature) String() string

func (DocumentKeyValueDetectionFeature) ValidateEnumValue 

func (m DocumentKeyValueDetectionFeature) 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 DocumentLanguageEnum 

type DocumentLanguageEnum string

DocumentLanguageEnum Enum with underlying type: string 

const (
	DocumentLanguageEng    DocumentLanguageEnum = "ENG"
	DocumentLanguageCes    DocumentLanguageEnum = "CES"
	DocumentLanguageDan    DocumentLanguageEnum = "DAN"
	DocumentLanguageNld    DocumentLanguageEnum = "NLD"
	DocumentLanguageFin    DocumentLanguageEnum = "FIN"
	DocumentLanguageFra    DocumentLanguageEnum = "FRA"
	DocumentLanguageDeu    DocumentLanguageEnum = "DEU"
	DocumentLanguageEll    DocumentLanguageEnum = "ELL"
	DocumentLanguageHun    DocumentLanguageEnum = "HUN"
	DocumentLanguageIta    DocumentLanguageEnum = "ITA"
	DocumentLanguageNor    DocumentLanguageEnum = "NOR"
	DocumentLanguagePol    DocumentLanguageEnum = "POL"
	DocumentLanguagePor    DocumentLanguageEnum = "POR"
	DocumentLanguageRon    DocumentLanguageEnum = "RON"
	DocumentLanguageRus    DocumentLanguageEnum = "RUS"
	DocumentLanguageSlk    DocumentLanguageEnum = "SLK"
	DocumentLanguageSpa    DocumentLanguageEnum = "SPA"
	DocumentLanguageSwe    DocumentLanguageEnum = "SWE"
	DocumentLanguageTur    DocumentLanguageEnum = "TUR"
	DocumentLanguageAra    DocumentLanguageEnum = "ARA"
	DocumentLanguageChiSim DocumentLanguageEnum = "CHI_SIM"
	DocumentLanguageHin    DocumentLanguageEnum = "HIN"
	DocumentLanguageJpn    DocumentLanguageEnum = "JPN"
	DocumentLanguageKor    DocumentLanguageEnum = "KOR"
	DocumentLanguageOthers DocumentLanguageEnum = "OTHERS"
)

Set of constants representing the allowable values for DocumentLanguageEnum

func GetDocumentLanguageEnumValues 

func GetDocumentLanguageEnumValues() []DocumentLanguageEnum

GetDocumentLanguageEnumValues Enumerates the set of values for DocumentLanguageEnum

func GetMappingDocumentLanguageEnum 

func GetMappingDocumentLanguageEnum(val string) (DocumentLanguageEnum, bool)

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

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 DocumentTableDetectionFeature 

type DocumentTableDetectionFeature struct {
}

DocumentTableDetectionFeature Detecting and extracting data in tables.

func (DocumentTableDetectionFeature) MarshalJSON 

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

MarshalJSON marshals to json representation

func (DocumentTableDetectionFeature) String 

func (m DocumentTableDetectionFeature) String() string

func (DocumentTableDetectionFeature) ValidateEnumValue 

func (m DocumentTableDetectionFeature) 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 DocumentTextDetectionFeature 

type DocumentTextDetectionFeature struct {

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

DocumentTextDetectionFeature Text recognition

func (DocumentTextDetectionFeature) MarshalJSON 

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

MarshalJSON marshals to json representation

func (DocumentTextDetectionFeature) String 

func (m DocumentTextDetectionFeature) String() string

func (DocumentTextDetectionFeature) ValidateEnumValue 

func (m DocumentTextDetectionFeature) 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"
)

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 GetDocumentJobRequest 

type GetDocumentJobRequest struct {

	// Document job id.
	DocumentJobId *string `mandatory:"true" contributesTo:"path" name:"documentJobId"`

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

GetDocumentJobRequest wrapper for the GetDocumentJob operation

See also

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

func (GetDocumentJobRequest) BinaryRequestBody 

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

BinaryRequestBody implements the OCIRequest interface

func (GetDocumentJobRequest) HTTPRequest 

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

HTTPRequest implements the OCIRequest interface

func (GetDocumentJobRequest) RetryPolicy 

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

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

func (GetDocumentJobRequest) String 

func (request GetDocumentJobRequest) String() string

func (GetDocumentJobRequest) ValidateEnumValue 

func (request GetDocumentJobRequest) 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 GetDocumentJobResponse 

type GetDocumentJobResponse struct {

	// The underlying http response
	RawResponse *http.Response

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

GetDocumentJobResponse wrapper for the GetDocumentJob operation

func (GetDocumentJobResponse) HTTPResponse 

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

HTTPResponse implements the OCIResponse interface

func (GetDocumentJobResponse) String 

func (response GetDocumentJobResponse) String() string

type GetImageJobRequest 

type GetImageJobRequest struct {

	// Image job id.
	ImageJobId *string `mandatory:"true" contributesTo:"path" name:"imageJobId"`

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

GetImageJobRequest wrapper for the GetImageJob operation

See also

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

func (GetImageJobRequest) BinaryRequestBody 

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

BinaryRequestBody implements the OCIRequest interface

func (GetImageJobRequest) HTTPRequest 

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

HTTPRequest implements the OCIRequest interface

func (GetImageJobRequest) RetryPolicy 

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

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

func (GetImageJobRequest) String 

func (request GetImageJobRequest) String() string

func (GetImageJobRequest) ValidateEnumValue 

func (request GetImageJobRequest) 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 GetImageJobResponse 

type GetImageJobResponse struct {

	// The underlying http response
	RawResponse *http.Response

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

GetImageJobResponse wrapper for the GetImageJob operation

func (GetImageJobResponse) HTTPResponse 

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

HTTPResponse implements the OCIResponse interface

func (GetImageJobResponse) String 

func (response GetImageJobResponse) String() string

type GetModelRequest 

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/aivision/GetModel.go.html to see an example of how to use GetModelRequest.

func (GetModelRequest) BinaryRequestBody 

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

BinaryRequestBody implements the OCIRequest interface

func (GetModelRequest) HTTPRequest 

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 

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

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

func (GetModelRequest) String 

func (request GetModelRequest) String() string

func (GetModelRequest) ValidateEnumValue 

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 

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 

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

HTTPResponse implements the OCIResponse interface

func (GetModelResponse) String 

func (response GetModelResponse) String() string

type GetProjectRequest 

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/aivision/GetProject.go.html to see an example of how to use GetProjectRequest.

func (GetProjectRequest) BinaryRequestBody 

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

BinaryRequestBody implements the OCIRequest interface

func (GetProjectRequest) HTTPRequest 

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 

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

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

func (GetProjectRequest) String 

func (request GetProjectRequest) String() string

func (GetProjectRequest) ValidateEnumValue 

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 

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 

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

HTTPResponse implements the OCIResponse interface

func (GetProjectResponse) String 

func (response GetProjectResponse) String() string

type GetWorkRequestRequest 

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/aivision/GetWorkRequest.go.html to see an example of how to use GetWorkRequestRequest.

func (GetWorkRequestRequest) BinaryRequestBody 

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

BinaryRequestBody implements the OCIRequest interface

func (GetWorkRequestRequest) HTTPRequest 

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 

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

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

func (GetWorkRequestRequest) String 

func (request GetWorkRequestRequest) String() string

func (GetWorkRequestRequest) ValidateEnumValue 

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 

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 

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

HTTPResponse implements the OCIResponse interface

func (GetWorkRequestResponse) String 

func (response GetWorkRequestResponse) String() string

type ImageClassificationFeature 

type ImageClassificationFeature struct {

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

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

ImageClassificationFeature The image classification parameters.

func (ImageClassificationFeature) MarshalJSON 

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

MarshalJSON marshals to json representation

func (ImageClassificationFeature) String 

func (m ImageClassificationFeature) String() string

func (ImageClassificationFeature) ValidateEnumValue 

func (m ImageClassificationFeature) 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 ImageDetails 

type ImageDetails interface {
}

ImageDetails The details of an image to analyze.

type ImageDetailsSourceEnum 

type ImageDetailsSourceEnum string

ImageDetailsSourceEnum Enum with underlying type: string 

const (
	ImageDetailsSourceInline        ImageDetailsSourceEnum = "INLINE"
	ImageDetailsSourceObjectStorage ImageDetailsSourceEnum = "OBJECT_STORAGE"
)

Set of constants representing the allowable values for ImageDetailsSourceEnum

func GetImageDetailsSourceEnumValues 

func GetImageDetailsSourceEnumValues() []ImageDetailsSourceEnum

GetImageDetailsSourceEnumValues Enumerates the set of values for ImageDetailsSourceEnum

func GetMappingImageDetailsSourceEnum 

func GetMappingImageDetailsSourceEnum(val string) (ImageDetailsSourceEnum, bool)

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

type ImageFeature 

type ImageFeature interface {
}

ImageFeature The type of image analysis.

type ImageFeatureFeatureTypeEnum 

type ImageFeatureFeatureTypeEnum string

ImageFeatureFeatureTypeEnum Enum with underlying type: string 

const (
	ImageFeatureFeatureTypeImageClassification ImageFeatureFeatureTypeEnum = "IMAGE_CLASSIFICATION"
	ImageFeatureFeatureTypeObjectDetection     ImageFeatureFeatureTypeEnum = "OBJECT_DETECTION"
	ImageFeatureFeatureTypeTextDetection       ImageFeatureFeatureTypeEnum = "TEXT_DETECTION"
)

Set of constants representing the allowable values for ImageFeatureFeatureTypeEnum

func GetImageFeatureFeatureTypeEnumValues 

func GetImageFeatureFeatureTypeEnumValues() []ImageFeatureFeatureTypeEnum

GetImageFeatureFeatureTypeEnumValues Enumerates the set of values for ImageFeatureFeatureTypeEnum

func GetMappingImageFeatureFeatureTypeEnum 

func GetMappingImageFeatureFeatureTypeEnum(val string) (ImageFeatureFeatureTypeEnum, bool)

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

type ImageJob 

type ImageJob struct {

	// The job id
	Id *string `mandatory:"true" json:"id"`

	// The OCID of the compartment that starts the job.
	CompartmentId *string `mandatory:"true" json:"compartmentId"`

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

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

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

	// The current state of the batch image job.
	LifecycleState ImageJobLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`

	// The image job display name.
	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 ImageJobLifecycleDetailsEnum `mandatory:"false" json:"lifecycleDetails,omitempty"`

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

ImageJob The job details for a batch image analysis.

func (ImageJob) String 

func (m ImageJob) String() string

func (*ImageJob) UnmarshalJSON 

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

UnmarshalJSON unmarshals from json

func (ImageJob) ValidateEnumValue 

func (m ImageJob) 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 ImageJobLifecycleDetailsEnum 

type ImageJobLifecycleDetailsEnum string

ImageJobLifecycleDetailsEnum Enum with underlying type: string 

const (
	ImageJobLifecycleDetailsPartiallySucceeded ImageJobLifecycleDetailsEnum = "PARTIALLY_SUCCEEDED"
	ImageJobLifecycleDetailsCompletelyFailed   ImageJobLifecycleDetailsEnum = "COMPLETELY_FAILED"
)

Set of constants representing the allowable values for ImageJobLifecycleDetailsEnum

func GetImageJobLifecycleDetailsEnumValues 

func GetImageJobLifecycleDetailsEnumValues() []ImageJobLifecycleDetailsEnum

GetImageJobLifecycleDetailsEnumValues Enumerates the set of values for ImageJobLifecycleDetailsEnum

func GetMappingImageJobLifecycleDetailsEnum 

func GetMappingImageJobLifecycleDetailsEnum(val string) (ImageJobLifecycleDetailsEnum, bool)

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

type ImageJobLifecycleStateEnum 

type ImageJobLifecycleStateEnum string

ImageJobLifecycleStateEnum Enum with underlying type: string 

const (
	ImageJobLifecycleStateSucceeded  ImageJobLifecycleStateEnum = "SUCCEEDED"
	ImageJobLifecycleStateFailed     ImageJobLifecycleStateEnum = "FAILED"
	ImageJobLifecycleStateAccepted   ImageJobLifecycleStateEnum = "ACCEPTED"
	ImageJobLifecycleStateCanceled   ImageJobLifecycleStateEnum = "CANCELED"
	ImageJobLifecycleStateInProgress ImageJobLifecycleStateEnum = "IN_PROGRESS"
	ImageJobLifecycleStateCanceling  ImageJobLifecycleStateEnum = "CANCELING"
)

Set of constants representing the allowable values for ImageJobLifecycleStateEnum

func GetImageJobLifecycleStateEnumValues 

func GetImageJobLifecycleStateEnumValues() []ImageJobLifecycleStateEnum

GetImageJobLifecycleStateEnumValues Enumerates the set of values for ImageJobLifecycleStateEnum

func GetMappingImageJobLifecycleStateEnum 

func GetMappingImageJobLifecycleStateEnum(val string) (ImageJobLifecycleStateEnum, bool)

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

type ImageObject 

type ImageObject struct {

	// The object category name. Every value returned by the pre-deployed model is in English.
	Name *string `mandatory:"true" json:"name"`

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

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

ImageObject The object detected in an image.

func (ImageObject) String 

func (m ImageObject) String() string

func (ImageObject) ValidateEnumValue 

func (m ImageObject) 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 ImageObjectDetectionFeature 

type ImageObjectDetectionFeature struct {

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

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

ImageObjectDetectionFeature The object detection parameters.

func (ImageObjectDetectionFeature) MarshalJSON 

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

MarshalJSON marshals to json representation

func (ImageObjectDetectionFeature) String 

func (m ImageObjectDetectionFeature) String() string

func (ImageObjectDetectionFeature) ValidateEnumValue 

func (m ImageObjectDetectionFeature) 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 ImageText 

type ImageText struct {

	// The words recognized in an image.
	Words []Word `mandatory:"true" json:"words"`

	// The lines of text recognized in an image.
	Lines []Line `mandatory:"true" json:"lines"`
}

ImageText The detected text.

func (ImageText) String 

func (m ImageText) String() string

func (ImageText) ValidateEnumValue 

func (m ImageText) 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 ImageTextDetectionFeature 

type ImageTextDetectionFeature struct {

	// The language of the document image, abbreviated according to ISO 639-2.
	Language DocumentLanguageEnum `mandatory:"false" json:"language,omitempty"`
}

ImageTextDetectionFeature The text detection parameters.

func (ImageTextDetectionFeature) MarshalJSON 

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

MarshalJSON marshals to json representation

func (ImageTextDetectionFeature) String 

func (m ImageTextDetectionFeature) String() string

func (ImageTextDetectionFeature) ValidateEnumValue 

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

type InlineDocumentDetails struct {

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

InlineDocumentDetails The document incorporated in the request payload.

func (InlineDocumentDetails) MarshalJSON 

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

MarshalJSON marshals to json representation

func (InlineDocumentDetails) String 

func (m InlineDocumentDetails) String() string

func (InlineDocumentDetails) ValidateEnumValue 

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 InlineImageDetails 

type InlineImageDetails struct {

	// Raw image data.
	Data []byte `mandatory:"true" json:"data"`
}

InlineImageDetails The image incorporated in the request payload.

func (InlineImageDetails) MarshalJSON 

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

MarshalJSON marshals to json representation

func (InlineImageDetails) String 

func (m InlineImageDetails) String() string

func (InlineImageDetails) ValidateEnumValue 

func (m InlineImageDetails) 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 (
	InputLocationSourceTypeObjectListInlineInputLocation InputLocationSourceTypeEnum = "OBJECT_LIST_INLINE_INPUT_LOCATION"
)

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 Label 

type Label struct {

	// The classification catagory label name.
	Name *string `mandatory:"true" json:"name"`

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

Label A label describing an image. Every label returned by the pre-deployed model is in English.

func (Label) String 

func (m Label) String() string

func (Label) ValidateEnumValue 

func (m Label) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type 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 

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/aivision/ListModels.go.html to see an example of how to use ListModelsRequest.

func (ListModelsRequest) BinaryRequestBody 

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

BinaryRequestBody implements the OCIRequest interface

func (ListModelsRequest) HTTPRequest 

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 

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

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

func (ListModelsRequest) String 

func (request ListModelsRequest) String() string

func (ListModelsRequest) ValidateEnumValue 

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 

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 

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

HTTPResponse implements the OCIResponse interface

func (ListModelsResponse) String 

func (response ListModelsResponse) String() string

type ListModelsSortByEnum 

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 

func GetListModelsSortByEnumValues() []ListModelsSortByEnum

GetListModelsSortByEnumValues Enumerates the set of values for ListModelsSortByEnum

func GetMappingListModelsSortByEnum 

func GetMappingListModelsSortByEnum(val string) (ListModelsSortByEnum, bool)

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

type ListModelsSortOrderEnum 

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 

func GetListModelsSortOrderEnumValues() []ListModelsSortOrderEnum

GetListModelsSortOrderEnumValues Enumerates the set of values for ListModelsSortOrderEnum

func GetMappingListModelsSortOrderEnum 

func GetMappingListModelsSortOrderEnum(val string) (ListModelsSortOrderEnum, bool)

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

type ListProjectsRequest 

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/aivision/ListProjects.go.html to see an example of how to use ListProjectsRequest.

func (ListProjectsRequest) BinaryRequestBody 

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

BinaryRequestBody implements the OCIRequest interface

func (ListProjectsRequest) HTTPRequest 

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 

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

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

func (ListProjectsRequest) String 

func (request ListProjectsRequest) String() string

func (ListProjectsRequest) ValidateEnumValue 

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 

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 

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

HTTPResponse implements the OCIResponse interface

func (ListProjectsResponse) String 

func (response ListProjectsResponse) String() string

type ListProjectsSortByEnum 

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 

func GetListProjectsSortByEnumValues() []ListProjectsSortByEnum

GetListProjectsSortByEnumValues Enumerates the set of values for ListProjectsSortByEnum

func GetMappingListProjectsSortByEnum 

func GetMappingListProjectsSortByEnum(val string) (ListProjectsSortByEnum, bool)

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

type ListProjectsSortOrderEnum 

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 

func GetListProjectsSortOrderEnumValues() []ListProjectsSortOrderEnum

GetListProjectsSortOrderEnumValues Enumerates the set of values for ListProjectsSortOrderEnum

func GetMappingListProjectsSortOrderEnum 

func GetMappingListProjectsSortOrderEnum(val string) (ListProjectsSortOrderEnum, bool)

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

type ListWorkRequestErrorsRequest 

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/aivision/ListWorkRequestErrors.go.html to see an example of how to use ListWorkRequestErrorsRequest.

func (ListWorkRequestErrorsRequest) BinaryRequestBody 

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

BinaryRequestBody implements the OCIRequest interface

func (ListWorkRequestErrorsRequest) HTTPRequest 

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 

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

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

func (ListWorkRequestErrorsRequest) String 

func (request ListWorkRequestErrorsRequest) String() string

func (ListWorkRequestErrorsRequest) ValidateEnumValue 

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 

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 

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

HTTPResponse implements the OCIResponse interface

func (ListWorkRequestErrorsResponse) String 

func (response ListWorkRequestErrorsResponse) String() string

type ListWorkRequestErrorsSortByEnum 

type ListWorkRequestErrorsSortByEnum string

ListWorkRequestErrorsSortByEnum Enum with underlying type: string 

const (
	ListWorkRequestErrorsSortByTimeaccepted ListWorkRequestErrorsSortByEnum = "timeAccepted"
)

Set of constants representing the allowable values for ListWorkRequestErrorsSortByEnum

func GetListWorkRequestErrorsSortByEnumValues 

func GetListWorkRequestErrorsSortByEnumValues() []ListWorkRequestErrorsSortByEnum

GetListWorkRequestErrorsSortByEnumValues Enumerates the set of values for ListWorkRequestErrorsSortByEnum

func GetMappingListWorkRequestErrorsSortByEnum 

func GetMappingListWorkRequestErrorsSortByEnum(val string) (ListWorkRequestErrorsSortByEnum, bool)

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

type ListWorkRequestErrorsSortOrderEnum 

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 

func GetListWorkRequestErrorsSortOrderEnumValues() []ListWorkRequestErrorsSortOrderEnum

GetListWorkRequestErrorsSortOrderEnumValues Enumerates the set of values for ListWorkRequestErrorsSortOrderEnum

func GetMappingListWorkRequestErrorsSortOrderEnum 

func GetMappingListWorkRequestErrorsSortOrderEnum(val string) (ListWorkRequestErrorsSortOrderEnum, bool)

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

type ListWorkRequestLogsRequest 

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/aivision/ListWorkRequestLogs.go.html to see an example of how to use ListWorkRequestLogsRequest.

func (ListWorkRequestLogsRequest) BinaryRequestBody 

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

BinaryRequestBody implements the OCIRequest interface

func (ListWorkRequestLogsRequest) HTTPRequest 

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 

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

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

func (ListWorkRequestLogsRequest) String 

func (request ListWorkRequestLogsRequest) String() string

func (ListWorkRequestLogsRequest) ValidateEnumValue 

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 

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 

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

HTTPResponse implements the OCIResponse interface

func (ListWorkRequestLogsResponse) String 

func (response ListWorkRequestLogsResponse) String() string

type ListWorkRequestLogsSortByEnum 

type ListWorkRequestLogsSortByEnum string

ListWorkRequestLogsSortByEnum Enum with underlying type: string 

const (
	ListWorkRequestLogsSortByTimeaccepted ListWorkRequestLogsSortByEnum = "timeAccepted"
)

Set of constants representing the allowable values for ListWorkRequestLogsSortByEnum

func GetListWorkRequestLogsSortByEnumValues 

func GetListWorkRequestLogsSortByEnumValues() []ListWorkRequestLogsSortByEnum

GetListWorkRequestLogsSortByEnumValues Enumerates the set of values for ListWorkRequestLogsSortByEnum

func GetMappingListWorkRequestLogsSortByEnum 

func GetMappingListWorkRequestLogsSortByEnum(val string) (ListWorkRequestLogsSortByEnum, bool)

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

type ListWorkRequestLogsSortOrderEnum 

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 

func GetListWorkRequestLogsSortOrderEnumValues() []ListWorkRequestLogsSortOrderEnum

GetListWorkRequestLogsSortOrderEnumValues Enumerates the set of values for ListWorkRequestLogsSortOrderEnum

func GetMappingListWorkRequestLogsSortOrderEnum 

func GetMappingListWorkRequestLogsSortOrderEnum(val string) (ListWorkRequestLogsSortOrderEnum, bool)

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

type ListWorkRequestsRequest 

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/aivision/ListWorkRequests.go.html to see an example of how to use ListWorkRequestsRequest.

func (ListWorkRequestsRequest) BinaryRequestBody 

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

BinaryRequestBody implements the OCIRequest interface

func (ListWorkRequestsRequest) HTTPRequest 

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 

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

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

func (ListWorkRequestsRequest) String 

func (request ListWorkRequestsRequest) String() string

func (ListWorkRequestsRequest) ValidateEnumValue 

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 

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 

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

HTTPResponse implements the OCIResponse interface

func (ListWorkRequestsResponse) String 

func (response ListWorkRequestsResponse) String() string

type ListWorkRequestsSortByEnum 

type ListWorkRequestsSortByEnum string

ListWorkRequestsSortByEnum Enum with underlying type: string 

const (
	ListWorkRequestsSortByTimeaccepted ListWorkRequestsSortByEnum = "timeAccepted"
)

Set of constants representing the allowable values for ListWorkRequestsSortByEnum

func GetListWorkRequestsSortByEnumValues 

func GetListWorkRequestsSortByEnumValues() []ListWorkRequestsSortByEnum

GetListWorkRequestsSortByEnumValues Enumerates the set of values for ListWorkRequestsSortByEnum

func GetMappingListWorkRequestsSortByEnum 

func GetMappingListWorkRequestsSortByEnum(val string) (ListWorkRequestsSortByEnum, bool)

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

type ListWorkRequestsSortOrderEnum 

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 

func GetListWorkRequestsSortOrderEnumValues() []ListWorkRequestsSortOrderEnum

GetListWorkRequestsSortOrderEnumValues Enumerates the set of values for ListWorkRequestsSortOrderEnum

func GetMappingListWorkRequestsSortOrderEnum 

func GetMappingListWorkRequestsSortOrderEnum(val string) (ListWorkRequestsSortOrderEnum, bool)

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

type ListWorkRequestsStatusEnum 

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 

func GetListWorkRequestsStatusEnumValues() []ListWorkRequestsStatusEnum

GetListWorkRequestsStatusEnumValues Enumerates the set of values for ListWorkRequestsStatusEnum

func GetMappingListWorkRequestsStatusEnum 

func GetMappingListWorkRequestsStatusEnum(val string) (ListWorkRequestsStatusEnum, bool)

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

type Model 

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

	// What type of Vision model this is.
	ModelType ModelModelTypeEnum `mandatory:"true" json:"modelType"`

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

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

	// 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 duration in hours, expressed as a decimal fraction.
	MaxTrainingDurationInHours *float64 `mandatory:"false" json:"maxTrainingDurationInHours"`

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

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

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

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

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

	// Recall of the trained model.
	Recall *float32 `mandatory:"false" json:"recall"`

	// The mean average precision of the trained model.
	AveragePrecision *float32 `mandatory:"false" json:"averagePrecision"`

	// The intersection over the union threshold used for calculating precision and recall.
	ConfidenceThreshold *float32 `mandatory:"false" json:"confidenceThreshold"`

	// The number of images in the dataset used to train, validate, and test the model.
	TotalImageCount *int `mandatory:"false" json:"totalImageCount"`

	// The number of images set aside for evaluating model performance metrics after training.
	TestImageCount *int `mandatory:"false" json:"testImageCount"`

	// The complete set of per-label metrics for successfully trained models.
	Metrics *string `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"`
}

Model Machine-learned Model.

func (Model) String 

func (m Model) String() string

func (*Model) UnmarshalJSON 

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

UnmarshalJSON unmarshals from json

func (Model) ValidateEnumValue 

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 

type ModelCollection struct {

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

ModelCollection The results of a model search.

func (ModelCollection) String 

func (m ModelCollection) String() string

func (ModelCollection) ValidateEnumValue 

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 

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 

func GetMappingModelLifecycleStateEnum(val string) (ModelLifecycleStateEnum, bool)

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

func GetModelLifecycleStateEnumValues 

func GetModelLifecycleStateEnumValues() []ModelLifecycleStateEnum

GetModelLifecycleStateEnumValues Enumerates the set of values for ModelLifecycleStateEnum

type ModelModelTypeEnum 

type ModelModelTypeEnum string

ModelModelTypeEnum Enum with underlying type: string 

const (
	ModelModelTypeImageClassification ModelModelTypeEnum = "IMAGE_CLASSIFICATION"
	ModelModelTypeObjectDetection     ModelModelTypeEnum = "OBJECT_DETECTION"
)

Set of constants representing the allowable values for ModelModelTypeEnum

func GetMappingModelModelTypeEnum 

func GetMappingModelModelTypeEnum(val string) (ModelModelTypeEnum, bool)

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

func GetModelModelTypeEnumValues 

func GetModelModelTypeEnumValues() []ModelModelTypeEnum

GetModelModelTypeEnumValues Enumerates the set of values for ModelModelTypeEnum

type ModelSummary 

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

	// What type of Vision model this is.
	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"`

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

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

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

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

ModelSummary The metadata about the model.

func (ModelSummary) String 

func (m ModelSummary) String() string

func (*ModelSummary) UnmarshalJSON 

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

UnmarshalJSON unmarshals from json

func (ModelSummary) ValidateEnumValue 

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 ObjectListInlineInputLocation 

type ObjectListInlineInputLocation struct {

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

ObjectListInlineInputLocation A list of object locations in Object Storage.

func (ObjectListInlineInputLocation) MarshalJSON 

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

MarshalJSON marshals to json representation

func (ObjectListInlineInputLocation) String 

func (m ObjectListInlineInputLocation) String() string

func (ObjectListInlineInputLocation) ValidateEnumValue 

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

type ObjectStorageDataset struct {

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

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

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

ObjectStorageDataset The dataset that resides in Object Storage.

func (ObjectStorageDataset) MarshalJSON 

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

MarshalJSON marshals to json representation

func (ObjectStorageDataset) String 

func (m ObjectStorageDataset) String() string

func (ObjectStorageDataset) ValidateEnumValue 

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 

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 

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

MarshalJSON marshals to json representation

func (ObjectStorageDocumentDetails) String 

func (m ObjectStorageDocumentDetails) String() string

func (ObjectStorageDocumentDetails) ValidateEnumValue 

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 ObjectStorageImageDetails 

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

ObjectStorageImageDetails The image residing in OCI Object Storage.

func (ObjectStorageImageDetails) MarshalJSON 

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

MarshalJSON marshals to json representation

func (ObjectStorageImageDetails) String 

func (m ObjectStorageImageDetails) String() string

func (ObjectStorageImageDetails) ValidateEnumValue 

func (m ObjectStorageImageDetails) 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 OntologyClass 

type OntologyClass struct {

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

	// The label parents.
	ParentNames []string `mandatory:"false" json:"parentNames"`

	// The label synonyms.
	SynonymNames []string `mandatory:"false" json:"synonymNames"`
}

OntologyClass Images and ImageObjects can be labeled with an OntologyClass.

func (OntologyClass) String 

func (m OntologyClass) String() string

func (OntologyClass) ValidateEnumValue 

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

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 

func GetMappingOperationStatusEnum(val string) (OperationStatusEnum, bool)

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

func GetOperationStatusEnumValues 

func GetOperationStatusEnumValues() []OperationStatusEnum

GetOperationStatusEnumValues Enumerates the set of values for OperationStatusEnum

type OperationTypeEnum 

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

Set of constants representing the allowable values for OperationTypeEnum

func GetMappingOperationTypeEnum 

func GetMappingOperationTypeEnum(val string) (OperationTypeEnum, bool)

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

func GetOperationTypeEnumValues 

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 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 Project 

type Project struct {

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

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

Project A Vision Project containing models.

func (Project) String 

func (m Project) String() string

func (Project) ValidateEnumValue 

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 

type ProjectCollection struct {

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

ProjectCollection The results of a project search.

func (ProjectCollection) String 

func (m ProjectCollection) String() string

func (ProjectCollection) ValidateEnumValue 

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 

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 

func GetMappingProjectLifecycleStateEnum(val string) (ProjectLifecycleStateEnum, bool)

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

func GetProjectLifecycleStateEnumValues 

func GetProjectLifecycleStateEnumValues() []ProjectLifecycleStateEnum

GetProjectLifecycleStateEnumValues Enumerates the set of values for ProjectLifecycleStateEnum

type ProjectSummary 

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

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

func (m ProjectSummary) String() string

func (ProjectSummary) ValidateEnumValue 

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 SortOrderEnum 

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 

func GetMappingSortOrderEnum(val string) (SortOrderEnum, bool)

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

func GetSortOrderEnumValues 

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 

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 

func (m UpdateModelDetails) String() string

func (UpdateModelDetails) ValidateEnumValue 

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 

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

	// 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/aivision/UpdateModel.go.html to see an example of how to use UpdateModelRequest.

func (UpdateModelRequest) BinaryRequestBody 

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

BinaryRequestBody implements the OCIRequest interface

func (UpdateModelRequest) HTTPRequest 

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 

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

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

func (UpdateModelRequest) String 

func (request UpdateModelRequest) String() string

func (UpdateModelRequest) ValidateEnumValue 

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 

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 

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

HTTPResponse implements the OCIResponse interface

func (UpdateModelResponse) String 

func (response UpdateModelResponse) String() string

type UpdateProjectDetails 

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 

func (m UpdateProjectDetails) String() string

func (UpdateProjectDetails) ValidateEnumValue 

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 

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

	// 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/aivision/UpdateProject.go.html to see an example of how to use UpdateProjectRequest.

func (UpdateProjectRequest) BinaryRequestBody 

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

BinaryRequestBody implements the OCIRequest interface

func (UpdateProjectRequest) HTTPRequest 

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 

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

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

func (UpdateProjectRequest) String 

func (request UpdateProjectRequest) String() string

func (UpdateProjectRequest) ValidateEnumValue 

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 

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 

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

HTTPResponse implements the OCIResponse interface

func (UpdateProjectResponse) String 

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

	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 

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 OCID of the compartment that contains the work request. Work requests should be scoped to
	// the same compartment as the resource the work request affects.
	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 

func (m WorkRequest) String() string

func (WorkRequest) ValidateEnumValue 

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 

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 

func (m WorkRequestError) String() string

func (WorkRequestError) ValidateEnumValue 

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 

type WorkRequestErrorCollection struct {

	// the list of workRequestError objects.
	Items []WorkRequestError `mandatory:"true" json:"items"`
}

WorkRequestErrorCollection The results of a workRequestError search.

func (WorkRequestErrorCollection) String 

func (m WorkRequestErrorCollection) String() string

func (WorkRequestErrorCollection) ValidateEnumValue 

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 

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 

func (m WorkRequestLogEntry) String() string

func (WorkRequestLogEntry) ValidateEnumValue 

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 

type WorkRequestLogEntryCollection struct {

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

WorkRequestLogEntryCollection The results of a workRequestLog search.

func (WorkRequestLogEntryCollection) String 

func (m WorkRequestLogEntryCollection) String() string

func (WorkRequestLogEntryCollection) ValidateEnumValue 

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 

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

WorkRequestResource A resource created, or operated on, by a work request.

func (WorkRequestResource) String 

func (m WorkRequestResource) String() string

func (WorkRequestResource) ValidateEnumValue 

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 WorkRequestSummary 

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 OCID of the compartment that contains the work request. Work requests should be scoped to
	// the same compartment as the resource the work request affects. If the work request affects multiple resources,
	// and those resources are not in the same compartment, it is up to the service team to pick the primary
	// resource whose compartment is used.
	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 

func (m WorkRequestSummary) String() string

func (WorkRequestSummary) ValidateEnumValue 

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 

type WorkRequestSummaryCollection struct {

	// The list of workRequestSummary objects.
	Items []WorkRequestSummary `mandatory:"true" json:"items"`
}

WorkRequestSummaryCollection The results of a workRequest search.

func (WorkRequestSummaryCollection) String 

func (m WorkRequestSummaryCollection) String() string

func (WorkRequestSummaryCollection) ValidateEnumValue 

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.