oci-ailanguage 2.50.2 → 2.50.3

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 (79) hide show
  1. package/lib/client.d.ts +70 -40
  2. package/lib/client.js +118 -40
  3. package/lib/client.js.map +1 -1
  4. package/lib/model/batch-detect-language-pii-entities-details.d.ts +39 -0
  5. package/lib/model/batch-detect-language-pii-entities-details.js +71 -0
  6. package/lib/model/batch-detect-language-pii-entities-details.js.map +1 -0
  7. package/lib/model/batch-detect-language-pii-entities-result.d.ts +33 -0
  8. package/lib/model/batch-detect-language-pii-entities-result.js +74 -0
  9. package/lib/model/batch-detect-language-pii-entities-result.js.map +1 -0
  10. package/lib/model/index.d.ts +16 -0
  11. package/lib/model/index.js +19 -2
  12. package/lib/model/index.js.map +1 -1
  13. package/lib/model/pii-entity-document-result.d.ts +41 -0
  14. package/lib/model/pii-entity-document-result.js +64 -0
  15. package/lib/model/pii-entity-document-result.js.map +1 -0
  16. package/lib/model/pii-entity-mask.d.ts +42 -0
  17. package/lib/model/pii-entity-mask.js +55 -0
  18. package/lib/model/pii-entity-mask.js.map +1 -0
  19. package/lib/model/pii-entity-masking.d.ts +25 -0
  20. package/lib/model/pii-entity-masking.js +79 -0
  21. package/lib/model/pii-entity-masking.js.map +1 -0
  22. package/lib/model/pii-entity-remove.d.ts +27 -0
  23. package/lib/model/pii-entity-remove.js +55 -0
  24. package/lib/model/pii-entity-remove.js.map +1 -0
  25. package/lib/model/pii-entity-replace.d.ts +31 -0
  26. package/lib/model/pii-entity-replace.js +55 -0
  27. package/lib/model/pii-entity-replace.js.map +1 -0
  28. package/lib/model/pii-entity.d.ts +44 -0
  29. package/lib/model/pii-entity.js +32 -0
  30. package/lib/model/pii-entity.js.map +1 -0
  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 +28 -0
  35. package/lib/request/batch-detect-language-pii-entities-request.js +15 -0
  36. package/lib/request/batch-detect-language-pii-entities-request.js.map +1 -0
  37. package/lib/request/batch-detect-language-sentiments-request.d.ts +1 -1
  38. package/lib/request/batch-detect-language-text-classification-request.d.ts +1 -1
  39. package/lib/request/batch-language-translation-request.d.ts +1 -1
  40. package/lib/request/change-endpoint-compartment-request.d.ts +1 -1
  41. package/lib/request/change-model-compartment-request.d.ts +1 -1
  42. package/lib/request/change-project-compartment-request.d.ts +1 -1
  43. package/lib/request/create-endpoint-request.d.ts +1 -1
  44. package/lib/request/create-model-request.d.ts +1 -1
  45. package/lib/request/create-project-request.d.ts +1 -1
  46. package/lib/request/delete-endpoint-request.d.ts +1 -1
  47. package/lib/request/delete-model-request.d.ts +1 -1
  48. package/lib/request/delete-project-request.d.ts +1 -1
  49. package/lib/request/detect-dominant-language-request.d.ts +1 -1
  50. package/lib/request/detect-language-entities-request.d.ts +1 -1
  51. package/lib/request/detect-language-key-phrases-request.d.ts +1 -1
  52. package/lib/request/detect-language-sentiments-request.d.ts +1 -1
  53. package/lib/request/detect-language-text-classification-request.d.ts +1 -1
  54. package/lib/request/get-endpoint-request.d.ts +1 -1
  55. package/lib/request/get-model-request.d.ts +1 -1
  56. package/lib/request/get-project-request.d.ts +1 -1
  57. package/lib/request/get-work-request-request.d.ts +1 -1
  58. package/lib/request/index.d.ts +2 -0
  59. package/lib/request/index.js.map +1 -1
  60. package/lib/request/list-endpoints-request.d.ts +1 -1
  61. package/lib/request/list-evaluation-results-request.d.ts +1 -1
  62. package/lib/request/list-models-request.d.ts +1 -1
  63. package/lib/request/list-projects-request.d.ts +1 -1
  64. package/lib/request/list-work-request-errors-request.d.ts +1 -1
  65. package/lib/request/list-work-request-logs-request.d.ts +1 -1
  66. package/lib/request/list-work-requests-request.d.ts +1 -1
  67. package/lib/request/update-endpoint-request.d.ts +1 -1
  68. package/lib/request/update-model-request.d.ts +1 -1
  69. package/lib/request/update-project-request.d.ts +1 -1
  70. package/lib/response/batch-detect-language-pii-entities-response.d.ts +25 -0
  71. package/lib/response/batch-detect-language-pii-entities-response.js +15 -0
  72. package/lib/response/batch-detect-language-pii-entities-response.js.map +1 -0
  73. package/lib/response/detect-dominant-language-response.d.ts +1 -1
  74. package/lib/response/detect-language-entities-response.d.ts +1 -1
  75. package/lib/response/detect-language-key-phrases-response.d.ts +1 -1
  76. package/lib/response/detect-language-sentiments-response.d.ts +1 -1
  77. package/lib/response/detect-language-text-classification-response.d.ts +1 -1
  78. package/lib/response/index.d.ts +2 -0
  79. package/package.json +3 -3
