func GetActionTypeEnumStringValues() []string
GetActionTypeEnumStringValues Enumerates the set of values in String for ActionTypeEnum
func GetAddModelLockDetailsTypeEnumStringValues() []string
GetAddModelLockDetailsTypeEnumStringValues Enumerates the set of values in String for AddModelLockDetailsTypeEnum
func GetAddProjectLockDetailsTypeEnumStringValues() []string
GetAddProjectLockDetailsTypeEnumStringValues Enumerates the set of values in String for AddProjectLockDetailsTypeEnum
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 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 GetInputLocationSourceTypeEnumStringValues() []string
GetInputLocationSourceTypeEnumStringValues Enumerates the set of values in String for InputLocationSourceTypeEnum
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 GetModelMetricsModelTypeEnumStringValues() []string
GetModelMetricsModelTypeEnumStringValues Enumerates the set of values in String for ModelMetricsModelTypeEnum
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 GetPatchModelOperationOperationEnumStringValues() []string
GetPatchModelOperationOperationEnumStringValues Enumerates the set of values in String for PatchModelOperationOperationEnum
func GetProcessorJobLifecycleDetailsEnumStringValues() []string
GetProcessorJobLifecycleDetailsEnumStringValues Enumerates the set of values in String for ProcessorJobLifecycleDetailsEnum
func GetProcessorJobLifecycleStateEnumStringValues() []string
GetProcessorJobLifecycleStateEnumStringValues Enumerates the set of values in String for ProcessorJobLifecycleStateEnum
func GetProcessorTypeEnumStringValues() []string
GetProcessorTypeEnumStringValues Enumerates the set of values in String for ProcessorTypeEnum
func GetProjectLifecycleStateEnumStringValues() []string
GetProjectLifecycleStateEnumStringValues Enumerates the set of values in String for ProjectLifecycleStateEnum
func GetRemoveModelLockDetailsTypeEnumStringValues() []string
GetRemoveModelLockDetailsTypeEnumStringValues Enumerates the set of values in String for RemoveModelLockDetailsTypeEnum
func GetRemoveProjectLockDetailsTypeEnumStringValues() []string
GetRemoveProjectLockDetailsTypeEnumStringValues Enumerates the set of values in String for RemoveProjectLockDetailsTypeEnum
func GetResourceLockTypeEnumStringValues() []string
GetResourceLockTypeEnumStringValues Enumerates the set of values in String for ResourceLockTypeEnum
func GetSortOrderEnumStringValues() []string
GetSortOrderEnumStringValues Enumerates the set of values in String for SortOrderEnum
func GetWorkRequestResourceMetadataKeyEnumStringValues() []string
GetWorkRequestResourceMetadataKeyEnumStringValues Enumerates the set of values in String for WorkRequestResourceMetadataKeyEnum
AIServiceDocumentClient a client for AIServiceDocument
type AIServiceDocumentClient struct {
common.BaseClient
// contains filtered or unexported fields
}
func NewAIServiceDocumentClientWithConfigurationProvider(configProvider common.ConfigurationProvider) (client AIServiceDocumentClient, err error)
NewAIServiceDocumentClientWithConfigurationProvider Creates a new default AIServiceDocument client with the given configuration provider. the configuration provider will be used for the default signer as well as reading the region
func NewAIServiceDocumentClientWithOboToken(configProvider common.ConfigurationProvider, oboToken string) (client AIServiceDocumentClient, err error)
NewAIServiceDocumentClientWithOboToken Creates a new default AIServiceDocument client with the given configuration provider. The obotoken will be added to default headers and signed; the configuration provider will be used for the signer
as well as reading the region
func (client AIServiceDocumentClient) AddModelLock(ctx context.Context, request AddModelLockRequest) (response AddModelLockResponse, err error)
AddModelLock Adds a lock to a resource.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/aidocument/AddModelLock.go.html to see an example of how to use AddModelLock API. A default retry strategy applies to this operation AddModelLock()
func (client AIServiceDocumentClient) AddProjectLock(ctx context.Context, request AddProjectLockRequest) (response AddProjectLockResponse, err error)
AddProjectLock Adds a lock to a resource.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/aidocument/AddProjectLock.go.html to see an example of how to use AddProjectLock API. A default retry strategy applies to this operation AddProjectLock()
func (client AIServiceDocumentClient) AnalyzeDocument(ctx context.Context, request AnalyzeDocumentRequest) (response AnalyzeDocumentResponse, err error)
AnalyzeDocument Perform different types of document analysis.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/aidocument/AnalyzeDocument.go.html to see an example of how to use AnalyzeDocument API. A default retry strategy applies to this operation AnalyzeDocument()
func (client AIServiceDocumentClient) CancelProcessorJob(ctx context.Context, request CancelProcessorJobRequest) (response CancelProcessorJobResponse, err error)
CancelProcessorJob Cancel a processor job.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/aidocument/CancelProcessorJob.go.html to see an example of how to use CancelProcessorJob API.
func (client AIServiceDocumentClient) CancelWorkRequest(ctx context.Context, request CancelWorkRequestRequest) (response CancelWorkRequestResponse, err error)
CancelWorkRequest Cancel the work request with the given ID.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/aidocument/CancelWorkRequest.go.html to see an example of how to use CancelWorkRequest API.
func (client AIServiceDocumentClient) ChangeModelCompartment(ctx context.Context, request ChangeModelCompartmentRequest) (response ChangeModelCompartmentResponse, err error)
ChangeModelCompartment Moves a model from one compartment to another. When provided, If-Match is checked against the ETag values of the resource.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/aidocument/ChangeModelCompartment.go.html to see an example of how to use ChangeModelCompartment API.
func (client AIServiceDocumentClient) ChangeProjectCompartment(ctx context.Context, request ChangeProjectCompartmentRequest) (response ChangeProjectCompartmentResponse, err error)
ChangeProjectCompartment Move a project from one compartment to another. When provided, If-Match is checked against the ETag values of the resource.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/aidocument/ChangeProjectCompartment.go.html to see an example of how to use ChangeProjectCompartment API.
func (client *AIServiceDocumentClient) ConfigurationProvider() *common.ConfigurationProvider
ConfigurationProvider the ConfigurationProvider used in this client, or null if none set
func (client AIServiceDocumentClient) CreateModel(ctx context.Context, request CreateModelRequest) (response CreateModelResponse, err error)
CreateModel Create a new model.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/aidocument/CreateModel.go.html to see an example of how to use CreateModel API. A default retry strategy applies to this operation CreateModel()
func (client AIServiceDocumentClient) CreateProcessorJob(ctx context.Context, request CreateProcessorJobRequest) (response CreateProcessorJobResponse, err error)
CreateProcessorJob Create a processor job for document analysis.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/aidocument/CreateProcessorJob.go.html to see an example of how to use CreateProcessorJob API. A default retry strategy applies to this operation CreateProcessorJob()
func (client AIServiceDocumentClient) CreateProject(ctx context.Context, request CreateProjectRequest) (response CreateProjectResponse, err error)
CreateProject Create a new project.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/aidocument/CreateProject.go.html to see an example of how to use CreateProject API. A default retry strategy applies to this operation CreateProject()
func (client AIServiceDocumentClient) DeleteModel(ctx context.Context, request DeleteModelRequest) (response DeleteModelResponse, err error)
DeleteModel Delete a model by identifier.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/aidocument/DeleteModel.go.html to see an example of how to use DeleteModel API.
func (client AIServiceDocumentClient) DeleteProject(ctx context.Context, request DeleteProjectRequest) (response DeleteProjectResponse, err error)
DeleteProject Delete a project by identifier.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/aidocument/DeleteProject.go.html to see an example of how to use DeleteProject API.
func (client AIServiceDocumentClient) GetModel(ctx context.Context, request GetModelRequest) (response GetModelResponse, err error)
GetModel Get a model by identifier.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/aidocument/GetModel.go.html to see an example of how to use GetModel API. A default retry strategy applies to this operation GetModel()
func (client AIServiceDocumentClient) GetProcessorJob(ctx context.Context, request GetProcessorJobRequest) (response GetProcessorJobResponse, err error)
GetProcessorJob Get the details of a processor job.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/aidocument/GetProcessorJob.go.html to see an example of how to use GetProcessorJob API. A default retry strategy applies to this operation GetProcessorJob()
func (client AIServiceDocumentClient) GetProject(ctx context.Context, request GetProjectRequest) (response GetProjectResponse, err error)
GetProject Get a project by identifier.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/aidocument/GetProject.go.html to see an example of how to use GetProject API. A default retry strategy applies to this operation GetProject()
func (client AIServiceDocumentClient) GetWorkRequest(ctx context.Context, request GetWorkRequestRequest) (response GetWorkRequestResponse, err error)
GetWorkRequest Gets the status of the work request with the given ID.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/aidocument/GetWorkRequest.go.html to see an example of how to use GetWorkRequest API. A default retry strategy applies to this operation GetWorkRequest()
func (client AIServiceDocumentClient) ListModels(ctx context.Context, request ListModelsRequest) (response ListModelsResponse, err error)
ListModels Returns a list of models in a compartment.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/aidocument/ListModels.go.html to see an example of how to use ListModels API. A default retry strategy applies to this operation ListModels()
func (client AIServiceDocumentClient) ListProjects(ctx context.Context, request ListProjectsRequest) (response ListProjectsResponse, err error)
ListProjects Returns a list of projects.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/aidocument/ListProjects.go.html to see an example of how to use ListProjects API. A default retry strategy applies to this operation ListProjects()
func (client AIServiceDocumentClient) ListWorkRequestErrors(ctx context.Context, request ListWorkRequestErrorsRequest) (response ListWorkRequestErrorsResponse, err error)
ListWorkRequestErrors Returns a (paginated) list of errors for a given work request.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/aidocument/ListWorkRequestErrors.go.html to see an example of how to use ListWorkRequestErrors API. A default retry strategy applies to this operation ListWorkRequestErrors()
func (client AIServiceDocumentClient) ListWorkRequestLogs(ctx context.Context, request ListWorkRequestLogsRequest) (response ListWorkRequestLogsResponse, err error)
ListWorkRequestLogs Return a (paginated) list of logs for a given work request.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/aidocument/ListWorkRequestLogs.go.html to see an example of how to use ListWorkRequestLogs API. A default retry strategy applies to this operation ListWorkRequestLogs()
func (client AIServiceDocumentClient) ListWorkRequests(ctx context.Context, request ListWorkRequestsRequest) (response ListWorkRequestsResponse, err error)
ListWorkRequests Lists the work requests in a compartment.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/aidocument/ListWorkRequests.go.html to see an example of how to use ListWorkRequests API. A default retry strategy applies to this operation ListWorkRequests()
func (client AIServiceDocumentClient) PatchModel(ctx context.Context, request PatchModelRequest) (response PatchModelResponse, err error)
PatchModel Updates the model metadata only selected path parameter.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/aidocument/PatchModel.go.html to see an example of how to use PatchModel API.
func (client AIServiceDocumentClient) RemoveModelLock(ctx context.Context, request RemoveModelLockRequest) (response RemoveModelLockResponse, err error)
RemoveModelLock Remove a lock from a resource.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/aidocument/RemoveModelLock.go.html to see an example of how to use RemoveModelLock API. A default retry strategy applies to this operation RemoveModelLock()
func (client AIServiceDocumentClient) RemoveProjectLock(ctx context.Context, request RemoveProjectLockRequest) (response RemoveProjectLockResponse, err error)
RemoveProjectLock Remove a lock from a resource.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/aidocument/RemoveProjectLock.go.html to see an example of how to use RemoveProjectLock API. A default retry strategy applies to this operation RemoveProjectLock()
func (client *AIServiceDocumentClient) SetRegion(region string)
SetRegion overrides the region of this client.
func (client AIServiceDocumentClient) UpdateModel(ctx context.Context, request UpdateModelRequest) (response UpdateModelResponse, err error)
UpdateModel Updates the model metadata.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/aidocument/UpdateModel.go.html to see an example of how to use UpdateModel API.
func (client AIServiceDocumentClient) UpdateProject(ctx context.Context, request UpdateProjectRequest) (response UpdateProjectResponse, err error)
UpdateProject Update the project metadata.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/aidocument/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
AddModelLockDetails Request payload to add lock to the resource.
type AddModelLockDetails struct {
// Type of the lock.
Type AddModelLockDetailsTypeEnum `mandatory:"true" json:"type"`
// The ID of the resource that is locking this resource. Indicates that deleting this resource will remove the lock.
RelatedResourceId *string `mandatory:"false" json:"relatedResourceId"`
// A message added by the creator of the lock. This is typically used to give an indication of why the resource is locked.
Message *string `mandatory:"false" json:"message"`
}
func (m AddModelLockDetails) String() string
func (m AddModelLockDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
AddModelLockDetailsTypeEnum Enum with underlying type: string
type AddModelLockDetailsTypeEnum string
Set of constants representing the allowable values for AddModelLockDetailsTypeEnum
const (
AddModelLockDetailsTypeFull AddModelLockDetailsTypeEnum = "FULL"
AddModelLockDetailsTypeDelete AddModelLockDetailsTypeEnum = "DELETE"
)
func GetAddModelLockDetailsTypeEnumValues() []AddModelLockDetailsTypeEnum
GetAddModelLockDetailsTypeEnumValues Enumerates the set of values for AddModelLockDetailsTypeEnum
func GetMappingAddModelLockDetailsTypeEnum(val string) (AddModelLockDetailsTypeEnum, bool)
GetMappingAddModelLockDetailsTypeEnum performs case Insensitive comparison on enum value and return the desired enum
AddModelLockRequest wrapper for the AddModelLock operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/aidocument/AddModelLock.go.html to see an example of how to use AddModelLockRequest.
type AddModelLockRequest struct {
// A unique model identifier.
ModelId *string `mandatory:"true" contributesTo:"path" name:"modelId"`
// Request payload to add lock to the resource.
AddModelLockDetails `contributesTo:"body"`
// A token that uniquely identifies a request so it can be retried in case of a timeout or
// server error without the risk of executing that same action again. Retry tokens expire after 24
// hours, but can be invalidated before then due to conflicting operations. For example, if a resource
// has been deleted and purged from the system, then a retry of the original creation request
// might be rejected.
OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`
// The client request ID for tracing.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// For optimistic concurrency control. In the PUT or DELETE call
// for a resource, set the `if-match` parameter to the value of the
// etag from a previous GET or POST response for that resource.
// The resource will be updated or deleted only if the etag you
// provide matches the resource's current etag value.
IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`
// Whether to override locks (if any exist).
IsLockOverride *bool `mandatory:"false" contributesTo:"query" name:"isLockOverride"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request AddModelLockRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request AddModelLockRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request AddModelLockRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request AddModelLockRequest) String() string
func (request AddModelLockRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
AddModelLockResponse wrapper for the AddModelLock operation
type AddModelLockResponse struct {
// The underlying http response
RawResponse *http.Response
// The Model instance
Model `presentIn:"body"`
// For optimistic concurrency control. See `if-match`.
Etag *string `presentIn:"header" name:"etag"`
// A unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response AddModelLockResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response AddModelLockResponse) String() string
AddProjectLockDetails Request payload to add lock to the resource.
type AddProjectLockDetails struct {
// Type of the lock.
Type AddProjectLockDetailsTypeEnum `mandatory:"true" json:"type"`
// The ID of the resource that is locking this resource. Indicates that deleting this resource will remove the lock.
RelatedResourceId *string `mandatory:"false" json:"relatedResourceId"`
// A message added by the creator of the lock. This is typically used to give an indication of why the resource is locked.
Message *string `mandatory:"false" json:"message"`
}
func (m AddProjectLockDetails) String() string
func (m AddProjectLockDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
AddProjectLockDetailsTypeEnum Enum with underlying type: string
type AddProjectLockDetailsTypeEnum string
Set of constants representing the allowable values for AddProjectLockDetailsTypeEnum
const (
AddProjectLockDetailsTypeFull AddProjectLockDetailsTypeEnum = "FULL"
AddProjectLockDetailsTypeDelete AddProjectLockDetailsTypeEnum = "DELETE"
)
func GetAddProjectLockDetailsTypeEnumValues() []AddProjectLockDetailsTypeEnum
GetAddProjectLockDetailsTypeEnumValues Enumerates the set of values for AddProjectLockDetailsTypeEnum
func GetMappingAddProjectLockDetailsTypeEnum(val string) (AddProjectLockDetailsTypeEnum, bool)
GetMappingAddProjectLockDetailsTypeEnum performs case Insensitive comparison on enum value and return the desired enum
AddProjectLockRequest wrapper for the AddProjectLock operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/aidocument/AddProjectLock.go.html to see an example of how to use AddProjectLockRequest.
type AddProjectLockRequest struct {
// A unique project identifier.
ProjectId *string `mandatory:"true" contributesTo:"path" name:"projectId"`
// Request payload to add lock to the resource.
AddProjectLockDetails `contributesTo:"body"`
// A token that uniquely identifies a request so it can be retried in case of a timeout or
// server error without the risk of executing that same action again. Retry tokens expire after 24
// hours, but can be invalidated before then due to conflicting operations. For example, if a resource
// has been deleted and purged from the system, then a retry of the original creation request
// might be rejected.
OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`
// The client request ID for tracing.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// For optimistic concurrency control. In the PUT or DELETE call
// for a resource, set the `if-match` parameter to the value of the
// etag from a previous GET or POST response for that resource.
// The resource will be updated or deleted only if the etag you
// provide matches the resource's current etag value.
IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`
// Whether to override locks (if any exist).
IsLockOverride *bool `mandatory:"false" contributesTo:"query" name:"isLockOverride"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request AddProjectLockRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request AddProjectLockRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request AddProjectLockRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request AddProjectLockRequest) String() string
func (request AddProjectLockRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
AddProjectLockResponse wrapper for the AddProjectLock operation
type AddProjectLockResponse struct {
// The underlying http response
RawResponse *http.Response
// The Project instance
Project `presentIn:"body"`
// For optimistic concurrency control. See `if-match`.
Etag *string `presentIn:"header" name:"etag"`
// A unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response AddProjectLockResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response AddProjectLockResponse) String() string
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 compartment identifier.
CompartmentId *string `mandatory:"false" json:"compartmentId"`
OutputLocation *OutputLocation `mandatory:"false" json:"outputLocation"`
// The document language, abbreviated according to the BCP 47 syntax.
Language *string `mandatory:"false" json:"language"`
// The document type.
DocumentType DocumentTypeEnum `mandatory:"false" json:"documentType,omitempty"`
OcrData *AnalyzeDocumentResult `mandatory:"false" json:"ocrData"`
}
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
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/aidocument/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"`
// 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 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"`
// The full URI of the resource related to the request
ContentLocation *string `presentIn:"header" name:"content-location"`
// The full URI of the resource related to the request
Location *string `presentIn:"header" name:"location"`
// For optimistic concurrency control. See `if-match`.
Etag *string `presentIn:"header" name:"etag"`
// A unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
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 extraction model version.
TextExtractionModelVersion *string `mandatory:"false" json:"textExtractionModelVersion"`
// The document keyValue extraction model version.
KeyValueExtractionModelVersion *string `mandatory:"false" json:"keyValueExtractionModelVersion"`
// The document table extraction model version.
TableExtractionModelVersion *string `mandatory:"false" json:"tableExtractionModelVersion"`
// The errors encountered during document analysis.
Errors []ProcessingError `mandatory:"false" json:"errors"`
// The searchable PDF file that was generated.
SearchablePdf []byte `mandatory:"false" json:"searchablePdf"`
}
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
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
CancelProcessorJobRequest wrapper for the CancelProcessorJob operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/aidocument/CancelProcessorJob.go.html to see an example of how to use CancelProcessorJobRequest.
type CancelProcessorJobRequest struct {
// Processor job id.
ProcessorJobId *string `mandatory:"true" contributesTo:"path" name:"processorJobId"`
// For optimistic concurrency control. In the PUT or DELETE call
// for a resource, set the `if-match` parameter to the value of the
// etag from a previous GET or POST response for that resource.
// The resource will be updated or deleted only if the etag you
// provide matches the resource's current etag value.
IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`
// The client request ID for tracing.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request CancelProcessorJobRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request CancelProcessorJobRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request CancelProcessorJobRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request CancelProcessorJobRequest) String() string
func (request CancelProcessorJobRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
CancelProcessorJobResponse wrapper for the CancelProcessorJob operation
type CancelProcessorJobResponse struct {
// The underlying http response
RawResponse *http.Response
// A unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response CancelProcessorJobResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response CancelProcessorJobResponse) String() string
CancelWorkRequestRequest wrapper for the CancelWorkRequest operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/aidocument/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 compartment identifier.
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
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/aidocument/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"`
// Whether to override locks (if any exist).
IsLockOverride *bool `mandatory:"false" contributesTo:"query" name:"isLockOverride"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
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 compartment identifier.
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
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/aidocument/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"`
// Whether to override locks (if any exist).
IsLockOverride *bool `mandatory:"false" contributesTo:"query" name:"isLockOverride"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
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
ComponentModel The custom model selected for Composition.
type ComponentModel struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of active custom Key Value model that need to be composed.
ModelId *string `mandatory:"false" json:"modelId"`
}
func (m ComponentModel) String() string
func (m ComponentModel) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
CreateModelDetails The information needed to create a new model.
type CreateModelDetails struct {
// The type of the Document model.
ModelType ModelModelTypeEnum `mandatory:"true" json:"modelType"`
// The compartment identifier.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the project that contains the model.
ProjectId *string `mandatory:"true" json:"projectId"`
// A human-friendly name for the model, which can be changed.
DisplayName *string `mandatory:"false" json:"displayName"`
// An optional description of the model.
Description *string `mandatory:"false" json:"description"`
// The model version
ModelVersion *string `mandatory:"false" json:"modelVersion"`
// Set to true when experimenting with a new model type or dataset, so the model training is quick, with a predefined low number of passes through the training data.
IsQuickMode *bool `mandatory:"false" json:"isQuickMode"`
// The maximum model training time in hours, expressed as a decimal fraction.
MaxTrainingTimeInHours *float64 `mandatory:"false" json:"maxTrainingTimeInHours"`
TrainingDataset Dataset `mandatory:"false" json:"trainingDataset"`
TestingDataset Dataset `mandatory:"false" json:"testingDataset"`
ValidationDataset Dataset `mandatory:"false" json:"validationDataset"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) list of active custom Key Value models that need to be composed.
ComponentModels []ComponentModel `mandatory:"false" json:"componentModels"`
// the alias name of the model.
AliasName *string `mandatory:"false" json:"aliasName"`
// A simple key-value pair that is applied without any predefined name, type, or scope. It exists for cross-compatibility only.
// For example: `{"bar-key": "value"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Defined tags for this resource. Each key is predefined and scoped to a namespace.
// For example: `{"foo-namespace": {"bar-key": "value"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
}
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
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/aidocument/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"`
// The full URI of the resource related to the request
ContentLocation *string `presentIn:"header" name:"content-location"`
// The full URI of the resource related to the request
Location *string `presentIn:"header" name:"location"`
// A unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation.
OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
// A unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
// For optimistic concurrency control. See `if-match`.
Etag *string `presentIn:"header" name:"etag"`
}
func (response CreateModelResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response CreateModelResponse) String() string
CreateProcessorJobDetails The details used to create a processor job.
type CreateProcessorJobDetails struct {
InputLocation InputLocation `mandatory:"true" json:"inputLocation"`
OutputLocation *OutputLocation `mandatory:"true" json:"outputLocation"`
// The compartment identifier.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
ProcessorConfig ProcessorConfig `mandatory:"true" json:"processorConfig"`
// The display name of the processor job.
DisplayName *string `mandatory:"false" json:"displayName"`
}
func (m CreateProcessorJobDetails) String() string
func (m *CreateProcessorJobDetails) UnmarshalJSON(data []byte) (e error)
UnmarshalJSON unmarshals from json
func (m CreateProcessorJobDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
CreateProcessorJobRequest wrapper for the CreateProcessorJob operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/aidocument/CreateProcessorJob.go.html to see an example of how to use CreateProcessorJobRequest.
type CreateProcessorJobRequest struct {
// The details for creating the processor job.
CreateProcessorJobDetails `contributesTo:"body"`
// A token that uniquely identifies a request so it can be retried in case of a timeout or
// server error without the risk of executing that same action again. Retry tokens expire after 24
// hours, but can be invalidated before then due to conflicting operations. For example, if a resource
// has been deleted and purged from the system, then a retry of the original creation request
// might be rejected.
OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`
// The client request ID for tracing.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request CreateProcessorJobRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request CreateProcessorJobRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request CreateProcessorJobRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request CreateProcessorJobRequest) String() string
func (request CreateProcessorJobRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
CreateProcessorJobResponse wrapper for the CreateProcessorJob operation
type CreateProcessorJobResponse struct {
// The underlying http response
RawResponse *http.Response
// The ProcessorJob instance
ProcessorJob `presentIn:"body"`
// A unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
// For optimistic concurrency control. See `if-match`.
Etag *string `presentIn:"header" name:"etag"`
}
func (response CreateProcessorJobResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response CreateProcessorJobResponse) 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
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/aidocument/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"`
// The full URI of the resource related to the request
ContentLocation *string `presentIn:"header" name:"content-location"`
// The full URI of the resource related to the request
Location *string `presentIn:"header" name:"location"`
// For optimistic concurrency control. See `if-match`.
Etag *string `presentIn:"header" name:"etag"`
// A unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation.
OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
// A unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
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
DatasetSummary Summary of count of samples used during model training.
type DatasetSummary struct {
// Number of samples used for training the model.
TrainingSampleCount *int `mandatory:"false" json:"trainingSampleCount"`
// Number of samples used for validating the model.
ValidationSampleCount *int `mandatory:"false" json:"validationSampleCount"`
// Number of samples used for testing the model.
TestSampleCount *int `mandatory:"false" json:"testSampleCount"`
}
func (m DatasetSummary) String() string
func (m DatasetSummary) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
DeleteModelRequest wrapper for the DeleteModel operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/aidocument/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"`
// Whether to override locks (if any exist).
IsLockOverride *bool `mandatory:"false" contributesTo:"query" name:"isLockOverride"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
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
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/aidocument/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"`
// Whether to override locks (if any exist).
IsLockOverride *bool `mandatory:"false" contributesTo:"query" name:"isLockOverride"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
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 document language, abbreviated according to the BCP 47 syntax.
Language *string `mandatory:"true" json:"language"`
// The confidence score between 0 and 1.
Confidence *float32 `mandatory:"true" json:"confidence"`
}
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
DocumentClassificationConfidenceEntry Confidence Entry.
type DocumentClassificationConfidenceEntry struct {
// Threshold used to calculate precision and recall.
Threshold *float32 `mandatory:"true" json:"threshold"`
// Precision under the threshold
Precision *float32 `mandatory:"true" json:"precision"`
// Recall under the threshold
Recall *float32 `mandatory:"true" json:"recall"`
// f1Score under the threshold
F1Score *float32 `mandatory:"true" json:"f1Score"`
}
func (m DocumentClassificationConfidenceEntry) String() string
func (m DocumentClassificationConfidenceEntry) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
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
DocumentClassificationLabelMetricsReport Label Metrics report for Document Classification Model.
type DocumentClassificationLabelMetricsReport struct {
// Mean average precision under different thresholds
MeanAveragePrecision *float32 `mandatory:"true" json:"meanAveragePrecision"`
// List of document classification confidence report.
ConfidenceEntries []DocumentClassificationConfidenceEntry `mandatory:"true" json:"confidenceEntries"`
// Label name
Label *string `mandatory:"false" json:"label"`
}
func (m DocumentClassificationLabelMetricsReport) String() string
func (m DocumentClassificationLabelMetricsReport) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
DocumentClassificationModelMetrics Metrics for Document Classification Model.
type DocumentClassificationModelMetrics struct {
// List of metrics entries per label.
LabelMetricsReport []DocumentClassificationLabelMetricsReport `mandatory:"true" json:"labelMetricsReport"`
OverallMetricsReport *DocumentClassificationOverallMetricsReport `mandatory:"true" json:"overallMetricsReport"`
DatasetSummary *DatasetSummary `mandatory:"false" json:"datasetSummary"`
}
func (m DocumentClassificationModelMetrics) GetDatasetSummary() *DatasetSummary
GetDatasetSummary returns DatasetSummary
func (m DocumentClassificationModelMetrics) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m DocumentClassificationModelMetrics) String() string
func (m DocumentClassificationModelMetrics) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
DocumentClassificationOverallMetricsReport Overall Metrics report for Document Classification Model.
type DocumentClassificationOverallMetricsReport struct {
// Mean average precision under different thresholds
MeanAveragePrecision *float32 `mandatory:"true" json:"meanAveragePrecision"`
// List of document classification confidence report.
ConfidenceEntries []DocumentClassificationConfidenceEntry `mandatory:"true" json:"confidenceEntries"`
}
func (m DocumentClassificationOverallMetricsReport) String() string
func (m DocumentClassificationOverallMetricsReport) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
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"
DocumentFeatureFeatureTypeTextExtraction DocumentFeatureFeatureTypeEnum = "TEXT_EXTRACTION"
DocumentFeatureFeatureTypeTableExtraction DocumentFeatureFeatureTypeEnum = "TABLE_EXTRACTION"
DocumentFeatureFeatureTypeKeyValueExtraction DocumentFeatureFeatureTypeEnum = "KEY_VALUE_EXTRACTION"
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
DocumentKeyValueExtractionFeature Extracting form fields.
type DocumentKeyValueExtractionFeature struct {
// The custom model ID.
ModelId *string `mandatory:"false" json:"modelId"`
}
func (m DocumentKeyValueExtractionFeature) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m DocumentKeyValueExtractionFeature) String() string
func (m DocumentKeyValueExtractionFeature) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
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
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
DocumentTableExtractionFeature Detecting and extracting data in tables.
type DocumentTableExtractionFeature struct {
}
func (m DocumentTableExtractionFeature) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m DocumentTableExtractionFeature) String() string
func (m DocumentTableExtractionFeature) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
DocumentTextExtractionFeature Text recognition
type DocumentTextExtractionFeature struct {
// Whether or not to generate a searchable PDF file.
GenerateSearchablePdf *bool `mandatory:"false" json:"generateSearchablePdf"`
}
func (m DocumentTextExtractionFeature) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m DocumentTextExtractionFeature) String() string
func (m DocumentTextExtractionFeature) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
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"
DocumentTypeHealthInsuranceId DocumentTypeEnum = "HEALTH_INSURANCE_ID"
)
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
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
GeneralProcessorConfig The configuration of a general processor.
type GeneralProcessorConfig struct {
// The types of document analysis requested.
Features []DocumentFeature `mandatory:"true" json:"features"`
// Whether or not to generate a ZIP file containing the results.
IsZipOutputEnabled *bool `mandatory:"false" json:"isZipOutputEnabled"`
// The document language, abbreviated according to the BCP 47 Language-Tag syntax.
Language *string `mandatory:"false" json:"language"`
// The document type.
DocumentType DocumentTypeEnum `mandatory:"false" json:"documentType,omitempty"`
}
func (m GeneralProcessorConfig) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m GeneralProcessorConfig) String() string
func (m *GeneralProcessorConfig) UnmarshalJSON(data []byte) (e error)
UnmarshalJSON unmarshals from json
func (m GeneralProcessorConfig) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
GetModelRequest wrapper for the GetModel operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/aidocument/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
GetProcessorJobRequest wrapper for the GetProcessorJob operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/aidocument/GetProcessorJob.go.html to see an example of how to use GetProcessorJobRequest.
type GetProcessorJobRequest struct {
// Processor job id.
ProcessorJobId *string `mandatory:"true" contributesTo:"path" name:"processorJobId"`
// The client request ID for tracing.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request GetProcessorJobRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request GetProcessorJobRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetProcessorJobRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetProcessorJobRequest) String() string
func (request GetProcessorJobRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
GetProcessorJobResponse wrapper for the GetProcessorJob operation
type GetProcessorJobResponse struct {
// The underlying http response
RawResponse *http.Response
// The ProcessorJob instance
ProcessorJob `presentIn:"body"`
// For optimistic concurrency control. See `if-match`.
Etag *string `presentIn:"header" name:"etag"`
// A unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response GetProcessorJobResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetProcessorJobResponse) String() string
GetProjectRequest wrapper for the GetProject operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/aidocument/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
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/aidocument/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
InlineDocumentContent The content of an inline document.
type InlineDocumentContent struct {
// Raw document data with Base64 encoding.
Data []byte `mandatory:"true" json:"data"`
}
func (m InlineDocumentContent) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m InlineDocumentContent) String() string
func (m InlineDocumentContent) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
InlineDocumentDetails The document incorporated in the request payload.
type InlineDocumentDetails struct {
// Raw document data with Base64 encoding.
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
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 (
InputLocationSourceTypeObjectStorageLocations InputLocationSourceTypeEnum = "OBJECT_STORAGE_LOCATIONS"
InputLocationSourceTypeInlineDocumentContent InputLocationSourceTypeEnum = "INLINE_DOCUMENT_CONTENT"
)
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
KeyValueDetectionConfidenceEntry Key Value Detection Confidence Entry.
type KeyValueDetectionConfidenceEntry struct {
// Threshold used to calculate precision and recall.
Threshold *float32 `mandatory:"true" json:"threshold"`
// Precision under the threshold
Precision *float32 `mandatory:"true" json:"precision"`
// Recall under the threshold
Recall *float32 `mandatory:"true" json:"recall"`
// f1Score under the threshold
F1Score *float32 `mandatory:"true" json:"f1Score"`
// accuracy under the threshold
Accuracy *float32 `mandatory:"true" json:"accuracy"`
}
func (m KeyValueDetectionConfidenceEntry) String() string
func (m KeyValueDetectionConfidenceEntry) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
KeyValueDetectionLabelMetricsReport Label Metrics report for Key Value Detection Model.
type KeyValueDetectionLabelMetricsReport struct {
// Mean average precision under different thresholds
MeanAveragePrecision *float32 `mandatory:"true" json:"meanAveragePrecision"`
// List of key value detection confidence report.
ConfidenceEntries []KeyValueDetectionConfidenceEntry `mandatory:"true" json:"confidenceEntries"`
// Total test documents in the label.
DocumentCount *int `mandatory:"false" json:"documentCount"`
// Label name
Label *string `mandatory:"false" json:"label"`
}
func (m KeyValueDetectionLabelMetricsReport) String() string
func (m KeyValueDetectionLabelMetricsReport) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
KeyValueDetectionModelMetrics Metrics for Document Key Value Detection Model.
type KeyValueDetectionModelMetrics struct {
// List of metrics entries per label.
LabelMetricsReport []KeyValueDetectionLabelMetricsReport `mandatory:"true" json:"labelMetricsReport"`
OverallMetricsReport *KeyValueDetectionOverallMetricsReport `mandatory:"true" json:"overallMetricsReport"`
DatasetSummary *DatasetSummary `mandatory:"false" json:"datasetSummary"`
}
func (m KeyValueDetectionModelMetrics) GetDatasetSummary() *DatasetSummary
GetDatasetSummary returns DatasetSummary
func (m KeyValueDetectionModelMetrics) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m KeyValueDetectionModelMetrics) String() string
func (m KeyValueDetectionModelMetrics) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
KeyValueDetectionOverallMetricsReport Overall Metrics report for Key Value Detection Model.
type KeyValueDetectionOverallMetricsReport struct {
// Mean average precision under different thresholds
MeanAveragePrecision *float32 `mandatory:"true" json:"meanAveragePrecision"`
// List of key value detection confidence report.
ConfidenceEntries []KeyValueDetectionConfidenceEntry `mandatory:"true" json:"confidenceEntries"`
// Total test documents in the label.
DocumentCount *int `mandatory:"false" json:"documentCount"`
}
func (m KeyValueDetectionOverallMetricsReport) String() string
func (m KeyValueDetectionOverallMetricsReport) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
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
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/aidocument/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
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/aidocument/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
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/aidocument/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
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/aidocument/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
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/aidocument/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"`
// The type of the Document model.
ModelType ModelModelTypeEnum `mandatory:"true" json:"modelType"`
// The version of the model.
ModelVersion *string `mandatory:"true" json:"modelVersion"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the project that contains the model.
ProjectId *string `mandatory:"true" json:"projectId"`
// When the model was created, as an RFC3339 datetime string.
TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`
// The current state of the model.
LifecycleState ModelLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`
// A human-friendly name for the model, which can be changed.
DisplayName *string `mandatory:"false" json:"displayName"`
// An optional description of the model.
Description *string `mandatory:"false" json:"description"`
// The tenancy id of the model.
TenancyId *string `mandatory:"false" json:"tenancyId"`
// the alias name of the model.
AliasName *string `mandatory:"false" json:"aliasName"`
// The collection of labels used to train the custom model.
Labels []string `mandatory:"false" json:"labels"`
// Set to true when experimenting with a new model type or dataset, so model training is quick, with a predefined low number of passes through the training data.
IsQuickMode *bool `mandatory:"false" json:"isQuickMode"`
// The maximum model training time in hours, expressed as a decimal fraction.
MaxTrainingTimeInHours *float64 `mandatory:"false" json:"maxTrainingTimeInHours"`
// The total hours actually used for model training.
TrainedTimeInHours *float64 `mandatory:"false" json:"trainedTimeInHours"`
TrainingDataset Dataset `mandatory:"false" json:"trainingDataset"`
TestingDataset Dataset `mandatory:"false" json:"testingDataset"`
ValidationDataset Dataset `mandatory:"false" json:"validationDataset"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) collection of active custom Key Value models that need to be composed.
ComponentModels []ComponentModel `mandatory:"false" json:"componentModels"`
// Set to true when the model is created by using multiple key value extraction models.
IsComposedModel *bool `mandatory:"false" json:"isComposedModel"`
// When the model was updated, as an RFC3339 datetime string.
TimeUpdated *common.SDKTime `mandatory:"false" json:"timeUpdated"`
// A message describing the current state in more detail, that can provide actionable information if training failed.
LifecycleDetails *string `mandatory:"false" json:"lifecycleDetails"`
Metrics ModelMetrics `mandatory:"false" json:"metrics"`
// A simple key-value pair that is applied without any predefined name, type, or scope. It exists for cross-compatibility only.
// For example: `{"bar-key": "value"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Defined tags for this resource. Each key is predefined and scoped to a namespace.
// For example: `{"foo-namespace": {"bar-key": "value"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
// Usage of system tag keys. These predefined keys are scoped to namespaces.
// For example: `{"orcl-cloud": {"free-tier-retained": "true"}}`
SystemTags map[string]map[string]interface{} `mandatory:"false" json:"systemTags"`
// Locks associated with this resource.
Locks []ResourceLock `mandatory:"false" json:"locks"`
}
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
ModelMetrics Trained Model Metrics.
type ModelMetrics interface {
GetDatasetSummary() *DatasetSummary
}
ModelMetricsModelTypeEnum Enum with underlying type: string
type ModelMetricsModelTypeEnum string
Set of constants representing the allowable values for ModelMetricsModelTypeEnum
const (
ModelMetricsModelTypeKeyValueExtraction ModelMetricsModelTypeEnum = "KEY_VALUE_EXTRACTION"
ModelMetricsModelTypeDocumentClassification ModelMetricsModelTypeEnum = "DOCUMENT_CLASSIFICATION"
)
func GetMappingModelMetricsModelTypeEnum(val string) (ModelMetricsModelTypeEnum, bool)
GetMappingModelMetricsModelTypeEnum performs case Insensitive comparison on enum value and return the desired enum
func GetModelMetricsModelTypeEnumValues() []ModelMetricsModelTypeEnum
GetModelMetricsModelTypeEnumValues Enumerates the set of values for ModelMetricsModelTypeEnum
ModelModelTypeEnum Enum with underlying type: string
type ModelModelTypeEnum string
Set of constants representing the allowable values for ModelModelTypeEnum
const (
ModelModelTypeKeyValueExtraction ModelModelTypeEnum = "KEY_VALUE_EXTRACTION"
ModelModelTypeDocumentClassification ModelModelTypeEnum = "DOCUMENT_CLASSIFICATION"
)
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"`
// The type of the Document model.
ModelType ModelModelTypeEnum `mandatory:"true" json:"modelType"`
// The version of the model.
ModelVersion *string `mandatory:"true" json:"modelVersion"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the project that contains the model.
ProjectId *string `mandatory:"true" json:"projectId"`
// When the model was created, as an RFC3339 datetime string.
TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`
// The current state of the model.
LifecycleState ModelLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`
// A human-friendly name for the model, which can be changed.
DisplayName *string `mandatory:"false" json:"displayName"`
// An optional description of the model.
Description *string `mandatory:"false" json:"description"`
// When the model was modified, as an RFC3339 datetime string.
TimeUpdated *common.SDKTime `mandatory:"false" json:"timeUpdated"`
// A message describing the current state in more detail, that can provide actionable information if training failed.
LifecycleDetails *string `mandatory:"false" json:"lifecycleDetails"`
// The precision of the trained model.
Precision *float32 `mandatory:"false" json:"precision"`
// The tenancy id of the model.
TenancyId *string `mandatory:"false" json:"tenancyId"`
// the alias name of the model.
AliasName *string `mandatory:"false" json:"aliasName"`
TrainingDataset Dataset `mandatory:"false" json:"trainingDataset"`
TestingDataset Dataset `mandatory:"false" json:"testingDataset"`
ValidationDataset Dataset `mandatory:"false" json:"validationDataset"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) list of active custom Key Value models that need to be composed.
ComponentModels []ComponentModel `mandatory:"false" json:"componentModels"`
// Set to true when the model is created by using multiple key value extraction models.
IsComposedModel *bool `mandatory:"false" json:"isComposedModel"`
// A simple key-value pair that is applied without any predefined name, type, or scope. It exists for cross-compatibility only.
// For example: `{"bar-key": "value"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Defined tags for this resource. Each key is predefined and scoped to a namespace.
// For example: `{"foo-namespace": {"bar-key": "value"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
// Usage of system tag keys. These predefined keys are scoped to namespaces.
// For example: `{"orcl-cloud": {"free-tier-retained": "true"}}`
SystemTags map[string]map[string]interface{} `mandatory:"false" json:"systemTags"`
// Locks associated with this resource.
Locks []ResourceLock `mandatory:"false" json:"locks"`
}
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
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
ObjectStorageLocations A list of object locations in Object Storage.
type ObjectStorageLocations struct {
// The list of ObjectLocations.
ObjectLocations []ObjectLocation `mandatory:"true" json:"objectLocations"`
}
func (m ObjectStorageLocations) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m ObjectStorageLocations) String() string
func (m ObjectStorageLocations) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
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"
OperationTypeComposeModel OperationTypeEnum = "COMPOSE_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
PatchModelDetails The model parameters to be updated using patch operation.
type PatchModelDetails struct {
// A list of patch operations for model.
Operations []PatchModelOperation `mandatory:"false" json:"operations"`
}
func (m PatchModelDetails) String() string
func (m PatchModelDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
PatchModelOperation The metadata which can be edited after model creation.
type PatchModelOperation struct {
// The parameter of the resource to be changed.
Path *string `mandatory:"false" json:"path"`
// The value of the parameter to be updated.
Value *string `mandatory:"false" json:"value"`
// The value of the parameter to be updated.
Operation PatchModelOperationOperationEnum `mandatory:"false" json:"operation,omitempty"`
}
func (m PatchModelOperation) String() string
func (m PatchModelOperation) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
PatchModelOperationOperationEnum Enum with underlying type: string
type PatchModelOperationOperationEnum string
Set of constants representing the allowable values for PatchModelOperationOperationEnum
const (
PatchModelOperationOperationDelete PatchModelOperationOperationEnum = "DELETE"
PatchModelOperationOperationAdd PatchModelOperationOperationEnum = "ADD"
PatchModelOperationOperationReplace PatchModelOperationOperationEnum = "REPLACE"
)
func GetMappingPatchModelOperationOperationEnum(val string) (PatchModelOperationOperationEnum, bool)
GetMappingPatchModelOperationOperationEnum performs case Insensitive comparison on enum value and return the desired enum
func GetPatchModelOperationOperationEnumValues() []PatchModelOperationOperationEnum
GetPatchModelOperationOperationEnumValues Enumerates the set of values for PatchModelOperationOperationEnum
PatchModelRequest wrapper for the PatchModel operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/aidocument/PatchModel.go.html to see an example of how to use PatchModelRequest.
type PatchModelRequest struct {
// A unique model identifier.
ModelId *string `mandatory:"true" contributesTo:"path" name:"modelId"`
// The model metadata to be updated.
PatchModelDetails `contributesTo:"body"`
// For optimistic concurrency control. In the PUT or DELETE call
// for a resource, set the `if-match` parameter to the value of the
// etag from a previous GET or POST response for that resource.
// The resource will be updated or deleted only if the etag you
// provide matches the resource's current etag value.
IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`
// The client request ID for tracing.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request PatchModelRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request PatchModelRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request PatchModelRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request PatchModelRequest) String() string
func (request PatchModelRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
PatchModelResponse wrapper for the PatchModel operation
type PatchModelResponse struct {
// The underlying http response
RawResponse *http.Response
// The PatchResponseMessage instance
PatchResponseMessage `presentIn:"body"`
// A unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation.
OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
// A unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
// For optimistic concurrency control. See `if-match`.
Etag *string `presentIn:"header" name:"etag"`
}
func (response PatchModelResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response PatchModelResponse) String() string
PatchResponseMessage The response containing the details of the patch operation status.
type PatchResponseMessage struct {
// The response message containing details of operation.
Message *string `mandatory:"true" json:"message"`
// Model ID representing the conflicting patch operation.
ModelId *string `mandatory:"false" json:"modelId"`
// Compartment ID representing the conflicting Model Compartment.
CompartmentId *string `mandatory:"false" json:"compartmentId"`
}
func (m PatchResponseMessage) String() string
func (m PatchResponseMessage) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
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
ProcessorConfig The configuration of a processor.
type ProcessorConfig interface {
}
ProcessorJob Details of a processor job.
type ProcessorJob struct {
// The id of the processor job.
Id *string `mandatory:"true" json:"id"`
// The compartment identifier.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
ProcessorConfig ProcessorConfig `mandatory:"true" json:"processorConfig"`
// The job acceptance time.
TimeAccepted *common.SDKTime `mandatory:"true" json:"timeAccepted"`
OutputLocation *OutputLocation `mandatory:"true" json:"outputLocation"`
// The current state of the processor job.
LifecycleState ProcessorJobLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`
// The display name of the processor job.
DisplayName *string `mandatory:"false" json:"displayName"`
InputLocation InputLocation `mandatory:"false" json:"inputLocation"`
// The job start time.
TimeStarted *common.SDKTime `mandatory:"false" json:"timeStarted"`
// The job finish time.
TimeFinished *common.SDKTime `mandatory:"false" json:"timeFinished"`
// How much progress the operation has made, compared to the total amount of work to be performed.
PercentComplete *float32 `mandatory:"false" json:"percentComplete"`
// The detailed status of FAILED state.
LifecycleDetails ProcessorJobLifecycleDetailsEnum `mandatory:"false" json:"lifecycleDetails,omitempty"`
}
func (m ProcessorJob) String() string
func (m *ProcessorJob) UnmarshalJSON(data []byte) (e error)
UnmarshalJSON unmarshals from json
func (m ProcessorJob) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ProcessorJobLifecycleDetailsEnum Enum with underlying type: string
type ProcessorJobLifecycleDetailsEnum string
Set of constants representing the allowable values for ProcessorJobLifecycleDetailsEnum
const (
ProcessorJobLifecycleDetailsPartiallySucceeded ProcessorJobLifecycleDetailsEnum = "PARTIALLY_SUCCEEDED"
ProcessorJobLifecycleDetailsCompletelyFailed ProcessorJobLifecycleDetailsEnum = "COMPLETELY_FAILED"
)
func GetMappingProcessorJobLifecycleDetailsEnum(val string) (ProcessorJobLifecycleDetailsEnum, bool)
GetMappingProcessorJobLifecycleDetailsEnum performs case Insensitive comparison on enum value and return the desired enum
func GetProcessorJobLifecycleDetailsEnumValues() []ProcessorJobLifecycleDetailsEnum
GetProcessorJobLifecycleDetailsEnumValues Enumerates the set of values for ProcessorJobLifecycleDetailsEnum
ProcessorJobLifecycleStateEnum Enum with underlying type: string
type ProcessorJobLifecycleStateEnum string
Set of constants representing the allowable values for ProcessorJobLifecycleStateEnum
const (
ProcessorJobLifecycleStateSucceeded ProcessorJobLifecycleStateEnum = "SUCCEEDED"
ProcessorJobLifecycleStateFailed ProcessorJobLifecycleStateEnum = "FAILED"
ProcessorJobLifecycleStateAccepted ProcessorJobLifecycleStateEnum = "ACCEPTED"
ProcessorJobLifecycleStateCanceled ProcessorJobLifecycleStateEnum = "CANCELED"
ProcessorJobLifecycleStateInProgress ProcessorJobLifecycleStateEnum = "IN_PROGRESS"
ProcessorJobLifecycleStateCanceling ProcessorJobLifecycleStateEnum = "CANCELING"
)
func GetMappingProcessorJobLifecycleStateEnum(val string) (ProcessorJobLifecycleStateEnum, bool)
GetMappingProcessorJobLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum
func GetProcessorJobLifecycleStateEnumValues() []ProcessorJobLifecycleStateEnum
GetProcessorJobLifecycleStateEnumValues Enumerates the set of values for ProcessorJobLifecycleStateEnum
ProcessorTypeEnum Enum with underlying type: string
type ProcessorTypeEnum string
Set of constants representing the allowable values for ProcessorTypeEnum
const (
ProcessorTypeGeneral ProcessorTypeEnum = "GENERAL"
)
func GetMappingProcessorTypeEnum(val string) (ProcessorTypeEnum, bool)
GetMappingProcessorTypeEnum performs case Insensitive comparison on enum value and return the desired enum
func GetProcessorTypeEnumValues() []ProcessorTypeEnum
GetProcessorTypeEnumValues Enumerates the set of values for ProcessorTypeEnum
Project A Document Project containing models.
type Project struct {
// A unique identifier that is immutable after creation.
Id *string `mandatory:"true" json:"id"`
// The compartment identifier.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// When the project was created, as an RFC3339 datetime string.
TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`
// The current state of the project.
LifecycleState ProjectLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`
// A human-friendly name for the project, which can be changed.
DisplayName *string `mandatory:"false" json:"displayName"`
// An optional description of the project.
Description *string `mandatory:"false" json:"description"`
// When the project was updated, as an RFC3339 datetime string.
TimeUpdated *common.SDKTime `mandatory:"false" json:"timeUpdated"`
// A message describing the current state in more detail, that can provide actionable information if creation failed.
LifecycleDetails *string `mandatory:"false" json:"lifecycleDetails"`
// A simple key-value pair that is applied without any predefined name, type, or scope. It exists for cross-compatibility only.
// For example: `{"bar-key": "value"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Defined tags for this resource. Each key is predefined and scoped to a namespace.
// For example: `{"foo-namespace": {"bar-key": "value"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
// Usage of system tag keys. These predefined keys are scoped to namespaces.
// For example: `{"orcl-cloud": {"free-tier-retained": "true"}}`
SystemTags map[string]map[string]interface{} `mandatory:"false" json:"systemTags"`
// Locks associated with this resource.
Locks []ResourceLock `mandatory:"false" json:"locks"`
}
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"`
// An optional description of the project.
Description *string `mandatory:"false" json:"description"`
// When the project was created, as an RFC3339 datetime string.
TimeUpdated *common.SDKTime `mandatory:"false" json:"timeUpdated"`
// A message describing the current state in more detail, that can provide actionable information if creation failed.
LifecycleDetails *string `mandatory:"false" json:"lifecycleDetails"`
// A simple key-value pair that is applied without any predefined name, type, or scope. It exists for cross-compatibility only.
// For example: `{"bar-key": "value"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Defined tags for this resource. Each key is predefined and scoped to a namespace.
// For example: `{"foo-namespace": {"bar-key": "value"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
// Usage of system tag keys. These predefined keys are scoped to namespaces.
// For example: `{"orcl-cloud": {"free-tier-retained": "true"}}`
SystemTags map[string]map[string]interface{} `mandatory:"false" json:"systemTags"`
}
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
RemoveModelLockDetails Request payload to remove lock to the resource.
type RemoveModelLockDetails struct {
// Type of the lock.
Type RemoveModelLockDetailsTypeEnum `mandatory:"true" json:"type"`
}
func (m RemoveModelLockDetails) String() string
func (m RemoveModelLockDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
RemoveModelLockDetailsTypeEnum Enum with underlying type: string
type RemoveModelLockDetailsTypeEnum string
Set of constants representing the allowable values for RemoveModelLockDetailsTypeEnum
const (
RemoveModelLockDetailsTypeFull RemoveModelLockDetailsTypeEnum = "FULL"
RemoveModelLockDetailsTypeDelete RemoveModelLockDetailsTypeEnum = "DELETE"
)
func GetMappingRemoveModelLockDetailsTypeEnum(val string) (RemoveModelLockDetailsTypeEnum, bool)
GetMappingRemoveModelLockDetailsTypeEnum performs case Insensitive comparison on enum value and return the desired enum
func GetRemoveModelLockDetailsTypeEnumValues() []RemoveModelLockDetailsTypeEnum
GetRemoveModelLockDetailsTypeEnumValues Enumerates the set of values for RemoveModelLockDetailsTypeEnum
RemoveModelLockRequest wrapper for the RemoveModelLock operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/aidocument/RemoveModelLock.go.html to see an example of how to use RemoveModelLockRequest.
type RemoveModelLockRequest struct {
// A unique model identifier.
ModelId *string `mandatory:"true" contributesTo:"path" name:"modelId"`
// Request payload to remove lock to the resource.
RemoveModelLockDetails `contributesTo:"body"`
// A token that uniquely identifies a request so it can be retried in case of a timeout or
// server error without the risk of executing that same action again. Retry tokens expire after 24
// hours, but can be invalidated before then due to conflicting operations. For example, if a resource
// has been deleted and purged from the system, then a retry of the original creation request
// might be rejected.
OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`
// The client request ID for tracing.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// For optimistic concurrency control. In the PUT or DELETE call
// for a resource, set the `if-match` parameter to the value of the
// etag from a previous GET or POST response for that resource.
// The resource will be updated or deleted only if the etag you
// provide matches the resource's current etag value.
IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`
// Whether to override locks (if any exist).
IsLockOverride *bool `mandatory:"false" contributesTo:"query" name:"isLockOverride"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request RemoveModelLockRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request RemoveModelLockRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request RemoveModelLockRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request RemoveModelLockRequest) String() string
func (request RemoveModelLockRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
RemoveModelLockResponse wrapper for the RemoveModelLock operation
type RemoveModelLockResponse struct {
// The underlying http response
RawResponse *http.Response
// The Model instance
Model `presentIn:"body"`
// For optimistic concurrency control. See `if-match`.
Etag *string `presentIn:"header" name:"etag"`
// A unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response RemoveModelLockResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response RemoveModelLockResponse) String() string
RemoveProjectLockDetails Request payload to remove lock to the resource.
type RemoveProjectLockDetails struct {
// Type of the lock.
Type RemoveProjectLockDetailsTypeEnum `mandatory:"true" json:"type"`
}
func (m RemoveProjectLockDetails) String() string
func (m RemoveProjectLockDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
RemoveProjectLockDetailsTypeEnum Enum with underlying type: string
type RemoveProjectLockDetailsTypeEnum string
Set of constants representing the allowable values for RemoveProjectLockDetailsTypeEnum
const (
RemoveProjectLockDetailsTypeFull RemoveProjectLockDetailsTypeEnum = "FULL"
RemoveProjectLockDetailsTypeDelete RemoveProjectLockDetailsTypeEnum = "DELETE"
)
func GetMappingRemoveProjectLockDetailsTypeEnum(val string) (RemoveProjectLockDetailsTypeEnum, bool)
GetMappingRemoveProjectLockDetailsTypeEnum performs case Insensitive comparison on enum value and return the desired enum
func GetRemoveProjectLockDetailsTypeEnumValues() []RemoveProjectLockDetailsTypeEnum
GetRemoveProjectLockDetailsTypeEnumValues Enumerates the set of values for RemoveProjectLockDetailsTypeEnum
RemoveProjectLockRequest wrapper for the RemoveProjectLock operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/aidocument/RemoveProjectLock.go.html to see an example of how to use RemoveProjectLockRequest.
type RemoveProjectLockRequest struct {
// A unique project identifier.
ProjectId *string `mandatory:"true" contributesTo:"path" name:"projectId"`
// Request payload to remove lock to the resource.
RemoveProjectLockDetails `contributesTo:"body"`
// A token that uniquely identifies a request so it can be retried in case of a timeout or
// server error without the risk of executing that same action again. Retry tokens expire after 24
// hours, but can be invalidated before then due to conflicting operations. For example, if a resource
// has been deleted and purged from the system, then a retry of the original creation request
// might be rejected.
OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`
// The client request ID for tracing.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// For optimistic concurrency control. In the PUT or DELETE call
// for a resource, set the `if-match` parameter to the value of the
// etag from a previous GET or POST response for that resource.
// The resource will be updated or deleted only if the etag you
// provide matches the resource's current etag value.
IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`
// Whether to override locks (if any exist).
IsLockOverride *bool `mandatory:"false" contributesTo:"query" name:"isLockOverride"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request RemoveProjectLockRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request RemoveProjectLockRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request RemoveProjectLockRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request RemoveProjectLockRequest) String() string
func (request RemoveProjectLockRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
RemoveProjectLockResponse wrapper for the RemoveProjectLock operation
type RemoveProjectLockResponse struct {
// The underlying http response
RawResponse *http.Response
// The Project instance
Project `presentIn:"body"`
// For optimistic concurrency control. See `if-match`.
Etag *string `presentIn:"header" name:"etag"`
// A unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response RemoveProjectLockResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response RemoveProjectLockResponse) String() string
ResourceLock Resource locks prevent certain APIs from being called for the resource. A full lock prevents both updating and deleting the resource. A lock delete prevents deleting the resource.
type ResourceLock struct {
// Lock type.
Type ResourceLockTypeEnum `mandatory:"true" json:"type"`
// The lock compartment ID.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// The resource ID that is locking this resource. Indicates that deleting this resource removes the lock.
RelatedResourceId *string `mandatory:"false" json:"relatedResourceId"`
// A message added by the lock creator. The message typically gives an
// indication of why the resource is locked.
Message *string `mandatory:"false" json:"message"`
// Indicates when the lock was created, in the format defined by RFC 3339.
TimeCreated *common.SDKTime `mandatory:"false" json:"timeCreated"`
}
func (m ResourceLock) String() string
func (m ResourceLock) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ResourceLockTypeEnum Enum with underlying type: string
type ResourceLockTypeEnum string
Set of constants representing the allowable values for ResourceLockTypeEnum
const (
ResourceLockTypeFull ResourceLockTypeEnum = "FULL"
ResourceLockTypeDelete ResourceLockTypeEnum = "DELETE"
)
func GetMappingResourceLockTypeEnum(val string) (ResourceLockTypeEnum, bool)
GetMappingResourceLockTypeEnum performs case Insensitive comparison on enum value and return the desired enum
func GetResourceLockTypeEnumValues() []ResourceLockTypeEnum
GetResourceLockTypeEnumValues Enumerates the set of values for ResourceLockTypeEnum
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
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/aidocument/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"`
// Whether to override locks (if any exist).
IsLockOverride *bool `mandatory:"false" contributesTo:"query" name:"isLockOverride"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
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
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/aidocument/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"`
// Whether to override locks (if any exist).
IsLockOverride *bool `mandatory:"false" contributesTo:"query" name:"isLockOverride"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
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"`
// The array of values.
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 compartment identifier.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// The resources affected by this work request.
Resources []WorkRequestResource `mandatory:"true" json:"resources"`
// The percentage of the request completed.
PercentComplete *float32 `mandatory:"true" json:"percentComplete"`
// The date and time the request was created, as described in
// RFC 3339 (https://tools.ietf.org/rfc/rfc3339), section 14.29.
TimeAccepted *common.SDKTime `mandatory:"true" json:"timeAccepted"`
// The date and time the request was started, as described in RFC 3339 (https://tools.ietf.org/rfc/rfc3339),
// section 14.29.
TimeStarted *common.SDKTime `mandatory:"false" json:"timeStarted"`
// The date and time the object was finished, as described in RFC 3339 (https://tools.ietf.org/rfc/rfc3339).
TimeFinished *common.SDKTime `mandatory:"false" json:"timeFinished"`
}
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.oracle.com/iaas/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"`
// Additional information that helps to explain the resource.
Metadata map[string]string `mandatory:"false" json:"metadata"`
}
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
WorkRequestResourceMetadataKeyEnum Enum with underlying type: string
type WorkRequestResourceMetadataKeyEnum string
Set of constants representing the allowable values for WorkRequestResourceMetadataKeyEnum
const (
WorkRequestResourceMetadataKeyIsDryRun WorkRequestResourceMetadataKeyEnum = "IS_DRY_RUN"
WorkRequestResourceMetadataKeyDisplayName WorkRequestResourceMetadataKeyEnum = "DISPLAY_NAME"
)
func GetMappingWorkRequestResourceMetadataKeyEnum(val string) (WorkRequestResourceMetadataKeyEnum, bool)
GetMappingWorkRequestResourceMetadataKeyEnum performs case Insensitive comparison on enum value and return the desired enum
func GetWorkRequestResourceMetadataKeyEnumValues() []WorkRequestResourceMetadataKeyEnum
GetWorkRequestResourceMetadataKeyEnumValues Enumerates the set of values for WorkRequestResourceMetadataKeyEnum
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 compartment identifier.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// The resources affected by this work request.
Resources []WorkRequestResource `mandatory:"true" json:"resources"`
// The percentage of the request completed.
PercentComplete *float32 `mandatory:"true" json:"percentComplete"`
// The date and time the request was created, as described in
// RFC 3339 (https://tools.ietf.org/rfc/rfc3339), section 14.29.
TimeAccepted *common.SDKTime `mandatory:"true" json:"timeAccepted"`
// The date and time the request was started, as described in RFC 3339 (https://tools.ietf.org/rfc/rfc3339),
// section 14.29.
TimeStarted *common.SDKTime `mandatory:"false" json:"timeStarted"`
// The date and time the object was finished, as described in RFC 3339 (https://tools.ietf.org/rfc/rfc3339).
TimeFinished *common.SDKTime `mandatory:"false" json:"timeFinished"`
}
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