...

Package aidocument

import "github.com/oracle/oci-go-sdk/aidocument"
Overview
Index

Overview ▾

Index ▾

func GetActionTypeEnumStringValues() []string
func GetDatasetDatasetTypeEnumStringValues() []string
func GetDimensionsUnitEnumStringValues() []string
func GetDocumentDetailsSourceEnumStringValues() []string
func GetDocumentFeatureFeatureTypeEnumStringValues() []string
func GetDocumentFieldFieldTypeEnumStringValues() []string
func GetDocumentTypeEnumStringValues() []string
func GetFieldValueValueTypeEnumStringValues() []string
func GetInputLocationSourceTypeEnumStringValues() []string
func GetListModelsSortByEnumStringValues() []string
func GetListModelsSortOrderEnumStringValues() []string
func GetListProjectsSortByEnumStringValues() []string
func GetListProjectsSortOrderEnumStringValues() []string
func GetListWorkRequestErrorsSortByEnumStringValues() []string
func GetListWorkRequestErrorsSortOrderEnumStringValues() []string
func GetListWorkRequestLogsSortByEnumStringValues() []string
func GetListWorkRequestLogsSortOrderEnumStringValues() []string
func GetListWorkRequestsSortByEnumStringValues() []string
func GetListWorkRequestsSortOrderEnumStringValues() []string
func GetListWorkRequestsStatusEnumStringValues() []string
func GetModelLifecycleStateEnumStringValues() []string
func GetModelMetricsModelTypeEnumStringValues() []string
func GetModelModelTypeEnumStringValues() []string
func GetOperationStatusEnumStringValues() []string
func GetOperationTypeEnumStringValues() []string
func GetPatchModelOperationOperationEnumStringValues() []string
func GetProcessorJobLifecycleDetailsEnumStringValues() []string
func GetProcessorJobLifecycleStateEnumStringValues() []string
func GetProcessorTypeEnumStringValues() []string
func GetProjectLifecycleStateEnumStringValues() []string
func GetSortOrderEnumStringValues() []string
func GetWorkRequestResourceMetadataKeyEnumStringValues() []string
type AIServiceDocumentClient
    func NewAIServiceDocumentClientWithConfigurationProvider(configProvider common.ConfigurationProvider) (client AIServiceDocumentClient, err error)
    func NewAIServiceDocumentClientWithOboToken(configProvider common.ConfigurationProvider, oboToken string) (client AIServiceDocumentClient, err error)
    func (client AIServiceDocumentClient) AnalyzeDocument(ctx context.Context, request AnalyzeDocumentRequest) (response AnalyzeDocumentResponse, err error)
    func (client AIServiceDocumentClient) CancelProcessorJob(ctx context.Context, request CancelProcessorJobRequest) (response CancelProcessorJobResponse, err error)
    func (client AIServiceDocumentClient) CancelWorkRequest(ctx context.Context, request CancelWorkRequestRequest) (response CancelWorkRequestResponse, err error)
    func (client AIServiceDocumentClient) ChangeModelCompartment(ctx context.Context, request ChangeModelCompartmentRequest) (response ChangeModelCompartmentResponse, err error)
    func (client AIServiceDocumentClient) ChangeProjectCompartment(ctx context.Context, request ChangeProjectCompartmentRequest) (response ChangeProjectCompartmentResponse, err error)
    func (client *AIServiceDocumentClient) ConfigurationProvider() *common.ConfigurationProvider
    func (client AIServiceDocumentClient) CreateModel(ctx context.Context, request CreateModelRequest) (response CreateModelResponse, err error)
    func (client AIServiceDocumentClient) CreateProcessorJob(ctx context.Context, request CreateProcessorJobRequest) (response CreateProcessorJobResponse, err error)
    func (client AIServiceDocumentClient) CreateProject(ctx context.Context, request CreateProjectRequest) (response CreateProjectResponse, err error)
    func (client AIServiceDocumentClient) DeleteModel(ctx context.Context, request DeleteModelRequest) (response DeleteModelResponse, err error)
    func (client AIServiceDocumentClient) DeleteProject(ctx context.Context, request DeleteProjectRequest) (response DeleteProjectResponse, err error)
    func (client AIServiceDocumentClient) GetModel(ctx context.Context, request GetModelRequest) (response GetModelResponse, err error)
    func (client AIServiceDocumentClient) GetProcessorJob(ctx context.Context, request GetProcessorJobRequest) (response GetProcessorJobResponse, err error)
    func (client AIServiceDocumentClient) GetProject(ctx context.Context, request GetProjectRequest) (response GetProjectResponse, err error)
    func (client AIServiceDocumentClient) GetWorkRequest(ctx context.Context, request GetWorkRequestRequest) (response GetWorkRequestResponse, err error)
    func (client AIServiceDocumentClient) ListModels(ctx context.Context, request ListModelsRequest) (response ListModelsResponse, err error)
    func (client AIServiceDocumentClient) ListProjects(ctx context.Context, request ListProjectsRequest) (response ListProjectsResponse, err error)
    func (client AIServiceDocumentClient) ListWorkRequestErrors(ctx context.Context, request ListWorkRequestErrorsRequest) (response ListWorkRequestErrorsResponse, err error)
    func (client AIServiceDocumentClient) ListWorkRequestLogs(ctx context.Context, request ListWorkRequestLogsRequest) (response ListWorkRequestLogsResponse, err error)
    func (client AIServiceDocumentClient) ListWorkRequests(ctx context.Context, request ListWorkRequestsRequest) (response ListWorkRequestsResponse, err error)
    func (client AIServiceDocumentClient) PatchModel(ctx context.Context, request PatchModelRequest) (response PatchModelResponse, err error)
    func (client *AIServiceDocumentClient) SetRegion(region string)
    func (client AIServiceDocumentClient) UpdateModel(ctx context.Context, request UpdateModelRequest) (response UpdateModelResponse, err error)
    func (client AIServiceDocumentClient) UpdateProject(ctx context.Context, request UpdateProjectRequest) (response UpdateProjectResponse, err error)
type ActionTypeEnum
    func GetActionTypeEnumValues() []ActionTypeEnum
    func GetMappingActionTypeEnum(val string) (ActionTypeEnum, bool)
type AnalyzeDocumentDetails
    func (m AnalyzeDocumentDetails) String() string
    func (m *AnalyzeDocumentDetails) UnmarshalJSON(data []byte) (e error)
    func (m AnalyzeDocumentDetails) ValidateEnumValue() (bool, error)