package/lib/client.d.ts CHANGED
@@ -86,7 +86,7 @@ export declare class AIServiceLanguageClient {
86
86
  * @param BatchDetectDominantLanguageRequest
87
87
  * @return BatchDetectDominantLanguageResponse
88
88
  * @throws OciError when an error occurs
89
- * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.50.2/ailanguage/BatchDetectDominantLanguage.ts.html |here} to see how to use BatchDetectDominantLanguage API.
89
+ * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.50.3/ailanguage/BatchDetectDominantLanguage.ts.html |here} to see how to use BatchDetectDominantLanguage API.
90
90
  */
91
91
  batchDetectDominantLanguage(batchDetectDominantLanguageRequest: requests.BatchDetectDominantLanguageRequest): Promise<responses.BatchDetectDominantLanguageResponse>;
92
92
  /**
@@ -103,7 +103,7 @@ export declare class AIServiceLanguageClient {
103
103
  * @param BatchDetectLanguageEntitiesRequest
104
104
  * @return BatchDetectLanguageEntitiesResponse
105
105
  * @throws OciError when an error occurs
106
- * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.50.2/ailanguage/BatchDetectLanguageEntities.ts.html |here} to see how to use BatchDetectLanguageEntities API.
106
+ * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.50.3/ailanguage/BatchDetectLanguageEntities.ts.html |here} to see how to use BatchDetectLanguageEntities API.
107
107
  */
108
108
  batchDetectLanguageEntities(batchDetectLanguageEntitiesRequest: requests.BatchDetectLanguageEntitiesRequest): Promise<responses.BatchDetectLanguageEntitiesResponse>;
109
109
  /**
@@ -118,9 +118,24 @@ export declare class AIServiceLanguageClient {
118
118
  * @param BatchDetectLanguageKeyPhrasesRequest
119
119
  * @return BatchDetectLanguageKeyPhrasesResponse
120
120
  * @throws OciError when an error occurs
121
- * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.50.2/ailanguage/BatchDetectLanguageKeyPhrases.ts.html |here} to see how to use BatchDetectLanguageKeyPhrases API.
121
+ * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.50.3/ailanguage/BatchDetectLanguageKeyPhrases.ts.html |here} to see how to use BatchDetectLanguageKeyPhrases API.
122
122
  */
123
123
  batchDetectLanguageKeyPhrases(batchDetectLanguageKeyPhrasesRequest: requests.BatchDetectLanguageKeyPhrasesRequest): Promise<responses.BatchDetectLanguageKeyPhrasesResponse>;
