oci-ailanguage 2.79.1 → 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.
- package/lib/client.d.ts +64 -55
- package/lib/client.js +214 -93
- package/lib/client.js.map +1 -1
- package/lib/model/batch-detect-dominant-language-details.d.ts +17 -0
- package/lib/model/batch-detect-dominant-language-details.js.map +1 -1
- package/lib/model/batch-detect-language-key-phrases-details.d.ts +4 -0
- package/lib/model/batch-detect-language-key-phrases-details.js.map +1 -1
- package/lib/model/batch-detect-language-pii-entities-details.d.ts +4 -0
- package/lib/model/batch-detect-language-pii-entities-details.js.map +1 -1
- package/lib/model/batch-detect-language-sentiments-details.d.ts +4 -0
- package/lib/model/batch-detect-language-sentiments-details.js.map +1 -1
- package/lib/model/batch-language-translation-details.d.ts +31 -24
- package/lib/model/batch-language-translation-details.js.map +1 -1
- package/lib/model/classification-type.js +4 -2
- package/lib/model/classification-type.js.map +1 -1
- package/lib/model/create-model-details.d.ts +1 -1
- package/lib/model/create-model-details.js.map +1 -1
- package/lib/model/dataset-details.js +4 -2
- package/lib/model/dataset-details.js.map +1 -1
- package/lib/model/endpoint-summary.d.ts +3 -1
- package/lib/model/endpoint.d.ts +3 -1
- package/lib/model/evaluation-result-summary.js +4 -2
- package/lib/model/evaluation-result-summary.js.map +1 -1
- package/lib/model/evaluation-results.js +4 -2
- package/lib/model/evaluation-results.js.map +1 -1
- package/lib/model/index.d.ts +0 -2
- package/lib/model/index.js +1 -3
- package/lib/model/index.js.map +1 -1
- package/lib/model/location-details.js +4 -2
- package/lib/model/location-details.js.map +1 -1
- package/lib/model/model-details.js +4 -6
- package/lib/model/model-details.js.map +1 -1
- package/lib/model/model-summary.d.ts +6 -4
- package/lib/model/model-summary.js.map +1 -1
- package/lib/model/model.d.ts +5 -3
- package/lib/model/model.js.map +1 -1
- package/lib/model/pii-entity-masking.js +4 -2
- package/lib/model/pii-entity-masking.js.map +1 -1
- package/lib/model/project-summary.d.ts +3 -1
- package/lib/model/project.d.ts +3 -1
- package/lib/model/test-strategy.js +4 -2
- package/lib/model/test-strategy.js.map +1 -1
- package/lib/model/translation-document-result.d.ts +2 -52
- package/lib/model/translation-document-result.js.map +1 -1
- package/lib/request/batch-detect-dominant-language-request.d.ts +1 -1
- package/lib/request/batch-detect-language-entities-request.d.ts +1 -1
- package/lib/request/batch-detect-language-key-phrases-request.d.ts +1 -1
- package/lib/request/batch-detect-language-pii-entities-request.d.ts +1 -1
- package/lib/request/batch-detect-language-sentiments-request.d.ts +1 -1
- package/lib/request/batch-detect-language-text-classification-request.d.ts +1 -1
- package/lib/request/batch-language-translation-request.d.ts +1 -1
- package/lib/request/change-endpoint-compartment-request.d.ts +1 -1
- package/lib/request/change-model-compartment-request.d.ts +1 -1
- package/lib/request/change-project-compartment-request.d.ts +1 -1
- package/lib/request/create-endpoint-request.d.ts +1 -1
- package/lib/request/create-model-request.d.ts +1 -1
- package/lib/request/create-project-request.d.ts +1 -1
- package/lib/request/delete-endpoint-request.d.ts +1 -1
- package/lib/request/delete-model-request.d.ts +1 -1
- package/lib/request/delete-project-request.d.ts +1 -1
- package/lib/request/detect-dominant-language-request.d.ts +1 -1
- package/lib/request/detect-language-entities-request.d.ts +1 -1
- package/lib/request/detect-language-key-phrases-request.d.ts +1 -1
- package/lib/request/detect-language-sentiments-request.d.ts +1 -1
- package/lib/request/detect-language-text-classification-request.d.ts +1 -1
- package/lib/request/get-endpoint-request.d.ts +1 -1
- package/lib/request/get-model-request.d.ts +1 -1
- package/lib/request/get-model-type-request.d.ts +1 -1
- package/lib/request/get-project-request.d.ts +1 -1
- package/lib/request/get-work-request-request.d.ts +1 -1
- package/lib/request/list-endpoints-request.d.ts +1 -1
- package/lib/request/list-evaluation-results-request.d.ts +1 -1
- package/lib/request/list-models-request.d.ts +1 -1
- package/lib/request/list-projects-request.d.ts +1 -1
- package/lib/request/list-work-request-errors-request.d.ts +1 -1
- package/lib/request/list-work-request-logs-request.d.ts +1 -1
- package/lib/request/list-work-requests-request.d.ts +1 -1
- package/lib/request/update-endpoint-request.d.ts +1 -1
- package/lib/request/update-model-request.d.ts +1 -1
- package/lib/request/update-project-request.d.ts +1 -1
- package/package.json +3 -3
- package/lib/model/pre-trained-phi-model-details.d.ts +0 -33
- package/lib/model/pre-trained-phi-model-details.js +0 -57
- 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;
|
|
@@ -49,6 +49,7 @@ export declare class AIServiceLanguageClient {
|
|
|
49
49
|
* @param endpoint The endpoint of the service.
|
|
50
50
|
*/
|
|
51
51
|
set endpoint(endpoint: string);
|
|
52
|
+
get logger(): import("oci-common/lib/log").Logger;
|
|
52
53
|
/**
|
|
53
54
|
* Determines whether realm specific endpoint should be used or not.
|
|
54
55
|
* Set realmSpecificEndpointTemplateEnabled to "true" if the user wants to enable use of realm specific endpoint template, otherwise set it to "false"
|
|
@@ -101,7 +102,7 @@ export declare class AIServiceLanguageClient {
|
|
|
101
102
|
* @param BatchDetectDominantLanguageRequest
|
|
102
103
|
* @return BatchDetectDominantLanguageResponse
|
|
103
104
|
* @throws OciError when an error occurs
|
|
104
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
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.
|
|
105
106
|
*/
|
|
106
107
|
batchDetectDominantLanguage(batchDetectDominantLanguageRequest: requests.BatchDetectDominantLanguageRequest): Promise<responses.BatchDetectDominantLanguageResponse>;
|
|
107
108
|
/**
|
|
@@ -118,7 +119,7 @@ export declare class AIServiceLanguageClient {
|
|
|
118
119
|
* @param BatchDetectLanguageEntitiesRequest
|
|
119
120
|
* @return BatchDetectLanguageEntitiesResponse
|
|
120
121
|
* @throws OciError when an error occurs
|
|
121
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
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.
|
|
122
123
|
*/
|
|
123
124
|
batchDetectLanguageEntities(batchDetectLanguageEntitiesRequest: requests.BatchDetectLanguageEntitiesRequest): Promise<responses.BatchDetectLanguageEntitiesResponse>;
|
|
124
125
|
/**
|
|
@@ -133,7 +134,7 @@ export declare class AIServiceLanguageClient {
|
|
|
133
134
|
* @param BatchDetectLanguageKeyPhrasesRequest
|
|
134
135
|
* @return BatchDetectLanguageKeyPhrasesResponse
|
|
135
136
|
* @throws OciError when an error occurs
|
|
136
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
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.
|
|
137
138
|
*/
|
|
138
139
|
batchDetectLanguageKeyPhrases(batchDetectLanguageKeyPhrasesRequest: requests.BatchDetectLanguageKeyPhrasesRequest): Promise<responses.BatchDetectLanguageKeyPhrasesResponse>;
|
|
139
140
|
/**
|
|
@@ -148,7 +149,7 @@ export declare class AIServiceLanguageClient {
|
|
|
148
149
|
* @param BatchDetectLanguagePiiEntitiesRequest
|
|
149
150
|
* @return BatchDetectLanguagePiiEntitiesResponse
|
|
150
151
|
* @throws OciError when an error occurs
|
|
151
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
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.
|
|
152
153
|
*/
|
|
153
154
|
batchDetectLanguagePiiEntities(batchDetectLanguagePiiEntitiesRequest: requests.BatchDetectLanguagePiiEntitiesRequest): Promise<responses.BatchDetectLanguagePiiEntitiesResponse>;
|
|
154
155
|
/**
|
|
@@ -169,7 +170,7 @@ export declare class AIServiceLanguageClient {
|
|
|
169
170
|
* @param BatchDetectLanguageSentimentsRequest
|
|
170
171
|
* @return BatchDetectLanguageSentimentsResponse
|
|
171
172
|
* @throws OciError when an error occurs
|
|
172
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
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.
|
|
173
174
|
*/
|
|
174
175
|
batchDetectLanguageSentiments(batchDetectLanguageSentimentsRequest: requests.BatchDetectLanguageSentimentsRequest): Promise<responses.BatchDetectLanguageSentimentsResponse>;
|
|
175
176
|
/**
|
|
@@ -188,22 +189,21 @@ export declare class AIServiceLanguageClient {
|
|
|
188
189
|
* @param BatchDetectLanguageTextClassificationRequest
|
|
189
190
|
* @return BatchDetectLanguageTextClassificationResponse
|
|
190
191
|
* @throws OciError when an error occurs
|
|
191
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
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.
|
|
192
193
|
*/
|
|
193
194
|
batchDetectLanguageTextClassification(batchDetectLanguageTextClassificationRequest: requests.BatchDetectLanguageTextClassificationRequest): Promise<responses.BatchDetectLanguageTextClassificationResponse>;
|
|
194
195
|
/**
|
|
195
|
-
*
|
|
196
|
-
*
|
|
197
|
-
*
|
|
198
|
-
* -
|
|
199
|
-
* -
|
|
200
|
-
* - 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.
|
|
201
201
|
*
|
|
202
202
|
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
203
203
|
* @param BatchLanguageTranslationRequest
|
|
204
204
|
* @return BatchLanguageTranslationResponse
|
|
205
205
|
* @throws OciError when an error occurs
|
|
206
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
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.
|
|
207
207
|
*/
|
|
208
208
|
batchLanguageTranslation(batchLanguageTranslationRequest: requests.BatchLanguageTranslationRequest): Promise<responses.BatchLanguageTranslationResponse>;
|
|
209
209
|
/**
|
|
@@ -212,7 +212,7 @@ export declare class AIServiceLanguageClient {
|
|
|
212
212
|
* @param ChangeEndpointCompartmentRequest
|
|
213
213
|
* @return ChangeEndpointCompartmentResponse
|
|
214
214
|
* @throws OciError when an error occurs
|
|
215
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
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.
|
|
216
216
|
*/
|
|
217
217
|
changeEndpointCompartment(changeEndpointCompartmentRequest: requests.ChangeEndpointCompartmentRequest): Promise<responses.ChangeEndpointCompartmentResponse>;
|
|
218
218
|
/**
|
|
@@ -221,7 +221,7 @@ export declare class AIServiceLanguageClient {
|
|
|
221
221
|
* @param ChangeModelCompartmentRequest
|
|
222
222
|
* @return ChangeModelCompartmentResponse
|
|
223
223
|
* @throws OciError when an error occurs
|
|
224
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
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.
|
|
225
225
|
*/
|
|
226
226
|
changeModelCompartment(changeModelCompartmentRequest: requests.ChangeModelCompartmentRequest): Promise<responses.ChangeModelCompartmentResponse>;
|
|
227
227
|
/**
|
|
@@ -230,7 +230,7 @@ export declare class AIServiceLanguageClient {
|
|
|
230
230
|
* @param ChangeProjectCompartmentRequest
|
|
231
231
|
* @return ChangeProjectCompartmentResponse
|
|
232
232
|
* @throws OciError when an error occurs
|
|
233
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
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.
|
|
234
234
|
*/
|
|
235
235
|
changeProjectCompartment(changeProjectCompartmentRequest: requests.ChangeProjectCompartmentRequest): Promise<responses.ChangeProjectCompartmentResponse>;
|
|
236
236
|
/**
|
|
@@ -240,7 +240,7 @@ export declare class AIServiceLanguageClient {
|
|
|
240
240
|
* @param CreateEndpointRequest
|
|
241
241
|
* @return CreateEndpointResponse
|
|
242
242
|
* @throws OciError when an error occurs
|
|
243
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
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.
|
|
244
244
|
*/
|
|
245
245
|
createEndpoint(createEndpointRequest: requests.CreateEndpointRequest): Promise<responses.CreateEndpointResponse>;
|
|
246
246
|
/**
|
|
@@ -250,7 +250,7 @@ export declare class AIServiceLanguageClient {
|
|
|
250
250
|
* @param CreateModelRequest
|
|
251
251
|
* @return CreateModelResponse
|
|
252
252
|
* @throws OciError when an error occurs
|
|
253
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
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.
|
|
254
254
|
*/
|
|
255
255
|
createModel(createModelRequest: requests.CreateModelRequest): Promise<responses.CreateModelResponse>;
|
|
256
256
|
/**
|
|
@@ -260,7 +260,7 @@ export declare class AIServiceLanguageClient {
|
|
|
260
260
|
* @param CreateProjectRequest
|
|
261
261
|
* @return CreateProjectResponse
|
|
262
262
|
* @throws OciError when an error occurs
|
|
263
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
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.
|
|
264
264
|
*/
|
|
265
265
|
createProject(createProjectRequest: requests.CreateProjectRequest): Promise<responses.CreateProjectResponse>;
|
|
266
266
|
/**
|
|
@@ -269,7 +269,7 @@ export declare class AIServiceLanguageClient {
|
|
|
269
269
|
* @param DeleteEndpointRequest
|
|
270
270
|
* @return DeleteEndpointResponse
|
|
271
271
|
* @throws OciError when an error occurs
|
|
272
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
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.
|
|
273
273
|
*/
|
|
274
274
|
deleteEndpoint(deleteEndpointRequest: requests.DeleteEndpointRequest): Promise<responses.DeleteEndpointResponse>;
|
|
275
275
|
/**
|
|
@@ -278,7 +278,7 @@ export declare class AIServiceLanguageClient {
|
|
|
278
278
|
* @param DeleteModelRequest
|
|
279
279
|
* @return DeleteModelResponse
|
|
280
280
|
* @throws OciError when an error occurs
|
|
281
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
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.
|
|
282
282
|
*/
|
|
283
283
|
deleteModel(deleteModelRequest: requests.DeleteModelRequest): Promise<responses.DeleteModelResponse>;
|
|
284
284
|
/**
|
|
@@ -287,14 +287,16 @@ export declare class AIServiceLanguageClient {
|
|
|
287
287
|
* @param DeleteProjectRequest
|
|
288
288
|
* @return DeleteProjectResponse
|
|
289
289
|
* @throws OciError when an error occurs
|
|
290
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
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.
|
|
291
291
|
*/
|
|
292
292
|
deleteProject(deleteProjectRequest: requests.DeleteProjectRequest): Promise<responses.DeleteProjectResponse>;
|
|
293
293
|
/**
|
|
294
|
-
* This API will be retired
|
|
295
|
-
*
|
|
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).
|
|
296
296
|
* <p>
|
|
297
|
-
|
|
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)
|
|
298
300
|
* <p>
|
|
299
301
|
Limitations:
|
|
300
302
|
* - A record may be up to 1000 characters long.
|
|
@@ -303,12 +305,14 @@ export declare class AIServiceLanguageClient {
|
|
|
303
305
|
* @param DetectDominantLanguageRequest
|
|
304
306
|
* @return DetectDominantLanguageResponse
|
|
305
307
|
* @throws OciError when an error occurs
|
|
306
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
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.
|
|
307
309
|
*/
|
|
308
310
|
detectDominantLanguage(detectDominantLanguageRequest: requests.DetectDominantLanguageRequest): Promise<responses.DetectDominantLanguageResponse>;
|
|
309
311
|
/**
|
|
310
|
-
* This API will be retired
|
|
311
|
-
*
|
|
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.
|
|
312
316
|
* <p>
|
|
313
317
|
Limitations:
|
|
314
318
|
* - A text may be up to 1000 characters long.
|
|
@@ -317,26 +321,29 @@ export declare class AIServiceLanguageClient {
|
|
|
317
321
|
* @param DetectLanguageEntitiesRequest
|
|
318
322
|
* @return DetectLanguageEntitiesResponse
|
|
319
323
|
* @throws OciError when an error occurs
|
|
320
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
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.
|
|
321
325
|
*/
|
|
322
326
|
detectLanguageEntities(detectLanguageEntitiesRequest: requests.DetectLanguageEntitiesRequest): Promise<responses.DetectLanguageEntitiesResponse>;
|
|
323
327
|
/**
|
|
324
|
-
* This API will be retired
|
|
325
|
-
*
|
|
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).
|
|
326
330
|
* <p>
|
|
327
|
-
|
|
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:
|
|
328
333
|
* - A record may be up to 1000 characters long.
|
|
329
334
|
*
|
|
330
335
|
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
331
336
|
* @param DetectLanguageKeyPhrasesRequest
|
|
332
337
|
* @return DetectLanguageKeyPhrasesResponse
|
|
333
338
|
* @throws OciError when an error occurs
|
|
334
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
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.
|
|
335
340
|
*/
|
|
336
341
|
detectLanguageKeyPhrases(detectLanguageKeyPhrasesRequest: requests.DetectLanguageKeyPhrasesRequest): Promise<responses.DetectLanguageKeyPhrasesResponse>;
|
|
337
342
|
/**
|
|
338
|
-
* This API will be retired
|
|
339
|
-
*
|
|
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.
|
|
340
347
|
* <p>
|
|
341
348
|
For aspect-based sentiment analysis, a set of aspects and their respective sentiment is returned.
|
|
342
349
|
* <p>
|
|
@@ -351,12 +358,14 @@ export declare class AIServiceLanguageClient {
|
|
|
351
358
|
* @param DetectLanguageSentimentsRequest
|
|
352
359
|
* @return DetectLanguageSentimentsResponse
|
|
353
360
|
* @throws OciError when an error occurs
|
|
354
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
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.
|
|
355
362
|
*/
|
|
356
363
|
detectLanguageSentiments(detectLanguageSentimentsRequest: requests.DetectLanguageSentimentsRequest): Promise<responses.DetectLanguageSentimentsResponse>;
|
|
357
364
|
/**
|
|
358
|
-
* This API will be retired
|
|
359
|
-
*
|
|
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.
|
|
360
369
|
* <p>
|
|
361
370
|
Learn more about text classification [here](https://docs.cloud.oracle.com/iaas/language/using/pretrain-models.htm#text-class).
|
|
362
371
|
* <p>
|
|
@@ -367,7 +376,7 @@ export declare class AIServiceLanguageClient {
|
|
|
367
376
|
* @param DetectLanguageTextClassificationRequest
|
|
368
377
|
* @return DetectLanguageTextClassificationResponse
|
|
369
378
|
* @throws OciError when an error occurs
|
|
370
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
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.
|
|
371
380
|
*/
|
|
372
381
|
detectLanguageTextClassification(detectLanguageTextClassificationRequest: requests.DetectLanguageTextClassificationRequest): Promise<responses.DetectLanguageTextClassificationResponse>;
|
|
373
382
|
/**
|
|
@@ -376,7 +385,7 @@ export declare class AIServiceLanguageClient {
|
|
|
376
385
|
* @param GetEndpointRequest
|
|
377
386
|
* @return GetEndpointResponse
|
|
378
387
|
* @throws OciError when an error occurs
|
|
379
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
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.
|
|
380
389
|
*/
|
|
381
390
|
getEndpoint(getEndpointRequest: requests.GetEndpointRequest): Promise<responses.GetEndpointResponse>;
|
|
382
391
|
/**
|
|
@@ -385,7 +394,7 @@ export declare class AIServiceLanguageClient {
|
|
|
385
394
|
* @param GetModelRequest
|
|
386
395
|
* @return GetModelResponse
|
|
387
396
|
* @throws OciError when an error occurs
|
|
388
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
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.
|
|
389
398
|
*/
|
|
390
399
|
getModel(getModelRequest: requests.GetModelRequest): Promise<responses.GetModelResponse>;
|
|
391
400
|
/**
|
|
@@ -394,7 +403,7 @@ export declare class AIServiceLanguageClient {
|
|
|
394
403
|
* @param GetModelTypeRequest
|
|
395
404
|
* @return GetModelTypeResponse
|
|
396
405
|
* @throws OciError when an error occurs
|
|
397
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
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.
|
|
398
407
|
*/
|
|
399
408
|
getModelType(getModelTypeRequest: requests.GetModelTypeRequest): Promise<responses.GetModelTypeResponse>;
|
|
400
409
|
/**
|
|
@@ -403,7 +412,7 @@ export declare class AIServiceLanguageClient {
|
|
|
403
412
|
* @param GetProjectRequest
|
|
404
413
|
* @return GetProjectResponse
|
|
405
414
|
* @throws OciError when an error occurs
|
|
406
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
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.
|
|
407
416
|
*/
|
|
408
417
|
getProject(getProjectRequest: requests.GetProjectRequest): Promise<responses.GetProjectResponse>;
|
|
409
418
|
/**
|
|
@@ -412,7 +421,7 @@ export declare class AIServiceLanguageClient {
|
|
|
412
421
|
* @param GetWorkRequestRequest
|
|
413
422
|
* @return GetWorkRequestResponse
|
|
414
423
|
* @throws OciError when an error occurs
|
|
415
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
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.
|
|
416
425
|
*/
|
|
417
426
|
getWorkRequest(getWorkRequestRequest: requests.GetWorkRequestRequest): Promise<responses.GetWorkRequestResponse>;
|
|
418
427
|
/**
|
|
@@ -422,7 +431,7 @@ export declare class AIServiceLanguageClient {
|
|
|
422
431
|
* @param ListEndpointsRequest
|
|
423
432
|
* @return ListEndpointsResponse
|
|
424
433
|
* @throws OciError when an error occurs
|
|
425
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
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.
|
|
426
435
|
*/
|
|
427
436
|
listEndpoints(listEndpointsRequest: requests.ListEndpointsRequest): Promise<responses.ListEndpointsResponse>;
|
|
428
437
|
/**
|
|
@@ -431,7 +440,7 @@ export declare class AIServiceLanguageClient {
|
|
|
431
440
|
* @param ListEvaluationResultsRequest
|
|
432
441
|
* @return ListEvaluationResultsResponse
|
|
433
442
|
* @throws OciError when an error occurs
|
|
434
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
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.
|
|
435
444
|
*/
|
|
436
445
|
listEvaluationResults(listEvaluationResultsRequest: requests.ListEvaluationResultsRequest): Promise<responses.ListEvaluationResultsResponse>;
|
|
437
446
|
/**
|
|
@@ -441,7 +450,7 @@ export declare class AIServiceLanguageClient {
|
|
|
441
450
|
* @param ListModelsRequest
|
|
442
451
|
* @return ListModelsResponse
|
|
443
452
|
* @throws OciError when an error occurs
|
|
444
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
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.
|
|
445
454
|
*/
|
|
446
455
|
listModels(listModelsRequest: requests.ListModelsRequest): Promise<responses.ListModelsResponse>;
|
|
447
456
|
/**
|
|
@@ -451,7 +460,7 @@ export declare class AIServiceLanguageClient {
|
|
|
451
460
|
* @param ListProjectsRequest
|
|
452
461
|
* @return ListProjectsResponse
|
|
453
462
|
* @throws OciError when an error occurs
|
|
454
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
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.
|
|
455
464
|
*/
|
|
456
465
|
listProjects(listProjectsRequest: requests.ListProjectsRequest): Promise<responses.ListProjectsResponse>;
|
|
457
466
|
/**
|
|
@@ -461,7 +470,7 @@ export declare class AIServiceLanguageClient {
|
|
|
461
470
|
* @param ListWorkRequestErrorsRequest
|
|
462
471
|
* @return ListWorkRequestErrorsResponse
|
|
463
472
|
* @throws OciError when an error occurs
|
|
464
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
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.
|
|
465
474
|
*/
|
|
466
475
|
listWorkRequestErrors(listWorkRequestErrorsRequest: requests.ListWorkRequestErrorsRequest): Promise<responses.ListWorkRequestErrorsResponse>;
|
|
467
476
|
/**
|
|
@@ -471,7 +480,7 @@ export declare class AIServiceLanguageClient {
|
|
|
471
480
|
* @param ListWorkRequestLogsRequest
|
|
472
481
|
* @return ListWorkRequestLogsResponse
|
|
473
482
|
* @throws OciError when an error occurs
|
|
474
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
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.
|
|
475
484
|
*/
|
|
476
485
|
listWorkRequestLogs(listWorkRequestLogsRequest: requests.ListWorkRequestLogsRequest): Promise<responses.ListWorkRequestLogsResponse>;
|
|
477
486
|
/**
|
|
@@ -481,7 +490,7 @@ export declare class AIServiceLanguageClient {
|
|
|
481
490
|
* @param ListWorkRequestsRequest
|
|
482
491
|
* @return ListWorkRequestsResponse
|
|
483
492
|
* @throws OciError when an error occurs
|
|
484
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
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.
|
|
485
494
|
*/
|
|
486
495
|
listWorkRequests(listWorkRequestsRequest: requests.ListWorkRequestsRequest): Promise<responses.ListWorkRequestsResponse>;
|
|
487
496
|
/**
|
|
@@ -490,7 +499,7 @@ export declare class AIServiceLanguageClient {
|
|
|
490
499
|
* @param UpdateEndpointRequest
|
|
491
500
|
* @return UpdateEndpointResponse
|
|
492
501
|
* @throws OciError when an error occurs
|
|
493
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
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.
|
|
494
503
|
*/
|
|
495
504
|
updateEndpoint(updateEndpointRequest: requests.UpdateEndpointRequest): Promise<responses.UpdateEndpointResponse>;
|
|
496
505
|
/**
|
|
@@ -499,7 +508,7 @@ export declare class AIServiceLanguageClient {
|
|
|
499
508
|
* @param UpdateModelRequest
|
|
500
509
|
* @return UpdateModelResponse
|
|
501
510
|
* @throws OciError when an error occurs
|
|
502
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
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.
|
|
503
512
|
*/
|
|
504
513
|
updateModel(updateModelRequest: requests.UpdateModelRequest): Promise<responses.UpdateModelResponse>;
|
|
505
514
|
/**
|
|
@@ -508,7 +517,7 @@ export declare class AIServiceLanguageClient {
|
|
|
508
517
|
* @param UpdateProjectRequest
|
|
509
518
|
* @return UpdateProjectResponse
|
|
510
519
|
* @throws OciError when an error occurs
|
|
511
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
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.
|
|
512
521
|
*/
|
|
513
522
|
updateProject(updateProjectRequest: requests.UpdateProjectRequest): Promise<responses.UpdateProjectResponse>;
|
|
514
523
|
}
|