type AnalyzeDocumentRequest
    func (request AnalyzeDocumentRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
    func (request AnalyzeDocumentRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
    func (request AnalyzeDocumentRequest) RetryPolicy() *common.RetryPolicy
    func (request AnalyzeDocumentRequest) String() string
    func (request AnalyzeDocumentRequest) ValidateEnumValue() (bool, error)
type AnalyzeDocumentResponse
    func (response AnalyzeDocumentResponse) HTTPResponse() *http.Response
    func (response AnalyzeDocumentResponse) String() string
type AnalyzeDocumentResult
    func (m AnalyzeDocumentResult) String() string
    func (m AnalyzeDocumentResult) ValidateEnumValue() (bool, error)
type BoundingPolygon
    func (m BoundingPolygon) String() string
    func (m BoundingPolygon) ValidateEnumValue() (bool, error)
type CancelProcessorJobRequest
    func (request CancelProcessorJobRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
    func (request CancelProcessorJobRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
    func (request CancelProcessorJobRequest) RetryPolicy() *common.RetryPolicy
    func (request CancelProcessorJobRequest) String() string
    func (request CancelProcessorJobRequest) ValidateEnumValue() (bool, error)
type CancelProcessorJobResponse
    func (response CancelProcessorJobResponse) HTTPResponse() *http.Response
    func (response CancelProcessorJobResponse) String() string
type CancelWorkRequestRequest
    func (request CancelWorkRequestRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
    func (request CancelWorkRequestRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
    func (request CancelWorkRequestRequest) RetryPolicy() *common.RetryPolicy
    func (request CancelWorkRequestRequest) String() string
    func (request CancelWorkRequestRequest) ValidateEnumValue() (bool, error)
type CancelWorkRequestResponse
    func (response CancelWorkRequestResponse) HTTPResponse() *http.Response
    func (response CancelWorkRequestResponse) String() string
type Cell
    func (m Cell) String() string
    func (m Cell) ValidateEnumValue() (bool, error)
type ChangeModelCompartmentDetails
    func (m ChangeModelCompartmentDetails) String() string
    func (m ChangeModelCompartmentDetails) ValidateEnumValue() (bool, error)
type ChangeModelCompartmentRequest
    func (request ChangeModelCompartmentRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
    func (request ChangeModelCompartmentRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
    func (request ChangeModelCompartmentRequest) RetryPolicy() *common.RetryPolicy
    func (request ChangeModelCompartmentRequest) String() string
    func (request ChangeModelCompartmentRequest) ValidateEnumValue() (bool, error)
type ChangeModelCompartmentResponse
    func (response ChangeModelCompartmentResponse) HTTPResponse() *http.Response
    func (response ChangeModelCompartmentResponse) String() string
type ChangeProjectCompartmentDetails
    func (m ChangeProjectCompartmentDetails) String() string
    func (m ChangeProjectCompartmentDetails) ValidateEnumValue() (bool, error)
type ChangeProjectCompartmentRequest
    func (request ChangeProjectCompartmentRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
    func (request ChangeProjectCompartmentRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
    func (request ChangeProjectCompartmentRequest) RetryPolicy() *common.RetryPolicy
    func (request ChangeProjectCompartmentRequest) String() string
    func (request ChangeProjectCompartmentRequest) ValidateEnumValue() (bool, error)
type ChangeProjectCompartmentResponse
    func (response ChangeProjectCompartmentResponse) HTTPResponse() *http.Response
    func (response ChangeProjectCompartmentResponse) String() string
type ComponentModel
    func (m ComponentModel) String() string
    func (m ComponentModel) ValidateEnumValue() (bool, error)
type CreateModelDetails
    func (m CreateModelDetails) String() string
    func (m *CreateModelDetails) UnmarshalJSON(data []byte) (e error)
    func (m CreateModelDetails) ValidateEnumValue() (bool, error)
type CreateModelRequest
    func (request CreateModelRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
    func (request CreateModelRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
    func (request CreateModelRequest) RetryPolicy() *common.RetryPolicy
    func (request CreateModelRequest) String() string
    func (request CreateModelRequest) ValidateEnumValue() (bool, error)
type CreateModelResponse
    func (response CreateModelResponse) HTTPResponse() *http.Response
    func (response CreateModelResponse) String() string
type CreateProcessorJobDetails
    func (m CreateProcessorJobDetails) String() string
    func (m *CreateProcessorJobDetails) UnmarshalJSON(data []byte) (e error)
    func (m CreateProcessorJobDetails) ValidateEnumValue() (bool, error)
type CreateProcessorJobRequest
    func (request CreateProcessorJobRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
    func (request CreateProcessorJobRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
    func (request CreateProcessorJobRequest) RetryPolicy() *common.RetryPolicy
    func (request CreateProcessorJobRequest) String() string
    func (request CreateProcessorJobRequest) ValidateEnumValue() (bool, error)
type CreateProcessorJobResponse
    func (response CreateProcessorJobResponse) HTTPResponse() *http.Response
    func (response CreateProcessorJobResponse) String() string
type CreateProjectDetails
    func (m CreateProjectDetails) String() string
    func (m CreateProjectDetails) ValidateEnumValue() (bool, error)
type CreateProjectRequest
    func (request CreateProjectRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
    func (request CreateProjectRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
    func (request CreateProjectRequest) RetryPolicy() *common.RetryPolicy
    func (request CreateProjectRequest) String() string
    func (request CreateProjectRequest) ValidateEnumValue() (bool, error)
type CreateProjectResponse
    func (response CreateProjectResponse) HTTPResponse() *http.Response
    func (response CreateProjectResponse) String() string
type DataScienceLabelingDataset
    func (m DataScienceLabelingDataset) MarshalJSON() (buff []byte, e error)
    func (m DataScienceLabelingDataset) String() string
    func (m DataScienceLabelingDataset) ValidateEnumValue() (bool, error)
type Dataset
type DatasetDatasetTypeEnum
    func GetDatasetDatasetTypeEnumValues() []DatasetDatasetTypeEnum
    func GetMappingDatasetDatasetTypeEnum(val string) (DatasetDatasetTypeEnum, bool)
type DatasetSummary
    func (m DatasetSummary) String() string
    func (m DatasetSummary) ValidateEnumValue() (bool, error)
type DeleteModelRequest
    func (request DeleteModelRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
    func (request DeleteModelRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
    func (request DeleteModelRequest) RetryPolicy() *common.RetryPolicy
    func (request DeleteModelRequest) String() string
    func (request DeleteModelRequest) ValidateEnumValue() (bool, error)
type DeleteModelResponse
    func (response DeleteModelResponse) HTTPResponse() *http.Response
    func (response DeleteModelResponse) String() string
type DeleteProjectRequest
    func (request DeleteProjectRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
    func (request DeleteProjectRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
    func (request DeleteProjectRequest) RetryPolicy() *common.RetryPolicy
    func (request DeleteProjectRequest) String() string
    func (request DeleteProjectRequest) ValidateEnumValue() (bool, error)
type DeleteProjectResponse
    func (response DeleteProjectResponse) HTTPResponse() *http.Response
    func (response DeleteProjectResponse) String() string
type DetectedDocumentType
    func (m DetectedDocumentType) String() string
    func (m DetectedDocumentType) ValidateEnumValue() (bool, error)
type DetectedLanguage
    func (m DetectedLanguage) String() string
    func (m DetectedLanguage) ValidateEnumValue() (bool, error)
type Dimensions
    func (m Dimensions) String() string
    func (m Dimensions) ValidateEnumValue() (bool, error)
type DimensionsUnitEnum
    func GetDimensionsUnitEnumValues() []DimensionsUnitEnum
    func GetMappingDimensionsUnitEnum(val string) (DimensionsUnitEnum, bool)
type DocumentClassificationConfidenceEntry
    func (m DocumentClassificationConfidenceEntry) String() string
    func (m DocumentClassificationConfidenceEntry) ValidateEnumValue() (bool, error)
type DocumentClassificationFeature
    func (m DocumentClassificationFeature) MarshalJSON() (buff []byte, e error)
    func (m DocumentClassificationFeature) String() string
    func (m DocumentClassificationFeature) ValidateEnumValue() (bool, error)
type DocumentClassificationLabelMetricsReport
    func (m DocumentClassificationLabelMetricsReport) String() string
    func (m DocumentClassificationLabelMetricsReport) ValidateEnumValue() (bool, error)
type DocumentClassificationModelMetrics
    func (m DocumentClassificationModelMetrics) GetDatasetSummary() *DatasetSummary
    func (m DocumentClassificationModelMetrics) MarshalJSON() (buff []byte, e error)
    func (m DocumentClassificationModelMetrics) String() string
    func (m DocumentClassificationModelMetrics) ValidateEnumValue() (bool, error)
type DocumentClassificationOverallMetricsReport
    func (m DocumentClassificationOverallMetricsReport) String() string
    func (m DocumentClassificationOverallMetricsReport) ValidateEnumValue() (bool, error)
type DocumentDetails
type DocumentDetailsSourceEnum
    func GetDocumentDetailsSourceEnumValues() []DocumentDetailsSourceEnum
    func GetMappingDocumentDetailsSourceEnum(val string) (DocumentDetailsSourceEnum, bool)
type DocumentFeature
type DocumentFeatureFeatureTypeEnum
    func GetDocumentFeatureFeatureTypeEnumValues() []DocumentFeatureFeatureTypeEnum
    func GetMappingDocumentFeatureFeatureTypeEnum(val string) (DocumentFeatureFeatureTypeEnum, bool)
type DocumentField
    func (m DocumentField) String() string
    func (m *DocumentField) UnmarshalJSON(data []byte) (e error)
    func (m DocumentField) ValidateEnumValue() (bool, error)
type DocumentFieldFieldTypeEnum
    func GetDocumentFieldFieldTypeEnumValues() []DocumentFieldFieldTypeEnum
    func GetMappingDocumentFieldFieldTypeEnum(val string) (DocumentFieldFieldTypeEnum, bool)
type DocumentKeyValueExtractionFeature
    func (m DocumentKeyValueExtractionFeature) MarshalJSON() (buff []byte, e error)
    func (m DocumentKeyValueExtractionFeature) String() string
    func (m DocumentKeyValueExtractionFeature) ValidateEnumValue() (bool, error)
type DocumentLanguageClassificationFeature
    func (m DocumentLanguageClassificationFeature) MarshalJSON() (buff []byte, e error)
    func (m DocumentLanguageClassificationFeature) String() string
    func (m DocumentLanguageClassificationFeature) ValidateEnumValue() (bool, error)
type DocumentMetadata
    func (m DocumentMetadata) String() string
    func (m DocumentMetadata) ValidateEnumValue() (bool, error)
type DocumentTableExtractionFeature
    func (m DocumentTableExtractionFeature) MarshalJSON() (buff []byte, e error)
    func (m DocumentTableExtractionFeature) String() string
    func (m DocumentTableExtractionFeature) ValidateEnumValue() (bool, error)
type DocumentTextExtractionFeature
    func (m DocumentTextExtractionFeature) MarshalJSON() (buff []byte, e error)
    func (m DocumentTextExtractionFeature) String() string
    func (m DocumentTextExtractionFeature) ValidateEnumValue() (bool, error)
type DocumentTypeEnum
    func GetDocumentTypeEnumValues() []DocumentTypeEnum
    func GetMappingDocumentTypeEnum(val string) (DocumentTypeEnum, bool)
type FieldLabel
    func (m FieldLabel) String() string
    func (m FieldLabel) ValidateEnumValue() (bool, error)
type FieldName
    func (m FieldName) String() string
    func (m FieldName) ValidateEnumValue() (bool, error)
type FieldValue
type FieldValueValueTypeEnum
    func GetFieldValueValueTypeEnumValues() []FieldValueValueTypeEnum
    func GetMappingFieldValueValueTypeEnum(val string) (FieldValueValueTypeEnum, bool)
type GeneralProcessorConfig
    func (m GeneralProcessorConfig) MarshalJSON() (buff []byte, e error)
    func (m GeneralProcessorConfig) String() string
    func (m *GeneralProcessorConfig) UnmarshalJSON(data []byte) (e error)
    func (m GeneralProcessorConfig) ValidateEnumValue() (bool, error)
type GetModelRequest
    func (request GetModelRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
    func (request GetModelRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
    func (request GetModelRequest) RetryPolicy() *common.RetryPolicy
    func (request GetModelRequest) String() string
    func (request GetModelRequest) ValidateEnumValue() (bool, error)
type GetModelResponse
    func (response GetModelResponse) HTTPResponse() *http.Response
    func (response GetModelResponse) String() string
type GetProcessorJobRequest
    func (request GetProcessorJobRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
    func (request GetProcessorJobRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
    func (request GetProcessorJobRequest) RetryPolicy() *common.RetryPolicy
    func (request GetProcessorJobRequest) String() string
    func (request GetProcessorJobRequest) ValidateEnumValue() (bool, error)
type GetProcessorJobResponse
    func (response GetProcessorJobResponse) HTTPResponse() *http.Response
    func (response GetProcessorJobResponse) String() string
type GetProjectRequest
    func (request GetProjectRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
    func (request GetProjectRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
    func (request GetProjectRequest) RetryPolicy() *common.RetryPolicy
    func (request GetProjectRequest) String() string
    func (request GetProjectRequest) ValidateEnumValue() (bool, error)
type GetProjectResponse
    func (response GetProjectResponse) HTTPResponse() *http.Response
    func (response GetProjectResponse) String() string
type GetWorkRequestRequest
    func (request GetWorkRequestRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
    func (request GetWorkRequestRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
    func (request GetWorkRequestRequest) RetryPolicy() *common.RetryPolicy
    func (request GetWorkRequestRequest) String() string
    func (request GetWorkRequestRequest) ValidateEnumValue() (bool, error)
type GetWorkRequestResponse
    func (response GetWorkRequestResponse) HTTPResponse() *http.Response
    func (response GetWorkRequestResponse) String() string
type InlineDocumentContent
    func (m InlineDocumentContent) MarshalJSON() (buff []byte, e error)
    func (m InlineDocumentContent) String() string
    func (m InlineDocumentContent) ValidateEnumValue() (bool, error)
type InlineDocumentDetails
    func (m InlineDocumentDetails) MarshalJSON() (buff []byte, e error)
    func (m InlineDocumentDetails) String() string
    func (m InlineDocumentDetails) ValidateEnumValue() (bool, error)
type InputLocation
type InputLocationSourceTypeEnum
    func GetInputLocationSourceTypeEnumValues() []InputLocationSourceTypeEnum
    func GetMappingInputLocationSourceTypeEnum(val string) (InputLocationSourceTypeEnum, bool)
type KeyValueDetectionConfidenceEntry
    func (m KeyValueDetectionConfidenceEntry) String() string
    func (m KeyValueDetectionConfidenceEntry) ValidateEnumValue() (bool, error)
type KeyValueDetectionLabelMetricsReport
    func (m KeyValueDetectionLabelMetricsReport) String() string
    func (m KeyValueDetectionLabelMetricsReport) ValidateEnumValue() (bool, error)
type KeyValueDetectionModelMetrics
    func (m KeyValueDetectionModelMetrics) GetDatasetSummary() *DatasetSummary
    func (m KeyValueDetectionModelMetrics) MarshalJSON() (buff []byte, e error)
    func (m KeyValueDetectionModelMetrics) String() string
    func (m KeyValueDetectionModelMetrics) ValidateEnumValue() (bool, error)
type KeyValueDetectionOverallMetricsReport
    func (m KeyValueDetectionOverallMetricsReport) String() string
    func (m KeyValueDetectionOverallMetricsReport) ValidateEnumValue() (bool, error)
type Line
    func (m Line) String() string
    func (m Line) ValidateEnumValue() (bool, error)
type ListModelsRequest
    func (request ListModelsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
    func (request ListModelsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
    func (request ListModelsRequest) RetryPolicy() *common.RetryPolicy
    func (request ListModelsRequest) String() string
    func (request ListModelsRequest) ValidateEnumValue() (bool, error)
type ListModelsResponse
    func (response ListModelsResponse) HTTPResponse() *http.Response
    func (response ListModelsResponse) String() string
type ListModelsSortByEnum
    func GetListModelsSortByEnumValues() []ListModelsSortByEnum
    func GetMappingListModelsSortByEnum(val string) (ListModelsSortByEnum, bool)
type ListModelsSortOrderEnum
    func GetListModelsSortOrderEnumValues() []ListModelsSortOrderEnum
    func GetMappingListModelsSortOrderEnum(val string) (ListModelsSortOrderEnum, bool)
type ListProjectsRequest
    func (request ListProjectsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
    func (request ListProjectsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
    func (request ListProjectsRequest) RetryPolicy() *common.RetryPolicy
    func (request ListProjectsRequest) String() string
    func (request ListProjectsRequest) ValidateEnumValue() (bool, error)
type ListProjectsResponse
    func (response ListProjectsResponse) HTTPResponse() *http.Response
    func (response ListProjectsResponse) String() string
type ListProjectsSortByEnum
    func GetListProjectsSortByEnumValues() []ListProjectsSortByEnum
    func GetMappingListProjectsSortByEnum(val string) (ListProjectsSortByEnum, bool)
type ListProjectsSortOrderEnum
    func GetListProjectsSortOrderEnumValues() []ListProjectsSortOrderEnum
    func GetMappingListProjectsSortOrderEnum(val string) (ListProjectsSortOrderEnum, bool)
type ListWorkRequestErrorsRequest
    func (request ListWorkRequestErrorsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
    func (request ListWorkRequestErrorsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
    func (request ListWorkRequestErrorsRequest) RetryPolicy() *common.RetryPolicy
    func (request ListWorkRequestErrorsRequest) String() string
    func (request ListWorkRequestErrorsRequest) ValidateEnumValue() (bool, error)
type ListWorkRequestErrorsResponse
    func (response ListWorkRequestErrorsResponse) HTTPResponse() *http.Response
    func (response ListWorkRequestErrorsResponse) String() string
type ListWorkRequestErrorsSortByEnum
    func GetListWorkRequestErrorsSortByEnumValues() []ListWorkRequestErrorsSortByEnum
    func GetMappingListWorkRequestErrorsSortByEnum(val string) (ListWorkRequestErrorsSortByEnum, bool)
type ListWorkRequestErrorsSortOrderEnum
    func GetListWorkRequestErrorsSortOrderEnumValues() []ListWorkRequestErrorsSortOrderEnum
    func GetMappingListWorkRequestErrorsSortOrderEnum(val string) (ListWorkRequestErrorsSortOrderEnum, bool)
type ListWorkRequestLogsRequest
    func (request ListWorkRequestLogsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
    func (request ListWorkRequestLogsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
    func (request ListWorkRequestLogsRequest) RetryPolicy() *common.RetryPolicy
    func (request ListWorkRequestLogsRequest) String() string
    func (request ListWorkRequestLogsRequest) ValidateEnumValue() (bool, error)
type ListWorkRequestLogsResponse
    func (response ListWorkRequestLogsResponse) HTTPResponse() *http.Response
    func (response ListWorkRequestLogsResponse) String() string
type ListWorkRequestLogsSortByEnum
    func GetListWorkRequestLogsSortByEnumValues() []ListWorkRequestLogsSortByEnum
    func GetMappingListWorkRequestLogsSortByEnum(val string) (ListWorkRequestLogsSortByEnum, bool)
type ListWorkRequestLogsSortOrderEnum
    func GetListWorkRequestLogsSortOrderEnumValues() []ListWorkRequestLogsSortOrderEnum
    func GetMappingListWorkRequestLogsSortOrderEnum(val string) (ListWorkRequestLogsSortOrderEnum, bool)
type ListWorkRequestsRequest
    func (request ListWorkRequestsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
    func (request ListWorkRequestsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
    func (request ListWorkRequestsRequest) RetryPolicy() *common.RetryPolicy
    func (request ListWorkRequestsRequest) String() string
    func (request ListWorkRequestsRequest) ValidateEnumValue() (bool, error)
type ListWorkRequestsResponse
    func (response ListWorkRequestsResponse) HTTPResponse() *http.Response
    func (response ListWorkRequestsResponse) String() string
type ListWorkRequestsSortByEnum
    func GetListWorkRequestsSortByEnumValues() []ListWorkRequestsSortByEnum
    func GetMappingListWorkRequestsSortByEnum(val string) (ListWorkRequestsSortByEnum, bool)
type ListWorkRequestsSortOrderEnum
    func GetListWorkRequestsSortOrderEnumValues() []ListWorkRequestsSortOrderEnum
    func GetMappingListWorkRequestsSortOrderEnum(val string) (ListWorkRequestsSortOrderEnum, bool)
type ListWorkRequestsStatusEnum
    func GetListWorkRequestsStatusEnumValues() []ListWorkRequestsStatusEnum
    func GetMappingListWorkRequestsStatusEnum(val string) (ListWorkRequestsStatusEnum, bool)
type Model
    func (m Model) String() string
    func (m *Model) UnmarshalJSON(data []byte) (e error)
    func (m Model) ValidateEnumValue() (bool, error)
type ModelCollection
    func (m ModelCollection) String() string
    func (m ModelCollection) ValidateEnumValue() (bool, error)
type ModelLifecycleStateEnum
    func GetMappingModelLifecycleStateEnum(val string) (ModelLifecycleStateEnum, bool)
    func GetModelLifecycleStateEnumValues() []ModelLifecycleStateEnum
type ModelMetrics
type ModelMetricsModelTypeEnum
    func GetMappingModelMetricsModelTypeEnum(val string) (ModelMetricsModelTypeEnum, bool)
    func GetModelMetricsModelTypeEnumValues() []ModelMetricsModelTypeEnum
type ModelModelTypeEnum
    func GetMappingModelModelTypeEnum(val string) (ModelModelTypeEnum, bool)
    func GetModelModelTypeEnumValues() []ModelModelTypeEnum
type ModelSummary
    func (m ModelSummary) String() string
    func (m *ModelSummary) UnmarshalJSON(data []byte) (e error)
    func (m ModelSummary) ValidateEnumValue() (bool, error)
type NormalizedVertex
    func (m NormalizedVertex) String() string
    func (m NormalizedVertex) ValidateEnumValue() (bool, error)
type ObjectLocation
    func (m ObjectLocation) String() string
    func (m ObjectLocation) ValidateEnumValue() (bool, error)
type ObjectStorageDataset
    func (m ObjectStorageDataset) MarshalJSON() (buff []byte, e error)
    func (m ObjectStorageDataset) String() string
    func (m ObjectStorageDataset) ValidateEnumValue() (bool, error)
type ObjectStorageDocumentDetails
    func (m ObjectStorageDocumentDetails) MarshalJSON() (buff []byte, e error)
    func (m ObjectStorageDocumentDetails) String() string
    func (m ObjectStorageDocumentDetails) ValidateEnumValue() (bool, error)
type ObjectStorageLocations
    func (m ObjectStorageLocations) MarshalJSON() (buff []byte, e error)
    func (m ObjectStorageLocations) String() string
    func (m ObjectStorageLocations) ValidateEnumValue() (bool, error)
type OperationStatusEnum
    func GetMappingOperationStatusEnum(val string) (OperationStatusEnum, bool)
    func GetOperationStatusEnumValues() []OperationStatusEnum
type OperationTypeEnum
    func GetMappingOperationTypeEnum(val string) (OperationTypeEnum, bool)
    func GetOperationTypeEnumValues() []OperationTypeEnum
type OutputLocation
    func (m OutputLocation) String() string
    func (m OutputLocation) ValidateEnumValue() (bool, error)
type Page
    func (m Page) String() string
    func (m Page) ValidateEnumValue() (bool, error)
type PatchModelDetails
    func (m PatchModelDetails) String() string
    func (m PatchModelDetails) ValidateEnumValue() (bool, error)
type PatchModelOperation
    func (m PatchModelOperation) String() string
    func (m PatchModelOperation) ValidateEnumValue() (bool, error)
type PatchModelOperationOperationEnum
    func GetMappingPatchModelOperationOperationEnum(val string) (PatchModelOperationOperationEnum, bool)
    func GetPatchModelOperationOperationEnumValues() []PatchModelOperationOperationEnum
type PatchModelRequest
    func (request PatchModelRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
    func (request PatchModelRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
    func (request PatchModelRequest) RetryPolicy() *common.RetryPolicy
    func (request PatchModelRequest) String() string
    func (request PatchModelRequest) ValidateEnumValue() (bool, error)
type PatchModelResponse
    func (response PatchModelResponse) HTTPResponse() *http.Response
    func (response PatchModelResponse) String() string
type PatchResponseMessage
    func (m PatchResponseMessage) String() string
    func (m PatchResponseMessage) ValidateEnumValue() (bool, error)
type ProcessingError
    func (m ProcessingError) String() string
    func (m ProcessingError) ValidateEnumValue() (bool, error)
type ProcessorConfig
type ProcessorJob
    func (m ProcessorJob) String() string
    func (m *ProcessorJob) UnmarshalJSON(data []byte) (e error)
    func (m ProcessorJob) ValidateEnumValue() (bool, error)
type ProcessorJobLifecycleDetailsEnum
    func GetMappingProcessorJobLifecycleDetailsEnum(val string) (ProcessorJobLifecycleDetailsEnum, bool)
    func GetProcessorJobLifecycleDetailsEnumValues() []ProcessorJobLifecycleDetailsEnum
type ProcessorJobLifecycleStateEnum
    func GetMappingProcessorJobLifecycleStateEnum(val string) (ProcessorJobLifecycleStateEnum, bool)
    func GetProcessorJobLifecycleStateEnumValues() []ProcessorJobLifecycleStateEnum
type ProcessorTypeEnum
    func GetMappingProcessorTypeEnum(val string) (ProcessorTypeEnum, bool)
    func GetProcessorTypeEnumValues() []ProcessorTypeEnum
type Project
    func (m Project) String() string
    func (m Project) ValidateEnumValue() (bool, error)
type ProjectCollection
    func (m ProjectCollection) String() string
    func (m ProjectCollection) ValidateEnumValue() (bool, error)
type ProjectLifecycleStateEnum
    func GetMappingProjectLifecycleStateEnum(val string) (ProjectLifecycleStateEnum, bool)
    func GetProjectLifecycleStateEnumValues() []ProjectLifecycleStateEnum
type ProjectSummary
    func (m ProjectSummary) String() string
    func (m ProjectSummary) ValidateEnumValue() (bool, error)
type SortOrderEnum
    func GetMappingSortOrderEnum(val string) (SortOrderEnum, bool)
    func GetSortOrderEnumValues() []SortOrderEnum
type Table
    func (m Table) String() string
    func (m Table) ValidateEnumValue() (bool, error)
type TableRow
    func (m TableRow) String() string
    func (m TableRow) ValidateEnumValue() (bool, error)
type UpdateModelDetails
    func (m UpdateModelDetails) String() string
    func (m UpdateModelDetails) ValidateEnumValue() (bool, error)
type UpdateModelRequest
    func (request UpdateModelRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
    func (request UpdateModelRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
    func (request UpdateModelRequest) RetryPolicy() *common.RetryPolicy
    func (request UpdateModelRequest) String() string
    func (request UpdateModelRequest) ValidateEnumValue() (bool, error)
type UpdateModelResponse
    func (response UpdateModelResponse) HTTPResponse() *http.Response
    func (response UpdateModelResponse) String() string
type UpdateProjectDetails
    func (m UpdateProjectDetails) String() string
    func (m UpdateProjectDetails) ValidateEnumValue() (bool, error)
type UpdateProjectRequest
    func (request UpdateProjectRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
    func (request UpdateProjectRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
    func (request UpdateProjectRequest) RetryPolicy() *common.RetryPolicy
    func (request UpdateProjectRequest) String() string
    func (request UpdateProjectRequest) ValidateEnumValue() (bool, error)
type UpdateProjectResponse
    func (response UpdateProjectResponse) HTTPResponse() *http.Response
    func (response UpdateProjectResponse) String() string
type ValueArray
    func (m ValueArray) GetBoundingPolygon() *BoundingPolygon
    func (m ValueArray) GetConfidence() *float32
    func (m ValueArray) GetText() *string
    func (m ValueArray) GetWordIndexes() []int
    func (m ValueArray) MarshalJSON() (buff []byte, e error)
    func (m ValueArray) String() string
    func (m ValueArray) ValidateEnumValue() (bool, error)
type ValueDate
    func (m ValueDate) GetBoundingPolygon() *BoundingPolygon
    func (m ValueDate) GetConfidence() *float32
    func (m ValueDate) GetText() *string
    func (m ValueDate) GetWordIndexes() []int
    func (m ValueDate) MarshalJSON() (buff []byte, e error)
    func (m ValueDate) String() string
    func (m ValueDate) ValidateEnumValue() (bool, error)
type ValueInteger
    func (m ValueInteger) GetBoundingPolygon() *BoundingPolygon
    func (m ValueInteger) GetConfidence() *float32
    func (m ValueInteger) GetText() *string
    func (m ValueInteger) GetWordIndexes() []int
    func (m ValueInteger) MarshalJSON() (buff []byte, e error)
    func (m ValueInteger) String() string
    func (m ValueInteger) ValidateEnumValue() (bool, error)
type ValueNumber
    func (m ValueNumber) GetBoundingPolygon() *BoundingPolygon
    func (m ValueNumber) GetConfidence() *float32
    func (m ValueNumber) GetText() *string
    func (m ValueNumber) GetWordIndexes() []int
    func (m ValueNumber) MarshalJSON() (buff []byte, e error)
    func (m ValueNumber) String() string
    func (m ValueNumber) ValidateEnumValue() (bool, error)
type ValuePhoneNumber
    func (m ValuePhoneNumber) GetBoundingPolygon() *BoundingPolygon
    func (m ValuePhoneNumber) GetConfidence() *float32
    func (m ValuePhoneNumber) GetText() *string
    func (m ValuePhoneNumber) GetWordIndexes() []int
    func (m ValuePhoneNumber) MarshalJSON() (buff []byte, e error)
    func (m ValuePhoneNumber) String() string
    func (m ValuePhoneNumber) ValidateEnumValue() (bool, error)
type ValueString
    func (m ValueString) GetBoundingPolygon() *BoundingPolygon
    func (m ValueString) GetConfidence() *float32
    func (m ValueString) GetText() *string
    func (m ValueString) GetWordIndexes() []int
    func (m ValueString) MarshalJSON() (buff []byte, e error)
    func (m ValueString) String() string
    func (m ValueString) ValidateEnumValue() (bool, error)
type ValueTime
    func (m ValueTime) GetBoundingPolygon() *BoundingPolygon
    func (m ValueTime) GetConfidence() *float32
    func (m ValueTime) GetText() *string
    func (m ValueTime) GetWordIndexes() []int
    func (m ValueTime) MarshalJSON() (buff []byte, e error)
    func (m ValueTime) String() string
    func (m ValueTime) ValidateEnumValue() (bool, error)
type Word
    func (m Word) String() string
    func (m Word) ValidateEnumValue() (bool, error)
type WorkRequest
    func (m WorkRequest) String() string
    func (m WorkRequest) ValidateEnumValue() (bool, error)
type WorkRequestError
    func (m WorkRequestError) String() string
    func (m WorkRequestError) ValidateEnumValue() (bool, error)
type WorkRequestErrorCollection
    func (m WorkRequestErrorCollection) String() string
    func (m WorkRequestErrorCollection) ValidateEnumValue() (bool, error)
type WorkRequestLogEntry
    func (m WorkRequestLogEntry) String() string
    func (m WorkRequestLogEntry) ValidateEnumValue() (bool, error)
type WorkRequestLogEntryCollection
    func (m WorkRequestLogEntryCollection) String() string
    func (m WorkRequestLogEntryCollection) ValidateEnumValue() (bool, error)
type WorkRequestResource
    func (m WorkRequestResource) String() string
    func (m WorkRequestResource) ValidateEnumValue() (bool, error)
type WorkRequestResourceMetadataKeyEnum
    func GetMappingWorkRequestResourceMetadataKeyEnum(val string) (WorkRequestResourceMetadataKeyEnum, bool)
    func GetWorkRequestResourceMetadataKeyEnumValues() []WorkRequestResourceMetadataKeyEnum
type WorkRequestSummary
    func (m WorkRequestSummary) String() string
    func (m WorkRequestSummary) ValidateEnumValue() (bool, error)
type WorkRequestSummaryCollection
    func (m WorkRequestSummaryCollection) String() string
    func (m WorkRequestSummaryCollection) ValidateEnumValue() (bool, error)

Package files

action_type.go aidocument_aiservicedocument_client.go analyze_document_details.go analyze_document_request_response.go analyze_document_result.go bounding_polygon.go cancel_processor_job_request_response.go cancel_work_request_request_response.go cell.go change_model_compartment_details.go change_model_compartment_request_response.go change_project_compartment_details.go change_project_compartment_request_response.go component_model.go create_model_details.go create_model_request_response.go create_processor_job_details.go create_processor_job_request_response.go create_project_details.go create_project_request_response.go data_science_labeling_dataset.go dataset.go dataset_summary.go delete_model_request_response.go delete_project_request_response.go detected_document_type.go detected_language.go dimensions.go document_classification_confidence_entry.go document_classification_feature.go document_classification_label_metrics_report.go document_classification_model_metrics.go document_classification_overall_metrics_report.go document_details.go document_feature.go document_field.go document_key_value_extraction_feature.go document_language_classification_feature.go document_metadata.go document_table_extraction_feature.go document_text_extraction_feature.go document_type.go field_label.go field_name.go field_value.go general_processor_config.go get_model_request_response.go get_processor_job_request_response.go get_project_request_response.go get_work_request_request_response.go inline_document_content.go inline_document_details.go input_location.go key_value_detection_confidence_entry.go key_value_detection_label_metrics_report.go key_value_detection_model_metrics.go key_value_detection_overall_metrics_report.go line.go list_models_request_response.go list_projects_request_response.go list_work_request_errors_request_response.go list_work_request_logs_request_response.go list_work_requests_request_response.go model.go model_collection.go model_metrics.go model_summary.go normalized_vertex.go object_location.go object_storage_dataset.go object_storage_document_details.go object_storage_locations.go operation_status.go operation_type.go output_location.go page.go patch_model_details.go patch_model_operation.go patch_model_request_response.go patch_response_message.go processing_error.go processor_config.go processor_job.go processor_type.go project.go project_collection.go project_summary.go sort_order.go table.go table_row.go update_model_details.go update_model_request_response.go update_project_details.go update_project_request_response.go value_array.go value_date.go value_integer.go value_number.go value_phone_number.go value_string.go value_time.go word.go work_request.go work_request_error.go work_request_error_collection.go work_request_log_entry.go work_request_log_entry_collection.go work_request_resource.go work_request_resource_metadata_key.go work_request_summary.go work_request_summary_collection.go

func GetActionTypeEnumStringValues

func GetActionTypeEnumStringValues() []string

GetActionTypeEnumStringValues Enumerates the set of values in String for ActionTypeEnum

func GetDatasetDatasetTypeEnumStringValues

func GetDatasetDatasetTypeEnumStringValues() []string

GetDatasetDatasetTypeEnumStringValues Enumerates the set of values in String for DatasetDatasetTypeEnum

func GetDimensionsUnitEnumStringValues

func GetDimensionsUnitEnumStringValues() []string

GetDimensionsUnitEnumStringValues Enumerates the set of values in String for DimensionsUnitEnum

func GetDocumentDetailsSourceEnumStringValues

func GetDocumentDetailsSourceEnumStringValues() []string

GetDocumentDetailsSourceEnumStringValues Enumerates the set of values in String for DocumentDetailsSourceEnum

func GetDocumentFeatureFeatureTypeEnumStringValues

func GetDocumentFeatureFeatureTypeEnumStringValues() []string

GetDocumentFeatureFeatureTypeEnumStringValues Enumerates the set of values in String for DocumentFeatureFeatureTypeEnum

func GetDocumentFieldFieldTypeEnumStringValues

func GetDocumentFieldFieldTypeEnumStringValues() []string

GetDocumentFieldFieldTypeEnumStringValues Enumerates the set of values in String for DocumentFieldFieldTypeEnum

func GetDocumentTypeEnumStringValues

func GetDocumentTypeEnumStringValues() []string

GetDocumentTypeEnumStringValues Enumerates the set of values in String for DocumentTypeEnum

func GetFieldValueValueTypeEnumStringValues

func GetFieldValueValueTypeEnumStringValues() []string

GetFieldValueValueTypeEnumStringValues Enumerates the set of values in String for FieldValueValueTypeEnum

func GetInputLocationSourceTypeEnumStringValues

func GetInputLocationSourceTypeEnumStringValues() []string

GetInputLocationSourceTypeEnumStringValues Enumerates the set of values in String for InputLocationSourceTypeEnum

func GetListModelsSortByEnumStringValues

func GetListModelsSortByEnumStringValues() []string

GetListModelsSortByEnumStringValues Enumerates the set of values in String for ListModelsSortByEnum

func GetListModelsSortOrderEnumStringValues

func GetListModelsSortOrderEnumStringValues() []string

GetListModelsSortOrderEnumStringValues Enumerates the set of values in String for ListModelsSortOrderEnum

func GetListProjectsSortByEnumStringValues

func GetListProjectsSortByEnumStringValues() []string

GetListProjectsSortByEnumStringValues Enumerates the set of values in String for ListProjectsSortByEnum

func GetListProjectsSortOrderEnumStringValues

func GetListProjectsSortOrderEnumStringValues() []string

GetListProjectsSortOrderEnumStringValues Enumerates the set of values in String for ListProjectsSortOrderEnum

func GetListWorkRequestErrorsSortByEnumStringValues

func GetListWorkRequestErrorsSortByEnumStringValues() []string

GetListWorkRequestErrorsSortByEnumStringValues Enumerates the set of values in String for ListWorkRequestErrorsSortByEnum

func GetListWorkRequestErrorsSortOrderEnumStringValues

func GetListWorkRequestErrorsSortOrderEnumStringValues() []string

GetListWorkRequestErrorsSortOrderEnumStringValues Enumerates the set of values in String for ListWorkRequestErrorsSortOrderEnum

func GetListWorkRequestLogsSortByEnumStringValues

func GetListWorkRequestLogsSortByEnumStringValues() []string

GetListWorkRequestLogsSortByEnumStringValues Enumerates the set of values in String for ListWorkRequestLogsSortByEnum

func GetListWorkRequestLogsSortOrderEnumStringValues

func GetListWorkRequestLogsSortOrderEnumStringValues() []string

GetListWorkRequestLogsSortOrderEnumStringValues Enumerates the set of values in String for ListWorkRequestLogsSortOrderEnum

func GetListWorkRequestsSortByEnumStringValues

func GetListWorkRequestsSortByEnumStringValues() []string

GetListWorkRequestsSortByEnumStringValues Enumerates the set of values in String for ListWorkRequestsSortByEnum

func GetListWorkRequestsSortOrderEnumStringValues

func GetListWorkRequestsSortOrderEnumStringValues() []string

GetListWorkRequestsSortOrderEnumStringValues Enumerates the set of values in String for ListWorkRequestsSortOrderEnum

func GetListWorkRequestsStatusEnumStringValues

func GetListWorkRequestsStatusEnumStringValues() []string

GetListWorkRequestsStatusEnumStringValues Enumerates the set of values in String for ListWorkRequestsStatusEnum

func GetModelLifecycleStateEnumStringValues

func GetModelLifecycleStateEnumStringValues() []string

GetModelLifecycleStateEnumStringValues Enumerates the set of values in String for ModelLifecycleStateEnum

func GetModelMetricsModelTypeEnumStringValues

func GetModelMetricsModelTypeEnumStringValues() []string

GetModelMetricsModelTypeEnumStringValues Enumerates the set of values in String for ModelMetricsModelTypeEnum

func GetModelModelTypeEnumStringValues

func GetModelModelTypeEnumStringValues() []string

GetModelModelTypeEnumStringValues Enumerates the set of values in String for ModelModelTypeEnum

func GetOperationStatusEnumStringValues

func GetOperationStatusEnumStringValues() []string

GetOperationStatusEnumStringValues Enumerates the set of values in String for OperationStatusEnum

func GetOperationTypeEnumStringValues

func GetOperationTypeEnumStringValues() []string

GetOperationTypeEnumStringValues Enumerates the set of values in String for OperationTypeEnum

func GetPatchModelOperationOperationEnumStringValues

func GetPatchModelOperationOperationEnumStringValues() []string

GetPatchModelOperationOperationEnumStringValues Enumerates the set of values in String for PatchModelOperationOperationEnum

func GetProcessorJobLifecycleDetailsEnumStringValues

func GetProcessorJobLifecycleDetailsEnumStringValues() []string

GetProcessorJobLifecycleDetailsEnumStringValues Enumerates the set of values in String for ProcessorJobLifecycleDetailsEnum

func GetProcessorJobLifecycleStateEnumStringValues

func GetProcessorJobLifecycleStateEnumStringValues() []string

GetProcessorJobLifecycleStateEnumStringValues Enumerates the set of values in String for ProcessorJobLifecycleStateEnum

func GetProcessorTypeEnumStringValues

func GetProcessorTypeEnumStringValues() []string

GetProcessorTypeEnumStringValues Enumerates the set of values in String for ProcessorTypeEnum

func GetProjectLifecycleStateEnumStringValues

func GetProjectLifecycleStateEnumStringValues() []string

GetProjectLifecycleStateEnumStringValues Enumerates the set of values in String for ProjectLifecycleStateEnum

func GetSortOrderEnumStringValues

func GetSortOrderEnumStringValues() []string

GetSortOrderEnumStringValues Enumerates the set of values in String for SortOrderEnum

func GetWorkRequestResourceMetadataKeyEnumStringValues

func GetWorkRequestResourceMetadataKeyEnumStringValues() []string

GetWorkRequestResourceMetadataKeyEnumStringValues Enumerates the set of values in String for WorkRequestResourceMetadataKeyEnum

type AIServiceDocumentClient

AIServiceDocumentClient a client for AIServiceDocument

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

func NewAIServiceDocumentClientWithConfigurationProvider

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

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

func NewAIServiceDocumentClientWithOboToken

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

NewAIServiceDocumentClientWithOboToken Creates a new default AIServiceDocument client with the given configuration provider. The obotoken will be added to default headers and signed; the configuration provider will be used for the signer

as well as reading the region

func (AIServiceDocumentClient) AnalyzeDocument

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

AnalyzeDocument Perform different types of document analysis.

# See also

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

func (AIServiceDocumentClient) CancelProcessorJob

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

CancelProcessorJob Cancel a processor job.

# See also

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

func (AIServiceDocumentClient) CancelWorkRequest

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

CancelWorkRequest Cancel the work request with the given ID.

# See also

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

func (AIServiceDocumentClient) ChangeModelCompartment

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

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

# See also

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

func (AIServiceDocumentClient) ChangeProjectCompartment

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

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

# See also

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

func (*AIServiceDocumentClient) ConfigurationProvider

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

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

func (AIServiceDocumentClient) CreateModel

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

CreateModel Create a new model.

# See also

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

func (AIServiceDocumentClient) CreateProcessorJob

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

CreateProcessorJob Create a processor job for document analysis.

# See also

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

func (AIServiceDocumentClient) CreateProject

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

CreateProject Create a new project.

# See also

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

func (AIServiceDocumentClient) DeleteModel

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

DeleteModel Delete a model by identifier.

# See also

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

func (AIServiceDocumentClient) DeleteProject

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

DeleteProject Delete a project by identifier.

# See also

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

func (AIServiceDocumentClient) GetModel

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

GetModel Get a model by identifier.

# See also

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

func (AIServiceDocumentClient) GetProcessorJob

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

GetProcessorJob Get the details of a processor job.

# See also

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

func (AIServiceDocumentClient) GetProject

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

GetProject Get a project by identifier.

# See also

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

func (AIServiceDocumentClient) GetWorkRequest

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

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

# See also

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

func (AIServiceDocumentClient) ListModels

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

ListModels Returns a list of models in a compartment.

# See also

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

func (AIServiceDocumentClient) ListProjects

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

ListProjects Returns a list of projects.

# See also

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

func (AIServiceDocumentClient) ListWorkRequestErrors

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

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

# See also

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

func (AIServiceDocumentClient) ListWorkRequestLogs

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

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

# See also

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

func (AIServiceDocumentClient) ListWorkRequests

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

ListWorkRequests Lists the work requests in a compartment.

# See also

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

func (AIServiceDocumentClient) PatchModel

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

PatchModel Updates the model metadata only selected path parameter.

# See also

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

func (*AIServiceDocumentClient) SetRegion

func (client *AIServiceDocumentClient) SetRegion(region string)

SetRegion overrides the region of this client.

func (AIServiceDocumentClient) UpdateModel

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

UpdateModel Updates the model metadata.

# See also

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

func (AIServiceDocumentClient) UpdateProject

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

UpdateProject Update the project metadata.

# See also

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

type ActionTypeEnum

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

func GetActionTypeEnumValues() []ActionTypeEnum

GetActionTypeEnumValues Enumerates the set of values for ActionTypeEnum

func GetMappingActionTypeEnum

func GetMappingActionTypeEnum(val string) (ActionTypeEnum, bool)

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

type AnalyzeDocumentDetails

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 (AnalyzeDocumentDetails) String

func (m AnalyzeDocumentDetails) String() string

func (*AnalyzeDocumentDetails) UnmarshalJSON

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

UnmarshalJSON unmarshals from json

func (AnalyzeDocumentDetails) ValidateEnumValue

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

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

type AnalyzeDocumentRequest

AnalyzeDocumentRequest wrapper for the AnalyzeDocument operation

# See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.62.0/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 (AnalyzeDocumentRequest) BinaryRequestBody

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

BinaryRequestBody implements the OCIRequest interface

func (AnalyzeDocumentRequest) HTTPRequest

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

HTTPRequest implements the OCIRequest interface

func (AnalyzeDocumentRequest) RetryPolicy

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

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

func (AnalyzeDocumentRequest) String

func (request AnalyzeDocumentRequest) String() string

func (AnalyzeDocumentRequest) ValidateEnumValue

func (request AnalyzeDocumentRequest) ValidateEnumValue() (bool, error)

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

type AnalyzeDocumentResponse

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 (AnalyzeDocumentResponse) HTTPResponse

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

HTTPResponse implements the OCIResponse interface

func (AnalyzeDocumentResponse) String

func (response AnalyzeDocumentResponse) String() string

type AnalyzeDocumentResult

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 (AnalyzeDocumentResult) String

func (m AnalyzeDocumentResult) String() string

func (AnalyzeDocumentResult) ValidateEnumValue

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

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

type BoundingPolygon

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 (BoundingPolygon) String

func (m BoundingPolygon) String() string

func (BoundingPolygon) ValidateEnumValue

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

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

type CancelProcessorJobRequest

CancelProcessorJobRequest wrapper for the CancelProcessorJob operation

# See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.62.0/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 (CancelProcessorJobRequest) BinaryRequestBody

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

BinaryRequestBody implements the OCIRequest interface

func (CancelProcessorJobRequest) HTTPRequest

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

HTTPRequest implements the OCIRequest interface

func (CancelProcessorJobRequest) RetryPolicy

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

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

func (CancelProcessorJobRequest) String

func (request CancelProcessorJobRequest) String() string

func (CancelProcessorJobRequest) ValidateEnumValue

func (request CancelProcessorJobRequest) ValidateEnumValue() (bool, error)

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

type CancelProcessorJobResponse

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 (CancelProcessorJobResponse) HTTPResponse

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

HTTPResponse implements the OCIResponse interface

func (CancelProcessorJobResponse) String

func (response CancelProcessorJobResponse) String() string

type CancelWorkRequestRequest

CancelWorkRequestRequest wrapper for the CancelWorkRequest operation

# See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.62.0/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 (CancelWorkRequestRequest) BinaryRequestBody

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

BinaryRequestBody implements the OCIRequest interface

func (CancelWorkRequestRequest) HTTPRequest

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

HTTPRequest implements the OCIRequest interface

func (CancelWorkRequestRequest) RetryPolicy

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

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

func (CancelWorkRequestRequest) String

func (request CancelWorkRequestRequest) String() string

func (CancelWorkRequestRequest) ValidateEnumValue

func (request CancelWorkRequestRequest) ValidateEnumValue() (bool, error)

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

type CancelWorkRequestResponse

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 (CancelWorkRequestResponse) HTTPResponse

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

HTTPResponse implements the OCIResponse interface

func (CancelWorkRequestResponse) String

func (response CancelWorkRequestResponse) String() string

type Cell

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 (Cell) String

func (m Cell) String() string

func (Cell) ValidateEnumValue

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

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

type ChangeModelCompartmentDetails

ChangeModelCompartmentDetails The compartment the model should be moved to.

type ChangeModelCompartmentDetails struct {

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

func (ChangeModelCompartmentDetails) String

func (m ChangeModelCompartmentDetails) String() string

func (ChangeModelCompartmentDetails) ValidateEnumValue

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

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

type ChangeModelCompartmentRequest

ChangeModelCompartmentRequest wrapper for the ChangeModelCompartment operation

# See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.62.0/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"`

    // 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 (ChangeModelCompartmentRequest) BinaryRequestBody

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

BinaryRequestBody implements the OCIRequest interface

func (ChangeModelCompartmentRequest) HTTPRequest

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

HTTPRequest implements the OCIRequest interface

func (ChangeModelCompartmentRequest) RetryPolicy

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

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

func (ChangeModelCompartmentRequest) String

func (request ChangeModelCompartmentRequest) String() string

func (ChangeModelCompartmentRequest) ValidateEnumValue

func (request ChangeModelCompartmentRequest) ValidateEnumValue() (bool, error)

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

type ChangeModelCompartmentResponse

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 (ChangeModelCompartmentResponse) HTTPResponse

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

HTTPResponse implements the OCIResponse interface

func (ChangeModelCompartmentResponse) String

func (response ChangeModelCompartmentResponse) String() string

type ChangeProjectCompartmentDetails

ChangeProjectCompartmentDetails Which compartment the project should be moved to.

type ChangeProjectCompartmentDetails struct {

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

func (ChangeProjectCompartmentDetails) String

func (m ChangeProjectCompartmentDetails) String() string

func (ChangeProjectCompartmentDetails) ValidateEnumValue

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

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

type ChangeProjectCompartmentRequest

ChangeProjectCompartmentRequest wrapper for the ChangeProjectCompartment operation

# See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.62.0/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"`

    // 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 (ChangeProjectCompartmentRequest) BinaryRequestBody

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

BinaryRequestBody implements the OCIRequest interface

func (ChangeProjectCompartmentRequest) HTTPRequest

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

HTTPRequest implements the OCIRequest interface

func (ChangeProjectCompartmentRequest) RetryPolicy

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

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

func (ChangeProjectCompartmentRequest) String

func (request ChangeProjectCompartmentRequest) String() string

func (ChangeProjectCompartmentRequest) ValidateEnumValue

func (request ChangeProjectCompartmentRequest) ValidateEnumValue() (bool, error)

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

type ChangeProjectCompartmentResponse

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 (ChangeProjectCompartmentResponse) HTTPResponse

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

HTTPResponse implements the OCIResponse interface

func (ChangeProjectCompartmentResponse) String

func (response ChangeProjectCompartmentResponse) String() string

type ComponentModel

ComponentModel The custom model selected for Composition.

type ComponentModel struct {

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

func (ComponentModel) String

func (m ComponentModel) String() string

func (ComponentModel) ValidateEnumValue

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

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

type CreateModelDetails

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.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the project that contains the model.
    ProjectId *string `mandatory:"true" json:"projectId"`

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

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

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

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

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

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

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

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

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

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

    // A simple key-value pair that is applied without any predefined name, type, or scope. It exists for cross-compatibility only.
    // For example: `{"bar-key": "value"}`
    FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`

    // Defined tags for this resource. Each key is predefined and scoped to a namespace.
    // For example: `{"foo-namespace": {"bar-key": "value"}}`
    DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
}

func (CreateModelDetails) String

func (m CreateModelDetails) String() string

func (*CreateModelDetails) UnmarshalJSON

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

UnmarshalJSON unmarshals from json

func (CreateModelDetails) ValidateEnumValue

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

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

type CreateModelRequest

CreateModelRequest wrapper for the CreateModel operation

# See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.62.0/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 (CreateModelRequest) BinaryRequestBody

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

BinaryRequestBody implements the OCIRequest interface

func (CreateModelRequest) HTTPRequest

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

HTTPRequest implements the OCIRequest interface

func (CreateModelRequest) RetryPolicy

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

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

func (CreateModelRequest) String

func (request CreateModelRequest) String() string

func (CreateModelRequest) ValidateEnumValue

func (request CreateModelRequest) ValidateEnumValue() (bool, error)

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

type CreateModelResponse

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 (CreateModelResponse) HTTPResponse

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

HTTPResponse implements the OCIResponse interface

func (CreateModelResponse) String

func (response CreateModelResponse) String() string

type CreateProcessorJobDetails

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 (CreateProcessorJobDetails) String

func (m CreateProcessorJobDetails) String() string

func (*CreateProcessorJobDetails) UnmarshalJSON

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

UnmarshalJSON unmarshals from json

func (CreateProcessorJobDetails) ValidateEnumValue

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

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

type CreateProcessorJobRequest

CreateProcessorJobRequest wrapper for the CreateProcessorJob operation

# See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.62.0/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 (CreateProcessorJobRequest) BinaryRequestBody

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

BinaryRequestBody implements the OCIRequest interface

func (CreateProcessorJobRequest) HTTPRequest

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

HTTPRequest implements the OCIRequest interface

func (CreateProcessorJobRequest) RetryPolicy

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

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

func (CreateProcessorJobRequest) String

func (request CreateProcessorJobRequest) String() string

func (CreateProcessorJobRequest) ValidateEnumValue

func (request CreateProcessorJobRequest) ValidateEnumValue() (bool, error)

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

type CreateProcessorJobResponse

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 (CreateProcessorJobResponse) HTTPResponse

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

HTTPResponse implements the OCIResponse interface

func (CreateProcessorJobResponse) String

func (response CreateProcessorJobResponse) String() string

type CreateProjectDetails

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 (CreateProjectDetails) String

func (m CreateProjectDetails) String() string

func (CreateProjectDetails) ValidateEnumValue

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

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

type CreateProjectRequest

CreateProjectRequest wrapper for the CreateProject operation

# See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.62.0/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 (CreateProjectRequest) BinaryRequestBody

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

BinaryRequestBody implements the OCIRequest interface

func (CreateProjectRequest) HTTPRequest

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

HTTPRequest implements the OCIRequest interface

func (CreateProjectRequest) RetryPolicy

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

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

func (CreateProjectRequest) String

func (request CreateProjectRequest) String() string

func (CreateProjectRequest) ValidateEnumValue

func (request CreateProjectRequest) ValidateEnumValue() (bool, error)

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

type CreateProjectResponse

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 (CreateProjectResponse) HTTPResponse

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

HTTPResponse implements the OCIResponse interface

func (CreateProjectResponse) String

func (response CreateProjectResponse) String() string

type DataScienceLabelingDataset

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 (DataScienceLabelingDataset) MarshalJSON

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

MarshalJSON marshals to json representation

func (DataScienceLabelingDataset) String

func (m DataScienceLabelingDataset) String() string

func (DataScienceLabelingDataset) ValidateEnumValue

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

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

type Dataset

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

type Dataset interface {
}

type DatasetDatasetTypeEnum

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

func GetDatasetDatasetTypeEnumValues() []DatasetDatasetTypeEnum

GetDatasetDatasetTypeEnumValues Enumerates the set of values for DatasetDatasetTypeEnum

func GetMappingDatasetDatasetTypeEnum

func GetMappingDatasetDatasetTypeEnum(val string) (DatasetDatasetTypeEnum, bool)

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

type DatasetSummary

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 (DatasetSummary) String

func (m DatasetSummary) String() string

func (DatasetSummary) ValidateEnumValue

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

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

type DeleteModelRequest

DeleteModelRequest wrapper for the DeleteModel operation

# See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.62.0/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"`

    // 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 (DeleteModelRequest) BinaryRequestBody

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

BinaryRequestBody implements the OCIRequest interface

func (DeleteModelRequest) HTTPRequest

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

HTTPRequest implements the OCIRequest interface

func (DeleteModelRequest) RetryPolicy

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

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

func (DeleteModelRequest) String

func (request DeleteModelRequest) String() string

func (DeleteModelRequest) ValidateEnumValue

func (request DeleteModelRequest) ValidateEnumValue() (bool, error)

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

type DeleteModelResponse

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 (DeleteModelResponse) HTTPResponse

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

HTTPResponse implements the OCIResponse interface

func (DeleteModelResponse) String

func (response DeleteModelResponse) String() string

type DeleteProjectRequest

DeleteProjectRequest wrapper for the DeleteProject operation

# See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.62.0/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"`

    // 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 (DeleteProjectRequest) BinaryRequestBody

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

BinaryRequestBody implements the OCIRequest interface

func (DeleteProjectRequest) HTTPRequest

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

HTTPRequest implements the OCIRequest interface

func (DeleteProjectRequest) RetryPolicy

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

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

func (DeleteProjectRequest) String

func (request DeleteProjectRequest) String() string

func (DeleteProjectRequest) ValidateEnumValue

func (request DeleteProjectRequest) ValidateEnumValue() (bool, error)

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

type DeleteProjectResponse

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 (DeleteProjectResponse) HTTPResponse

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

HTTPResponse implements the OCIResponse interface

func (DeleteProjectResponse) String

func (response DeleteProjectResponse) String() string

type DetectedDocumentType

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

    // The OCID (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Key-Value Extraction model that was used to extract the key-value pairs.
    DocumentId *string `mandatory:"false" json:"documentId"`
}

func (DetectedDocumentType) String

func (m DetectedDocumentType) String() string

func (DetectedDocumentType) ValidateEnumValue

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

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

type DetectedLanguage

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 (DetectedLanguage) String

func (m DetectedLanguage) String() string

func (DetectedLanguage) ValidateEnumValue

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

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

type Dimensions

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 (Dimensions) String

func (m Dimensions) String() string

func (Dimensions) ValidateEnumValue

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

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

type DimensionsUnitEnum

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

func GetDimensionsUnitEnumValues() []DimensionsUnitEnum

GetDimensionsUnitEnumValues Enumerates the set of values for DimensionsUnitEnum

func GetMappingDimensionsUnitEnum

func GetMappingDimensionsUnitEnum(val string) (DimensionsUnitEnum, bool)

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

type DocumentClassificationConfidenceEntry

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 (DocumentClassificationConfidenceEntry) String

func (m DocumentClassificationConfidenceEntry) String() string

func (DocumentClassificationConfidenceEntry) ValidateEnumValue

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

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

type DocumentClassificationFeature

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

    // The custom model tenancy ID when modelId represents aliasName.
    TenancyId *string `mandatory:"false" json:"tenancyId"`
}

func (DocumentClassificationFeature) MarshalJSON

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

MarshalJSON marshals to json representation

func (DocumentClassificationFeature) String

func (m DocumentClassificationFeature) String() string

func (DocumentClassificationFeature) ValidateEnumValue

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

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

type DocumentClassificationLabelMetricsReport

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 (DocumentClassificationLabelMetricsReport) String

func (m DocumentClassificationLabelMetricsReport) String() string

func (DocumentClassificationLabelMetricsReport) ValidateEnumValue

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

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

type DocumentClassificationModelMetrics

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 (DocumentClassificationModelMetrics) GetDatasetSummary

func (m DocumentClassificationModelMetrics) GetDatasetSummary() *DatasetSummary

GetDatasetSummary returns DatasetSummary

func (DocumentClassificationModelMetrics) MarshalJSON

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

MarshalJSON marshals to json representation

func (DocumentClassificationModelMetrics) String

func (m DocumentClassificationModelMetrics) String() string

func (DocumentClassificationModelMetrics) ValidateEnumValue

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

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

type DocumentClassificationOverallMetricsReport

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 (DocumentClassificationOverallMetricsReport) String

func (m DocumentClassificationOverallMetricsReport) String() string

func (DocumentClassificationOverallMetricsReport) ValidateEnumValue

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

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

type DocumentDetails

DocumentDetails The details of a document to analyze.

type DocumentDetails interface {
}

type DocumentDetailsSourceEnum

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

func GetDocumentDetailsSourceEnumValues() []DocumentDetailsSourceEnum

GetDocumentDetailsSourceEnumValues Enumerates the set of values for DocumentDetailsSourceEnum

func GetMappingDocumentDetailsSourceEnum

func GetMappingDocumentDetailsSourceEnum(val string) (DocumentDetailsSourceEnum, bool)

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

type DocumentFeature

DocumentFeature The type of document analysis.

type DocumentFeature interface {
}

type DocumentFeatureFeatureTypeEnum

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

func GetDocumentFeatureFeatureTypeEnumValues() []DocumentFeatureFeatureTypeEnum

GetDocumentFeatureFeatureTypeEnumValues Enumerates the set of values for DocumentFeatureFeatureTypeEnum

func GetMappingDocumentFeatureFeatureTypeEnum

func GetMappingDocumentFeatureFeatureTypeEnum(val string) (DocumentFeatureFeatureTypeEnum, bool)

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

type DocumentField

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 (DocumentField) String

func (m DocumentField) String() string

func (*DocumentField) UnmarshalJSON

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

UnmarshalJSON unmarshals from json

func (DocumentField) ValidateEnumValue

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

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

type DocumentFieldFieldTypeEnum

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

func GetDocumentFieldFieldTypeEnumValues() []DocumentFieldFieldTypeEnum

GetDocumentFieldFieldTypeEnumValues Enumerates the set of values for DocumentFieldFieldTypeEnum

func GetMappingDocumentFieldFieldTypeEnum

func GetMappingDocumentFieldFieldTypeEnum(val string) (DocumentFieldFieldTypeEnum, bool)

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

type DocumentKeyValueExtractionFeature

DocumentKeyValueExtractionFeature Extracting form fields.

type DocumentKeyValueExtractionFeature struct {

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

    // The custom model tenancy ID when modelId represents aliasName.
    TenancyId *string `mandatory:"false" json:"tenancyId"`
}

func (DocumentKeyValueExtractionFeature) MarshalJSON

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

MarshalJSON marshals to json representation

func (DocumentKeyValueExtractionFeature) String

func (m DocumentKeyValueExtractionFeature) String() string

func (DocumentKeyValueExtractionFeature) ValidateEnumValue

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

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

type DocumentLanguageClassificationFeature

DocumentLanguageClassificationFeature Detecting the language of the document.

type DocumentLanguageClassificationFeature struct {

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

func (DocumentLanguageClassificationFeature) MarshalJSON

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

MarshalJSON marshals to json representation

func (DocumentLanguageClassificationFeature) String

func (m DocumentLanguageClassificationFeature) String() string

func (DocumentLanguageClassificationFeature) ValidateEnumValue

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

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

type DocumentMetadata

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 (DocumentMetadata) String

func (m DocumentMetadata) String() string

func (DocumentMetadata) ValidateEnumValue

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

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

type DocumentTableExtractionFeature

DocumentTableExtractionFeature Detecting and extracting data in tables.

type DocumentTableExtractionFeature struct {
}

func (DocumentTableExtractionFeature) MarshalJSON

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

MarshalJSON marshals to json representation

func (DocumentTableExtractionFeature) String

func (m DocumentTableExtractionFeature) String() string

func (DocumentTableExtractionFeature) ValidateEnumValue

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

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

type DocumentTextExtractionFeature

DocumentTextExtractionFeature Text recognition

type DocumentTextExtractionFeature struct {

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

func (DocumentTextExtractionFeature) MarshalJSON

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

MarshalJSON marshals to json representation

func (DocumentTextExtractionFeature) String

func (m DocumentTextExtractionFeature) String() string

func (DocumentTextExtractionFeature) ValidateEnumValue

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

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

type DocumentTypeEnum

DocumentTypeEnum Enum with underlying type: string

type DocumentTypeEnum string

Set of constants representing the allowable values for DocumentTypeEnum

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

func GetDocumentTypeEnumValues

func GetDocumentTypeEnumValues() []DocumentTypeEnum

GetDocumentTypeEnumValues Enumerates the set of values for DocumentTypeEnum

func GetMappingDocumentTypeEnum

func GetMappingDocumentTypeEnum(val string) (DocumentTypeEnum, bool)

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

type FieldLabel

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 (FieldLabel) String

func (m FieldLabel) String() string

func (FieldLabel) ValidateEnumValue

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

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

type FieldName

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 (FieldName) String

func (m FieldName) String() string

func (FieldName) ValidateEnumValue

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

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

type FieldValue

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
}

type FieldValueValueTypeEnum

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

func GetFieldValueValueTypeEnumValues() []FieldValueValueTypeEnum

GetFieldValueValueTypeEnumValues Enumerates the set of values for FieldValueValueTypeEnum

func GetMappingFieldValueValueTypeEnum

func GetMappingFieldValueValueTypeEnum(val string) (FieldValueValueTypeEnum, bool)

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

type GeneralProcessorConfig

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 (GeneralProcessorConfig) MarshalJSON

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

MarshalJSON marshals to json representation

func (GeneralProcessorConfig) String

func (m GeneralProcessorConfig) String() string

func (*GeneralProcessorConfig) UnmarshalJSON

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

UnmarshalJSON unmarshals from json

func (GeneralProcessorConfig) ValidateEnumValue

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

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

type GetModelRequest

GetModelRequest wrapper for the GetModel operation

# See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.62.0/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 (GetModelRequest) BinaryRequestBody

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

BinaryRequestBody implements the OCIRequest interface

func (GetModelRequest) HTTPRequest

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

HTTPRequest implements the OCIRequest interface

func (GetModelRequest) RetryPolicy

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

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

func (GetModelRequest) String

func (request GetModelRequest) String() string

func (GetModelRequest) ValidateEnumValue

func (request GetModelRequest) ValidateEnumValue() (bool, error)

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

type GetModelResponse

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 (GetModelResponse) HTTPResponse

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

HTTPResponse implements the OCIResponse interface

func (GetModelResponse) String

func (response GetModelResponse) String() string

type GetProcessorJobRequest

GetProcessorJobRequest wrapper for the GetProcessorJob operation

# See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.62.0/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 (GetProcessorJobRequest) BinaryRequestBody

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

BinaryRequestBody implements the OCIRequest interface

func (GetProcessorJobRequest) HTTPRequest

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

HTTPRequest implements the OCIRequest interface

func (GetProcessorJobRequest) RetryPolicy

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

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

func (GetProcessorJobRequest) String

func (request GetProcessorJobRequest) String() string

func (GetProcessorJobRequest) ValidateEnumValue

func (request GetProcessorJobRequest) ValidateEnumValue() (bool, error)

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

type GetProcessorJobResponse

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 (GetProcessorJobResponse) HTTPResponse

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

HTTPResponse implements the OCIResponse interface

func (GetProcessorJobResponse) String

func (response GetProcessorJobResponse) String() string

type GetProjectRequest

GetProjectRequest wrapper for the GetProject operation

# See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.62.0/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 (GetProjectRequest) BinaryRequestBody

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

BinaryRequestBody implements the OCIRequest interface

func (GetProjectRequest) HTTPRequest

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

HTTPRequest implements the OCIRequest interface

func (GetProjectRequest) RetryPolicy

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

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

func (GetProjectRequest) String

func (request GetProjectRequest) String() string

func (GetProjectRequest) ValidateEnumValue

func (request GetProjectRequest) ValidateEnumValue() (bool, error)

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

type GetProjectResponse

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 (GetProjectResponse) HTTPResponse

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

HTTPResponse implements the OCIResponse interface

func (GetProjectResponse) String

func (response GetProjectResponse) String() string

type GetWorkRequestRequest

GetWorkRequestRequest wrapper for the GetWorkRequest operation

# See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.62.0/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 (GetWorkRequestRequest) BinaryRequestBody

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

BinaryRequestBody implements the OCIRequest interface

func (GetWorkRequestRequest) HTTPRequest

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

HTTPRequest implements the OCIRequest interface

func (GetWorkRequestRequest) RetryPolicy

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

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

func (GetWorkRequestRequest) String

func (request GetWorkRequestRequest) String() string

func (GetWorkRequestRequest) ValidateEnumValue

func (request GetWorkRequestRequest) ValidateEnumValue() (bool, error)

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

type GetWorkRequestResponse

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 (GetWorkRequestResponse) HTTPResponse

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

HTTPResponse implements the OCIResponse interface

func (GetWorkRequestResponse) String

func (response GetWorkRequestResponse) String() string

type InlineDocumentContent

InlineDocumentContent The content of an inline document.

type InlineDocumentContent struct {

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

func (InlineDocumentContent) MarshalJSON

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

MarshalJSON marshals to json representation

func (InlineDocumentContent) String

func (m InlineDocumentContent) String() string

func (InlineDocumentContent) ValidateEnumValue

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

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

type InlineDocumentDetails

InlineDocumentDetails The document incorporated in the request payload.

type InlineDocumentDetails struct {

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

func (InlineDocumentDetails) MarshalJSON

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

MarshalJSON marshals to json representation

func (InlineDocumentDetails) String

func (m InlineDocumentDetails) String() string

func (InlineDocumentDetails) ValidateEnumValue

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

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

type InputLocation

InputLocation The location of the inputs.

type InputLocation interface {
}

type InputLocationSourceTypeEnum

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

func GetInputLocationSourceTypeEnumValues() []InputLocationSourceTypeEnum

GetInputLocationSourceTypeEnumValues Enumerates the set of values for InputLocationSourceTypeEnum

func GetMappingInputLocationSourceTypeEnum

func GetMappingInputLocationSourceTypeEnum(val string) (InputLocationSourceTypeEnum, bool)

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

type KeyValueDetectionConfidenceEntry

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 (KeyValueDetectionConfidenceEntry) String

func (m KeyValueDetectionConfidenceEntry) String() string

func (KeyValueDetectionConfidenceEntry) ValidateEnumValue

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

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

type KeyValueDetectionLabelMetricsReport

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 (KeyValueDetectionLabelMetricsReport) String

func (m KeyValueDetectionLabelMetricsReport) String() string

func (KeyValueDetectionLabelMetricsReport) ValidateEnumValue

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

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

type KeyValueDetectionModelMetrics

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 (KeyValueDetectionModelMetrics) GetDatasetSummary

func (m KeyValueDetectionModelMetrics) GetDatasetSummary() *DatasetSummary

GetDatasetSummary returns DatasetSummary

func (KeyValueDetectionModelMetrics) MarshalJSON

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

MarshalJSON marshals to json representation

func (KeyValueDetectionModelMetrics) String

func (m KeyValueDetectionModelMetrics) String() string

func (KeyValueDetectionModelMetrics) ValidateEnumValue

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

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

type KeyValueDetectionOverallMetricsReport

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 (KeyValueDetectionOverallMetricsReport) String

func (m KeyValueDetectionOverallMetricsReport) String() string

func (KeyValueDetectionOverallMetricsReport) ValidateEnumValue

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

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

type Line

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 (Line) String

func (m Line) String() string

func (Line) ValidateEnumValue

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

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

type ListModelsRequest

ListModelsRequest wrapper for the ListModels operation

# See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.62.0/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 (ListModelsRequest) BinaryRequestBody

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

BinaryRequestBody implements the OCIRequest interface

func (ListModelsRequest) HTTPRequest

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

HTTPRequest implements the OCIRequest interface

func (ListModelsRequest) RetryPolicy

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

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

func (ListModelsRequest) String

func (request ListModelsRequest) String() string

func (ListModelsRequest) ValidateEnumValue

func (request ListModelsRequest) ValidateEnumValue() (bool, error)

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

type ListModelsResponse

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 (ListModelsResponse) HTTPResponse

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

HTTPResponse implements the OCIResponse interface

func (ListModelsResponse) String

func (response ListModelsResponse) String() string

type ListModelsSortByEnum

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

func GetListModelsSortByEnumValues() []ListModelsSortByEnum

GetListModelsSortByEnumValues Enumerates the set of values for ListModelsSortByEnum

func GetMappingListModelsSortByEnum

func GetMappingListModelsSortByEnum(val string) (ListModelsSortByEnum, bool)

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

type ListModelsSortOrderEnum

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

func GetListModelsSortOrderEnumValues() []ListModelsSortOrderEnum

GetListModelsSortOrderEnumValues Enumerates the set of values for ListModelsSortOrderEnum

func GetMappingListModelsSortOrderEnum

func GetMappingListModelsSortOrderEnum(val string) (ListModelsSortOrderEnum, bool)

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

type ListProjectsRequest

ListProjectsRequest wrapper for the ListProjects operation

# See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.62.0/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 (ListProjectsRequest) BinaryRequestBody

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

BinaryRequestBody implements the OCIRequest interface

func (ListProjectsRequest) HTTPRequest

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

HTTPRequest implements the OCIRequest interface

func (ListProjectsRequest) RetryPolicy

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

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

func (ListProjectsRequest) String

func (request ListProjectsRequest) String() string

func (ListProjectsRequest) ValidateEnumValue

func (request ListProjectsRequest) ValidateEnumValue() (bool, error)

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

type ListProjectsResponse

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 (ListProjectsResponse) HTTPResponse

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

HTTPResponse implements the OCIResponse interface

func (ListProjectsResponse) String

func (response ListProjectsResponse) String() string

type ListProjectsSortByEnum

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

func GetListProjectsSortByEnumValues() []ListProjectsSortByEnum

GetListProjectsSortByEnumValues Enumerates the set of values for ListProjectsSortByEnum

func GetMappingListProjectsSortByEnum

func GetMappingListProjectsSortByEnum(val string) (ListProjectsSortByEnum, bool)

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

type ListProjectsSortOrderEnum

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

func GetListProjectsSortOrderEnumValues() []ListProjectsSortOrderEnum

GetListProjectsSortOrderEnumValues Enumerates the set of values for ListProjectsSortOrderEnum

func GetMappingListProjectsSortOrderEnum

func GetMappingListProjectsSortOrderEnum(val string) (ListProjectsSortOrderEnum, bool)

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

type ListWorkRequestErrorsRequest

ListWorkRequestErrorsRequest wrapper for the ListWorkRequestErrors operation

# See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.62.0/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 (ListWorkRequestErrorsRequest) BinaryRequestBody

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

BinaryRequestBody implements the OCIRequest interface

func (ListWorkRequestErrorsRequest) HTTPRequest

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

HTTPRequest implements the OCIRequest interface

func (ListWorkRequestErrorsRequest) RetryPolicy

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

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

func (ListWorkRequestErrorsRequest) String

func (request ListWorkRequestErrorsRequest) String() string

func (ListWorkRequestErrorsRequest) ValidateEnumValue

func (request ListWorkRequestErrorsRequest) ValidateEnumValue() (bool, error)

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

type ListWorkRequestErrorsResponse

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 (ListWorkRequestErrorsResponse) HTTPResponse

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

HTTPResponse implements the OCIResponse interface

func (ListWorkRequestErrorsResponse) String

func (response ListWorkRequestErrorsResponse) String() string

type ListWorkRequestErrorsSortByEnum

ListWorkRequestErrorsSortByEnum Enum with underlying type: string

type ListWorkRequestErrorsSortByEnum string

Set of constants representing the allowable values for ListWorkRequestErrorsSortByEnum

const (
    ListWorkRequestErrorsSortByTimeaccepted ListWorkRequestErrorsSortByEnum = "timeAccepted"
)

func GetListWorkRequestErrorsSortByEnumValues

func GetListWorkRequestErrorsSortByEnumValues() []ListWorkRequestErrorsSortByEnum

GetListWorkRequestErrorsSortByEnumValues Enumerates the set of values for ListWorkRequestErrorsSortByEnum

func GetMappingListWorkRequestErrorsSortByEnum

func GetMappingListWorkRequestErrorsSortByEnum(val string) (ListWorkRequestErrorsSortByEnum, bool)

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

type ListWorkRequestErrorsSortOrderEnum

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

func GetListWorkRequestErrorsSortOrderEnumValues() []ListWorkRequestErrorsSortOrderEnum

GetListWorkRequestErrorsSortOrderEnumValues Enumerates the set of values for ListWorkRequestErrorsSortOrderEnum

func GetMappingListWorkRequestErrorsSortOrderEnum

func GetMappingListWorkRequestErrorsSortOrderEnum(val string) (ListWorkRequestErrorsSortOrderEnum, bool)

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

type ListWorkRequestLogsRequest

ListWorkRequestLogsRequest wrapper for the ListWorkRequestLogs operation

# See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.62.0/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 (ListWorkRequestLogsRequest) BinaryRequestBody

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

BinaryRequestBody implements the OCIRequest interface

func (ListWorkRequestLogsRequest) HTTPRequest

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

HTTPRequest implements the OCIRequest interface

func (ListWorkRequestLogsRequest) RetryPolicy

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

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

func (ListWorkRequestLogsRequest) String

func (request ListWorkRequestLogsRequest) String() string

func (ListWorkRequestLogsRequest) ValidateEnumValue

func (request ListWorkRequestLogsRequest) ValidateEnumValue() (bool, error)

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

type ListWorkRequestLogsResponse

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 (ListWorkRequestLogsResponse) HTTPResponse

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

HTTPResponse implements the OCIResponse interface

func (ListWorkRequestLogsResponse) String

func (response ListWorkRequestLogsResponse) String() string

type ListWorkRequestLogsSortByEnum

ListWorkRequestLogsSortByEnum Enum with underlying type: string

type ListWorkRequestLogsSortByEnum string

Set of constants representing the allowable values for ListWorkRequestLogsSortByEnum

const (
    ListWorkRequestLogsSortByTimeaccepted ListWorkRequestLogsSortByEnum = "timeAccepted"
)

func GetListWorkRequestLogsSortByEnumValues

func GetListWorkRequestLogsSortByEnumValues() []ListWorkRequestLogsSortByEnum

GetListWorkRequestLogsSortByEnumValues Enumerates the set of values for ListWorkRequestLogsSortByEnum

func GetMappingListWorkRequestLogsSortByEnum

func GetMappingListWorkRequestLogsSortByEnum(val string) (ListWorkRequestLogsSortByEnum, bool)

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

type ListWorkRequestLogsSortOrderEnum

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

func GetListWorkRequestLogsSortOrderEnumValues() []ListWorkRequestLogsSortOrderEnum

GetListWorkRequestLogsSortOrderEnumValues Enumerates the set of values for ListWorkRequestLogsSortOrderEnum

func GetMappingListWorkRequestLogsSortOrderEnum

func GetMappingListWorkRequestLogsSortOrderEnum(val string) (ListWorkRequestLogsSortOrderEnum, bool)

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

type ListWorkRequestsRequest

ListWorkRequestsRequest wrapper for the ListWorkRequests operation

# See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.62.0/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 (ListWorkRequestsRequest) BinaryRequestBody

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

BinaryRequestBody implements the OCIRequest interface

func (ListWorkRequestsRequest) HTTPRequest

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

HTTPRequest implements the OCIRequest interface

func (ListWorkRequestsRequest) RetryPolicy

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

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

func (ListWorkRequestsRequest) String

func (request ListWorkRequestsRequest) String() string

func (ListWorkRequestsRequest) ValidateEnumValue

func (request ListWorkRequestsRequest) ValidateEnumValue() (bool, error)

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

type ListWorkRequestsResponse

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 (ListWorkRequestsResponse) HTTPResponse

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

HTTPResponse implements the OCIResponse interface

func (ListWorkRequestsResponse) String

func (response ListWorkRequestsResponse) String() string

type ListWorkRequestsSortByEnum

ListWorkRequestsSortByEnum Enum with underlying type: string

type ListWorkRequestsSortByEnum string

Set of constants representing the allowable values for ListWorkRequestsSortByEnum

const (
    ListWorkRequestsSortByTimeaccepted ListWorkRequestsSortByEnum = "timeAccepted"
)

func GetListWorkRequestsSortByEnumValues

func GetListWorkRequestsSortByEnumValues() []ListWorkRequestsSortByEnum

GetListWorkRequestsSortByEnumValues Enumerates the set of values for ListWorkRequestsSortByEnum

func GetMappingListWorkRequestsSortByEnum

func GetMappingListWorkRequestsSortByEnum(val string) (ListWorkRequestsSortByEnum, bool)

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

type ListWorkRequestsSortOrderEnum

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

func GetListWorkRequestsSortOrderEnumValues() []ListWorkRequestsSortOrderEnum

GetListWorkRequestsSortOrderEnumValues Enumerates the set of values for ListWorkRequestsSortOrderEnum

func GetMappingListWorkRequestsSortOrderEnum

func GetMappingListWorkRequestsSortOrderEnum(val string) (ListWorkRequestsSortOrderEnum, bool)

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

type ListWorkRequestsStatusEnum

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

func GetListWorkRequestsStatusEnumValues() []ListWorkRequestsStatusEnum

GetListWorkRequestsStatusEnumValues Enumerates the set of values for ListWorkRequestsStatusEnum

func GetMappingListWorkRequestsStatusEnum

func GetMappingListWorkRequestsStatusEnum(val string) (ListWorkRequestsStatusEnum, bool)

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

type Model

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.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the project that contains the model.
    ProjectId *string `mandatory:"true" json:"projectId"`

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

    // A simple key-value pair that is applied without any predefined name, type, or scope. It exists for cross-compatibility only.
    // For example: `{"bar-key": "value"}`
    FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`

    // Defined tags for this resource. Each key is predefined and scoped to a namespace.
    // For example: `{"foo-namespace": {"bar-key": "value"}}`
    DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`

    // Usage of system tag keys. These predefined keys are scoped to namespaces.
    // For example: `{"orcl-cloud": {"free-tier-retained": "true"}}`
    SystemTags map[string]map[string]interface{} `mandatory:"false" json:"systemTags"`
}

func (Model) String

func (m Model) String() string

func (*Model) UnmarshalJSON

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

UnmarshalJSON unmarshals from json

func (Model) ValidateEnumValue

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

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

type ModelCollection

ModelCollection The results of a model search.

type ModelCollection struct {

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

func (ModelCollection) String

func (m ModelCollection) String() string

func (ModelCollection) ValidateEnumValue

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

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

type ModelLifecycleStateEnum

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

func GetMappingModelLifecycleStateEnum(val string) (ModelLifecycleStateEnum, bool)

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

func GetModelLifecycleStateEnumValues

func GetModelLifecycleStateEnumValues() []ModelLifecycleStateEnum

GetModelLifecycleStateEnumValues Enumerates the set of values for ModelLifecycleStateEnum

type ModelMetrics

ModelMetrics Trained Model Metrics.

type ModelMetrics interface {
    GetDatasetSummary() *DatasetSummary
}

type ModelMetricsModelTypeEnum

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

func GetMappingModelMetricsModelTypeEnum(val string) (ModelMetricsModelTypeEnum, bool)

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

func GetModelMetricsModelTypeEnumValues

func GetModelMetricsModelTypeEnumValues() []ModelMetricsModelTypeEnum

GetModelMetricsModelTypeEnumValues Enumerates the set of values for ModelMetricsModelTypeEnum

type ModelModelTypeEnum

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

func GetMappingModelModelTypeEnum(val string) (ModelModelTypeEnum, bool)

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

func GetModelModelTypeEnumValues

func GetModelModelTypeEnumValues() []ModelModelTypeEnum

GetModelModelTypeEnumValues Enumerates the set of values for ModelModelTypeEnum

type ModelSummary

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.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the project that contains the model.
    ProjectId *string `mandatory:"true" json:"projectId"`

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

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

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

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

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

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

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

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

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

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

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

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

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

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

    // A simple key-value pair that is applied without any predefined name, type, or scope. It exists for cross-compatibility only.
    // For example: `{"bar-key": "value"}`
    FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`

    // Defined tags for this resource. Each key is predefined and scoped to a namespace.
    // For example: `{"foo-namespace": {"bar-key": "value"}}`
    DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`

    // Usage of system tag keys. These predefined keys are scoped to namespaces.
    // For example: `{"orcl-cloud": {"free-tier-retained": "true"}}`
    SystemTags map[string]map[string]interface{} `mandatory:"false" json:"systemTags"`
}

func (ModelSummary) String

func (m ModelSummary) String() string

func (*ModelSummary) UnmarshalJSON

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

UnmarshalJSON unmarshals from json

func (ModelSummary) ValidateEnumValue

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

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

type NormalizedVertex

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 (NormalizedVertex) String

func (m NormalizedVertex) String() string

func (NormalizedVertex) ValidateEnumValue

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

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

type ObjectLocation

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 (ObjectLocation) String

func (m ObjectLocation) String() string

func (ObjectLocation) ValidateEnumValue

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

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

type ObjectStorageDataset

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 (ObjectStorageDataset) MarshalJSON

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

MarshalJSON marshals to json representation

func (ObjectStorageDataset) String

func (m ObjectStorageDataset) String() string

func (ObjectStorageDataset) ValidateEnumValue

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

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

type ObjectStorageDocumentDetails

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 (ObjectStorageDocumentDetails) MarshalJSON

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

MarshalJSON marshals to json representation

func (ObjectStorageDocumentDetails) String

func (m ObjectStorageDocumentDetails) String() string

func (ObjectStorageDocumentDetails) ValidateEnumValue

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

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

type ObjectStorageLocations

ObjectStorageLocations A list of object locations in Object Storage.

type ObjectStorageLocations struct {

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

func (ObjectStorageLocations) MarshalJSON

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

MarshalJSON marshals to json representation

func (ObjectStorageLocations) String

func (m ObjectStorageLocations) String() string

func (ObjectStorageLocations) ValidateEnumValue

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

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

type OperationStatusEnum

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

func GetMappingOperationStatusEnum(val string) (OperationStatusEnum, bool)

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

func GetOperationStatusEnumValues

func GetOperationStatusEnumValues() []OperationStatusEnum

GetOperationStatusEnumValues Enumerates the set of values for OperationStatusEnum

type OperationTypeEnum

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

func GetMappingOperationTypeEnum(val string) (OperationTypeEnum, bool)

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

func GetOperationTypeEnumValues

func GetOperationTypeEnumValues() []OperationTypeEnum

GetOperationTypeEnumValues Enumerates the set of values for OperationTypeEnum

type OutputLocation

OutputLocation The object storage location where to store analysis results.

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 (OutputLocation) String

func (m OutputLocation) String() string

func (OutputLocation) ValidateEnumValue

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

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

type Page

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 (Page) String

func (m Page) String() string

func (Page) ValidateEnumValue

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

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

type PatchModelDetails

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 (PatchModelDetails) String

func (m PatchModelDetails) String() string

func (PatchModelDetails) ValidateEnumValue

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

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

type PatchModelOperation

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 (PatchModelOperation) String

func (m PatchModelOperation) String() string

func (PatchModelOperation) ValidateEnumValue

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

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

type PatchModelOperationOperationEnum

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

func GetMappingPatchModelOperationOperationEnum(val string) (PatchModelOperationOperationEnum, bool)

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

func GetPatchModelOperationOperationEnumValues

func GetPatchModelOperationOperationEnumValues() []PatchModelOperationOperationEnum

GetPatchModelOperationOperationEnumValues Enumerates the set of values for PatchModelOperationOperationEnum

type PatchModelRequest

PatchModelRequest wrapper for the PatchModel operation

# See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.62.0/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 (PatchModelRequest) BinaryRequestBody

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

BinaryRequestBody implements the OCIRequest interface

func (PatchModelRequest) HTTPRequest

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

HTTPRequest implements the OCIRequest interface

func (PatchModelRequest) RetryPolicy

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

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

func (PatchModelRequest) String

func (request PatchModelRequest) String() string

func (PatchModelRequest) ValidateEnumValue

func (request PatchModelRequest) ValidateEnumValue() (bool, error)

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

type PatchModelResponse

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 (PatchModelResponse) HTTPResponse

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

HTTPResponse implements the OCIResponse interface

func (PatchModelResponse) String

func (response PatchModelResponse) String() string

type PatchResponseMessage

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 (PatchResponseMessage) String

func (m PatchResponseMessage) String() string

func (PatchResponseMessage) ValidateEnumValue

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

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

type ProcessingError

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 (ProcessingError) String

func (m ProcessingError) String() string

func (ProcessingError) ValidateEnumValue

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

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

type ProcessorConfig

ProcessorConfig The configuration of a processor.

type ProcessorConfig interface {
}

type ProcessorJob

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 (ProcessorJob) String

func (m ProcessorJob) String() string

func (*ProcessorJob) UnmarshalJSON

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

UnmarshalJSON unmarshals from json

func (ProcessorJob) ValidateEnumValue

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

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

type ProcessorJobLifecycleDetailsEnum

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

func GetMappingProcessorJobLifecycleDetailsEnum(val string) (ProcessorJobLifecycleDetailsEnum, bool)

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

func GetProcessorJobLifecycleDetailsEnumValues

func GetProcessorJobLifecycleDetailsEnumValues() []ProcessorJobLifecycleDetailsEnum

GetProcessorJobLifecycleDetailsEnumValues Enumerates the set of values for ProcessorJobLifecycleDetailsEnum

type ProcessorJobLifecycleStateEnum

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

func GetMappingProcessorJobLifecycleStateEnum(val string) (ProcessorJobLifecycleStateEnum, bool)

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

func GetProcessorJobLifecycleStateEnumValues

func GetProcessorJobLifecycleStateEnumValues() []ProcessorJobLifecycleStateEnum

GetProcessorJobLifecycleStateEnumValues Enumerates the set of values for ProcessorJobLifecycleStateEnum

type ProcessorTypeEnum

ProcessorTypeEnum Enum with underlying type: string

type ProcessorTypeEnum string

Set of constants representing the allowable values for ProcessorTypeEnum

const (
    ProcessorTypeGeneral ProcessorTypeEnum = "GENERAL"
)

func GetMappingProcessorTypeEnum

func GetMappingProcessorTypeEnum(val string) (ProcessorTypeEnum, bool)

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

func GetProcessorTypeEnumValues

func GetProcessorTypeEnumValues() []ProcessorTypeEnum

GetProcessorTypeEnumValues Enumerates the set of values for ProcessorTypeEnum

type Project

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

func (Project) String

func (m Project) String() string

func (Project) ValidateEnumValue

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

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

type ProjectCollection

ProjectCollection The results of a project search.

type ProjectCollection struct {

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

func (ProjectCollection) String

func (m ProjectCollection) String() string

func (ProjectCollection) ValidateEnumValue

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

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

type ProjectLifecycleStateEnum

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

func GetMappingProjectLifecycleStateEnum(val string) (ProjectLifecycleStateEnum, bool)

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

func GetProjectLifecycleStateEnumValues

func GetProjectLifecycleStateEnumValues() []ProjectLifecycleStateEnum

GetProjectLifecycleStateEnumValues Enumerates the set of values for ProjectLifecycleStateEnum

type ProjectSummary

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 (ProjectSummary) String

func (m ProjectSummary) String() string

func (ProjectSummary) ValidateEnumValue

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

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

type SortOrderEnum

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

func GetMappingSortOrderEnum(val string) (SortOrderEnum, bool)

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

func GetSortOrderEnumValues

func GetSortOrderEnumValues() []SortOrderEnum

GetSortOrderEnumValues Enumerates the set of values for SortOrderEnum

type Table

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 (Table) String

func (m Table) String() string

func (Table) ValidateEnumValue

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

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

type TableRow

TableRow A single row in a table.

type TableRow struct {

    // The cells in the row.
    Cells []Cell `mandatory:"true" json:"cells"`
}

func (TableRow) String

func (m TableRow) String() string

func (TableRow) ValidateEnumValue

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

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

type UpdateModelDetails

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 (UpdateModelDetails) String

func (m UpdateModelDetails) String() string

func (UpdateModelDetails) ValidateEnumValue

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

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

type UpdateModelRequest

UpdateModelRequest wrapper for the UpdateModel operation

# See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.62.0/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"`

    // 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 (UpdateModelRequest) BinaryRequestBody

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

BinaryRequestBody implements the OCIRequest interface

func (UpdateModelRequest) HTTPRequest

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

HTTPRequest implements the OCIRequest interface

func (UpdateModelRequest) RetryPolicy

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

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

func (UpdateModelRequest) String

func (request UpdateModelRequest) String() string

func (UpdateModelRequest) ValidateEnumValue

func (request UpdateModelRequest) ValidateEnumValue() (bool, error)

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

type UpdateModelResponse

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 (UpdateModelResponse) HTTPResponse

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

HTTPResponse implements the OCIResponse interface

func (UpdateModelResponse) String

func (response UpdateModelResponse) String() string

type UpdateProjectDetails

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 (UpdateProjectDetails) String

func (m UpdateProjectDetails) String() string

func (UpdateProjectDetails) ValidateEnumValue

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

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

type UpdateProjectRequest

UpdateProjectRequest wrapper for the UpdateProject operation

# See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.62.0/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"`

    // 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 (UpdateProjectRequest) BinaryRequestBody

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

BinaryRequestBody implements the OCIRequest interface

func (UpdateProjectRequest) HTTPRequest

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

HTTPRequest implements the OCIRequest interface

func (UpdateProjectRequest) RetryPolicy

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

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

func (UpdateProjectRequest) String

func (request UpdateProjectRequest) String() string

func (UpdateProjectRequest) ValidateEnumValue

func (request UpdateProjectRequest) ValidateEnumValue() (bool, error)

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

type UpdateProjectResponse

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 (UpdateProjectResponse) HTTPResponse

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

HTTPResponse implements the OCIResponse interface

func (UpdateProjectResponse) String

func (response UpdateProjectResponse) String() string

type ValueArray

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 (ValueArray) GetBoundingPolygon

func (m ValueArray) GetBoundingPolygon() *BoundingPolygon

GetBoundingPolygon returns BoundingPolygon

func (ValueArray) GetConfidence

func (m ValueArray) GetConfidence() *float32

GetConfidence returns Confidence

func (ValueArray) GetText

func (m ValueArray) GetText() *string

GetText returns Text

func (ValueArray) GetWordIndexes

func (m ValueArray) GetWordIndexes() []int

GetWordIndexes returns WordIndexes

func (ValueArray) MarshalJSON

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

MarshalJSON marshals to json representation

func (ValueArray) String

func (m ValueArray) String() string

func (ValueArray) ValidateEnumValue

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

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

type ValueDate

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 (ValueDate) GetBoundingPolygon

func (m ValueDate) GetBoundingPolygon() *BoundingPolygon

GetBoundingPolygon returns BoundingPolygon

func (ValueDate) GetConfidence

func (m ValueDate) GetConfidence() *float32

GetConfidence returns Confidence

func (ValueDate) GetText

func (m ValueDate) GetText() *string

GetText returns Text

func (ValueDate) GetWordIndexes

func (m ValueDate) GetWordIndexes() []int

GetWordIndexes returns WordIndexes

func (ValueDate) MarshalJSON

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

MarshalJSON marshals to json representation

func (ValueDate) String

func (m ValueDate) String() string

func (ValueDate) ValidateEnumValue

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

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

type ValueInteger

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 (ValueInteger) GetBoundingPolygon

func (m ValueInteger) GetBoundingPolygon() *BoundingPolygon

GetBoundingPolygon returns BoundingPolygon

func (ValueInteger) GetConfidence

func (m ValueInteger) GetConfidence() *float32

GetConfidence returns Confidence

func (ValueInteger) GetText

func (m ValueInteger) GetText() *string

GetText returns Text

func (ValueInteger) GetWordIndexes

func (m ValueInteger) GetWordIndexes() []int

GetWordIndexes returns WordIndexes

func (ValueInteger) MarshalJSON

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

MarshalJSON marshals to json representation

func (ValueInteger) String

func (m ValueInteger) String() string

func (ValueInteger) ValidateEnumValue

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

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

type ValueNumber

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 (ValueNumber) GetBoundingPolygon

func (m ValueNumber) GetBoundingPolygon() *BoundingPolygon

GetBoundingPolygon returns BoundingPolygon

func (ValueNumber) GetConfidence

func (m ValueNumber) GetConfidence() *float32

GetConfidence returns Confidence

func (ValueNumber) GetText

func (m ValueNumber) GetText() *string

GetText returns Text

func (ValueNumber) GetWordIndexes

func (m ValueNumber) GetWordIndexes() []int

GetWordIndexes returns WordIndexes

func (ValueNumber) MarshalJSON

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

MarshalJSON marshals to json representation

func (ValueNumber) String

func (m ValueNumber) String() string

func (ValueNumber) ValidateEnumValue

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

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

type ValuePhoneNumber

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 (ValuePhoneNumber) GetBoundingPolygon

func (m ValuePhoneNumber) GetBoundingPolygon() *BoundingPolygon

GetBoundingPolygon returns BoundingPolygon

func (ValuePhoneNumber) GetConfidence

func (m ValuePhoneNumber) GetConfidence() *float32

GetConfidence returns Confidence

func (ValuePhoneNumber) GetText

func (m ValuePhoneNumber) GetText() *string

GetText returns Text

func (ValuePhoneNumber) GetWordIndexes

func (m ValuePhoneNumber) GetWordIndexes() []int

GetWordIndexes returns WordIndexes

func (ValuePhoneNumber) MarshalJSON

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

MarshalJSON marshals to json representation

func (ValuePhoneNumber) String

func (m ValuePhoneNumber) String() string

func (ValuePhoneNumber) ValidateEnumValue

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

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

type ValueString

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 (ValueString) GetBoundingPolygon

func (m ValueString) GetBoundingPolygon() *BoundingPolygon

GetBoundingPolygon returns BoundingPolygon

func (ValueString) GetConfidence

func (m ValueString) GetConfidence() *float32

GetConfidence returns Confidence

func (ValueString) GetText

func (m ValueString) GetText() *string

GetText returns Text

func (ValueString) GetWordIndexes

func (m ValueString) GetWordIndexes() []int

GetWordIndexes returns WordIndexes

func (ValueString) MarshalJSON

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

MarshalJSON marshals to json representation

func (ValueString) String

func (m ValueString) String() string

func (ValueString) ValidateEnumValue

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

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

type ValueTime

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 (ValueTime) GetBoundingPolygon

func (m ValueTime) GetBoundingPolygon() *BoundingPolygon

GetBoundingPolygon returns BoundingPolygon

func (ValueTime) GetConfidence

func (m ValueTime) GetConfidence() *float32

GetConfidence returns Confidence

func (ValueTime) GetText

func (m ValueTime) GetText() *string

GetText returns Text

func (ValueTime) GetWordIndexes

func (m ValueTime) GetWordIndexes() []int

GetWordIndexes returns WordIndexes

func (ValueTime) MarshalJSON

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

MarshalJSON marshals to json representation

func (ValueTime) String

func (m ValueTime) String() string

func (ValueTime) ValidateEnumValue

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

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

type Word

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 (Word) String

func (m Word) String() string

func (Word) ValidateEnumValue

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

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

type WorkRequest

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 (WorkRequest) String

func (m WorkRequest) String() string

func (WorkRequest) ValidateEnumValue

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

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

type WorkRequestError

WorkRequestError An error encountered while executing a work request.

type WorkRequestError struct {

    // A machine-usable code for the error that occured. Error codes are listed on
    // (https://docs.cloud.oracle.com/Content/API/References/apierrors.htm).
    Code *string `mandatory:"true" json:"code"`

    // A human-readable description of the issue encountered.
    Message *string `mandatory:"true" json:"message"`

    // When the error occured, as an RFC3339 formatted datetime.
    Timestamp *common.SDKTime `mandatory:"true" json:"timestamp"`
}

func (WorkRequestError) String

func (m WorkRequestError) String() string

func (WorkRequestError) ValidateEnumValue

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

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

type WorkRequestErrorCollection

WorkRequestErrorCollection The results of a workRequestError search.

type WorkRequestErrorCollection struct {

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

func (WorkRequestErrorCollection) String

func (m WorkRequestErrorCollection) String() string

func (WorkRequestErrorCollection) ValidateEnumValue

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

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

type WorkRequestLogEntry

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 (WorkRequestLogEntry) String

func (m WorkRequestLogEntry) String() string

func (WorkRequestLogEntry) ValidateEnumValue

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

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

type WorkRequestLogEntryCollection

WorkRequestLogEntryCollection The results of a workRequestLog search.

type WorkRequestLogEntryCollection struct {

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

func (WorkRequestLogEntryCollection) String

func (m WorkRequestLogEntryCollection) String() string

func (WorkRequestLogEntryCollection) ValidateEnumValue

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

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

type WorkRequestResource

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 (WorkRequestResource) String

func (m WorkRequestResource) String() string

func (WorkRequestResource) ValidateEnumValue

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

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

type WorkRequestResourceMetadataKeyEnum

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

func GetMappingWorkRequestResourceMetadataKeyEnum(val string) (WorkRequestResourceMetadataKeyEnum, bool)

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

func GetWorkRequestResourceMetadataKeyEnumValues

func GetWorkRequestResourceMetadataKeyEnumValues() []WorkRequestResourceMetadataKeyEnum

GetWorkRequestResourceMetadataKeyEnumValues Enumerates the set of values for WorkRequestResourceMetadataKeyEnum

type WorkRequestSummary

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 (WorkRequestSummary) String

func (m WorkRequestSummary) String() string

func (WorkRequestSummary) ValidateEnumValue

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

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

type WorkRequestSummaryCollection

WorkRequestSummaryCollection The results of a workRequest search.

type WorkRequestSummaryCollection struct {

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

func (WorkRequestSummaryCollection) String

func (m WorkRequestSummaryCollection) String() string

func (WorkRequestSummaryCollection) ValidateEnumValue

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

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