124
+ /**
125
+ * The API extracts pii entities in text records. For each entity, its type and confidence score (between 0 and 1) is returned. It supports passing a batch of records.
126
+ * <p>
127
+ Limitations:
128
+ * - A batch may have up to 100 records.
129
+ * - A record may be up to 5000 characters long.
130
+ * - The total of characters to process in a request can be up to 20,000 characters.
131
+ *
132
+ * This operation does not retry by default if the user has not defined a retry configuration.
133
+ * @param BatchDetectLanguagePiiEntitiesRequest
134
+ * @return BatchDetectLanguagePiiEntitiesResponse
135
+ * @throws OciError when an error occurs
136
+ * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.50.3/ailanguage/BatchDetectLanguagePiiEntities.ts.html |here} to see how to use BatchDetectLanguagePiiEntities API.
137
+ */
138
+ batchDetectLanguagePiiEntities(batchDetectLanguagePiiEntitiesRequest: requests.BatchDetectLanguagePiiEntitiesRequest): Promise<responses.BatchDetectLanguagePiiEntitiesResponse>;
124
139
  /**
125
140
  * The API extracts aspect-based and sentence level sentiment in text records.
126
141
  * <p>
@@ -139,7 +154,7 @@ export declare class AIServiceLanguageClient {
139
154
  * @param BatchDetectLanguageSentimentsRequest
140
155
  * @return BatchDetectLanguageSentimentsResponse
141
156
  * @throws OciError when an error occurs
142
- * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.50.2/ailanguage/BatchDetectLanguageSentiments.ts.html |here} to see how to use BatchDetectLanguageSentiments API.
157
+ * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.50.3/ailanguage/BatchDetectLanguageSentiments.ts.html |here} to see how to use BatchDetectLanguageSentiments API.
143
158
  */
144
159
  batchDetectLanguageSentiments(batchDetectLanguageSentimentsRequest: requests.BatchDetectLanguageSentimentsRequest): Promise<responses.BatchDetectLanguageSentimentsResponse>;
145
160
  /**
@@ -158,7 +173,7 @@ export declare class AIServiceLanguageClient {
158
173
  * @param BatchDetectLanguageTextClassificationRequest
159
174
  * @return BatchDetectLanguageTextClassificationResponse
160
175
  * @throws OciError when an error occurs
161
- * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.50.2/ailanguage/BatchDetectLanguageTextClassification.ts.html |here} to see how to use BatchDetectLanguageTextClassification API.
176
+ * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.50.3/ailanguage/BatchDetectLanguageTextClassification.ts.html |here} to see how to use BatchDetectLanguageTextClassification API.
162
177
  */
163
178
  batchDetectLanguageTextClassification(batchDetectLanguageTextClassificationRequest: requests.BatchDetectLanguageTextClassificationRequest): Promise<responses.BatchDetectLanguageTextClassificationResponse>;
164
179
  /**
@@ -173,7 +188,7 @@ export declare class AIServiceLanguageClient {
173
188
  * @param BatchLanguageTranslationRequest
174
189
  * @return BatchLanguageTranslationResponse
175
190
  * @throws OciError when an error occurs
176
- * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.50.2/ailanguage/BatchLanguageTranslation.ts.html |here} to see how to use BatchLanguageTranslation API.
191
+ * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.50.3/ailanguage/BatchLanguageTranslation.ts.html |here} to see how to use BatchLanguageTranslation API.
177
192
  */
178
193
  batchLanguageTranslation(batchLanguageTranslationRequest: requests.BatchLanguageTranslationRequest): Promise<responses.BatchLanguageTranslationResponse>;
179
194
  /**
@@ -182,7 +197,7 @@ export declare class AIServiceLanguageClient {
182
197
  * @param ChangeEndpointCompartmentRequest
183
198
  * @return ChangeEndpointCompartmentResponse
184
199
  * @throws OciError when an error occurs
185
- * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.50.2/ailanguage/ChangeEndpointCompartment.ts.html |here} to see how to use ChangeEndpointCompartment API.
200
+ * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.50.3/ailanguage/ChangeEndpointCompartment.ts.html |here} to see how to use ChangeEndpointCompartment API.
186
201
  */
187
202
  changeEndpointCompartment(changeEndpointCompartmentRequest: requests.ChangeEndpointCompartmentRequest): Promise<responses.ChangeEndpointCompartmentResponse>;
188
203
  /**
@@ -191,7 +206,7 @@ export declare class AIServiceLanguageClient {
191
206
  * @param ChangeModelCompartmentRequest
192
207
  * @return ChangeModelCompartmentResponse
193
208
  * @throws OciError when an error occurs
194
- * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.50.2/ailanguage/ChangeModelCompartment.ts.html |here} to see how to use ChangeModelCompartment API.
209
+ * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.50.3/ailanguage/ChangeModelCompartment.ts.html |here} to see how to use ChangeModelCompartment API.
195
210
  */
