oci-ailanguage 2.79.0 → 2.80.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (70) hide show
  1. package/lib/client.d.ts +63 -55
  2. package/lib/client.js +63 -55
  3. package/lib/client.js.map +1 -1
  4. package/lib/model/batch-detect-dominant-language-details.d.ts +17 -0
  5. package/lib/model/batch-detect-dominant-language-details.js.map +1 -1
  6. package/lib/model/batch-detect-language-key-phrases-details.d.ts +4 -0
  7. package/lib/model/batch-detect-language-key-phrases-details.js.map +1 -1
  8. package/lib/model/batch-detect-language-pii-entities-details.d.ts +4 -0
  9. package/lib/model/batch-detect-language-pii-entities-details.js.map +1 -1
  10. package/lib/model/batch-detect-language-sentiments-details.d.ts +4 -0
  11. package/lib/model/batch-detect-language-sentiments-details.js.map +1 -1
  12. package/lib/model/batch-language-translation-details.d.ts +31 -24
  13. package/lib/model/batch-language-translation-details.js.map +1 -1
  14. package/lib/model/create-model-details.d.ts +1 -1
  15. package/lib/model/create-model-details.js.map +1 -1
  16. package/lib/model/endpoint-summary.d.ts +3 -1
  17. package/lib/model/endpoint.d.ts +3 -1
  18. package/lib/model/index.d.ts +0 -2
  19. package/lib/model/index.js +1 -3
  20. package/lib/model/index.js.map +1 -1
  21. package/lib/model/model-details.js +0 -4
  22. package/lib/model/model-details.js.map +1 -1
  23. package/lib/model/model-summary.d.ts +6 -4
  24. package/lib/model/model-summary.js.map +1 -1
  25. package/lib/model/model.d.ts +5 -3
  26. package/lib/model/model.js.map +1 -1
  27. package/lib/model/project-summary.d.ts +3 -1
  28. package/lib/model/project.d.ts +3 -1
  29. package/lib/model/translation-document-result.d.ts +2 -52
  30. package/lib/model/translation-document-result.js.map +1 -1
  31. package/lib/request/batch-detect-dominant-language-request.d.ts +1 -1
  32. package/lib/request/batch-detect-language-entities-request.d.ts +1 -1
  33. package/lib/request/batch-detect-language-key-phrases-request.d.ts +1 -1
  34. package/lib/request/batch-detect-language-pii-entities-request.d.ts +1 -1
  35. package/lib/request/batch-detect-language-sentiments-request.d.ts +1 -1
  36. package/lib/request/batch-detect-language-text-classification-request.d.ts +1 -1
  37. package/lib/request/batch-language-translation-request.d.ts +1 -1
  38. package/lib/request/change-endpoint-compartment-request.d.ts +1 -1
  39. package/lib/request/change-model-compartment-request.d.ts +1 -1
  40. package/lib/request/change-project-compartment-request.d.ts +1 -1
  41. package/lib/request/create-endpoint-request.d.ts +1 -1
  42. package/lib/request/create-model-request.d.ts +1 -1
  43. package/lib/request/create-project-request.d.ts +1 -1
  44. package/lib/request/delete-endpoint-request.d.ts +1 -1
  45. package/lib/request/delete-model-request.d.ts +1 -1
  46. package/lib/request/delete-project-request.d.ts +1 -1
  47. package/lib/request/detect-dominant-language-request.d.ts +1 -1
  48. package/lib/request/detect-language-entities-request.d.ts +1 -1
  49. package/lib/request/detect-language-key-phrases-request.d.ts +1 -1
  50. package/lib/request/detect-language-sentiments-request.d.ts +1 -1
  51. package/lib/request/detect-language-text-classification-request.d.ts +1 -1
  52. package/lib/request/get-endpoint-request.d.ts +1 -1
  53. package/lib/request/get-model-request.d.ts +1 -1
  54. package/lib/request/get-model-type-request.d.ts +1 -1
  55. package/lib/request/get-project-request.d.ts +1 -1
  56. package/lib/request/get-work-request-request.d.ts +1 -1
  57. package/lib/request/list-endpoints-request.d.ts +1 -1
  58. package/lib/request/list-evaluation-results-request.d.ts +1 -1
  59. package/lib/request/list-models-request.d.ts +1 -1
  60. package/lib/request/list-projects-request.d.ts +1 -1
  61. package/lib/request/list-work-request-errors-request.d.ts +1 -1
  62. package/lib/request/list-work-request-logs-request.d.ts +1 -1
  63. package/lib/request/list-work-requests-request.d.ts +1 -1
  64. package/lib/request/update-endpoint-request.d.ts +1 -1
  65. package/lib/request/update-model-request.d.ts +1 -1
  66. package/lib/request/update-project-request.d.ts +1 -1
  67. package/package.json +3 -3
  68. package/lib/model/pre-trained-phi-model-details.d.ts +0 -33
  69. package/lib/model/pre-trained-phi-model-details.js +0 -57
  70. package/lib/model/pre-trained-phi-model-details.js.map +0 -1
