You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: discovery/v1-generated.ts
+54-6Lines changed: 54 additions & 6 deletions
Original file line number
Diff line number
Diff line change
@@ -1166,6 +1166,9 @@ class DiscoveryV1 extends BaseService {
1166
1166
* @param {boolean} [params.highlight] - When true a highlight field is returned for each result which contains the fields that match the query with `<em></em>` tags around the matching query terms. Defaults to false.
1167
1167
* @param {boolean} [params.deduplicate] - When `true` and used with a Watson Discovery News collection, duplicate results (based on the contents of the `title` field) are removed. Duplicate comparison is limited to the current query only, `offset` is not considered. Defaults to `false`. This parameter is currently Beta functionality.
1168
1168
* @param {string} [params.deduplicate_field] - When specified, duplicate results based on the field specified are removed from the returned results. Duplicate comparison is limited to the current query only, `offset` is not considered. This parameter is currently Beta functionality.
1169
+
* @param {boolean} [params.similar] - When `true`, results are returned based on their similarity to the document IDs specified in the `similar.document_ids` parameter. The default is `false`.
1170
+
* @param {string[]} [params.similar_document_ids] - A comma-separated list of document IDs that will be used to find similar documents. **Note:** If the `natural_language_query` parameter is also specified, it will be used to expand the scope of the document similarity search to include the natural language query. Other query parameters, such as `filter` and `query` are subsequently applied and reduce the query scope.
1171
+
* @param {string[]} [params.similar_fields] - A comma-separated list of field names that will be used as a basis for comparison to identify similar documents. If not specified, the entire document is used for comparison.
1169
1172
* @param {Function} [callback] - The callback that handles the response.
1170
1173
* @returns {NodeJS.ReadableStream|void}
1171
1174
*/
@@ -1189,7 +1192,10 @@ class DiscoveryV1 extends BaseService {
@@ -1229,6 +1235,9 @@ class DiscoveryV1 extends BaseService {
1229
1235
* @param {string[]} [params.sort] - A comma separated list of fields in the document to sort on. You can optionally specify a sort direction by prefixing the field with `-` for descending or `+` for ascending. Ascending is the default sort direction if no prefix is specified.
1230
1236
* @param {boolean} [params.highlight] - When true a highlight field is returned for each result which contains the fields that match the query with `<em></em>` tags around the matching query terms. Defaults to false.
1231
1237
* @param {string} [params.deduplicate_field] - When specified, duplicate results based on the field specified are removed from the returned results. Duplicate comparison is limited to the current query only, `offset` is not considered. This parameter is currently Beta functionality.
1238
+
* @param {boolean} [params.similar] - When `true`, results are returned based on their similarity to the document IDs specified in the `similar.document_ids` parameter. The default is `false`.
1239
+
* @param {string[]} [params.similar_document_ids] - A comma-separated list of document IDs that will be used to find similar documents. **Note:** If the `natural_language_query` parameter is also specified, it will be used to expand the scope of the document similarity search to include the natural language query. Other query parameters, such as `filter` and `query` are subsequently applied and reduce the query scope.
1240
+
* @param {string[]} [params.similar_fields] - A comma-separated list of field names that will be used as a basis for comparison to identify similar documents. If not specified, the entire document is used for comparison.
1232
1241
* @param {Function} [callback] - The callback that handles the response.
1233
1242
* @returns {NodeJS.ReadableStream|void}
1234
1243
*/
@@ -1251,7 +1260,10 @@ class DiscoveryV1 extends BaseService {
@@ -1287,7 +1299,7 @@ class DiscoveryV1 extends BaseService {
1287
1299
* @param {boolean} [params.passages] - A passages query that returns the most relevant passages from the results.
1288
1300
* @param {string} [params.aggregation] - An aggregation search uses combinations of filters and query search to return an exact answer. Aggregations are useful for building applications, because you can use them to build lists, tables, and time series. For a full list of possible aggregrations, see the Query reference.
1289
1301
* @param {number} [params.count] - Number of documents to return.
1290
-
* @param {string[]} [params.return_fields] - A comma separated list of the portion of the document hierarchy to return_fields.
1302
+
* @param {string[]} [params.return_fields] - A comma separated list of the portion of the document hierarchy to return.
1291
1303
* @param {number} [params.offset] - The number of query results to skip at the beginning. For example, if the total number of results that are returned is 10, and the offset is 8, it returns the last two results.
1292
1304
* @param {string[]} [params.sort] - A comma separated list of fields in the document to sort on. You can optionally specify a sort direction by prefixing the field with `-` for descending or `+` for ascending. Ascending is the default sort direction if no prefix is specified.
1293
1305
* @param {boolean} [params.highlight] - When true a highlight field is returned for each result which contains the fields that match the query with `<em></em>` tags around the matching query terms. Defaults to false.
@@ -1296,6 +1308,9 @@ class DiscoveryV1 extends BaseService {
1296
1308
* @param {number} [params.passages_characters] - The approximate number of characters that any one passage will have. The default is `400`. The minimum is `50`. The maximum is `2000`.
1297
1309
* @param {boolean} [params.deduplicate] - When `true` and used with a Watson Discovery News collection, duplicate results (based on the contents of the `title` field) are removed. Duplicate comparison is limited to the current query only, `offset` is not considered. Defaults to `false`. This parameter is currently Beta functionality.
1298
1310
* @param {string} [params.deduplicate_field] - When specified, duplicate results based on the field specified are removed from the returned results. Duplicate comparison is limited to the current query only, `offset` is not considered. This parameter is currently Beta functionality.
1311
+
* @param {boolean} [params.similar] - When `true`, results are returned based on their similarity to the document IDs specified in the `similar.document_ids` parameter. The default is `false`.
1312
+
* @param {string[]} [params.similar_document_ids] - A comma-separated list of document IDs that will be used to find similar documents. **Note:** If the `natural_language_query` parameter is also specified, it will be used to expand the scope of the document similarity search to include the natural language query. Other query parameters, such as `filter` and `query` are subsequently applied and reduce the query scope.
1313
+
* @param {string[]} [params.similar_fields] - A comma-separated list of field names that will be used as a basis for comparison to identify similar documents. If not specified, the entire document is used for comparison.
1299
1314
* @param {Function} [callback] - The callback that handles the response.
1300
1315
* @returns {NodeJS.ReadableStream|void}
1301
1316
*/
@@ -1322,7 +1337,10 @@ class DiscoveryV1 extends BaseService {
@@ -1418,6 +1436,9 @@ class DiscoveryV1 extends BaseService {
1418
1436
* @param {number} [params.passages_count] - The maximum number of passages to return. The search returns fewer passages if the requested total is not found. The default is `10`. The maximum is `100`.
1419
1437
* @param {number} [params.passages_characters] - The approximate number of characters that any one passage will have. The default is `400`. The minimum is `50`. The maximum is `2000`.
1420
1438
* @param {string} [params.deduplicate_field] - When specified, duplicate results based on the field specified are removed from the returned results. Duplicate comparison is limited to the current query only, `offset` is not considered. This parameter is currently Beta functionality.
1439
+
* @param {boolean} [params.similar] - When `true`, results are returned based on their similarity to the document IDs specified in the `similar.document_ids` parameter. The default is `false`.
1440
+
* @param {string[]} [params.similar_document_ids] - A comma-separated list of document IDs that will be used to find similar documents. **Note:** If the `natural_language_query` parameter is also specified, it will be used to expand the scope of the document similarity search to include the natural language query. Other query parameters, such as `filter` and `query` are subsequently applied and reduce the query scope.
1441
+
* @param {string[]} [params.similar_fields] - A comma-separated list of field names that will be used as a basis for comparison to identify similar documents. If not specified, the entire document is used for comparison.
1421
1442
* @param {Function} [callback] - The callback that handles the response.
1422
1443
* @returns {NodeJS.ReadableStream|void}
1423
1444
*/
@@ -1443,7 +1464,10 @@ class DiscoveryV1 extends BaseService {
/** When specified, duplicate results based on the field specified are removed from the returned results. Duplicate comparison is limited to the current query only, `offset` is not considered. This parameter is currently Beta functionality. */
2344
2368
deduplicate_field?: string;
2369
+
/** When `true`, results are returned based on their similarity to the document IDs specified in the `similar.document_ids` parameter. The default is `false`. */
2370
+
similar?: boolean;
2371
+
/** A comma-separated list of document IDs that will be used to find similar documents. **Note:** If the `natural_language_query` parameter is also specified, it will be used to expand the scope of the document similarity search to include the natural language query. Other query parameters, such as `filter` and `query` are subsequently applied and reduce the query scope. */
2372
+
similar_document_ids?: string[];
2373
+
/** A comma-separated list of field names that will be used as a basis for comparison to identify similar documents. If not specified, the entire document is used for comparison. */
2374
+
similar_fields?: string[];
2345
2375
}
2346
2376
2347
2377
/** Parameters for the `federatedQueryNotices` operation. */
@@ -2370,6 +2400,12 @@ namespace DiscoveryV1 {
2370
2400
highlight?: boolean;
2371
2401
/** When specified, duplicate results based on the field specified are removed from the returned results. Duplicate comparison is limited to the current query only, `offset` is not considered. This parameter is currently Beta functionality. */
2372
2402
deduplicate_field?: string;
2403
+
/** When `true`, results are returned based on their similarity to the document IDs specified in the `similar.document_ids` parameter. The default is `false`. */
2404
+
similar?: boolean;
2405
+
/** A comma-separated list of document IDs that will be used to find similar documents. **Note:** If the `natural_language_query` parameter is also specified, it will be used to expand the scope of the document similarity search to include the natural language query. Other query parameters, such as `filter` and `query` are subsequently applied and reduce the query scope. */
2406
+
similar_document_ids?: string[];
2407
+
/** A comma-separated list of field names that will be used as a basis for comparison to identify similar documents. If not specified, the entire document is used for comparison. */
2408
+
similar_fields?: string[];
2373
2409
}
2374
2410
2375
2411
/** Parameters for the `query` operation. */
@@ -2390,7 +2426,7 @@ namespace DiscoveryV1 {
2390
2426
aggregation?: string;
2391
2427
/** Number of documents to return. */
2392
2428
count?: number;
2393
-
/** A comma separated list of the portion of the document hierarchy to return_fields. */
2429
+
/** A comma separated list of the portion of the document hierarchy to return. */
2394
2430
return_fields?: string[];
2395
2431
/** The number of query results to skip at the beginning. For example, if the total number of results that are returned is 10, and the offset is 8, it returns the last two results. */
2396
2432
offset?: number;
@@ -2408,6 +2444,12 @@ namespace DiscoveryV1 {
2408
2444
deduplicate?: boolean;
2409
2445
/** When specified, duplicate results based on the field specified are removed from the returned results. Duplicate comparison is limited to the current query only, `offset` is not considered. This parameter is currently Beta functionality. */
2410
2446
deduplicate_field?: string;
2447
+
/** When `true`, results are returned based on their similarity to the document IDs specified in the `similar.document_ids` parameter. The default is `false`. */
2448
+
similar?: boolean;
2449
+
/** A comma-separated list of document IDs that will be used to find similar documents. **Note:** If the `natural_language_query` parameter is also specified, it will be used to expand the scope of the document similarity search to include the natural language query. Other query parameters, such as `filter` and `query` are subsequently applied and reduce the query scope. */
2450
+
similar_document_ids?: string[];
2451
+
/** A comma-separated list of field names that will be used as a basis for comparison to identify similar documents. If not specified, the entire document is used for comparison. */
2452
+
similar_fields?: string[];
2411
2453
}
2412
2454
2413
2455
/** Parameters for the `queryEntities` operation. */
@@ -2460,6 +2502,12 @@ namespace DiscoveryV1 {
2460
2502
passages_characters?: number;
2461
2503
/** When specified, duplicate results based on the field specified are removed from the returned results. Duplicate comparison is limited to the current query only, `offset` is not considered. This parameter is currently Beta functionality. */
2462
2504
deduplicate_field?: string;
2505
+
/** When `true`, results are returned based on their similarity to the document IDs specified in the `similar.document_ids` parameter. The default is `false`. */
2506
+
similar?: boolean;
2507
+
/** A comma-separated list of document IDs that will be used to find similar documents. **Note:** If the `natural_language_query` parameter is also specified, it will be used to expand the scope of the document similarity search to include the natural language query. Other query parameters, such as `filter` and `query` are subsequently applied and reduce the query scope. */
2508
+
similar_document_ids?: string[];
2509
+
/** A comma-separated list of field names that will be used as a basis for comparison to identify similar documents. If not specified, the entire document is used for comparison. */
2510
+
similar_fields?: string[];
2463
2511
}
2464
2512
2465
2513
/** Parameters for the `queryRelations` operation. */
Copy file name to clipboardExpand all lines: language-translator/v2-generated.ts
+3-7Lines changed: 3 additions & 7 deletions
Original file line number
Diff line number
Diff line change
@@ -14,21 +14,17 @@
14
14
* limitations under the License.
15
15
*/
16
16
17
-
18
17
import*asextendfrom'extend';
19
18
import{RequestResponse}from'request';
20
19
import{BaseService}from'../lib/base_service';
21
20
import{FileObject}from'../lib/helper';
22
21
import{getMissingParams}from'../lib/helper';
23
22
import{createRequest}from'../lib/requestwrapper';
24
23
25
-
26
24
/**
27
25
* Language Translator translates text from one language to another. The service offers multiple domain-specific models that you can customize based on your unique terminology and language. Use Language Translator to take news from across the globe and present it in your language, communicate with your customers in their own language, and more.
@@ -307,7 +303,7 @@ class LanguageTranslatorV2 extends BaseService {
307
303
* @param {Object} [params] - The parameters to send to the service.
308
304
* @param {string} [params.source] - Specify a language code to filter results by source language.
309
305
* @param {string} [params.target] - Specify a language code to filter results by target language.
310
-
* @param {boolean} [params.default_models] - If the default_models parameter isn't specified, the service will return all models (default_models and non-default_models) for each language pair. To return only default_models models, set this to `true`. To return only non-default_models models, set this to `false`.
306
+
* @param {boolean} [params.default_models] - If the default parameter isn't specified, the service will return all models (default and non-default) for each language pair. To return only default models, set this to `true`. To return only non-default models, set this to `false`.
311
307
* @param {Function} [callback] - The callback that handles the response.
/** Specify a language code to filter results by target language. */
420
416
target?: string;
421
-
/** If the default_models parameter isn't specified, the service will return all models (default_models and non-default_models) for each language pair. To return only default_models models, set this to `true`. To return only non-default_models models, set this to `false`. */
417
+
/** If the default parameter isn't specified, the service will return all models (default and non-default) for each language pair. To return only default models, set this to `true`. To return only non-default models, set this to `false`. */
0 commit comments