196
211
  changeModelCompartment(changeModelCompartmentRequest: requests.ChangeModelCompartmentRequest): Promise<responses.ChangeModelCompartmentResponse>;
197
212
  /**
@@ -200,7 +215,7 @@ export declare class AIServiceLanguageClient {
200
215
  * @param ChangeProjectCompartmentRequest
201
216
  * @return ChangeProjectCompartmentResponse
202
217
  * @throws OciError when an error occurs
203
- * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.50.2/ailanguage/ChangeProjectCompartment.ts.html |here} to see how to use ChangeProjectCompartment API.
218
+ * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.50.3/ailanguage/ChangeProjectCompartment.ts.html |here} to see how to use ChangeProjectCompartment API.
204
219
  */
205
220
  changeProjectCompartment(changeProjectCompartmentRequest: requests.ChangeProjectCompartmentRequest): Promise<responses.ChangeProjectCompartmentResponse>;
206
221
  /**
@@ -210,7 +225,7 @@ export declare class AIServiceLanguageClient {
210
225
  * @param CreateEndpointRequest
211
226
  * @return CreateEndpointResponse
212
227
  * @throws OciError when an error occurs
213
- * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.50.2/ailanguage/CreateEndpoint.ts.html |here} to see how to use CreateEndpoint API.
228
+ * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.50.3/ailanguage/CreateEndpoint.ts.html |here} to see how to use CreateEndpoint API.
214
229
  */
215
230
  createEndpoint(createEndpointRequest: requests.CreateEndpointRequest): Promise<responses.CreateEndpointResponse>;
216
231
  /**
@@ -220,7 +235,7 @@ export declare class AIServiceLanguageClient {
220
235
  * @param CreateModelRequest
221
236
  * @return CreateModelResponse
222
237
  * @throws OciError when an error occurs
223
- * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.50.2/ailanguage/CreateModel.ts.html |here} to see how to use CreateModel API.
238
+ * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.50.3/ailanguage/CreateModel.ts.html |here} to see how to use CreateModel API.
224
239
  */
225
240
  createModel(createModelRequest: requests.CreateModelRequest): Promise<responses.CreateModelResponse>;
226
241
  /**
@@ -230,7 +245,7 @@ export declare class AIServiceLanguageClient {
230
245
  * @param CreateProjectRequest
231
246
  * @return CreateProjectResponse
232
247
  * @throws OciError when an error occurs
233
- * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.50.2/ailanguage/CreateProject.ts.html |here} to see how to use CreateProject API.
248
+ * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.50.3/ailanguage/CreateProject.ts.html |here} to see how to use CreateProject API.
234
249
  */
235
250
  createProject(createProjectRequest: requests.CreateProjectRequest): Promise<responses.CreateProjectResponse>;
236
251
  /**
@@ -239,7 +254,7 @@ export declare class AIServiceLanguageClient {
239
254
  * @param DeleteEndpointRequest
240
255
  * @return DeleteEndpointResponse
241
256
  * @throws OciError when an error occurs
242
- * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.50.2/ailanguage/DeleteEndpoint.ts.html |here} to see how to use DeleteEndpoint API.
257
+ * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.50.3/ailanguage/DeleteEndpoint.ts.html |here} to see how to use DeleteEndpoint API.
243
258
  */
244
259
  deleteEndpoint(deleteEndpointRequest: requests.DeleteEndpointRequest): Promise<responses.DeleteEndpointResponse>;
245
260
  /**
@@ -248,7 +263,7 @@ export declare class AIServiceLanguageClient {
248
263
  * @param DeleteModelRequest
249
264
  * @return DeleteModelResponse
250
265
  * @throws OciError when an error occurs
251
- * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.50.2/ailanguage/DeleteModel.ts.html |here} to see how to use DeleteModel API.
266
+ * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.50.3/ailanguage/DeleteModel.ts.html |here} to see how to use DeleteModel API.
252
267
  */
253
268
  deleteModel(deleteModelRequest: requests.DeleteModelRequest): Promise<responses.DeleteModelResponse>;
