|
| 1 | +/** |
| 2 | + * Copyright (c) 2016, 2021, Oracle and/or its affiliates. All rights reserved. |
| 3 | + * This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. |
| 4 | + */ |
| 5 | +package com.oracle.bmc.ailanguage; |
| 6 | + |
| 7 | +import com.oracle.bmc.ailanguage.requests.*; |
| 8 | +import com.oracle.bmc.ailanguage.responses.*; |
| 9 | + |
| 10 | +/** |
| 11 | + * OCI AI Service solutions can help Enterprise customers integrate AI into their products immediately using our proven, |
| 12 | + * pre-trained and custom models or containers, without a need to set up an house team of AI and ML experts. |
| 13 | + * This allows enterprises to focus on business drivers and development work rather than AI and ML operations, which shortens the time to market. |
| 14 | + * |
| 15 | + */ |
| 16 | +@javax.annotation.Generated(value = "OracleSDKGenerator", comments = "API Version: 20210101") |
| 17 | +public interface AIServiceLanguageAsync extends AutoCloseable { |
| 18 | + |
| 19 | + /** |
| 20 | + * Sets the endpoint to call (ex, https://www.example.com). |
| 21 | + * @param endpoint The endpoint of the serice. |
| 22 | + */ |
| 23 | + void setEndpoint(String endpoint); |
| 24 | + |
| 25 | + /** |
| 26 | + * Gets the set endpoint for REST call (ex, https://www.example.com) |
| 27 | + */ |
| 28 | + String getEndpoint(); |
| 29 | + |
| 30 | + /** |
| 31 | + * Sets the region to call (ex, Region.US_PHOENIX_1). |
| 32 | + * <p> |
| 33 | + * Note, this will call {@link #setEndpoint(String) setEndpoint} after resolving the endpoint. If the service is not available in this region, however, an IllegalArgumentException will be raised. |
| 34 | + * @param region The region of the service. |
| 35 | + */ |
| 36 | + void setRegion(com.oracle.bmc.Region region); |
| 37 | + |
| 38 | + /** |
| 39 | + * Sets the region to call (ex, 'us-phoenix-1'). |
| 40 | + * <p> |
| 41 | + * Note, this will first try to map the region ID to a known Region and call |
| 42 | + * {@link #setRegion(Region) setRegion}. |
| 43 | + * <p> |
| 44 | + * If no known Region could be determined, it will create an endpoint based on the |
| 45 | + * default endpoint format ({@link com.oracle.bmc.Region#formatDefaultRegionEndpoint(Service, String)} |
| 46 | + * and then call {@link #setEndpoint(String) setEndpoint}. |
| 47 | + * @param regionId The public region ID. |
| 48 | + */ |
| 49 | + void setRegion(String regionId); |
| 50 | + |
| 51 | + /** |
| 52 | + * Make a detect call to language detection pre-deployed model. |
| 53 | + * |
| 54 | + * @param request The request object containing the details to send |
| 55 | + * @param handler The request handler to invoke upon completion, may be null. |
| 56 | + * @return A Future that can be used to get the response if no AsyncHandler was |
| 57 | + * provided. Note, if you provide an AsyncHandler and use the Future, some |
| 58 | + * types of responses (like java.io.InputStream) may not be able to be read in |
| 59 | + * both places as the underlying stream may only be consumed once. |
| 60 | + */ |
| 61 | + java.util.concurrent.Future<DetectDominantLanguageResponse> detectDominantLanguage( |
| 62 | + DetectDominantLanguageRequest request, |
| 63 | + com.oracle.bmc.responses.AsyncHandler< |
| 64 | + DetectDominantLanguageRequest, DetectDominantLanguageResponse> |
| 65 | + handler); |
| 66 | + |
| 67 | + /** |
| 68 | + * Make a detect call to enitiy pre-deployed model |
| 69 | + * |
| 70 | + * @param request The request object containing the details to send |
| 71 | + * @param handler The request handler to invoke upon completion, may be null. |
| 72 | + * @return A Future that can be used to get the response if no AsyncHandler was |
| 73 | + * provided. Note, if you provide an AsyncHandler and use the Future, some |
| 74 | + * types of responses (like java.io.InputStream) may not be able to be read in |
| 75 | + * both places as the underlying stream may only be consumed once. |
| 76 | + */ |
| 77 | + java.util.concurrent.Future<DetectLanguageEntitiesResponse> detectLanguageEntities( |
| 78 | + DetectLanguageEntitiesRequest request, |
| 79 | + com.oracle.bmc.responses.AsyncHandler< |
| 80 | + DetectLanguageEntitiesRequest, DetectLanguageEntitiesResponse> |
| 81 | + handler); |
| 82 | + |
| 83 | + /** |
| 84 | + * Make a detect call to the keyPhrase pre-deployed model. |
| 85 | + * |
| 86 | + * @param request The request object containing the details to send |
| 87 | + * @param handler The request handler to invoke upon completion, may be null. |
| 88 | + * @return A Future that can be used to get the response if no AsyncHandler was |
| 89 | + * provided. Note, if you provide an AsyncHandler and use the Future, some |
| 90 | + * types of responses (like java.io.InputStream) may not be able to be read in |
| 91 | + * both places as the underlying stream may only be consumed once. |
| 92 | + */ |
| 93 | + java.util.concurrent.Future<DetectLanguageKeyPhrasesResponse> detectLanguageKeyPhrases( |
| 94 | + DetectLanguageKeyPhrasesRequest request, |
| 95 | + com.oracle.bmc.responses.AsyncHandler< |
| 96 | + DetectLanguageKeyPhrasesRequest, DetectLanguageKeyPhrasesResponse> |
| 97 | + handler); |
| 98 | + |
| 99 | + /** |
| 100 | + * Make a detect call to sentiment pre-deployed model. |
| 101 | + * |
| 102 | + * @param request The request object containing the details to send |
| 103 | + * @param handler The request handler to invoke upon completion, may be null. |
| 104 | + * @return A Future that can be used to get the response if no AsyncHandler was |
| 105 | + * provided. Note, if you provide an AsyncHandler and use the Future, some |
| 106 | + * types of responses (like java.io.InputStream) may not be able to be read in |
| 107 | + * both places as the underlying stream may only be consumed once. |
| 108 | + */ |
| 109 | + java.util.concurrent.Future<DetectLanguageSentimentsResponse> detectLanguageSentiments( |
| 110 | + DetectLanguageSentimentsRequest request, |
| 111 | + com.oracle.bmc.responses.AsyncHandler< |
| 112 | + DetectLanguageSentimentsRequest, DetectLanguageSentimentsResponse> |
| 113 | + handler); |
| 114 | + |
| 115 | + /** |
| 116 | + * Make a detect call to text classification from the pre-deployed model. |
| 117 | + * |
| 118 | + * @param request The request object containing the details to send |
| 119 | + * @param handler The request handler to invoke upon completion, may be null. |
| 120 | + * @return A Future that can be used to get the response if no AsyncHandler was |
| 121 | + * provided. Note, if you provide an AsyncHandler and use the Future, some |
| 122 | + * types of responses (like java.io.InputStream) may not be able to be read in |
| 123 | + * both places as the underlying stream may only be consumed once. |
| 124 | + */ |
| 125 | + java.util.concurrent.Future<DetectLanguageTextClassificationResponse> |
| 126 | + detectLanguageTextClassification( |
| 127 | + DetectLanguageTextClassificationRequest request, |
| 128 | + com.oracle.bmc.responses.AsyncHandler< |
| 129 | + DetectLanguageTextClassificationRequest, |
| 130 | + DetectLanguageTextClassificationResponse> |
| 131 | + handler); |
| 132 | +} |
0 commit comments