@Generated(value="OracleSDKGenerator", comments="API Version: 20220125") public interface AIServiceVisionAsync extends AutoCloseable
Using Vision, you can upload images to detect and classify objects in them. If you have lots of images, you can process them in batch using asynchronous API endpoints. Vision’s features are thematically split between Document AI for document-centric images, and Image Analysis for object and scene-based images. Pretrained models and custom models are supported.
close
void refreshClient()
Rebuilds the client from scratch. Useful to refresh certificates.
void setEndpoint(String endpoint)
Sets the endpoint to call (ex, https://www.example.com).
endpoint
- The endpoint of the serice.String getEndpoint()
Gets the set endpoint for REST call (ex, https://www.example.com)
void setRegion(Region region)
Sets the region to call (ex, Region.US_PHOENIX_1).
Note, this will call setEndpoint
after resolving the
endpoint. If the service is not available in this region, however, an
IllegalArgumentException will be raised.
region
- The region of the service.void setRegion(String regionId)
Sets the region to call (ex, ‘us-phoenix-1’).
Note, this will first try to map the region ID to a known Region and call setRegion
.
If no known Region could be determined, it will create an endpoint based on the default
endpoint format (Region.formatDefaultRegionEndpoint(Service, String)
and then call setEndpoint
.
regionId
- The public region ID.void useRealmSpecificEndpointTemplate(boolean realmSpecificEndpointTemplateEnabled)
Determines whether realm specific endpoint should be used or not. Set realmSpecificEndpointTemplateEnabled to “true” if the user wants to enable use of realm specific endpoint template, otherwise set it to “false”
realmSpecificEndpointTemplateEnabled
- flag to enable the use of realm specific endpoint
templateFuture<AnalyzeDocumentResponse> analyzeDocument(AnalyzeDocumentRequest request, AsyncHandler<AnalyzeDocumentRequest,AnalyzeDocumentResponse> handler)
Perform different types of image analysis.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<AnalyzeImageResponse> analyzeImage(AnalyzeImageRequest request, AsyncHandler<AnalyzeImageRequest,AnalyzeImageResponse> handler)
Perform different types of image analysis.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<CancelDocumentJobResponse> cancelDocumentJob(CancelDocumentJobRequest request, AsyncHandler<CancelDocumentJobRequest,CancelDocumentJobResponse> handler)
Cancel a document batch job.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<CancelImageJobResponse> cancelImageJob(CancelImageJobRequest request, AsyncHandler<CancelImageJobRequest,CancelImageJobResponse> handler)
Cancel an image batch job.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<CancelVideoJobResponse> cancelVideoJob(CancelVideoJobRequest request, AsyncHandler<CancelVideoJobRequest,CancelVideoJobResponse> handler)
Cancel a video analysis job.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<CancelWorkRequestResponse> cancelWorkRequest(CancelWorkRequestRequest request, AsyncHandler<CancelWorkRequestRequest,CancelWorkRequestResponse> handler)
Cancel the work request with the given ID.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<ChangeModelCompartmentResponse> changeModelCompartment(ChangeModelCompartmentRequest request, AsyncHandler<ChangeModelCompartmentRequest,ChangeModelCompartmentResponse> handler)
Moves a model from one compartment to another. When provided, If-Match is checked against the ETag values of the resource.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<ChangeProjectCompartmentResponse> changeProjectCompartment(ChangeProjectCompartmentRequest request, AsyncHandler<ChangeProjectCompartmentRequest,ChangeProjectCompartmentResponse> handler)
Move a project from one compartment to another. When provided, If-Match is checked against the ETag values of the resource.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<CreateDocumentJobResponse> createDocumentJob(CreateDocumentJobRequest request, AsyncHandler<CreateDocumentJobRequest,CreateDocumentJobResponse> handler)
Create a document analysis batch job.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<CreateImageJobResponse> createImageJob(CreateImageJobRequest request, AsyncHandler<CreateImageJobRequest,CreateImageJobResponse> handler)
Create an image analysis batch job.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<CreateModelResponse> createModel(CreateModelRequest request, AsyncHandler<CreateModelRequest,CreateModelResponse> handler)
Create a new model.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<CreateProjectResponse> createProject(CreateProjectRequest request, AsyncHandler<CreateProjectRequest,CreateProjectResponse> handler)
Create a new project.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<CreateVideoJobResponse> createVideoJob(CreateVideoJobRequest request, AsyncHandler<CreateVideoJobRequest,CreateVideoJobResponse> handler)
Create a video analysis job with given inputs and features.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<DeleteModelResponse> deleteModel(DeleteModelRequest request, AsyncHandler<DeleteModelRequest,DeleteModelResponse> handler)
Delete a model by identifier.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<DeleteProjectResponse> deleteProject(DeleteProjectRequest request, AsyncHandler<DeleteProjectRequest,DeleteProjectResponse> handler)
Delete a project by identifier.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<GetDocumentJobResponse> getDocumentJob(GetDocumentJobRequest request, AsyncHandler<GetDocumentJobRequest,GetDocumentJobResponse> handler)
Get details of a document batch job.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<GetImageJobResponse> getImageJob(GetImageJobRequest request, AsyncHandler<GetImageJobRequest,GetImageJobResponse> handler)
Get details of an image batch job.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<GetModelResponse> getModel(GetModelRequest request, AsyncHandler<GetModelRequest,GetModelResponse> handler)
Get a model by identifier.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<GetProjectResponse> getProject(GetProjectRequest request, AsyncHandler<GetProjectRequest,GetProjectResponse> handler)
Get a project by identifier.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<GetVideoJobResponse> getVideoJob(GetVideoJobRequest request, AsyncHandler<GetVideoJobRequest,GetVideoJobResponse> handler)
Get details of a video analysis job.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<GetWorkRequestResponse> getWorkRequest(GetWorkRequestRequest request, AsyncHandler<GetWorkRequestRequest,GetWorkRequestResponse> handler)
Gets the status of the work request with the given ID.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<ListModelsResponse> listModels(ListModelsRequest request, AsyncHandler<ListModelsRequest,ListModelsResponse> handler)
Returns a list of models in a compartment.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<ListProjectsResponse> listProjects(ListProjectsRequest request, AsyncHandler<ListProjectsRequest,ListProjectsResponse> handler)
Returns a list of projects.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<ListWorkRequestErrorsResponse> listWorkRequestErrors(ListWorkRequestErrorsRequest request, AsyncHandler<ListWorkRequestErrorsRequest,ListWorkRequestErrorsResponse> handler)
Returns a (paginated) list of errors for a given work request.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<ListWorkRequestLogsResponse> listWorkRequestLogs(ListWorkRequestLogsRequest request, AsyncHandler<ListWorkRequestLogsRequest,ListWorkRequestLogsResponse> handler)
Return a (paginated) list of logs for a given work request.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<ListWorkRequestsResponse> listWorkRequests(ListWorkRequestsRequest request, AsyncHandler<ListWorkRequestsRequest,ListWorkRequestsResponse> handler)
Lists the work requests in a compartment.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<UpdateModelResponse> updateModel(UpdateModelRequest request, AsyncHandler<UpdateModelRequest,UpdateModelResponse> handler)
Updates the model metadata.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<UpdateProjectResponse> updateProject(UpdateProjectRequest request, AsyncHandler<UpdateProjectRequest,UpdateProjectResponse> handler)
Update the project metadata.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Copyright © 2016–2024. All rights reserved.