254
269
  /**
@@ -257,13 +272,16 @@ export declare class AIServiceLanguageClient {
257
272
  * @param DeleteProjectRequest
258
273
  * @return DeleteProjectResponse
259
274
  * @throws OciError when an error occurs
260
- * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.50.2/ailanguage/DeleteProject.ts.html |here} to see how to use DeleteProject API.
275
+ * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.50.3/ailanguage/DeleteProject.ts.html |here} to see how to use DeleteProject API.
261
276
  */
262
277
  deleteProject(deleteProjectRequest: requests.DeleteProjectRequest): Promise<responses.DeleteProjectResponse>;
263
278
  /**
264
- * The API returns the detected language and a related confidence score (between 0 and 1).
279
+ * **Deprecated**: This API will be retired Tuesday, 10 Oct 2023 00:00:00 GMT.
280
+ * We recommend you replace this API with the batch API, [BatchDetectDominantLanguage](https://docs.cloud.oracle.com/iaas/api/#/en/language/20221001/BatchDetectDominantLanguage/BatchDetectDominantLanguage).
265
281
  * <p>
266
- [List of supported languages.](https://docs.cloud.oracle.com/iaas/language/using/pretrain-models.htm#lang-detect)
282
+ The DetectDominantLanguage API returns the detected language and a related confidence score (between 0 and 1).
283
+ * <p>
284
+ [List of supported languages](https://docs.cloud.oracle.com/iaas/language/using/pretrain-models.htm#lang-detect)
267
285
  * <p>
268
286
  Limitations:
269
287
  * - A record may be up to 1000 characters long.
@@ -272,11 +290,14 @@ export declare class AIServiceLanguageClient {
272
290
  * @param DetectDominantLanguageRequest
273
291
  * @return DetectDominantLanguageResponse
274
292
  * @throws OciError when an error occurs
275
- * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.50.2/ailanguage/DetectDominantLanguage.ts.html |here} to see how to use DetectDominantLanguage API.
293
+ * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.50.3/ailanguage/DetectDominantLanguage.ts.html |here} to see how to use DetectDominantLanguage API.
276
294
  */
277
295
  detectDominantLanguage(detectDominantLanguageRequest: requests.DetectDominantLanguageRequest): Promise<responses.DetectDominantLanguageResponse>;
278
296
  /**
279
- * The API extracts entities in text records. For each entity, its type and confidence score (between 0 and 1) is returned.
297
+ * **Deprecated**: This API will be retired Tuesday, 10 Oct 2023 00:00:00 GMT.
298
+ * We recommend you replace this API with the batch API, [BatchDetectLanguageEntities](https://docs.cloud.oracle.com/iaas/api/#/en/language/20221001/BatchDetectLanguageEntities/BatchDetectLanguageEntities).
299
+ * <p>
300
+ The DetectLanguageEntities API extracts entities in text records. For each entity, its type and confidence score (between 0 and 1) is returned.
280
301
  * <p>
281
302
  Limitations:
282
303
  * - A text may be up to 1000 characters long.
@@ -285,11 +306,14 @@ export declare class AIServiceLanguageClient {
285
306
  * @param DetectLanguageEntitiesRequest
286
307
  * @return DetectLanguageEntitiesResponse
287
308
  * @throws OciError when an error occurs
288
- * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.50.2/ailanguage/DetectLanguageEntities.ts.html |here} to see how to use DetectLanguageEntities API.
309
+ * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.50.3/ailanguage/DetectLanguageEntities.ts.html |here} to see how to use DetectLanguageEntities API.
289
310
  */
290
311
  detectLanguageEntities(detectLanguageEntitiesRequest: requests.DetectLanguageEntitiesRequest): Promise<responses.DetectLanguageEntitiesResponse>;
