func GetActionTypeEnumStringValues() []string
GetActionTypeEnumStringValues Enumerates the set of values in String for ActionTypeEnum
func GetDatasetDatasetTypeEnumStringValues() []string
GetDatasetDatasetTypeEnumStringValues Enumerates the set of values in String for DatasetDatasetTypeEnum
func GetDimensionsUnitEnumStringValues() []string
GetDimensionsUnitEnumStringValues Enumerates the set of values in String for DimensionsUnitEnum
func GetDocumentDetailsSourceEnumStringValues() []string
GetDocumentDetailsSourceEnumStringValues Enumerates the set of values in String for DocumentDetailsSourceEnum
func GetDocumentFeatureFeatureTypeEnumStringValues() []string
GetDocumentFeatureFeatureTypeEnumStringValues Enumerates the set of values in String for DocumentFeatureFeatureTypeEnum
func GetDocumentFieldFieldTypeEnumStringValues() []string
GetDocumentFieldFieldTypeEnumStringValues Enumerates the set of values in String for DocumentFieldFieldTypeEnum
func GetDocumentJobLifecycleDetailsEnumStringValues() []string
GetDocumentJobLifecycleDetailsEnumStringValues Enumerates the set of values in String for DocumentJobLifecycleDetailsEnum
func GetDocumentJobLifecycleStateEnumStringValues() []string
GetDocumentJobLifecycleStateEnumStringValues Enumerates the set of values in String for DocumentJobLifecycleStateEnum
func GetDocumentLanguageEnumStringValues() []string
GetDocumentLanguageEnumStringValues Enumerates the set of values in String for DocumentLanguageEnum
func GetDocumentTypeEnumStringValues() []string
GetDocumentTypeEnumStringValues Enumerates the set of values in String for DocumentTypeEnum
func GetFieldValueValueTypeEnumStringValues() []string
GetFieldValueValueTypeEnumStringValues Enumerates the set of values in String for FieldValueValueTypeEnum
func GetImageDetailsSourceEnumStringValues() []string
GetImageDetailsSourceEnumStringValues Enumerates the set of values in String for ImageDetailsSourceEnum
func GetImageFeatureFeatureTypeEnumStringValues() []string
GetImageFeatureFeatureTypeEnumStringValues Enumerates the set of values in String for ImageFeatureFeatureTypeEnum
func GetImageJobLifecycleDetailsEnumStringValues() []string
GetImageJobLifecycleDetailsEnumStringValues Enumerates the set of values in String for ImageJobLifecycleDetailsEnum
func GetImageJobLifecycleStateEnumStringValues() []string
GetImageJobLifecycleStateEnumStringValues Enumerates the set of values in String for ImageJobLifecycleStateEnum
func GetInputLocationSourceTypeEnumStringValues() []string
GetInputLocationSourceTypeEnumStringValues Enumerates the set of values in String for InputLocationSourceTypeEnum
func GetLandmarkTypeEnumStringValues() []string
GetLandmarkTypeEnumStringValues Enumerates the set of values in String for LandmarkTypeEnum
func GetListModelsSortByEnumStringValues() []string
GetListModelsSortByEnumStringValues Enumerates the set of values in String for ListModelsSortByEnum
func GetListModelsSortOrderEnumStringValues() []string
GetListModelsSortOrderEnumStringValues Enumerates the set of values in String for ListModelsSortOrderEnum
func GetListProjectsSortByEnumStringValues() []string
GetListProjectsSortByEnumStringValues Enumerates the set of values in String for ListProjectsSortByEnum
func GetListProjectsSortOrderEnumStringValues() []string
GetListProjectsSortOrderEnumStringValues Enumerates the set of values in String for ListProjectsSortOrderEnum
func GetListWorkRequestErrorsSortByEnumStringValues() []string
GetListWorkRequestErrorsSortByEnumStringValues Enumerates the set of values in String for ListWorkRequestErrorsSortByEnum
func GetListWorkRequestErrorsSortOrderEnumStringValues() []string
GetListWorkRequestErrorsSortOrderEnumStringValues Enumerates the set of values in String for ListWorkRequestErrorsSortOrderEnum
func GetListWorkRequestLogsSortByEnumStringValues() []string
GetListWorkRequestLogsSortByEnumStringValues Enumerates the set of values in String for ListWorkRequestLogsSortByEnum
func GetListWorkRequestLogsSortOrderEnumStringValues() []string
GetListWorkRequestLogsSortOrderEnumStringValues Enumerates the set of values in String for ListWorkRequestLogsSortOrderEnum
func GetListWorkRequestsSortByEnumStringValues() []string
GetListWorkRequestsSortByEnumStringValues Enumerates the set of values in String for ListWorkRequestsSortByEnum
func GetListWorkRequestsSortOrderEnumStringValues() []string
GetListWorkRequestsSortOrderEnumStringValues Enumerates the set of values in String for ListWorkRequestsSortOrderEnum
func GetListWorkRequestsStatusEnumStringValues() []string
GetListWorkRequestsStatusEnumStringValues Enumerates the set of values in String for ListWorkRequestsStatusEnum
func GetModelLifecycleStateEnumStringValues() []string
GetModelLifecycleStateEnumStringValues Enumerates the set of values in String for ModelLifecycleStateEnum
func GetModelModelTypeEnumStringValues() []string
GetModelModelTypeEnumStringValues Enumerates the set of values in String for ModelModelTypeEnum
func GetOperationStatusEnumStringValues() []string
GetOperationStatusEnumStringValues Enumerates the set of values in String for OperationStatusEnum
func GetOperationTypeEnumStringValues() []string
GetOperationTypeEnumStringValues Enumerates the set of values in String for OperationTypeEnum
func GetProjectLifecycleStateEnumStringValues() []string
GetProjectLifecycleStateEnumStringValues Enumerates the set of values in String for ProjectLifecycleStateEnum
func GetSortOrderEnumStringValues() []string
GetSortOrderEnumStringValues Enumerates the set of values in String for SortOrderEnum
AIServiceVisionClient a client for AIServiceVision
type AIServiceVisionClient struct {
common.BaseClient
// contains filtered or unexported fields
}
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(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 (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/65.64.0/aivision/AnalyzeDocument.go.html to see an example of how to use AnalyzeDocument API. A default retry strategy applies to this operation AnalyzeDocument()
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/65.64.0/aivision/AnalyzeImage.go.html to see an example of how to use AnalyzeImage API. A default retry strategy applies to this operation AnalyzeImage()
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/65.64.0/aivision/CancelDocumentJob.go.html to see an example of how to use CancelDocumentJob API.
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/65.64.0/aivision/CancelImageJob.go.html to see an example of how to use CancelImageJob API.
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/65.64.0/aivision/CancelWorkRequest.go.html to see an example of how to use CancelWorkRequest API.
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/65.64.0/aivision/ChangeModelCompartment.go.html to see an example of how to use ChangeModelCompartment API.
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/65.64.0/aivision/ChangeProjectCompartment.go.html to see an example of how to use ChangeProjectCompartment API.
func (client *AIServiceVisionClient) ConfigurationProvider() *common.ConfigurationProvider
ConfigurationProvider the ConfigurationProvider used in this client, or null if none set
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/65.64.0/aivision/CreateDocumentJob.go.html to see an example of how to use CreateDocumentJob API.
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/65.64.0/aivision/CreateImageJob.go.html to see an example of how to use CreateImageJob API.
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/65.64.0/aivision/CreateModel.go.html to see an example of how to use CreateModel API.
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/65.64.0/aivision/CreateProject.go.html to see an example of how to use CreateProject API.
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/65.64.0/aivision/DeleteModel.go.html to see an example of how to use DeleteModel API.
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/65.64.0/aivision/DeleteProject.go.html to see an example of how to use DeleteProject API.
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/65.64.0/aivision/GetDocumentJob.go.html to see an example of how to use GetDocumentJob API.
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/65.64.0/aivision/GetImageJob.go.html to see an example of how to use GetImageJob API.
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/65.64.0/aivision/GetModel.go.html to see an example of how to use GetModel API.
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/65.64.0/aivision/GetProject.go.html to see an example of how to use GetProject API.
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/65.64.0/aivision/GetWorkRequest.go.html to see an example of how to use GetWorkRequest API.
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/65.64.0/aivision/ListModels.go.html to see an example of how to use ListModels API.
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/65.64.0/aivision/ListProjects.go.html to see an example of how to use ListProjects API.
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/65.64.0/aivision/ListWorkRequestErrors.go.html to see an example of how to use ListWorkRequestErrors API.
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/65.64.0/aivision/ListWorkRequestLogs.go.html to see an example of how to use ListWorkRequestLogs API.
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/65.64.0/aivision/ListWorkRequests.go.html to see an example of how to use ListWorkRequests API.
func (client *AIServiceVisionClient) SetRegion(region string)
SetRegion overrides the region of this client.
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/65.64.0/aivision/UpdateModel.go.html to see an example of how to use UpdateModel API.
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/65.64.0/aivision/UpdateProject.go.html to see an example of how to use UpdateProject API.
ActionTypeEnum Enum with underlying type: string
type ActionTypeEnum string
Set of constants representing the allowable values for ActionTypeEnum
const (
ActionTypeCreated ActionTypeEnum = "CREATED"
ActionTypeUpdated ActionTypeEnum = "UPDATED"
ActionTypeDeleted ActionTypeEnum = "DELETED"
ActionTypeInProgress ActionTypeEnum = "IN_PROGRESS"
ActionTypeRelated ActionTypeEnum = "RELATED"
ActionTypeFailed ActionTypeEnum = "FAILED"
)
func GetActionTypeEnumValues() []ActionTypeEnum
GetActionTypeEnumValues Enumerates the set of values for ActionTypeEnum
func GetMappingActionTypeEnum(val string) (ActionTypeEnum, bool)
GetMappingActionTypeEnum performs case Insensitive comparison on enum value and return the desired enum
AnalyzeDocumentDetails The details of how to analyze a document.
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"`
}
func (m AnalyzeDocumentDetails) String() string
func (m *AnalyzeDocumentDetails) UnmarshalJSON(data []byte) (e error)
UnmarshalJSON unmarshals from json
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
AnalyzeDocumentRequest wrapper for the AnalyzeDocument operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.64.0/aivision/AnalyzeDocument.go.html to see an example of how to use 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
}
func (request AnalyzeDocumentRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request AnalyzeDocumentRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request AnalyzeDocumentRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request AnalyzeDocumentRequest) String() string
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
AnalyzeDocumentResponse wrapper for the AnalyzeDocument operation
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"`
}
func (response AnalyzeDocumentResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response AnalyzeDocumentResponse) String() string
AnalyzeDocumentResult The document analysis results.
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"`
}
func (m AnalyzeDocumentResult) String() string
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
AnalyzeImageDetails The details of how to analyze an image.
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"`
}
func (m AnalyzeImageDetails) String() string
func (m *AnalyzeImageDetails) UnmarshalJSON(data []byte) (e error)
UnmarshalJSON unmarshals from json
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
AnalyzeImageRequest wrapper for the AnalyzeImage operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.64.0/aivision/AnalyzeImage.go.html to see an example of how to use 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
}
func (request AnalyzeImageRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request AnalyzeImageRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request AnalyzeImageRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request AnalyzeImageRequest) String() string
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
AnalyzeImageResponse wrapper for the AnalyzeImage operation
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"`
}
func (response AnalyzeImageResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response AnalyzeImageResponse) String() string
AnalyzeImageResult The image analysis results.
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 detected faces.
DetectedFaces []Face `mandatory:"false" json:"detectedFaces"`
// 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 face detection model version.
FaceDetectionModelVersion *string `mandatory:"false" json:"faceDetectionModelVersion"`
// The errors encountered during image analysis.
Errors []ProcessingError `mandatory:"false" json:"errors"`
}
func (m AnalyzeImageResult) String() string
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
BoundingPolygon The object-bounding polygon box.
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"`
}
func (m BoundingPolygon) String() string
func (m BoundingPolygon) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
CancelDocumentJobRequest wrapper for the CancelDocumentJob operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.64.0/aivision/CancelDocumentJob.go.html to see an example of how to use CancelDocumentJobRequest.
type CancelDocumentJobRequest struct {
// The 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
}
func (request CancelDocumentJobRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request CancelDocumentJobRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request CancelDocumentJobRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request CancelDocumentJobRequest) String() string
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
CancelDocumentJobResponse wrapper for the CancelDocumentJob operation
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"`
}
func (response CancelDocumentJobResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response CancelDocumentJobResponse) String() string
CancelImageJobRequest wrapper for the CancelImageJob operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.64.0/aivision/CancelImageJob.go.html to see an example of how to use CancelImageJobRequest.
type CancelImageJobRequest struct {
// The 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
}
func (request CancelImageJobRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request CancelImageJobRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request CancelImageJobRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request CancelImageJobRequest) String() string
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
CancelImageJobResponse wrapper for the CancelImageJob operation
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"`
}
func (response CancelImageJobResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response CancelImageJobResponse) String() string
CancelWorkRequestRequest wrapper for the CancelWorkRequest operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.64.0/aivision/CancelWorkRequest.go.html to see an example of how to use 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
}
func (request CancelWorkRequestRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request CancelWorkRequestRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request CancelWorkRequestRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request CancelWorkRequestRequest) String() string
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
CancelWorkRequestResponse wrapper for the CancelWorkRequest operation
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"`
}
func (response CancelWorkRequestResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response CancelWorkRequestResponse) String() string
Cell A single cell in a table.
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"`
}
func (m Cell) String() string
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
ChangeModelCompartmentDetails The compartment the model should be moved to.
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"`
}
func (m ChangeModelCompartmentDetails) String() string
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
ChangeModelCompartmentRequest wrapper for the ChangeModelCompartment operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.64.0/aivision/ChangeModelCompartment.go.html to see an example of how to use 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
}
func (request ChangeModelCompartmentRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ChangeModelCompartmentRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ChangeModelCompartmentRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ChangeModelCompartmentRequest) String() string
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
ChangeModelCompartmentResponse wrapper for the ChangeModelCompartment operation
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"`
}
func (response ChangeModelCompartmentResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ChangeModelCompartmentResponse) String() string
ChangeProjectCompartmentDetails Which compartment the project should be moved to.
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"`
}
func (m ChangeProjectCompartmentDetails) String() string
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
ChangeProjectCompartmentRequest wrapper for the ChangeProjectCompartment operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.64.0/aivision/ChangeProjectCompartment.go.html to see an example of how to use 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
}
func (request ChangeProjectCompartmentRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ChangeProjectCompartmentRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ChangeProjectCompartmentRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ChangeProjectCompartmentRequest) String() string
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
ChangeProjectCompartmentResponse wrapper for the ChangeProjectCompartment operation
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"`
}
func (response ChangeProjectCompartmentResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ChangeProjectCompartmentResponse) String() string
CreateDocumentJobDetails The batch document analysis details.
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"`
}
func (m CreateDocumentJobDetails) String() string
func (m *CreateDocumentJobDetails) UnmarshalJSON(data []byte) (e error)
UnmarshalJSON unmarshals from json
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
CreateDocumentJobRequest wrapper for the CreateDocumentJob operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.64.0/aivision/CreateDocumentJob.go.html to see an example of how to use 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
}
func (request CreateDocumentJobRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request CreateDocumentJobRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request CreateDocumentJobRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request CreateDocumentJobRequest) String() string
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
CreateDocumentJobResponse wrapper for the CreateDocumentJob operation
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"`
}
func (response CreateDocumentJobResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response CreateDocumentJobResponse) String() string
CreateImageJobDetails The details of the batch image analysis.
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"`
}
func (m CreateImageJobDetails) String() string
func (m *CreateImageJobDetails) UnmarshalJSON(data []byte) (e error)
UnmarshalJSON unmarshals from json
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
CreateImageJobRequest wrapper for the CreateImageJob operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.64.0/aivision/CreateImageJob.go.html to see an example of how to use 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
}
func (request CreateImageJobRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request CreateImageJobRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request CreateImageJobRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request CreateImageJobRequest) String() string
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
CreateImageJobResponse wrapper for the CreateImageJob operation
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"`
}
func (response CreateImageJobResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response CreateImageJobResponse) String() string
CreateModelDetails The information needed to create a new model.
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"`
}
func (m CreateModelDetails) String() string
func (m *CreateModelDetails) UnmarshalJSON(data []byte) (e error)
UnmarshalJSON unmarshals from json
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
CreateModelRequest wrapper for the CreateModel operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.64.0/aivision/CreateModel.go.html to see an example of how to use 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
}
func (request CreateModelRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request CreateModelRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request CreateModelRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request CreateModelRequest) String() string
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
CreateModelResponse wrapper for the CreateModel operation
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"`
}
func (response CreateModelResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response CreateModelResponse) String() string
CreateProjectDetails The information needed to create a new project.
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"`
}
func (m CreateProjectDetails) String() string
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
CreateProjectRequest wrapper for the CreateProject operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.64.0/aivision/CreateProject.go.html to see an example of how to use 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
}
func (request CreateProjectRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request CreateProjectRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request CreateProjectRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request CreateProjectRequest) String() string
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
CreateProjectResponse wrapper for the CreateProject operation
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"`
}
func (response CreateProjectResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response CreateProjectResponse) String() string
DataScienceLabelingDataset The dataset created by the Data Labeling Service.
type DataScienceLabelingDataset struct {
// OCID of the Data Labeling dataset.
DatasetId *string `mandatory:"true" json:"datasetId"`
}
func (m DataScienceLabelingDataset) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m DataScienceLabelingDataset) String() string
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
Dataset The base entity which is the input for creating and training a model.
type Dataset interface {
}
DatasetDatasetTypeEnum Enum with underlying type: string
type DatasetDatasetTypeEnum string
Set of constants representing the allowable values for DatasetDatasetTypeEnum
const (
DatasetDatasetTypeDataScienceLabeling DatasetDatasetTypeEnum = "DATA_SCIENCE_LABELING"
DatasetDatasetTypeObjectStorage DatasetDatasetTypeEnum = "OBJECT_STORAGE"
)
func GetDatasetDatasetTypeEnumValues() []DatasetDatasetTypeEnum
GetDatasetDatasetTypeEnumValues Enumerates the set of values for DatasetDatasetTypeEnum
func GetMappingDatasetDatasetTypeEnum(val string) (DatasetDatasetTypeEnum, bool)
GetMappingDatasetDatasetTypeEnum performs case Insensitive comparison on enum value and return the desired enum
DeleteModelRequest wrapper for the DeleteModel operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.64.0/aivision/DeleteModel.go.html to see an example of how to use 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
}
func (request DeleteModelRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request DeleteModelRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request DeleteModelRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request DeleteModelRequest) String() string
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
DeleteModelResponse wrapper for the DeleteModel operation
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"`
}
func (response DeleteModelResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response DeleteModelResponse) String() string
DeleteProjectRequest wrapper for the DeleteProject operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.64.0/aivision/DeleteProject.go.html to see an example of how to use 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
}
func (request DeleteProjectRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request DeleteProjectRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request DeleteProjectRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request DeleteProjectRequest) String() string
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
DeleteProjectResponse wrapper for the DeleteProject operation
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"`
}
func (response DeleteProjectResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response DeleteProjectResponse) String() string
DetectedDocumentType The detected document type.
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"`
}
func (m DetectedDocumentType) String() string
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
DetectedLanguage The language detected in a document.
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"`
}
func (m DetectedLanguage) String() string
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
Dimensions The width and height of a page.
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"`
}
func (m Dimensions) String() string
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
DimensionsUnitEnum Enum with underlying type: string
type DimensionsUnitEnum string
Set of constants representing the allowable values for DimensionsUnitEnum
const (
DimensionsUnitPixel DimensionsUnitEnum = "PIXEL"
DimensionsUnitInch DimensionsUnitEnum = "INCH"
)
func GetDimensionsUnitEnumValues() []DimensionsUnitEnum
GetDimensionsUnitEnumValues Enumerates the set of values for DimensionsUnitEnum
func GetMappingDimensionsUnitEnum(val string) (DimensionsUnitEnum, bool)
GetMappingDimensionsUnitEnum performs case Insensitive comparison on enum value and return the desired enum
DocumentClassificationFeature Identifying the document type.
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"`
}
func (m DocumentClassificationFeature) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m DocumentClassificationFeature) String() string
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
DocumentDetails The details of a document to analyze.
type DocumentDetails interface {
}
DocumentDetailsSourceEnum Enum with underlying type: string
type DocumentDetailsSourceEnum string
Set of constants representing the allowable values for DocumentDetailsSourceEnum
const (
DocumentDetailsSourceInline DocumentDetailsSourceEnum = "INLINE"
DocumentDetailsSourceObjectStorage DocumentDetailsSourceEnum = "OBJECT_STORAGE"
)
func GetDocumentDetailsSourceEnumValues() []DocumentDetailsSourceEnum
GetDocumentDetailsSourceEnumValues Enumerates the set of values for DocumentDetailsSourceEnum
func GetMappingDocumentDetailsSourceEnum(val string) (DocumentDetailsSourceEnum, bool)
GetMappingDocumentDetailsSourceEnum performs case Insensitive comparison on enum value and return the desired enum
DocumentFeature The type of document analysis.
type DocumentFeature interface {
}
DocumentFeatureFeatureTypeEnum Enum with underlying type: string
type DocumentFeatureFeatureTypeEnum string
Set of constants representing the allowable values for DocumentFeatureFeatureTypeEnum
const (
DocumentFeatureFeatureTypeLanguageClassification DocumentFeatureFeatureTypeEnum = "LANGUAGE_CLASSIFICATION"
DocumentFeatureFeatureTypeTextDetection DocumentFeatureFeatureTypeEnum = "TEXT_DETECTION"
DocumentFeatureFeatureTypeTableDetection DocumentFeatureFeatureTypeEnum = "TABLE_DETECTION"
DocumentFeatureFeatureTypeKeyValueDetection DocumentFeatureFeatureTypeEnum = "KEY_VALUE_DETECTION"
DocumentFeatureFeatureTypeDocumentClassification DocumentFeatureFeatureTypeEnum = "DOCUMENT_CLASSIFICATION"
)
func GetDocumentFeatureFeatureTypeEnumValues() []DocumentFeatureFeatureTypeEnum
GetDocumentFeatureFeatureTypeEnumValues Enumerates the set of values for DocumentFeatureFeatureTypeEnum
func GetMappingDocumentFeatureFeatureTypeEnum(val string) (DocumentFeatureFeatureTypeEnum, bool)
GetMappingDocumentFeatureFeatureTypeEnum performs case Insensitive comparison on enum value and return the desired enum
DocumentField Form field.
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"`
}
func (m DocumentField) String() string
func (m *DocumentField) UnmarshalJSON(data []byte) (e error)
UnmarshalJSON unmarshals from json
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
DocumentFieldFieldTypeEnum Enum with underlying type: string
type DocumentFieldFieldTypeEnum string
Set of constants representing the allowable values for DocumentFieldFieldTypeEnum
const (
DocumentFieldFieldTypeLineItemGroup DocumentFieldFieldTypeEnum = "LINE_ITEM_GROUP"
DocumentFieldFieldTypeLineItem DocumentFieldFieldTypeEnum = "LINE_ITEM"
DocumentFieldFieldTypeLineItemField DocumentFieldFieldTypeEnum = "LINE_ITEM_FIELD"
DocumentFieldFieldTypeKeyValue DocumentFieldFieldTypeEnum = "KEY_VALUE"
)
func GetDocumentFieldFieldTypeEnumValues() []DocumentFieldFieldTypeEnum
GetDocumentFieldFieldTypeEnumValues Enumerates the set of values for DocumentFieldFieldTypeEnum
func GetMappingDocumentFieldFieldTypeEnum(val string) (DocumentFieldFieldTypeEnum, bool)
GetMappingDocumentFieldFieldTypeEnum performs case Insensitive comparison on enum value and return the desired enum
DocumentJob The job details for a batch document analysis.
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"`
}
func (m DocumentJob) String() string
func (m *DocumentJob) UnmarshalJSON(data []byte) (e error)
UnmarshalJSON unmarshals from json
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
DocumentJobLifecycleDetailsEnum Enum with underlying type: string
type DocumentJobLifecycleDetailsEnum string
Set of constants representing the allowable values for DocumentJobLifecycleDetailsEnum
const (
DocumentJobLifecycleDetailsPartiallySucceeded DocumentJobLifecycleDetailsEnum = "PARTIALLY_SUCCEEDED"
DocumentJobLifecycleDetailsCompletelyFailed DocumentJobLifecycleDetailsEnum = "COMPLETELY_FAILED"
)
func GetDocumentJobLifecycleDetailsEnumValues() []DocumentJobLifecycleDetailsEnum
GetDocumentJobLifecycleDetailsEnumValues Enumerates the set of values for DocumentJobLifecycleDetailsEnum
func GetMappingDocumentJobLifecycleDetailsEnum(val string) (DocumentJobLifecycleDetailsEnum, bool)
GetMappingDocumentJobLifecycleDetailsEnum performs case Insensitive comparison on enum value and return the desired enum
DocumentJobLifecycleStateEnum Enum with underlying type: string
type DocumentJobLifecycleStateEnum string
Set of constants representing the allowable values for DocumentJobLifecycleStateEnum
const (
DocumentJobLifecycleStateSucceeded DocumentJobLifecycleStateEnum = "SUCCEEDED"
DocumentJobLifecycleStateFailed DocumentJobLifecycleStateEnum = "FAILED"
DocumentJobLifecycleStateAccepted DocumentJobLifecycleStateEnum = "ACCEPTED"
DocumentJobLifecycleStateCanceled DocumentJobLifecycleStateEnum = "CANCELED"
DocumentJobLifecycleStateInProgress DocumentJobLifecycleStateEnum = "IN_PROGRESS"
DocumentJobLifecycleStateCanceling DocumentJobLifecycleStateEnum = "CANCELING"
)
func GetDocumentJobLifecycleStateEnumValues() []DocumentJobLifecycleStateEnum
GetDocumentJobLifecycleStateEnumValues Enumerates the set of values for DocumentJobLifecycleStateEnum
func GetMappingDocumentJobLifecycleStateEnum(val string) (DocumentJobLifecycleStateEnum, bool)
GetMappingDocumentJobLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum
DocumentKeyValueDetectionFeature Extracting form fields.
type DocumentKeyValueDetectionFeature struct {
}
func (m DocumentKeyValueDetectionFeature) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m DocumentKeyValueDetectionFeature) String() string
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
DocumentLanguageClassificationFeature Detecting the language of the document.
type DocumentLanguageClassificationFeature struct {
// The maximum number of results to return.
MaxResults *int `mandatory:"false" json:"maxResults"`
}
func (m DocumentLanguageClassificationFeature) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m DocumentLanguageClassificationFeature) String() string
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
DocumentLanguageEnum Enum with underlying type: string
type DocumentLanguageEnum string
Set of constants representing the allowable values for DocumentLanguageEnum
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"
)
func GetDocumentLanguageEnumValues() []DocumentLanguageEnum
GetDocumentLanguageEnumValues Enumerates the set of values for DocumentLanguageEnum
func GetMappingDocumentLanguageEnum(val string) (DocumentLanguageEnum, bool)
GetMappingDocumentLanguageEnum performs case Insensitive comparison on enum value and return the desired enum
DocumentMetadata The document information.
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"`
}
func (m DocumentMetadata) String() string
func (m DocumentMetadata) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
DocumentTableDetectionFeature Detecting and extracting data in tables.
type DocumentTableDetectionFeature struct {
}
func (m DocumentTableDetectionFeature) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m DocumentTableDetectionFeature) String() string
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
DocumentTextDetectionFeature Text recognition
type DocumentTextDetectionFeature struct {
// Whether or not to generate a searchable PDF file.
GenerateSearchablePdf *bool `mandatory:"false" json:"generateSearchablePdf"`
}
func (m DocumentTextDetectionFeature) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m DocumentTextDetectionFeature) String() string
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
DocumentTypeEnum Enum with underlying type: string
type DocumentTypeEnum string
Set of constants representing the allowable values for DocumentTypeEnum
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"
)
func GetDocumentTypeEnumValues() []DocumentTypeEnum
GetDocumentTypeEnumValues Enumerates the set of values for DocumentTypeEnum
func GetMappingDocumentTypeEnum(val string) (DocumentTypeEnum, bool)
GetMappingDocumentTypeEnum performs case Insensitive comparison on enum value and return the desired enum
Face The detected face.
type Face struct {
// The confidence score, between 0 and 1.
Confidence *float32 `mandatory:"true" json:"confidence"`
BoundingPolygon *BoundingPolygon `mandatory:"true" json:"boundingPolygon"`
// The quality score of the face detected, between 0 and 1.
QualityScore *float32 `mandatory:"true" json:"qualityScore"`
// A point of interest within a face.
Landmarks []Landmark `mandatory:"false" json:"landmarks"`
}
func (m Face) String() string
func (m Face) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
FaceDetectionFeature The face detection parameters.
type FaceDetectionFeature struct {
// The maximum number of results to return.
MaxResults *int `mandatory:"false" json:"maxResults"`
// Whether or not return face landmarks.
ShouldReturnLandmarks *bool `mandatory:"false" json:"shouldReturnLandmarks"`
}
func (m FaceDetectionFeature) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m FaceDetectionFeature) String() string
func (m FaceDetectionFeature) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
FieldLabel The label in a field.
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"`
}
func (m FieldLabel) String() string
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
FieldName The name of a form field.
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"`
}
func (m FieldName) String() string
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
FieldValue The value of a form field.
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
}
FieldValueValueTypeEnum Enum with underlying type: string
type FieldValueValueTypeEnum string
Set of constants representing the allowable values for FieldValueValueTypeEnum
const (
FieldValueValueTypeString FieldValueValueTypeEnum = "STRING"
FieldValueValueTypeDate FieldValueValueTypeEnum = "DATE"
FieldValueValueTypeTime FieldValueValueTypeEnum = "TIME"
FieldValueValueTypePhoneNumber FieldValueValueTypeEnum = "PHONE_NUMBER"
FieldValueValueTypeNumber FieldValueValueTypeEnum = "NUMBER"
FieldValueValueTypeInteger FieldValueValueTypeEnum = "INTEGER"
FieldValueValueTypeArray FieldValueValueTypeEnum = "ARRAY"
)
func GetFieldValueValueTypeEnumValues() []FieldValueValueTypeEnum
GetFieldValueValueTypeEnumValues Enumerates the set of values for FieldValueValueTypeEnum
func GetMappingFieldValueValueTypeEnum(val string) (FieldValueValueTypeEnum, bool)
GetMappingFieldValueValueTypeEnum performs case Insensitive comparison on enum value and return the desired enum
GetDocumentJobRequest wrapper for the GetDocumentJob operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.64.0/aivision/GetDocumentJob.go.html to see an example of how to use GetDocumentJobRequest.
type GetDocumentJobRequest struct {
// The 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
}
func (request GetDocumentJobRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request GetDocumentJobRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetDocumentJobRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetDocumentJobRequest) String() string
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
GetDocumentJobResponse wrapper for the GetDocumentJob operation
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"`
}
func (response GetDocumentJobResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetDocumentJobResponse) String() string
GetImageJobRequest wrapper for the GetImageJob operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.64.0/aivision/GetImageJob.go.html to see an example of how to use GetImageJobRequest.
type GetImageJobRequest struct {
// The 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
}
func (request GetImageJobRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request GetImageJobRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetImageJobRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetImageJobRequest) String() string
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
GetImageJobResponse wrapper for the GetImageJob operation
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"`
}
func (response GetImageJobResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetImageJobResponse) String() string
GetModelRequest wrapper for the GetModel operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.64.0/aivision/GetModel.go.html to see an example of how to use 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
}
func (request GetModelRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request GetModelRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetModelRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetModelRequest) String() string
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
GetModelResponse wrapper for the GetModel operation
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"`
}
func (response GetModelResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetModelResponse) String() string
GetProjectRequest wrapper for the GetProject operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.64.0/aivision/GetProject.go.html to see an example of how to use 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
}
func (request GetProjectRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request GetProjectRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetProjectRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetProjectRequest) String() string
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
GetProjectResponse wrapper for the GetProject operation
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"`
}
func (response GetProjectResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetProjectResponse) String() string
GetWorkRequestRequest wrapper for the GetWorkRequest operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.64.0/aivision/GetWorkRequest.go.html to see an example of how to use 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
}
func (request GetWorkRequestRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request GetWorkRequestRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetWorkRequestRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetWorkRequestRequest) String() string
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
GetWorkRequestResponse wrapper for the GetWorkRequest operation
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"`
}
func (response GetWorkRequestResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetWorkRequestResponse) String() string
ImageClassificationFeature The image classification parameters.
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"`
}
func (m ImageClassificationFeature) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m ImageClassificationFeature) String() string
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
ImageDetails The details of an image to analyze.
type ImageDetails interface {
}
ImageDetailsSourceEnum Enum with underlying type: string
type ImageDetailsSourceEnum string
Set of constants representing the allowable values for ImageDetailsSourceEnum
const (
ImageDetailsSourceInline ImageDetailsSourceEnum = "INLINE"
ImageDetailsSourceObjectStorage ImageDetailsSourceEnum = "OBJECT_STORAGE"
)
func GetImageDetailsSourceEnumValues() []ImageDetailsSourceEnum
GetImageDetailsSourceEnumValues Enumerates the set of values for ImageDetailsSourceEnum
func GetMappingImageDetailsSourceEnum(val string) (ImageDetailsSourceEnum, bool)
GetMappingImageDetailsSourceEnum performs case Insensitive comparison on enum value and return the desired enum
ImageFeature The type of image analysis.
type ImageFeature interface {
}
ImageFeatureFeatureTypeEnum Enum with underlying type: string
type ImageFeatureFeatureTypeEnum string
Set of constants representing the allowable values for ImageFeatureFeatureTypeEnum
const (
ImageFeatureFeatureTypeImageClassification ImageFeatureFeatureTypeEnum = "IMAGE_CLASSIFICATION"
ImageFeatureFeatureTypeObjectDetection ImageFeatureFeatureTypeEnum = "OBJECT_DETECTION"
ImageFeatureFeatureTypeTextDetection ImageFeatureFeatureTypeEnum = "TEXT_DETECTION"
ImageFeatureFeatureTypeFaceDetection ImageFeatureFeatureTypeEnum = "FACE_DETECTION"
)
func GetImageFeatureFeatureTypeEnumValues() []ImageFeatureFeatureTypeEnum
GetImageFeatureFeatureTypeEnumValues Enumerates the set of values for ImageFeatureFeatureTypeEnum
func GetMappingImageFeatureFeatureTypeEnum(val string) (ImageFeatureFeatureTypeEnum, bool)
GetMappingImageFeatureFeatureTypeEnum performs case Insensitive comparison on enum value and return the desired enum
ImageJob The job details for a batch image analysis.
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"`
}
func (m ImageJob) String() string
func (m *ImageJob) UnmarshalJSON(data []byte) (e error)
UnmarshalJSON unmarshals from json
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
ImageJobLifecycleDetailsEnum Enum with underlying type: string
type ImageJobLifecycleDetailsEnum string
Set of constants representing the allowable values for ImageJobLifecycleDetailsEnum
const (
ImageJobLifecycleDetailsPartiallySucceeded ImageJobLifecycleDetailsEnum = "PARTIALLY_SUCCEEDED"
ImageJobLifecycleDetailsCompletelyFailed ImageJobLifecycleDetailsEnum = "COMPLETELY_FAILED"
)
func GetImageJobLifecycleDetailsEnumValues() []ImageJobLifecycleDetailsEnum
GetImageJobLifecycleDetailsEnumValues Enumerates the set of values for ImageJobLifecycleDetailsEnum
func GetMappingImageJobLifecycleDetailsEnum(val string) (ImageJobLifecycleDetailsEnum, bool)
GetMappingImageJobLifecycleDetailsEnum performs case Insensitive comparison on enum value and return the desired enum
ImageJobLifecycleStateEnum Enum with underlying type: string
type ImageJobLifecycleStateEnum string
Set of constants representing the allowable values for ImageJobLifecycleStateEnum
const (
ImageJobLifecycleStateSucceeded ImageJobLifecycleStateEnum = "SUCCEEDED"
ImageJobLifecycleStateFailed ImageJobLifecycleStateEnum = "FAILED"
ImageJobLifecycleStateAccepted ImageJobLifecycleStateEnum = "ACCEPTED"
ImageJobLifecycleStateCanceled ImageJobLifecycleStateEnum = "CANCELED"
ImageJobLifecycleStateInProgress ImageJobLifecycleStateEnum = "IN_PROGRESS"
ImageJobLifecycleStateCanceling ImageJobLifecycleStateEnum = "CANCELING"
)
func GetImageJobLifecycleStateEnumValues() []ImageJobLifecycleStateEnum
GetImageJobLifecycleStateEnumValues Enumerates the set of values for ImageJobLifecycleStateEnum
func GetMappingImageJobLifecycleStateEnum(val string) (ImageJobLifecycleStateEnum, bool)
GetMappingImageJobLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum
ImageObject The object detected in an image.
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"`
}
func (m ImageObject) String() string
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
ImageObjectDetectionFeature The object detection parameters.
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"`
}
func (m ImageObjectDetectionFeature) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m ImageObjectDetectionFeature) String() string
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
ImageText The detected text.
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"`
}
func (m ImageText) String() string
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
ImageTextDetectionFeature The text detection parameters.
type ImageTextDetectionFeature struct {
// The language of the document image, abbreviated according to ISO 639-2.
Language DocumentLanguageEnum `mandatory:"false" json:"language,omitempty"`
}
func (m ImageTextDetectionFeature) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m ImageTextDetectionFeature) String() string
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
InlineDocumentDetails The document incorporated in the request payload.
type InlineDocumentDetails struct {
// Raw document data.
Data []byte `mandatory:"true" json:"data"`
}
func (m InlineDocumentDetails) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m InlineDocumentDetails) String() string
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
InlineImageDetails The image incorporated in the request payload.
type InlineImageDetails struct {
// Raw image data.
Data []byte `mandatory:"true" json:"data"`
}
func (m InlineImageDetails) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m InlineImageDetails) String() string
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
InputLocation The location of the inputs.
type InputLocation interface {
}
InputLocationSourceTypeEnum Enum with underlying type: string
type InputLocationSourceTypeEnum string
Set of constants representing the allowable values for InputLocationSourceTypeEnum
const (
InputLocationSourceTypeObjectListInlineInputLocation InputLocationSourceTypeEnum = "OBJECT_LIST_INLINE_INPUT_LOCATION"
)
func GetInputLocationSourceTypeEnumValues() []InputLocationSourceTypeEnum
GetInputLocationSourceTypeEnumValues Enumerates the set of values for InputLocationSourceTypeEnum
func GetMappingInputLocationSourceTypeEnum(val string) (InputLocationSourceTypeEnum, bool)
GetMappingInputLocationSourceTypeEnum performs case Insensitive comparison on enum value and return the desired enum
Label A label describing an image. Every label returned by the pre-deployed model is in English.
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"`
}
func (m Label) String() string
func (m Label) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
Landmark The landmark on the face.
type Landmark struct {
// The face landmark type
Type LandmarkTypeEnum `mandatory:"true" json:"type"`
// The X-axis normalized coordinate.
X *float32 `mandatory:"true" json:"x"`
// The Y-axis normalized coordinate.
Y *float32 `mandatory:"true" json:"y"`
}
func (m Landmark) String() string
func (m Landmark) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
LandmarkTypeEnum Enum with underlying type: string
type LandmarkTypeEnum string
Set of constants representing the allowable values for LandmarkTypeEnum
const (
LandmarkTypeLeftEye LandmarkTypeEnum = "LEFT_EYE"
LandmarkTypeRightEye LandmarkTypeEnum = "RIGHT_EYE"
LandmarkTypeNoseTip LandmarkTypeEnum = "NOSE_TIP"
LandmarkTypeLeftEdgeOfMouth LandmarkTypeEnum = "LEFT_EDGE_OF_MOUTH"
LandmarkTypeRightEdgeOfMouth LandmarkTypeEnum = "RIGHT_EDGE_OF_MOUTH"
)
func GetLandmarkTypeEnumValues() []LandmarkTypeEnum
GetLandmarkTypeEnumValues Enumerates the set of values for LandmarkTypeEnum
func GetMappingLandmarkTypeEnum(val string) (LandmarkTypeEnum, bool)
GetMappingLandmarkTypeEnum performs case Insensitive comparison on enum value and return the desired enum
Line The line of text.
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"`
}
func (m Line) String() string
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
ListModelsRequest wrapper for the ListModels operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.64.0/aivision/ListModels.go.html to see an example of how to use 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
}
func (request ListModelsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListModelsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListModelsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListModelsRequest) String() string
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
ListModelsResponse wrapper for the ListModels operation
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"`
}
func (response ListModelsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListModelsResponse) String() string
ListModelsSortByEnum Enum with underlying type: string
type ListModelsSortByEnum string
Set of constants representing the allowable values for ListModelsSortByEnum
const (
ListModelsSortByTimecreated ListModelsSortByEnum = "timeCreated"
ListModelsSortByDisplayname ListModelsSortByEnum = "displayName"
)
func GetListModelsSortByEnumValues() []ListModelsSortByEnum
GetListModelsSortByEnumValues Enumerates the set of values for ListModelsSortByEnum
func GetMappingListModelsSortByEnum(val string) (ListModelsSortByEnum, bool)
GetMappingListModelsSortByEnum performs case Insensitive comparison on enum value and return the desired enum
ListModelsSortOrderEnum Enum with underlying type: string
type ListModelsSortOrderEnum string
Set of constants representing the allowable values for ListModelsSortOrderEnum
const (
ListModelsSortOrderAsc ListModelsSortOrderEnum = "ASC"
ListModelsSortOrderDesc ListModelsSortOrderEnum = "DESC"
)
func GetListModelsSortOrderEnumValues() []ListModelsSortOrderEnum
GetListModelsSortOrderEnumValues Enumerates the set of values for ListModelsSortOrderEnum
func GetMappingListModelsSortOrderEnum(val string) (ListModelsSortOrderEnum, bool)
GetMappingListModelsSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
ListProjectsRequest wrapper for the ListProjects operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.64.0/aivision/ListProjects.go.html to see an example of how to use 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
}
func (request ListProjectsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListProjectsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListProjectsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListProjectsRequest) String() string
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
ListProjectsResponse wrapper for the ListProjects operation
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"`
}
func (response ListProjectsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListProjectsResponse) String() string
ListProjectsSortByEnum Enum with underlying type: string
type ListProjectsSortByEnum string
Set of constants representing the allowable values for ListProjectsSortByEnum
const (
ListProjectsSortByTimecreated ListProjectsSortByEnum = "timeCreated"
ListProjectsSortByDisplayname ListProjectsSortByEnum = "displayName"
)
func GetListProjectsSortByEnumValues() []ListProjectsSortByEnum
GetListProjectsSortByEnumValues Enumerates the set of values for ListProjectsSortByEnum
func GetMappingListProjectsSortByEnum(val string) (ListProjectsSortByEnum, bool)
GetMappingListProjectsSortByEnum performs case Insensitive comparison on enum value and return the desired enum
ListProjectsSortOrderEnum Enum with underlying type: string
type ListProjectsSortOrderEnum string
Set of constants representing the allowable values for ListProjectsSortOrderEnum
const (
ListProjectsSortOrderAsc ListProjectsSortOrderEnum = "ASC"
ListProjectsSortOrderDesc ListProjectsSortOrderEnum = "DESC"
)
func GetListProjectsSortOrderEnumValues() []ListProjectsSortOrderEnum
GetListProjectsSortOrderEnumValues Enumerates the set of values for ListProjectsSortOrderEnum
func GetMappingListProjectsSortOrderEnum(val string) (ListProjectsSortOrderEnum, bool)
GetMappingListProjectsSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
ListWorkRequestErrorsRequest wrapper for the ListWorkRequestErrors operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.64.0/aivision/ListWorkRequestErrors.go.html to see an example of how to use 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
}
func (request ListWorkRequestErrorsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListWorkRequestErrorsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListWorkRequestErrorsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListWorkRequestErrorsRequest) String() string
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
ListWorkRequestErrorsResponse wrapper for the ListWorkRequestErrors operation
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"`
}
func (response ListWorkRequestErrorsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListWorkRequestErrorsResponse) String() string
ListWorkRequestErrorsSortByEnum Enum with underlying type: string
type ListWorkRequestErrorsSortByEnum string
Set of constants representing the allowable values for ListWorkRequestErrorsSortByEnum
const (
ListWorkRequestErrorsSortByTimeaccepted ListWorkRequestErrorsSortByEnum = "timeAccepted"
)
func GetListWorkRequestErrorsSortByEnumValues() []ListWorkRequestErrorsSortByEnum
GetListWorkRequestErrorsSortByEnumValues Enumerates the set of values for ListWorkRequestErrorsSortByEnum
func GetMappingListWorkRequestErrorsSortByEnum(val string) (ListWorkRequestErrorsSortByEnum, bool)
GetMappingListWorkRequestErrorsSortByEnum performs case Insensitive comparison on enum value and return the desired enum
ListWorkRequestErrorsSortOrderEnum Enum with underlying type: string
type ListWorkRequestErrorsSortOrderEnum string
Set of constants representing the allowable values for ListWorkRequestErrorsSortOrderEnum
const (
ListWorkRequestErrorsSortOrderAsc ListWorkRequestErrorsSortOrderEnum = "ASC"
ListWorkRequestErrorsSortOrderDesc ListWorkRequestErrorsSortOrderEnum = "DESC"
)
func GetListWorkRequestErrorsSortOrderEnumValues() []ListWorkRequestErrorsSortOrderEnum
GetListWorkRequestErrorsSortOrderEnumValues Enumerates the set of values for ListWorkRequestErrorsSortOrderEnum
func GetMappingListWorkRequestErrorsSortOrderEnum(val string) (ListWorkRequestErrorsSortOrderEnum, bool)
GetMappingListWorkRequestErrorsSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
ListWorkRequestLogsRequest wrapper for the ListWorkRequestLogs operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.64.0/aivision/ListWorkRequestLogs.go.html to see an example of how to use 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
}
func (request ListWorkRequestLogsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListWorkRequestLogsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListWorkRequestLogsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListWorkRequestLogsRequest) String() string
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
ListWorkRequestLogsResponse wrapper for the ListWorkRequestLogs operation
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"`
}
func (response ListWorkRequestLogsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListWorkRequestLogsResponse) String() string
ListWorkRequestLogsSortByEnum Enum with underlying type: string
type ListWorkRequestLogsSortByEnum string
Set of constants representing the allowable values for ListWorkRequestLogsSortByEnum
const (
ListWorkRequestLogsSortByTimeaccepted ListWorkRequestLogsSortByEnum = "timeAccepted"
)
func GetListWorkRequestLogsSortByEnumValues() []ListWorkRequestLogsSortByEnum
GetListWorkRequestLogsSortByEnumValues Enumerates the set of values for ListWorkRequestLogsSortByEnum
func GetMappingListWorkRequestLogsSortByEnum(val string) (ListWorkRequestLogsSortByEnum, bool)
GetMappingListWorkRequestLogsSortByEnum performs case Insensitive comparison on enum value and return the desired enum
ListWorkRequestLogsSortOrderEnum Enum with underlying type: string
type ListWorkRequestLogsSortOrderEnum string
Set of constants representing the allowable values for ListWorkRequestLogsSortOrderEnum
const (
ListWorkRequestLogsSortOrderAsc ListWorkRequestLogsSortOrderEnum = "ASC"
ListWorkRequestLogsSortOrderDesc ListWorkRequestLogsSortOrderEnum = "DESC"
)
func GetListWorkRequestLogsSortOrderEnumValues() []ListWorkRequestLogsSortOrderEnum
GetListWorkRequestLogsSortOrderEnumValues Enumerates the set of values for ListWorkRequestLogsSortOrderEnum
func GetMappingListWorkRequestLogsSortOrderEnum(val string) (ListWorkRequestLogsSortOrderEnum, bool)
GetMappingListWorkRequestLogsSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
ListWorkRequestsRequest wrapper for the ListWorkRequests operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.64.0/aivision/ListWorkRequests.go.html to see an example of how to use 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
}
func (request ListWorkRequestsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListWorkRequestsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListWorkRequestsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListWorkRequestsRequest) String() string
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
ListWorkRequestsResponse wrapper for the ListWorkRequests operation
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"`
}
func (response ListWorkRequestsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListWorkRequestsResponse) String() string
ListWorkRequestsSortByEnum Enum with underlying type: string
type ListWorkRequestsSortByEnum string
Set of constants representing the allowable values for ListWorkRequestsSortByEnum
const (
ListWorkRequestsSortByTimeaccepted ListWorkRequestsSortByEnum = "timeAccepted"
)
func GetListWorkRequestsSortByEnumValues() []ListWorkRequestsSortByEnum
GetListWorkRequestsSortByEnumValues Enumerates the set of values for ListWorkRequestsSortByEnum
func GetMappingListWorkRequestsSortByEnum(val string) (ListWorkRequestsSortByEnum, bool)
GetMappingListWorkRequestsSortByEnum performs case Insensitive comparison on enum value and return the desired enum
ListWorkRequestsSortOrderEnum Enum with underlying type: string
type ListWorkRequestsSortOrderEnum string
Set of constants representing the allowable values for ListWorkRequestsSortOrderEnum
const (
ListWorkRequestsSortOrderAsc ListWorkRequestsSortOrderEnum = "ASC"
ListWorkRequestsSortOrderDesc ListWorkRequestsSortOrderEnum = "DESC"
)
func GetListWorkRequestsSortOrderEnumValues() []ListWorkRequestsSortOrderEnum
GetListWorkRequestsSortOrderEnumValues Enumerates the set of values for ListWorkRequestsSortOrderEnum
func GetMappingListWorkRequestsSortOrderEnum(val string) (ListWorkRequestsSortOrderEnum, bool)
GetMappingListWorkRequestsSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
ListWorkRequestsStatusEnum Enum with underlying type: string
type ListWorkRequestsStatusEnum string
Set of constants representing the allowable values for ListWorkRequestsStatusEnum
const (
ListWorkRequestsStatusAccepted ListWorkRequestsStatusEnum = "ACCEPTED"
ListWorkRequestsStatusInProgress ListWorkRequestsStatusEnum = "IN_PROGRESS"
ListWorkRequestsStatusWaiting ListWorkRequestsStatusEnum = "WAITING"
ListWorkRequestsStatusFailed ListWorkRequestsStatusEnum = "FAILED"
ListWorkRequestsStatusSucceeded ListWorkRequestsStatusEnum = "SUCCEEDED"
ListWorkRequestsStatusCanceling ListWorkRequestsStatusEnum = "CANCELING"
ListWorkRequestsStatusCanceled ListWorkRequestsStatusEnum = "CANCELED"
)
func GetListWorkRequestsStatusEnumValues() []ListWorkRequestsStatusEnum
GetListWorkRequestsStatusEnumValues Enumerates the set of values for ListWorkRequestsStatusEnum
func GetMappingListWorkRequestsStatusEnum(val string) (ListWorkRequestsStatusEnum, bool)
GetMappingListWorkRequestsStatusEnum performs case Insensitive comparison on enum value and return the desired enum
Model Machine-learned 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"`
}
func (m Model) String() string
func (m *Model) UnmarshalJSON(data []byte) (e error)
UnmarshalJSON unmarshals from json
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
ModelCollection The results of a model search.
type ModelCollection struct {
// A list of models.
Items []ModelSummary `mandatory:"true" json:"items"`
}
func (m ModelCollection) String() string
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
ModelLifecycleStateEnum Enum with underlying type: string
type ModelLifecycleStateEnum string
Set of constants representing the allowable values for ModelLifecycleStateEnum
const (
ModelLifecycleStateCreating ModelLifecycleStateEnum = "CREATING"
ModelLifecycleStateUpdating ModelLifecycleStateEnum = "UPDATING"
ModelLifecycleStateActive ModelLifecycleStateEnum = "ACTIVE"
ModelLifecycleStateDeleting ModelLifecycleStateEnum = "DELETING"
ModelLifecycleStateDeleted ModelLifecycleStateEnum = "DELETED"
ModelLifecycleStateFailed ModelLifecycleStateEnum = "FAILED"
)
func GetMappingModelLifecycleStateEnum(val string) (ModelLifecycleStateEnum, bool)
GetMappingModelLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum
func GetModelLifecycleStateEnumValues() []ModelLifecycleStateEnum
GetModelLifecycleStateEnumValues Enumerates the set of values for ModelLifecycleStateEnum
ModelModelTypeEnum Enum with underlying type: string
type ModelModelTypeEnum string
Set of constants representing the allowable values for ModelModelTypeEnum
const (
ModelModelTypeImageClassification ModelModelTypeEnum = "IMAGE_CLASSIFICATION"
ModelModelTypeObjectDetection ModelModelTypeEnum = "OBJECT_DETECTION"
)
func GetMappingModelModelTypeEnum(val string) (ModelModelTypeEnum, bool)
GetMappingModelModelTypeEnum performs case Insensitive comparison on enum value and return the desired enum
func GetModelModelTypeEnumValues() []ModelModelTypeEnum
GetModelModelTypeEnumValues Enumerates the set of values for ModelModelTypeEnum
ModelSummary The metadata about the model.
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"`
}
func (m ModelSummary) String() string
func (m *ModelSummary) UnmarshalJSON(data []byte) (e error)
UnmarshalJSON unmarshals from json
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
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).
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"`
}
func (m NormalizedVertex) String() string
func (m NormalizedVertex) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ObjectListInlineInputLocation A list of object locations in Object Storage.
type ObjectListInlineInputLocation struct {
// The list of ObjectLocations.
ObjectLocations []ObjectLocation `mandatory:"true" json:"objectLocations"`
}
func (m ObjectListInlineInputLocation) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m ObjectListInlineInputLocation) String() string
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
ObjectLocation A location in Object Storage that is uniquely identified by namespace name, bucket name and object name.
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"`
}
func (m ObjectLocation) String() string
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
ObjectStorageDataset The dataset that resides in Object Storage.
type ObjectStorageDataset struct {
// The namespace name of the Object Storage bucket that contains the input data file.
NamespaceName *string `mandatory:"true" json:"namespaceName"`
// The name of the Object Storage bucket that contains the input data file.
BucketName *string `mandatory:"true" json:"bucketName"`
// The object name of the input data file.
ObjectName *string `mandatory:"true" json:"objectName"`
}
func (m ObjectStorageDataset) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m ObjectStorageDataset) String() string
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
ObjectStorageDocumentDetails A document in OCI Object Storage.
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"`
}
func (m ObjectStorageDocumentDetails) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m ObjectStorageDocumentDetails) String() string
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
ObjectStorageImageDetails The image residing in OCI Object Storage.
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"`
}
func (m ObjectStorageImageDetails) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m ObjectStorageImageDetails) String() string
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
OntologyClass Images and ImageObjects can be labeled with an 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"`
}
func (m OntologyClass) String() string
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
OperationStatusEnum Enum with underlying type: string
type OperationStatusEnum string
Set of constants representing the allowable values for OperationStatusEnum
const (
OperationStatusAccepted OperationStatusEnum = "ACCEPTED"
OperationStatusInProgress OperationStatusEnum = "IN_PROGRESS"
OperationStatusWaiting OperationStatusEnum = "WAITING"
OperationStatusFailed OperationStatusEnum = "FAILED"
OperationStatusSucceeded OperationStatusEnum = "SUCCEEDED"
OperationStatusCanceling OperationStatusEnum = "CANCELING"
OperationStatusCanceled OperationStatusEnum = "CANCELED"
)
func GetMappingOperationStatusEnum(val string) (OperationStatusEnum, bool)
GetMappingOperationStatusEnum performs case Insensitive comparison on enum value and return the desired enum
func GetOperationStatusEnumValues() []OperationStatusEnum
GetOperationStatusEnumValues Enumerates the set of values for OperationStatusEnum
OperationTypeEnum Enum with underlying type: string
type OperationTypeEnum string
Set of constants representing the allowable values for OperationTypeEnum
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"
)
func GetMappingOperationTypeEnum(val string) (OperationTypeEnum, bool)
GetMappingOperationTypeEnum performs case Insensitive comparison on enum value and return the desired enum
func GetOperationTypeEnumValues() []OperationTypeEnum
GetOperationTypeEnumValues Enumerates the set of values for OperationTypeEnum
OutputLocation The Object Storage Location.
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"`
}
func (m OutputLocation) String() string
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
Page One page document analysis result.
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"`
}
func (m Page) String() string
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
ProcessingError The error in document processing.
type ProcessingError struct {
// The error code.
Code *string `mandatory:"true" json:"code"`
// The error message.
Message *string `mandatory:"true" json:"message"`
}
func (m ProcessingError) String() string
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
Project A Vision Project containing models.
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"`
}
func (m Project) String() string
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
ProjectCollection The results of a project search.
type ProjectCollection struct {
// List of projects.
Items []ProjectSummary `mandatory:"true" json:"items"`
}
func (m ProjectCollection) String() string
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
ProjectLifecycleStateEnum Enum with underlying type: string
type ProjectLifecycleStateEnum string
Set of constants representing the allowable values for ProjectLifecycleStateEnum
const (
ProjectLifecycleStateCreating ProjectLifecycleStateEnum = "CREATING"
ProjectLifecycleStateUpdating ProjectLifecycleStateEnum = "UPDATING"
ProjectLifecycleStateActive ProjectLifecycleStateEnum = "ACTIVE"
ProjectLifecycleStateDeleting ProjectLifecycleStateEnum = "DELETING"
ProjectLifecycleStateDeleted ProjectLifecycleStateEnum = "DELETED"
ProjectLifecycleStateFailed ProjectLifecycleStateEnum = "FAILED"
)
func GetMappingProjectLifecycleStateEnum(val string) (ProjectLifecycleStateEnum, bool)
GetMappingProjectLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum
func GetProjectLifecycleStateEnumValues() []ProjectLifecycleStateEnum
GetProjectLifecycleStateEnumValues Enumerates the set of values for ProjectLifecycleStateEnum
ProjectSummary the metadata about the project.
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"`
}
func (m ProjectSummary) String() string
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
SortOrderEnum Enum with underlying type: string
type SortOrderEnum string
Set of constants representing the allowable values for SortOrderEnum
const (
SortOrderAsc SortOrderEnum = "ASC"
SortOrderDesc SortOrderEnum = "DESC"
)
func GetMappingSortOrderEnum(val string) (SortOrderEnum, bool)
GetMappingSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
func GetSortOrderEnumValues() []SortOrderEnum
GetSortOrderEnumValues Enumerates the set of values for SortOrderEnum
Table The table extracted from a document.
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"`
}
func (m Table) String() string
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
TableRow A single row in a table.
type TableRow struct {
// The cells in the row.
Cells []Cell `mandatory:"true" json:"cells"`
}
func (m TableRow) String() string
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
UpdateModelDetails The metadata which can be edited after model creation.
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"`
}
func (m UpdateModelDetails) String() string
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
UpdateModelRequest wrapper for the UpdateModel operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.64.0/aivision/UpdateModel.go.html to see an example of how to use 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
}
func (request UpdateModelRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request UpdateModelRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request UpdateModelRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request UpdateModelRequest) String() string
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
UpdateModelResponse wrapper for the UpdateModel operation
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"`
}
func (response UpdateModelResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response UpdateModelResponse) String() string
UpdateProjectDetails The metadata that can be edited after project creation.
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"`
}
func (m UpdateProjectDetails) String() string
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
UpdateProjectRequest wrapper for the UpdateProject operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.64.0/aivision/UpdateProject.go.html to see an example of how to use 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
}
func (request UpdateProjectRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request UpdateProjectRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request UpdateProjectRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request UpdateProjectRequest) String() string
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
UpdateProjectResponse wrapper for the UpdateProject operation
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"`
}
func (response UpdateProjectResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response UpdateProjectResponse) String() string
ValueArray The array of field values.
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"`
}
func (m ValueArray) GetBoundingPolygon() *BoundingPolygon
GetBoundingPolygon returns BoundingPolygon
func (m ValueArray) GetConfidence() *float32
GetConfidence returns Confidence
func (m ValueArray) GetText() *string
GetText returns Text
func (m ValueArray) GetWordIndexes() []int
GetWordIndexes returns WordIndexes
func (m ValueArray) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m ValueArray) String() string
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
ValueDate The date field value.
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"`
}
func (m ValueDate) GetBoundingPolygon() *BoundingPolygon
GetBoundingPolygon returns BoundingPolygon
func (m ValueDate) GetConfidence() *float32
GetConfidence returns Confidence
func (m ValueDate) GetText() *string
GetText returns Text
func (m ValueDate) GetWordIndexes() []int
GetWordIndexes returns WordIndexes
func (m ValueDate) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m ValueDate) String() string
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
ValueInteger The integer field value.
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"`
}
func (m ValueInteger) GetBoundingPolygon() *BoundingPolygon
GetBoundingPolygon returns BoundingPolygon
func (m ValueInteger) GetConfidence() *float32
GetConfidence returns Confidence
func (m ValueInteger) GetText() *string
GetText returns Text
func (m ValueInteger) GetWordIndexes() []int
GetWordIndexes returns WordIndexes
func (m ValueInteger) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m ValueInteger) String() string
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
ValueNumber The floating point number field value.
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"`
}
func (m ValueNumber) GetBoundingPolygon() *BoundingPolygon
GetBoundingPolygon returns BoundingPolygon
func (m ValueNumber) GetConfidence() *float32
GetConfidence returns Confidence
func (m ValueNumber) GetText() *string
GetText returns Text
func (m ValueNumber) GetWordIndexes() []int
GetWordIndexes returns WordIndexes
func (m ValueNumber) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m ValueNumber) String() string
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
ValuePhoneNumber The phone number field value.
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"`
}
func (m ValuePhoneNumber) GetBoundingPolygon() *BoundingPolygon
GetBoundingPolygon returns BoundingPolygon
func (m ValuePhoneNumber) GetConfidence() *float32
GetConfidence returns Confidence
func (m ValuePhoneNumber) GetText() *string
GetText returns Text
func (m ValuePhoneNumber) GetWordIndexes() []int
GetWordIndexes returns WordIndexes
func (m ValuePhoneNumber) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m ValuePhoneNumber) String() string
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
ValueString The string field value.
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"`
}
func (m ValueString) GetBoundingPolygon() *BoundingPolygon
GetBoundingPolygon returns BoundingPolygon
func (m ValueString) GetConfidence() *float32
GetConfidence returns Confidence
func (m ValueString) GetText() *string
GetText returns Text
func (m ValueString) GetWordIndexes() []int
GetWordIndexes returns WordIndexes
func (m ValueString) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m ValueString) String() string
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
ValueTime The time field value.
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"`
}
func (m ValueTime) GetBoundingPolygon() *BoundingPolygon
GetBoundingPolygon returns BoundingPolygon
func (m ValueTime) GetConfidence() *float32
GetConfidence returns Confidence
func (m ValueTime) GetText() *string
GetText returns Text
func (m ValueTime) GetWordIndexes() []int
GetWordIndexes returns WordIndexes
func (m ValueTime) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m ValueTime) String() string
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
Word A single 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"`
}
func (m Word) String() string
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
WorkRequest The workrequest status details.
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"`
}
func (m WorkRequest) String() string
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
WorkRequestError An error encountered while executing a work request.
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"`
}
func (m WorkRequestError) String() string
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
WorkRequestErrorCollection The results of a workRequestError search.
type WorkRequestErrorCollection struct {
// the list of workRequestError objects.
Items []WorkRequestError `mandatory:"true" json:"items"`
}
func (m WorkRequestErrorCollection) String() string
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
WorkRequestLogEntry A log message from the execution of a work request.
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"`
}
func (m WorkRequestLogEntry) String() string
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
WorkRequestLogEntryCollection The results of a workRequestLog search.
type WorkRequestLogEntryCollection struct {
// The list of workRequestLogEntries.
Items []WorkRequestLogEntry `mandatory:"true" json:"items"`
}
func (m WorkRequestLogEntryCollection) String() string
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
WorkRequestResource A resource created, or operated on, by a work request.
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"`
}
func (m WorkRequestResource) String() string
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
WorkRequestSummary A summary of the status of a work request.
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"`
}
func (m WorkRequestSummary) String() string
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
WorkRequestSummaryCollection The results of a workRequest search.
type WorkRequestSummaryCollection struct {
// The list of workRequestSummary objects.
Items []WorkRequestSummary `mandatory:"true" json:"items"`
}
func (m WorkRequestSummaryCollection) String() string
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