Skip to content

Commit 6d6e8d6

Browse files
dpopp07dpopp07
committed
docs: regenerated files with mostly docs changes
1 parent a114881 commit 6d6e8d6

8 files changed

Lines changed: 156 additions & 118 deletions

File tree

‎assistant/v1.ts‎

Lines changed: 28 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -74,6 +74,10 @@ class AssistantV1 extends BaseService {
7474
*
7575
* Send user input to a workspace and receive a response.
7676
*
77+
* **Note:** For most applications, there are significant advantages to using the v2 runtime API instead. These
78+
* advantages include ease of deployment, automatic state management, versioning, and search capabilities. For more
79+
* information, see the [documentation](https://cloud.ibm.com/docs/services/assistant?topic=assistant-api-overview).
80+
*
7781
* There is no rate limit for this operation.
7882
*
7983
* @param {Object} params - The parameters to send to the service.
@@ -121,7 +125,7 @@ class AssistantV1 extends BaseService {
121125
'context': _params.context,
122126
'output': _params.output
123127
};
124-
128+
125129
const query = {
126130
'nodes_visited_details': _params.nodes_visited_details
127131
};
@@ -319,7 +323,7 @@ class AssistantV1 extends BaseService {
319323
if (missingParams) {
320324
return _callback(missingParams);
321325
}
322-
326+
323327
const query = {
324328
'export': _params._export,
325329
'include_audit': _params.include_audit,
@@ -379,7 +383,7 @@ class AssistantV1 extends BaseService {
379383
});
380384
});
381385
}
382-
386+
383387
const query = {
384388
'page_limit': _params.page_limit,
385389
'include_count': _params.include_count,
@@ -472,7 +476,7 @@ class AssistantV1 extends BaseService {
472476
'dialog_nodes': _params.dialog_nodes,
473477
'counterexamples': _params.counterexamples
474478
};
475-
479+
476480
const query = {
477481
'append': _params.append
478482
};
@@ -668,7 +672,7 @@ class AssistantV1 extends BaseService {
668672
if (missingParams) {
669673
return _callback(missingParams);
670674
}
671-
675+
672676
const query = {
673677
'export': _params._export,
674678
'include_audit': _params.include_audit
@@ -739,7 +743,7 @@ class AssistantV1 extends BaseService {
739743
if (missingParams) {
740744
return _callback(missingParams);
741745
}
742-
746+
743747
const query = {
744748
'export': _params._export,
745749
'page_limit': _params.page_limit,
@@ -1011,7 +1015,7 @@ class AssistantV1 extends BaseService {
10111015
if (missingParams) {
10121016
return _callback(missingParams);
10131017
}
1014-
1018+
10151019
const query = {
10161020
'include_audit': _params.include_audit
10171021
};
@@ -1079,7 +1083,7 @@ class AssistantV1 extends BaseService {
10791083
if (missingParams) {
10801084
return _callback(missingParams);
10811085
}
1082-
1086+
10831087
const query = {
10841088
'page_limit': _params.page_limit,
10851089
'include_count': _params.include_count,
@@ -1342,7 +1346,7 @@ class AssistantV1 extends BaseService {
13421346
if (missingParams) {
13431347
return _callback(missingParams);
13441348
}
1345-
1349+
13461350
const query = {
13471351
'include_audit': _params.include_audit
13481352
};
@@ -1408,7 +1412,7 @@ class AssistantV1 extends BaseService {
14081412
if (missingParams) {
14091413
return _callback(missingParams);
14101414
}
1411-
1415+
14121416
const query = {
14131417
'page_limit': _params.page_limit,
14141418
'include_count': _params.include_count,
@@ -1679,7 +1683,7 @@ class AssistantV1 extends BaseService {
16791683
if (missingParams) {
16801684
return _callback(missingParams);
16811685
}
1682-
1686+
16831687
const query = {
16841688
'export': _params._export,
16851689
'include_audit': _params.include_audit
@@ -1750,7 +1754,7 @@ class AssistantV1 extends BaseService {
17501754
if (missingParams) {
17511755
return _callback(missingParams);
17521756
}
1753-
1757+
17541758
const query = {
17551759
'export': _params._export,
17561760
'page_limit': _params.page_limit,
@@ -1902,7 +1906,7 @@ class AssistantV1 extends BaseService {
19021906
if (missingParams) {
19031907
return _callback(missingParams);
19041908
}
1905-
1909+
19061910
const query = {
19071911
'export': _params._export,
19081912
'include_audit': _params.include_audit
@@ -2113,7 +2117,7 @@ class AssistantV1 extends BaseService {
21132117
if (missingParams) {
21142118
return _callback(missingParams);
21152119
}
2116-
2120+
21172121
const query = {
21182122
'export': _params._export,
21192123
'include_audit': _params.include_audit
@@ -2185,7 +2189,7 @@ class AssistantV1 extends BaseService {
21852189
if (missingParams) {
21862190
return _callback(missingParams);
21872191
}
2188-
2192+
21892193
const query = {
21902194
'export': _params._export,
21912195
'page_limit': _params.page_limit,
@@ -2472,7 +2476,7 @@ class AssistantV1 extends BaseService {
24722476
if (missingParams) {
24732477
return _callback(missingParams);
24742478
}
2475-
2479+
24762480
const query = {
24772481
'include_audit': _params.include_audit
24782482
};
@@ -2542,7 +2546,7 @@ class AssistantV1 extends BaseService {
25422546
if (missingParams) {
25432547
return _callback(missingParams);
25442548
}
2545-
2549+
25462550
const query = {
25472551
'page_limit': _params.page_limit,
25482552
'include_count': _params.include_count,
@@ -2849,7 +2853,7 @@ class AssistantV1 extends BaseService {
28492853
if (missingParams) {
28502854
return _callback(missingParams);
28512855
}
2852-
2856+
28532857
const query = {
28542858
'include_audit': _params.include_audit
28552859
};
@@ -2915,7 +2919,7 @@ class AssistantV1 extends BaseService {
29152919
if (missingParams) {
29162920
return _callback(missingParams);
29172921
}
2918-
2922+
29192923
const query = {
29202924
'page_limit': _params.page_limit,
29212925
'include_count': _params.include_count,
@@ -3101,7 +3105,7 @@ class AssistantV1 extends BaseService {
31013105
if (missingParams) {
31023106
return _callback(missingParams);
31033107
}
3104-
3108+
31053109
const query = {
31063110
'filter': _params.filter,
31073111
'sort': _params.sort,
@@ -3165,7 +3169,7 @@ class AssistantV1 extends BaseService {
31653169
if (missingParams) {
31663170
return _callback(missingParams);
31673171
}
3168-
3172+
31693173
const query = {
31703174
'sort': _params.sort,
31713175
'filter': _params.filter,
@@ -3233,7 +3237,7 @@ class AssistantV1 extends BaseService {
32333237
if (missingParams) {
32343238
return _callback(missingParams);
32353239
}
3236-
3240+
32373241
const query = {
32383242
'customer_id': _params.customer_id
32393243
};
@@ -4790,9 +4794,9 @@ namespace AssistantV1 {
47904794
entity: string;
47914795
/** An array of zero-based character offsets that indicate where the detected entity values begin and end in the input text. */
47924796
location: number[];
4793-
/** The term in the input text that was recognized as an entity value. */
4797+
/** The entity value that was recognized in the user input. */
47944798
value: string;
4795-
/** A decimal percentage that represents Watson's confidence in the entity. */
4799+
/** A decimal percentage that represents Watson's confidence in the recognized entity. */
47964800
confidence?: number;
47974801
/** Any metadata for the entity. */
47984802
metadata?: JsonObject;

‎discovery/v1.ts‎

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -249,7 +249,7 @@ class DiscoveryV1 extends BaseService {
249249
});
250250
});
251251
}
252-
252+
253253
const query = {
254254
'name': _params.name
255255
};
@@ -301,7 +301,7 @@ class DiscoveryV1 extends BaseService {
301301
if (missingParams) {
302302
return _callback(missingParams);
303303
}
304-
304+
305305
const query = {
306306
'collection_ids': _params.collection_ids
307307
};
@@ -610,7 +610,7 @@ class DiscoveryV1 extends BaseService {
610610
if (missingParams) {
611611
return _callback(missingParams);
612612
}
613-
613+
614614
const query = {
615615
'name': _params.name
616616
};
@@ -780,7 +780,7 @@ class DiscoveryV1 extends BaseService {
780780
},
781781
'metadata': _params.metadata
782782
};
783-
783+
784784
const query = {
785785
'step': _params.step,
786786
'configuration_id': _params.configuration_id
@@ -1062,7 +1062,7 @@ class DiscoveryV1 extends BaseService {
10621062
if (missingParams) {
10631063
return _callback(missingParams);
10641064
}
1065-
1065+
10661066
const query = {
10671067
'name': _params.name
10681068
};
@@ -2162,7 +2162,7 @@ class DiscoveryV1 extends BaseService {
21622162
if (missingParams) {
21632163
return _callback(missingParams);
21642164
}
2165-
2165+
21662166
const query = {
21672167
'collection_ids': _params.collection_ids,
21682168
'filter': _params.filter,
@@ -2475,7 +2475,7 @@ class DiscoveryV1 extends BaseService {
24752475
if (missingParams) {
24762476
return _callback(missingParams);
24772477
}
2478-
2478+
24792479
const query = {
24802480
'filter': _params.filter,
24812481
'query': _params.query,
@@ -3216,7 +3216,7 @@ class DiscoveryV1 extends BaseService {
32163216
if (missingParams) {
32173217
return _callback(missingParams);
32183218
}
3219-
3219+
32203220
const query = {
32213221
'customer_id': _params.customer_id
32223222
};
@@ -3325,7 +3325,7 @@ class DiscoveryV1 extends BaseService {
33253325
});
33263326
});
33273327
}
3328-
3328+
33293329
const query = {
33303330
'start_time': _params.start_time,
33313331
'end_time': _params.end_time,
@@ -3376,7 +3376,7 @@ class DiscoveryV1 extends BaseService {
33763376
});
33773377
});
33783378
}
3379-
3379+
33803380
const query = {
33813381
'start_time': _params.start_time,
33823382
'end_time': _params.end_time,
@@ -3429,7 +3429,7 @@ class DiscoveryV1 extends BaseService {
34293429
});
34303430
});
34313431
}
3432-
3432+
34333433
const query = {
34343434
'start_time': _params.start_time,
34353435
'end_time': _params.end_time,
@@ -3481,7 +3481,7 @@ class DiscoveryV1 extends BaseService {
34813481
});
34823482
});
34833483
}
3484-
3484+
34853485
const query = {
34863486
'start_time': _params.start_time,
34873487
'end_time': _params.end_time,
@@ -3531,7 +3531,7 @@ class DiscoveryV1 extends BaseService {
35313531
});
35323532
});
35333533
}
3534-
3534+
35353535
const query = {
35363536
'count': _params.count
35373537
};
@@ -3588,7 +3588,7 @@ class DiscoveryV1 extends BaseService {
35883588
});
35893589
});
35903590
}
3591-
3591+
35923592
const query = {
35933593
'filter': _params.filter,
35943594
'query': _params.query,

‎language-translator/v3.ts‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -240,7 +240,7 @@ class LanguageTranslatorV3 extends BaseService {
240240
* files is limited to <b>250 MB</b>. To successfully train with a parallel corpus you must have at least <b>5,000
241241
* parallel sentences</b> in your corpus.
242242
*
243-
* You can have a <b>maxium of 10 custom models per language pair</b>.
243+
* You can have a <b>maximum of 10 custom models per language pair</b>.
244244
*
245245
* @param {Object} params - The parameters to send to the service.
246246
* @param {string} params.base_model_id - The model ID of the model to use as the base for customization. To see
@@ -288,7 +288,7 @@ class LanguageTranslatorV3 extends BaseService {
288288
contentType: 'application/octet-stream'
289289
}
290290
};
291-
291+
292292
const query = {
293293
'base_model_id': _params.base_model_id,
294294
'name': _params.name
@@ -444,7 +444,7 @@ class LanguageTranslatorV3 extends BaseService {
444444
});
445445
});
446446
}
447-
447+
448448
const query = {
449449
'source': _params.source,
450450
'target': _params.target,

‎natural-language-understanding/v1.ts‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -548,6 +548,8 @@ namespace NaturalLanguageUnderstandingV1 {
548548
text?: string;
549549
/** Relevance score from 0 to 1. Higher values indicate greater relevance. */
550550
relevance?: number;
551+
/** Confidence in the entity identification from 0 to 1. Higher values indicate higher confidence. In standard entities requests, confidence is returned only for English text. All entities requests that use custom models return the confidence score. */
552+
confidence?: number;
551553
/** Entity mentions and locations. */
552554
mentions?: EntityMention[];
553555
/** How many times the entity was mentioned in the text. */
@@ -566,6 +568,8 @@ namespace NaturalLanguageUnderstandingV1 {
566568
text?: string;
567569
/** Character offsets indicating the beginning and end of the mention in the analyzed text. */
568570
location?: number[];
571+
/** Confidence in the entity identification from 0 to 1. Higher values indicate higher confidence. In standard entities requests, confidence is returned only for English text. All entities requests that use custom models return the confidence score. */
572+
confidence?: number;
569573
}
570574

571575
/** FeatureSentimentResults. */

0 commit comments

Comments
 (0)