291
312
  /**
292
- * 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.
313
+ * **Deprecated**: This API will be retired Tuesday, 10 Oct 2023 00:00:00 GMT.
314
+ * We recommend you replace this API with the batch API, [BatchDetectLanguageKeyPhrases](https://docs.cloud.oracle.com/iaas/api/#/en/language/20221001/BatchDetectLanguageKeyPhrases/BatchDetectLanguageKeyPhrases).
315
+ * <p>
316
+ 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.
293
317
  * <p>
294
318
  Limitations:
295
319
  * - A record may be up to 1000 characters long.
@@ -298,11 +322,14 @@ export declare class AIServiceLanguageClient {
298
322
  * @param DetectLanguageKeyPhrasesRequest
299
323
  * @return DetectLanguageKeyPhrasesResponse
300
324
  * @throws OciError when an error occurs
301
- * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.50.2/ailanguage/DetectLanguageKeyPhrases.ts.html |here} to see how to use DetectLanguageKeyPhrases API.
325
+ * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.50.3/ailanguage/DetectLanguageKeyPhrases.ts.html |here} to see how to use DetectLanguageKeyPhrases API.
302
326
  */
303
327
  detectLanguageKeyPhrases(detectLanguageKeyPhrasesRequest: requests.DetectLanguageKeyPhrasesRequest): Promise<responses.DetectLanguageKeyPhrasesResponse>;
304
328
  /**
305
- * The API extracts aspect-based in text records.
329
+ * **Deprecated**: This API will be retired Tuesday, 10 Oct 2023 00:00:00 GMT.
330
+ * We recommend you replace this API with the batch API, [BatchDetectLanguageSentiments](https://docs.cloud.oracle.com/iaas/api/#/en/language/20221001/BatchDetectLanguageSentiments/BatchDetectLanguageSentiments).
331
+ * <p>
332
+ The DetectLanguageSentiments API extracts aspect-based in text records.
306
333
  * <p>
307
334
  For aspect-based sentiment analysis, a set of aspects and their respective sentiment is returned.
308
335
  * <p>
@@ -317,11 +344,14 @@ export declare class AIServiceLanguageClient {
317
344
  * @param DetectLanguageSentimentsRequest
318
345
  * @return DetectLanguageSentimentsResponse
319
346
  * @throws OciError when an error occurs
320
- * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.50.2/ailanguage/DetectLanguageSentiments.ts.html |here} to see how to use DetectLanguageSentiments API.
347
+ * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.50.3/ailanguage/DetectLanguageSentiments.ts.html |here} to see how to use DetectLanguageSentiments API.
321
348
  */
322
349
  detectLanguageSentiments(detectLanguageSentimentsRequest: requests.DetectLanguageSentimentsRequest): Promise<responses.DetectLanguageSentimentsResponse>;
323
350
  /**
324
- * 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.
351
+ * **Deprecated**: This API will be retired Tuesday, 10 Oct 2023 00:00:00 GMT.
352
+ * We recommend you replace this API with the batch API, [BatchDetectLanguageTextClassification](https://docs.cloud.oracle.com/iaas/api/#/en/language/20221001/BatchDetectLanguageTextClassification/BatchDetectLanguageTextClassification).
353
+ * <p>
354
+ 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.
325
355
  * <p>
326
356
  Learn more about text classification [here](https://docs.cloud.oracle.com/iaas/language/using/pretrain-models.htm#text-class).
327
357
  * <p>
@@ -332,7 +362,7 @@ export declare class AIServiceLanguageClient {
332
362
  * @param DetectLanguageTextClassificationRequest
333
363
  * @return DetectLanguageTextClassificationResponse
334
364
  * @throws OciError when an error occurs
335
- * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.50.2/ailanguage/DetectLanguageTextClassification.ts.html |here} to see how to use DetectLanguageTextClassification API.
365
+ * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.50.3/ailanguage/DetectLanguageTextClassification.ts.html |here} to see how to use DetectLanguageTextClassification API.
336
366
  */
337
367
  detectLanguageTextClassification(detectLanguageTextClassificationRequest: requests.DetectLanguageTextClassificationRequest): Promise<responses.DetectLanguageTextClassificationResponse>;
338
368
  /**
@@ -341,7 +371,7 @@ export declare class AIServiceLanguageClient {
341
371
  * @param GetEndpointRequest
342
372
  * @return GetEndpointResponse
343
373
  * @throws OciError when an error occurs
344
- * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.50.2/ailanguage/GetEndpoint.ts.html |here} to see how to use GetEndpoint API.
374
+ * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.50.3/ailanguage/GetEndpoint.ts.html |here} to see how to use GetEndpoint API.
345
375
  */