package/lib/client.d.ts CHANGED
@@ -26,7 +26,7 @@ export declare enum AIServiceLanguageApiKeys {
26
26
  export declare class AIServiceLanguageClient {
27
27
  protected static serviceEndpointTemplate: string;
28
28
  protected static endpointServiceName: string;
29
- protected "_realmSpecificEndpointTemplateEnabled": boolean;
29
+ protected "_realmSpecificEndpointTemplateEnabled": boolean | undefined;
30
30
  protected "_endpoint": string;
31
31
  protected "_defaultHeaders": any;
32
32
  protected "_waiters": AIServiceLanguageWaiter;
@@ -102,7 +102,7 @@ export declare class AIServiceLanguageClient {
102
102
  * @param BatchDetectDominantLanguageRequest
103
103
  * @return BatchDetectDominantLanguageResponse
104
104
  * @throws OciError when an error occurs
105
- * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.79.0/ailanguage/BatchDetectDominantLanguage.ts.html |here} to see how to use BatchDetectDominantLanguage API.
105
+ * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.80.0/ailanguage/BatchDetectDominantLanguage.ts.html |here} to see how to use BatchDetectDominantLanguage API.
106
106
  */
107
107
  batchDetectDominantLanguage(batchDetectDominantLanguageRequest: requests.BatchDetectDominantLanguageRequest): Promise<responses.BatchDetectDominantLanguageResponse>;
108
108
  /**
@@ -119,7 +119,7 @@ export declare class AIServiceLanguageClient {
119
119
  * @param BatchDetectLanguageEntitiesRequest
120
120
  * @return BatchDetectLanguageEntitiesResponse
121
121
  * @throws OciError when an error occurs
122
- * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.79.0/ailanguage/BatchDetectLanguageEntities.ts.html |here} to see how to use BatchDetectLanguageEntities API.
122
+ * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.80.0/ailanguage/BatchDetectLanguageEntities.ts.html |here} to see how to use BatchDetectLanguageEntities API.
123
123
  */
124
124
  batchDetectLanguageEntities(batchDetectLanguageEntitiesRequest: requests.BatchDetectLanguageEntitiesRequest): Promise<responses.BatchDetectLanguageEntitiesResponse>;
125
125
  /**
@@ -134,7 +134,7 @@ export declare class AIServiceLanguageClient {
134
134
  * @param BatchDetectLanguageKeyPhrasesRequest
135
135
  * @return BatchDetectLanguageKeyPhrasesResponse
136
136
  * @throws OciError when an error occurs
137
- * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.79.0/ailanguage/BatchDetectLanguageKeyPhrases.ts.html |here} to see how to use BatchDetectLanguageKeyPhrases API.
137
+ * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.80.0/ailanguage/BatchDetectLanguageKeyPhrases.ts.html |here} to see how to use BatchDetectLanguageKeyPhrases API.
138
138
  */
139
139
  batchDetectLanguageKeyPhrases(batchDetectLanguageKeyPhrasesRequest: requests.BatchDetectLanguageKeyPhrasesRequest): Promise<responses.BatchDetectLanguageKeyPhrasesResponse>;
140
140
  /**
@@ -149,7 +149,7 @@ export declare class AIServiceLanguageClient {
149
149
  * @param BatchDetectLanguagePiiEntitiesRequest
150
150
  * @return BatchDetectLanguagePiiEntitiesResponse
151
151
  * @throws OciError when an error occurs
152
- * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.79.0/ailanguage/BatchDetectLanguagePiiEntities.ts.html |here} to see how to use BatchDetectLanguagePiiEntities API.
152
+ * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.80.0/ailanguage/BatchDetectLanguagePiiEntities.ts.html |here} to see how to use BatchDetectLanguagePiiEntities API.
153
153
  */
154
154
  batchDetectLanguagePiiEntities(batchDetectLanguagePiiEntitiesRequest: requests.BatchDetectLanguagePiiEntitiesRequest): Promise<responses.BatchDetectLanguagePiiEntitiesResponse>;
155
155
  /**
@@ -170,7 +170,7 @@ export declare class AIServiceLanguageClient {
170
170
  * @param BatchDetectLanguageSentimentsRequest
171
171
  * @return BatchDetectLanguageSentimentsResponse
172
172
  * @throws OciError when an error occurs
173
- * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.79.0/ailanguage/BatchDetectLanguageSentiments.ts.html |here} to see how to use BatchDetectLanguageSentiments API.
173
+ * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.80.0/ailanguage/BatchDetectLanguageSentiments.ts.html |here} to see how to use BatchDetectLanguageSentiments API.
174
174
  */
175
175
  batchDetectLanguageSentiments(batchDetectLanguageSentimentsRequest: requests.BatchDetectLanguageSentimentsRequest): Promise<responses.BatchDetectLanguageSentimentsResponse>;
176
176
  /**
@@ -189,22 +189,21 @@ export declare class AIServiceLanguageClient {
189
189
  * @param BatchDetectLanguageTextClassificationRequest
190
190
  * @return BatchDetectLanguageTextClassificationResponse
191
191
  * @throws OciError when an error occurs
192
- * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.79.0/ailanguage/BatchDetectLanguageTextClassification.ts.html |here} to see how to use BatchDetectLanguageTextClassification API.
192
+ * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.80.0/ailanguage/BatchDetectLanguageTextClassification.ts.html |here} to see how to use BatchDetectLanguageTextClassification API.
193
193
  */
194
194
  batchDetectLanguageTextClassification(batchDetectLanguageTextClassificationRequest: requests.BatchDetectLanguageTextClassificationRequest): Promise<responses.BatchDetectLanguageTextClassificationResponse>;
195
195
  /**
196
- * Translate text to other language over pre-deployed model.
197
- * Use state of the art neural machine translation to translate text between more than 15 languages.
198
- * Limitations:
199
- * - A batch may have up to 100 records.
200
- * - A record may be up to 5000 characters long.
201
- * - The total of characters to process in a request can be up to 20,000 characters.
196
+ * Translates a batch of text documents from source to target language.
197
+ * A batch can contain:
198
+ * - up to 100 records.
199
+ * - documents length less than 5000 characters.
200
+ * - 20,000 characters in total as a sum of all documents length.
202
201
  *
203
202
  * This operation does not retry by default if the user has not defined a retry configuration.
204
203
  * @param BatchLanguageTranslationRequest
205
204
  * @return BatchLanguageTranslationResponse
206
205
  * @throws OciError when an error occurs
207
- * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.79.0/ailanguage/BatchLanguageTranslation.ts.html |here} to see how to use BatchLanguageTranslation API.
206
+ * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.80.0/ailanguage/BatchLanguageTranslation.ts.html |here} to see how to use BatchLanguageTranslation API.
208
207
  */
209
208
  batchLanguageTranslation(batchLanguageTranslationRequest: requests.BatchLanguageTranslationRequest): Promise<responses.BatchLanguageTranslationResponse>;
210
209
  /**
@@ -213,7 +212,7 @@ export declare class AIServiceLanguageClient {
213
212
  * @param ChangeEndpointCompartmentRequest
214
213
  * @return ChangeEndpointCompartmentResponse
215
214
  * @throws OciError when an error occurs
216
- * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.79.0/ailanguage/ChangeEndpointCompartment.ts.html |here} to see how to use ChangeEndpointCompartment API.
215
+ * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.80.0/ailanguage/ChangeEndpointCompartment.ts.html |here} to see how to use ChangeEndpointCompartment API.
217
216
  */
218
217
  changeEndpointCompartment(changeEndpointCompartmentRequest: requests.ChangeEndpointCompartmentRequest): Promise<responses.ChangeEndpointCompartmentResponse>;
219
218
  /**
@@ -222,7 +221,7 @@ export declare class AIServiceLanguageClient {
222
221
  * @param ChangeModelCompartmentRequest
223
222
  * @return ChangeModelCompartmentResponse
224
223
  * @throws OciError when an error occurs
225
- * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.79.0/ailanguage/ChangeModelCompartment.ts.html |here} to see how to use ChangeModelCompartment API.
224
+ * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.80.0/ailanguage/ChangeModelCompartment.ts.html |here} to see how to use ChangeModelCompartment API.
226
225
  */
227
226
  changeModelCompartment(changeModelCompartmentRequest: requests.ChangeModelCompartmentRequest): Promise<responses.ChangeModelCompartmentResponse>;
228
227
  /**
@@ -231,7 +230,7 @@ export declare class AIServiceLanguageClient {
231
230
  * @param ChangeProjectCompartmentRequest
232
231
  * @return ChangeProjectCompartmentResponse
233
232
  * @throws OciError when an error occurs
234
- * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.79.0/ailanguage/ChangeProjectCompartment.ts.html |here} to see how to use ChangeProjectCompartment API.
233
+ * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.80.0/ailanguage/ChangeProjectCompartment.ts.html |here} to see how to use ChangeProjectCompartment API.
235
234
  */
236
235
  changeProjectCompartment(changeProjectCompartmentRequest: requests.ChangeProjectCompartmentRequest): Promise<responses.ChangeProjectCompartmentResponse>;
237
236
  /**
@@ -241,7 +240,7 @@ export declare class AIServiceLanguageClient {
241
240
  * @param CreateEndpointRequest
242
241
  * @return CreateEndpointResponse
243
242
  * @throws OciError when an error occurs
244
- * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.79.0/ailanguage/CreateEndpoint.ts.html |here} to see how to use CreateEndpoint API.
243
+ * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.80.0/ailanguage/CreateEndpoint.ts.html |here} to see how to use CreateEndpoint API.
245
244
  */
246
245
  createEndpoint(createEndpointRequest: requests.CreateEndpointRequest): Promise<responses.CreateEndpointResponse>;
247
246
  /**
@@ -251,7 +250,7 @@ export declare class AIServiceLanguageClient {
251
250
  * @param CreateModelRequest
252
251
  * @return CreateModelResponse
253
252
  * @throws OciError when an error occurs
254
- * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.79.0/ailanguage/CreateModel.ts.html |here} to see how to use CreateModel API.
253
+ * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.80.0/ailanguage/CreateModel.ts.html |here} to see how to use CreateModel API.
255
254
  */
256
255
  createModel(createModelRequest: requests.CreateModelRequest): Promise<responses.CreateModelResponse>;
257
256
  /**
@@ -261,7 +260,7 @@ export declare class AIServiceLanguageClient {
261
260
  * @param CreateProjectRequest
262
261
  * @return CreateProjectResponse
263
262
  * @throws OciError when an error occurs
264
- * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.79.0/ailanguage/CreateProject.ts.html |here} to see how to use CreateProject API.
263
+ * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.80.0/ailanguage/CreateProject.ts.html |here} to see how to use CreateProject API.
265
264
  */
266
265
  createProject(createProjectRequest: requests.CreateProjectRequest): Promise<responses.CreateProjectResponse>;
267
266
  /**
@@ -270,7 +269,7 @@ export declare class AIServiceLanguageClient {
270
269
  * @param DeleteEndpointRequest
271
270
  * @return DeleteEndpointResponse
272
271
  * @throws OciError when an error occurs
273
- * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.79.0/ailanguage/DeleteEndpoint.ts.html |here} to see how to use DeleteEndpoint API.
272
+ * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.80.0/ailanguage/DeleteEndpoint.ts.html |here} to see how to use DeleteEndpoint API.
274
273
  */
275
274
  deleteEndpoint(deleteEndpointRequest: requests.DeleteEndpointRequest): Promise<responses.DeleteEndpointResponse>;
276
275
  /**
@@ -279,7 +278,7 @@ export declare class AIServiceLanguageClient {
279
278
  * @param DeleteModelRequest
280
279
  * @return DeleteModelResponse
281
280
  * @throws OciError when an error occurs
282
- * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.79.0/ailanguage/DeleteModel.ts.html |here} to see how to use DeleteModel API.
281
+ * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.80.0/ailanguage/DeleteModel.ts.html |here} to see how to use DeleteModel API.
283
282
  */
284
283
  deleteModel(deleteModelRequest: requests.DeleteModelRequest): Promise<responses.DeleteModelResponse>;
285
284
  /**
@@ -288,14 +287,16 @@ export declare class AIServiceLanguageClient {
288
287
  * @param DeleteProjectRequest
289
288
  * @return DeleteProjectResponse
290
289
  * @throws OciError when an error occurs
291
- * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.79.0/ailanguage/DeleteProject.ts.html |here} to see how to use DeleteProject API.
290
+ * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.80.0/ailanguage/DeleteProject.ts.html |here} to see how to use DeleteProject API.
292
291
  */
293
292
  deleteProject(deleteProjectRequest: requests.DeleteProjectRequest): Promise<responses.DeleteProjectResponse>;
294
293
  /**
295
- * This API will be retired on Monday, 10 Oct 2023 00:00:00 GMT
296
- * The API returns the detected language and a related confidence score (between 0 and 1).
294
+ * **Deprecated**: This API will be retired Tuesday, 10 Oct 2023 00:00:00 GMT.
295
+ * We recommend you replace this API with the batch API, [BatchDetectDominantLanguage](https://docs.cloud.oracle.com/iaas/api/#/en/language/20221001/BatchDetectDominantLanguage/BatchDetectDominantLanguage).
297
296
  * <p>
298
- [List of supported languages.](https://docs.cloud.oracle.com/iaas/language/using/pretrain-models.htm#lang-detect)
297
+ The DetectDominantLanguage API returns the detected language and a related confidence score (between 0 and 1).
298
+ * <p>
299
+ [List of supported languages](https://docs.cloud.oracle.com/iaas/language/using/pretrain-models.htm#lang-detect)
299
300
  * <p>
300
301
  Limitations:
301
302
  * - A record may be up to 1000 characters long.
@@ -304,12 +305,14 @@ export declare class AIServiceLanguageClient {
304
305
  * @param DetectDominantLanguageRequest
305
306
  * @return DetectDominantLanguageResponse
306
307
  * @throws OciError when an error occurs
307
- * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.79.0/ailanguage/DetectDominantLanguage.ts.html |here} to see how to use DetectDominantLanguage API.
308
+ * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.80.0/ailanguage/DetectDominantLanguage.ts.html |here} to see how to use DetectDominantLanguage API.
308
309
  */
309
310
  detectDominantLanguage(detectDominantLanguageRequest: requests.DetectDominantLanguageRequest): Promise<responses.DetectDominantLanguageResponse>;
310
311
  /**
311
- * This API will be retired on Monday, 10 Oct 2023 00:00:00 GMT
312
- * The API extracts entities in text records. For each entity, its type and confidence score (between 0 and 1) is returned.
312
+ * **Deprecated**: This API will be retired Tuesday, 10 Oct 2023 00:00:00 GMT.
313
+ * We recommend you replace this API with the batch API, [BatchDetectLanguageEntities](https://docs.cloud.oracle.com/iaas/api/#/en/language/20221001/BatchDetectLanguageEntities/BatchDetectLanguageEntities).
314
+ * <p>
315
+ The DetectLanguageEntities API extracts entities in text records. For each entity, its type and confidence score (between 0 and 1) is returned.
313
316
  * <p>
314
317
  Limitations:
315
318
  * - A text may be up to 1000 characters long.
@@ -318,26 +321,29 @@ export declare class AIServiceLanguageClient {
318
321
  * @param DetectLanguageEntitiesRequest
319
322
  * @return DetectLanguageEntitiesResponse
320
323
  * @throws OciError when an error occurs
321
- * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.79.0/ailanguage/DetectLanguageEntities.ts.html |here} to see how to use DetectLanguageEntities API.
324
+ * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.80.0/ailanguage/DetectLanguageEntities.ts.html |here} to see how to use DetectLanguageEntities API.
322
325
  */
323
326
  detectLanguageEntities(detectLanguageEntitiesRequest: requests.DetectLanguageEntitiesRequest): Promise<responses.DetectLanguageEntitiesResponse>;
324
327
  /**
325
- * This API will be retired on Monday, 10 Oct 2023 00:00:00 GMT
326
- * The API extracts key-phrases in text records. For each key-phrase, a score (between 0 and 1) is returned that highlights the importance of the key-phrase in the context of the text.
328
+ * **Deprecated**: This API will be retired Tuesday, 10 Oct 2023 00:00:00 GMT.
329
+ * We recommend you replace this API with the batch API, [BatchDetectLanguageKeyPhrases](https://docs.cloud.oracle.com/iaas/api/#/en/language/20221001/BatchDetectLanguageKeyPhrases/BatchDetectLanguageKeyPhrases).
327
330
  * <p>
328
- Limitations:
331
+ The DetectLanguageKeyPhrases API extracts key-phrases in text records. For each key-phrase, a score (between 0 and 1) is returned that highlights the importance of the key-phrase in the context of the text.
332
+ * Limitations:
329
333
  * - A record may be up to 1000 characters long.
330
334
  *
331
335
  * This operation does not retry by default if the user has not defined a retry configuration.
332
336
  * @param DetectLanguageKeyPhrasesRequest
333
337
  * @return DetectLanguageKeyPhrasesResponse
334
338
  * @throws OciError when an error occurs
335
- * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.79.0/ailanguage/DetectLanguageKeyPhrases.ts.html |here} to see how to use DetectLanguageKeyPhrases API.
339
+ * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.80.0/ailanguage/DetectLanguageKeyPhrases.ts.html |here} to see how to use DetectLanguageKeyPhrases API.
336
340
  */
337
341
  detectLanguageKeyPhrases(detectLanguageKeyPhrasesRequest: requests.DetectLanguageKeyPhrasesRequest): Promise<responses.DetectLanguageKeyPhrasesResponse>;
338
342
  /**
339
- * This API will be retired on Monday, 10 Oct 2023 00:00:00 GMT
340
- * The API extracts aspect-based in text records.
343
+ * **Deprecated**: This API will be retired Tuesday, 10 Oct 2023 00:00:00 GMT.
344
+ * We recommend you replace this API with the batch API, [BatchDetectLanguageSentiments](https://docs.cloud.oracle.com/iaas/api/#/en/language/20221001/BatchDetectLanguageSentiments/BatchDetectLanguageSentiments).
345
+ * <p>
346
+ The DetectLanguageSentiments API extracts aspect-based in text records.
341
347
  * <p>
342
348
  For aspect-based sentiment analysis, a set of aspects and their respective sentiment is returned.
343
349
  * <p>
@@ -352,12 +358,14 @@ export declare class AIServiceLanguageClient {
352
358
  * @param DetectLanguageSentimentsRequest
353
359
  * @return DetectLanguageSentimentsResponse
354
360
  * @throws OciError when an error occurs
355
- * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.79.0/ailanguage/DetectLanguageSentiments.ts.html |here} to see how to use DetectLanguageSentiments API.
361
+ * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.80.0/ailanguage/DetectLanguageSentiments.ts.html |here} to see how to use DetectLanguageSentiments API.
356
362
  */
357
363
  detectLanguageSentiments(detectLanguageSentimentsRequest: requests.DetectLanguageSentimentsRequest): Promise<responses.DetectLanguageSentimentsResponse>;
358
364
  /**
359
- * This API will be retired on Monday, 10 Oct 2023 00:00:00 GMT
360
- * The API automatically classifies text into a set of pre-determined classes and sub-classes. A single class/subclass is returned for each record classified.
365
+ * **Deprecated**: This API will be retired Tuesday, 10 Oct 2023 00:00:00 GMT.
366
+ * We recommend you replace this API with the batch API, [BatchDetectLanguageTextClassification](https://docs.cloud.oracle.com/iaas/api/#/en/language/20221001/BatchDetectLanguageTextClassification/BatchDetectLanguageTextClassification).
367
+ * <p>
368
+ The DetectLanguageTextClassification API automatically classifies text into a set of pre-determined classes and sub-classes. A single class/subclass is returned for each record classified.
361
369
  * <p>
362
370
  Learn more about text classification [here](https://docs.cloud.oracle.com/iaas/language/using/pretrain-models.htm#text-class).
363
371
  * <p>
@@ -368,7 +376,7 @@ export declare class AIServiceLanguageClient {
368
376
  * @param DetectLanguageTextClassificationRequest
369
377
  * @return DetectLanguageTextClassificationResponse
370
378
  * @throws OciError when an error occurs
371
- * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.79.0/ailanguage/DetectLanguageTextClassification.ts.html |here} to see how to use DetectLanguageTextClassification API.
379
+ * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.80.0/ailanguage/DetectLanguageTextClassification.ts.html |here} to see how to use DetectLanguageTextClassification API.
372
380
  */
373
381
  detectLanguageTextClassification(detectLanguageTextClassificationRequest: requests.DetectLanguageTextClassificationRequest): Promise<responses.DetectLanguageTextClassificationResponse>;
374
382
  /**
@@ -377,7 +385,7 @@ export declare class AIServiceLanguageClient {
377
385
  * @param GetEndpointRequest
378
386
  * @return GetEndpointResponse
379
387
  * @throws OciError when an error occurs
380
- * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.79.0/ailanguage/GetEndpoint.ts.html |here} to see how to use GetEndpoint API.
388
+ * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.80.0/ailanguage/GetEndpoint.ts.html |here} to see how to use GetEndpoint API.
381
389
  */
382
390
  getEndpoint(getEndpointRequest: requests.GetEndpointRequest): Promise<responses.GetEndpointResponse>;
383
391
  /**
@@ -386,7 +394,7 @@ export declare class AIServiceLanguageClient {
386
394
  * @param GetModelRequest
387
395
  * @return GetModelResponse
388
396
  * @throws OciError when an error occurs
389
- * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.79.0/ailanguage/GetModel.ts.html |here} to see how to use GetModel API.
397
+ * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.80.0/ailanguage/GetModel.ts.html |here} to see how to use GetModel API.
390
398
  */
391
399
  getModel(getModelRequest: requests.GetModelRequest): Promise<responses.GetModelResponse>;
392
400
  /**
@@ -395,7 +403,7 @@ export declare class AIServiceLanguageClient {
395
403
  * @param GetModelTypeRequest
396
404
  * @return GetModelTypeResponse
397
405
  * @throws OciError when an error occurs
398
- * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.79.0/ailanguage/GetModelType.ts.html |here} to see how to use GetModelType API.
406
+ * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.80.0/ailanguage/GetModelType.ts.html |here} to see how to use GetModelType API.
399
407
  */
400
408
  getModelType(getModelTypeRequest: requests.GetModelTypeRequest): Promise<responses.GetModelTypeResponse>;
401
409
  /**
@@ -404,7 +412,7 @@ export declare class AIServiceLanguageClient {
404
412
  * @param GetProjectRequest
405
413
  * @return GetProjectResponse
406
414
  * @throws OciError when an error occurs
407
- * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.79.0/ailanguage/GetProject.ts.html |here} to see how to use GetProject API.
415
+ * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.80.0/ailanguage/GetProject.ts.html |here} to see how to use GetProject API.
408
416
  */
409
417
  getProject(getProjectRequest: requests.GetProjectRequest): Promise<responses.GetProjectResponse>;
410
418
  /**
@@ -413,7 +421,7 @@ export declare class AIServiceLanguageClient {
413
421
  * @param GetWorkRequestRequest
414
422
  * @return GetWorkRequestResponse
415
423
  * @throws OciError when an error occurs
416
- * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.79.0/ailanguage/GetWorkRequest.ts.html |here} to see how to use GetWorkRequest API.
424
+ * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.80.0/ailanguage/GetWorkRequest.ts.html |here} to see how to use GetWorkRequest API.
417
425
  */
418
426
  getWorkRequest(getWorkRequestRequest: requests.GetWorkRequestRequest): Promise<responses.GetWorkRequestResponse>;
419
427
  /**
@@ -423,7 +431,7 @@ export declare class AIServiceLanguageClient {
423
431
  * @param ListEndpointsRequest
424
432
  * @return ListEndpointsResponse
425
433
  * @throws OciError when an error occurs
426
- * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.79.0/ailanguage/ListEndpoints.ts.html |here} to see how to use ListEndpoints API.
434
+ * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.80.0/ailanguage/ListEndpoints.ts.html |here} to see how to use ListEndpoints API.
427
435
  */
428
436
  listEndpoints(listEndpointsRequest: requests.ListEndpointsRequest): Promise<responses.ListEndpointsResponse>;
429
437
  /**
@@ -432,7 +440,7 @@ export declare class AIServiceLanguageClient {
432
440
  * @param ListEvaluationResultsRequest
433
441
  * @return ListEvaluationResultsResponse
434
442
  * @throws OciError when an error occurs
435
- * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.79.0/ailanguage/ListEvaluationResults.ts.html |here} to see how to use ListEvaluationResults API.
443
+ * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.80.0/ailanguage/ListEvaluationResults.ts.html |here} to see how to use ListEvaluationResults API.
436
444
  */
437
445
  listEvaluationResults(listEvaluationResultsRequest: requests.ListEvaluationResultsRequest): Promise<responses.ListEvaluationResultsResponse>;
438
446
  /**
@@ -442,7 +450,7 @@ export declare class AIServiceLanguageClient {
442
450
  * @param ListModelsRequest
443
451
  * @return ListModelsResponse
444
452
  * @throws OciError when an error occurs
445
- * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.79.0/ailanguage/ListModels.ts.html |here} to see how to use ListModels API.
453
+ * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.80.0/ailanguage/ListModels.ts.html |here} to see how to use ListModels API.
446
454
  */
447
455
  listModels(listModelsRequest: requests.ListModelsRequest): Promise<responses.ListModelsResponse>;
448
456
  /**
@@ -452,7 +460,7 @@ export declare class AIServiceLanguageClient {
452
460
  * @param ListProjectsRequest
453
461
  * @return ListProjectsResponse
454
462
  * @throws OciError when an error occurs
455
- * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.79.0/ailanguage/ListProjects.ts.html |here} to see how to use ListProjects API.
463
+ * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.80.0/ailanguage/ListProjects.ts.html |here} to see how to use ListProjects API.
456
464
  */
457
465
  listProjects(listProjectsRequest: requests.ListProjectsRequest): Promise<responses.ListProjectsResponse>;
458
466
  /**
@@ -462,7 +470,7 @@ export declare class AIServiceLanguageClient {
462
470
  * @param ListWorkRequestErrorsRequest
463
471
  * @return ListWorkRequestErrorsResponse
464
472
  * @throws OciError when an error occurs
465
- * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.79.0/ailanguage/ListWorkRequestErrors.ts.html |here} to see how to use ListWorkRequestErrors API.
473
+ * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.80.0/ailanguage/ListWorkRequestErrors.ts.html |here} to see how to use ListWorkRequestErrors API.
466
474
  */
467
475
  listWorkRequestErrors(listWorkRequestErrorsRequest: requests.ListWorkRequestErrorsRequest): Promise<responses.ListWorkRequestErrorsResponse>;
468
476
  /**
@@ -472,7 +480,7 @@ export declare class AIServiceLanguageClient {
472
480
  * @param ListWorkRequestLogsRequest
473
481
  * @return ListWorkRequestLogsResponse
474
482
  * @throws OciError when an error occurs
475
- * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.79.0/ailanguage/ListWorkRequestLogs.ts.html |here} to see how to use ListWorkRequestLogs API.
483
+ * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.80.0/ailanguage/ListWorkRequestLogs.ts.html |here} to see how to use ListWorkRequestLogs API.
476
484
  */
477
485
  listWorkRequestLogs(listWorkRequestLogsRequest: requests.ListWorkRequestLogsRequest): Promise<responses.ListWorkRequestLogsResponse>;
478
486
  /**
@@ -482,7 +490,7 @@ export declare class AIServiceLanguageClient {
482
490
  * @param ListWorkRequestsRequest
483
491
  * @return ListWorkRequestsResponse
484
492
  * @throws OciError when an error occurs
485
- * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.79.0/ailanguage/ListWorkRequests.ts.html |here} to see how to use ListWorkRequests API.
493
+ * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.80.0/ailanguage/ListWorkRequests.ts.html |here} to see how to use ListWorkRequests API.
486
494
  */
487
495
  listWorkRequests(listWorkRequestsRequest: requests.ListWorkRequestsRequest): Promise<responses.ListWorkRequestsResponse>;
488
496
  /**
@@ -491,7 +499,7 @@ export declare class AIServiceLanguageClient {
491
499
  * @param UpdateEndpointRequest
492
500
  * @return UpdateEndpointResponse
493
501
  * @throws OciError when an error occurs
494
- * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.79.0/ailanguage/UpdateEndpoint.ts.html |here} to see how to use UpdateEndpoint API.
502
+ * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.80.0/ailanguage/UpdateEndpoint.ts.html |here} to see how to use UpdateEndpoint API.
495
503
  */
496
504
  updateEndpoint(updateEndpointRequest: requests.UpdateEndpointRequest): Promise<responses.UpdateEndpointResponse>;
497
505
  /**
@@ -500,7 +508,7 @@ export declare class AIServiceLanguageClient {
500
508
  * @param UpdateModelRequest
501
509
  * @return UpdateModelResponse
502
510
  * @throws OciError when an error occurs
503
- * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.79.0/ailanguage/UpdateModel.ts.html |here} to see how to use UpdateModel API.
511
+ * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.80.0/ailanguage/UpdateModel.ts.html |here} to see how to use UpdateModel API.
504
512
  */
505
513
  updateModel(updateModelRequest: requests.UpdateModelRequest): Promise<responses.UpdateModelResponse>;
506
514
  /**
@@ -509,7 +517,7 @@ export declare class AIServiceLanguageClient {
509
517
  * @param UpdateProjectRequest
510
518
  * @return UpdateProjectResponse
511
519
  * @throws OciError when an error occurs
512
- * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.79.0/ailanguage/UpdateProject.ts.html |here} to see how to use UpdateProject API.
520
+ * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.80.0/ailanguage/UpdateProject.ts.html |here} to see how to use UpdateProject API.
513
521
  */
514
522
  updateProject(updateProjectRequest: requests.UpdateProjectRequest): Promise<responses.UpdateProjectResponse>;
515
523
  }