346
376
  getEndpoint(getEndpointRequest: requests.GetEndpointRequest): Promise<responses.GetEndpointResponse>;
347
377
  /**
@@ -350,7 +380,7 @@ export declare class AIServiceLanguageClient {
350
380
  * @param GetModelRequest
351
381
  * @return GetModelResponse
352
382
  * @throws OciError when an error occurs
353
- * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.50.2/ailanguage/GetModel.ts.html |here} to see how to use GetModel API.
383
+ * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.50.3/ailanguage/GetModel.ts.html |here} to see how to use GetModel API.
354
384
  */
355
385
  getModel(getModelRequest: requests.GetModelRequest): Promise<responses.GetModelResponse>;
356
386
  /**
@@ -359,7 +389,7 @@ export declare class AIServiceLanguageClient {
359
389
  * @param GetProjectRequest
360
390
  * @return GetProjectResponse
361
391
  * @throws OciError when an error occurs
362
- * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.50.2/ailanguage/GetProject.ts.html |here} to see how to use GetProject API.
392
+ * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.50.3/ailanguage/GetProject.ts.html |here} to see how to use GetProject API.
363
393
  */
364
394
  getProject(getProjectRequest: requests.GetProjectRequest): Promise<responses.GetProjectResponse>;
365
395
  /**
@@ -368,7 +398,7 @@ export declare class AIServiceLanguageClient {
368
398
  * @param GetWorkRequestRequest
369
399
  * @return GetWorkRequestResponse
370
400
  * @throws OciError when an error occurs
371
- * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.50.2/ailanguage/GetWorkRequest.ts.html |here} to see how to use GetWorkRequest API.
401
+ * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.50.3/ailanguage/GetWorkRequest.ts.html |here} to see how to use GetWorkRequest API.
372
402
  */
373
403
  getWorkRequest(getWorkRequestRequest: requests.GetWorkRequestRequest): Promise<responses.GetWorkRequestResponse>;
374
404
  /**
@@ -378,7 +408,7 @@ export declare class AIServiceLanguageClient {
378
408
  * @param ListEndpointsRequest
379
409
  * @return ListEndpointsResponse
380
410
  * @throws OciError when an error occurs
381
- * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.50.2/ailanguage/ListEndpoints.ts.html |here} to see how to use ListEndpoints API.
411
+ * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.50.3/ailanguage/ListEndpoints.ts.html |here} to see how to use ListEndpoints API.
382
412
  */
383
413
  listEndpoints(listEndpointsRequest: requests.ListEndpointsRequest): Promise<responses.ListEndpointsResponse>;
384
414
  /**
@@ -387,7 +417,7 @@ export declare class AIServiceLanguageClient {
387
417
  * @param ListEvaluationResultsRequest
388
418
  * @return ListEvaluationResultsResponse
389
419
  * @throws OciError when an error occurs
390
- * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.50.2/ailanguage/ListEvaluationResults.ts.html |here} to see how to use ListEvaluationResults API.
420
+ * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.50.3/ailanguage/ListEvaluationResults.ts.html |here} to see how to use ListEvaluationResults API.
391
421
  */
392
422
  listEvaluationResults(listEvaluationResultsRequest: requests.ListEvaluationResultsRequest): Promise<responses.ListEvaluationResultsResponse>;
393
423
  /**
@@ -397,7 +427,7 @@ export declare class AIServiceLanguageClient {
397
427
  * @param ListModelsRequest
398
428
  * @return ListModelsResponse
399
429
  * @throws OciError when an error occurs
400
- * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.50.2/ailanguage/ListModels.ts.html |here} to see how to use ListModels API.
430
+ * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.50.3/ailanguage/ListModels.ts.html |here} to see how to use ListModels API.
401
431
  */
402
432
  listModels(listModelsRequest: requests.ListModelsRequest): Promise<responses.ListModelsResponse>;
403
433
  /**
@@ -407,7 +437,7 @@ export declare class AIServiceLanguageClient {
407
437
  * @param ListProjectsRequest
408
438
  * @return ListProjectsResponse
409
439
  * @throws OciError when an error occurs
410
- * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.50.2/ailanguage/ListProjects.ts.html |here} to see how to use ListProjects API.
440
+ * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.50.3/ailanguage/ListProjects.ts.html |here} to see how to use ListProjects API.
411
441
  */
412
442
  listProjects(listProjectsRequest: requests.ListProjectsRequest): Promise<responses.ListProjectsResponse>;
413
443
  /**
@@ -417,7 +447,7 @@ export declare class AIServiceLanguageClient {
417
447
  * @param ListWorkRequestErrorsRequest
418
448
  * @return ListWorkRequestErrorsResponse
419
449
  * @throws OciError when an error occurs
420
- * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.50.2/ailanguage/ListWorkRequestErrors.ts.html |here} to see how to use ListWorkRequestErrors API.
450
+ * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.50.3/ailanguage/ListWorkRequestErrors.ts.html |here} to see how to use ListWorkRequestErrors API.
421
451
  */
422
452
  listWorkRequestErrors(listWorkRequestErrorsRequest: requests.ListWorkRequestErrorsRequest): Promise<responses.ListWorkRequestErrorsResponse>;
423
453
  /**
@@ -427,7 +457,7 @@ export declare class AIServiceLanguageClient {
427
457
  * @param ListWorkRequestLogsRequest
428
458
  * @return ListWorkRequestLogsResponse
429
459
  * @throws OciError when an error occurs
430
- * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.50.2/ailanguage/ListWorkRequestLogs.ts.html |here} to see how to use ListWorkRequestLogs API.
460
+ * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.50.3/ailanguage/ListWorkRequestLogs.ts.html |here} to see how to use ListWorkRequestLogs API.
431
461
  */
432
462
  listWorkRequestLogs(listWorkRequestLogsRequest: requests.ListWorkRequestLogsRequest): Promise<responses.ListWorkRequestLogsResponse>;
433
463
  /**
@@ -437,7 +467,7 @@ export declare class AIServiceLanguageClient {
437
467
  * @param ListWorkRequestsRequest
438
468
  * @return ListWorkRequestsResponse
439
469
  * @throws OciError when an error occurs
440
- * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.50.2/ailanguage/ListWorkRequests.ts.html |here} to see how to use ListWorkRequests API.
470
+ * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.50.3/ailanguage/ListWorkRequests.ts.html |here} to see how to use ListWorkRequests API.
441
471
  */
442
472
  listWorkRequests(listWorkRequestsRequest: requests.ListWorkRequestsRequest): Promise<responses.ListWorkRequestsResponse>;
443
473
  /**
@@ -446,7 +476,7 @@ export declare class AIServiceLanguageClient {
446
476
  * @param UpdateEndpointRequest
447
477
  * @return UpdateEndpointResponse
448
478
  * @throws OciError when an error occurs
449
- * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.50.2/ailanguage/UpdateEndpoint.ts.html |here} to see how to use UpdateEndpoint API.
479
+ * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.50.3/ailanguage/UpdateEndpoint.ts.html |here} to see how to use UpdateEndpoint API.
450
480
  */
451
481
  updateEndpoint(updateEndpointRequest: requests.UpdateEndpointRequest): Promise<responses.UpdateEndpointResponse>;
452
482
  /**
@@ -455,7 +485,7 @@ export declare class AIServiceLanguageClient {
455
485
  * @param UpdateModelRequest
456
486
  * @return UpdateModelResponse
457
487
  * @throws OciError when an error occurs
458
- * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.50.2/ailanguage/UpdateModel.ts.html |here} to see how to use UpdateModel API.
488
+ * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.50.3/ailanguage/UpdateModel.ts.html |here} to see how to use UpdateModel API.
459
489
  */
460
490
  updateModel(updateModelRequest: requests.UpdateModelRequest): Promise<responses.UpdateModelResponse>;
461
491
  /**
@@ -464,7 +494,7 @@ export declare class AIServiceLanguageClient {
464
494
  * @param UpdateProjectRequest
465
495
  * @return UpdateProjectResponse
466
496
  * @throws OciError when an error occurs
467
- * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.50.2/ailanguage/UpdateProject.ts.html |here} to see how to use UpdateProject API.
497
+ * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.50.3/ailanguage/UpdateProject.ts.html |here} to see how to use UpdateProject API.
468
498
  */
469
499
  updateProject(updateProjectRequest: requests.UpdateProjectRequest): Promise<responses.UpdateProjectResponse>;
470
500
  }