Skip to content

Commit 44438d9

Browse files
authored
Merge pull request #633 from watson-developer-cloud/release-3-2020
Release 3 2020
2 parents f4305d4 + 0ac684d commit 44438d9

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

41 files changed

+400
-153
lines changed

Examples/ExampleTextToSpeechV1.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -75,7 +75,7 @@ void Update()
7575
}
7676
textInput.text = placeholderText;
7777
audioStream = null;
78-
StartListening(); // need to connect because service disconnect websocket after transcribing https://cloud.ibm.com/docs/services/text-to-speech?topic=text-to-speech-usingWebSocket#WSsend
78+
StartListening(); // need to connect because service disconnect websocket after transcribing https://cloud.ibm.com/docs/text-to-speech?topic=text-to-speech-usingWebSocket#WSsend
7979
}
8080
}
8181

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -111,7 +111,7 @@ Some services use token-based Identity and Access Management (IAM) authenticatio
111111
You supply either an IAM service **API key** or an **access token**:
112112

113113
- Use the API key to have the SDK manage the lifecycle of the access token. The SDK requests an access token, ensures that the access token is valid, and refreshes it if necessary.
114-
- Use the access token if you want to manage the lifecycle yourself. For details, see [Authenticating with IAM tokens](https://cloud.ibm.com/docs/services/watson?topic=watson-iam). If you want to switch to API key, in a coroutine, override your stored IAM credentials with an IAM API key and yield until the credentials object `HasIamTokenData()` returns `true`.
114+
- Use the access token if you want to manage the lifecycle yourself. For details, see [Authenticating with IAM tokens](https://cloud.ibm.com/docs/watson?topic=watson-iam). If you want to switch to API key, in a coroutine, override your stored IAM credentials with an IAM API key and yield until the credentials object `HasIamTokenData()` returns `true`.
115115

116116
#### Supplying the IAM API key
117117
```cs

Scripts/Services/Assistant/V1/AssistantService.cs

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1268,7 +1268,7 @@ private void OnListExamplesResponse(RESTConnector.Request req, RESTConnector.Res
12681268
///
12691269
/// Add a new user input example to an intent.
12701270
///
1271-
/// If you want to add multiple exaples with a single API call, consider using the **[Update
1271+
/// If you want to add multiple examples with a single API call, consider using the **[Update
12721272
/// intent](#update-intent)** method instead.
12731273
///
12741274
/// This operation is limited to 1000 requests per 30 minutes. For more information, see **Rate limiting**.
@@ -3720,7 +3720,7 @@ private void OnListDialogNodesResponse(RESTConnector.Request req, RESTConnector.
37203720
/// <param name="userLabel">A label that can be displayed externally to describe the purpose of the node to
37213721
/// users. (optional)</param>
37223722
/// <param name="disambiguationOptOut">Whether the dialog node should be excluded from disambiguation
3723-
/// suggestions. (optional, default to false)</param>
3723+
/// suggestions. Valid only when **type**=`standard` or `frame`. (optional, default to false)</param>
37243724
/// <param name="includeAudit">Whether to include the audit properties (`created` and `updated` timestamps) in
37253725
/// the response. (optional, default to false)</param>
37263726
/// <returns><see cref="DialogNode" />DialogNode</returns>
@@ -3960,7 +3960,7 @@ private void OnGetDialogNodeResponse(RESTConnector.Request req, RESTConnector.Re
39603960
/// <param name="newUserLabel">A label that can be displayed externally to describe the purpose of the node to
39613961
/// users. (optional)</param>
39623962
/// <param name="newDisambiguationOptOut">Whether the dialog node should be excluded from disambiguation
3963-
/// suggestions. (optional, default to false)</param>
3963+
/// suggestions. Valid only when **type**=`standard` or `frame`. (optional, default to false)</param>
39643964
/// <param name="includeAudit">Whether to include the audit properties (`created` and `updated` timestamps) in
39653965
/// the response. (optional, default to false)</param>
39663966
/// <returns><see cref="DialogNode" />DialogNode</returns>
@@ -4416,4 +4416,4 @@ private void OnDeleteUserDataResponse(RESTConnector.Request req, RESTConnector.R
44164416
((RequestObject<object>)req).Callback(response, resp.Error);
44174417
}
44184418
}
4419-
}
4419+
}

Scripts/Services/Assistant/V1/Model/DialogNode.cs

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -263,7 +263,8 @@ public class DigressOutSlotsValue
263263
[JsonProperty("user_label", NullValueHandling = NullValueHandling.Ignore)]
264264
public string UserLabel { get; set; }
265265
/// <summary>
266-
/// Whether the dialog node should be excluded from disambiguation suggestions.
266+
/// Whether the dialog node should be excluded from disambiguation suggestions. Valid only when
267+
/// **type**=`standard` or `frame`.
267268
/// </summary>
268269
[JsonProperty("disambiguation_opt_out", NullValueHandling = NullValueHandling.Ignore)]
269270
public bool? DisambiguationOptOut { get; set; }

Scripts/Services/Assistant/V1/Model/DialogNodeOutputGeneric.cs

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/**
2-
* Copyright 2018, 2019 IBM Corp. All Rights Reserved.
2+
* (C) Copyright IBM Corp. 2018, 2020.
33
*
44
* Licensed under the Apache License, Version 2.0 (the "License");
55
* you may not use this file except in compliance with the License.
@@ -198,15 +198,15 @@ public class QueryTypeValue
198198
/// The text of the search query. This can be either a natural-language query or a query that uses the Discovery
199199
/// query language syntax, depending on the value of the **query_type** property. For more information, see the
200200
/// [Discovery service
201-
/// documentation](https://cloud.ibm.com/docs/services/discovery/query-operators.html#query-operators). Required
202-
/// when **response_type**=`search_skill`.
201+
/// documentation](https://cloud.ibm.com/docs/discovery/query-operators.html#query-operators). Required when
202+
/// **response_type**=`search_skill`.
203203
/// </summary>
204204
[JsonProperty("query", NullValueHandling = NullValueHandling.Ignore)]
205205
public string Query { get; set; }
206206
/// <summary>
207207
/// An optional filter that narrows the set of documents to be searched. For more information, see the
208208
/// [Discovery service documentation]([Discovery service
209-
/// documentation](https://cloud.ibm.com/docs/services/discovery/query-parameters.html#filter).
209+
/// documentation](https://cloud.ibm.com/docs/discovery/query-parameters.html#filter).
210210
/// </summary>
211211
[JsonProperty("filter", NullValueHandling = NullValueHandling.Ignore)]
212212
public string Filter { get; set; }

Scripts/Services/Assistant/V1/Model/DialogSuggestionResponseGeneric.cs

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/**
2-
* Copyright 2018, 2019 IBM Corp. All Rights Reserved.
2+
* (C) Copyright IBM Corp. 2018, 2020.
33
*
44
* Licensed under the Apache License, Version 2.0 (the "License");
55
* you may not use this file except in compliance with the License.
@@ -136,14 +136,13 @@ public class PreferenceValue
136136
[JsonProperty("message_to_human_agent", NullValueHandling = NullValueHandling.Ignore)]
137137
public string MessageToHumanAgent { get; set; }
138138
/// <summary>
139-
/// A label identifying the topic of the conversation, derived from the **user_label** property of the relevant
140-
/// node.
139+
/// A label identifying the topic of the conversation, derived from the **title** property of the relevant node.
141140
/// </summary>
142141
[JsonProperty("topic", NullValueHandling = NullValueHandling.Ignore)]
143142
public virtual string Topic { get; private set; }
144143
/// <summary>
145144
/// The ID of the dialog node that the **topic** property is taken from. The **topic** property is populated
146-
/// using the value of the dialog node's **user_label** property.
145+
/// using the value of the dialog node's **title** property.
147146
/// </summary>
148147
[JsonProperty("dialog_node", NullValueHandling = NullValueHandling.Ignore)]
149148
public string DialogNode { get; set; }

Scripts/Services/Assistant/V1/Model/RuntimeEntity.cs

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -66,6 +66,15 @@ public class RuntimeEntity
6666
[JsonProperty("interpretation", NullValueHandling = NullValueHandling.Ignore)]
6767
public RuntimeEntityInterpretation Interpretation { get; set; }
6868
/// <summary>
69+
/// An array of possible alternative values that the user might have intended instead of the value returned in
70+
/// the **value** property. This property is returned only for `@sys-time` and `@sys-date` entities when the
71+
/// user's input is ambiguous.
72+
///
73+
/// This property is included only if the new system entities are enabled for the workspace.
74+
/// </summary>
75+
[JsonProperty("alternatives", NullValueHandling = NullValueHandling.Ignore)]
76+
public List<RuntimeEntityAlternative> Alternatives { get; set; }
77+
/// <summary>
6978
/// An object describing the role played by a system entity that is specifies the beginning or end of a range
7079
/// recognized in the user input. This property is included only if the new system entities are enabled for the
7180
/// workspace.
Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
/**
2+
* (C) Copyright IBM Corp. 2018, 2020.
3+
*
4+
* Licensed under the Apache License, Version 2.0 (the "License");
5+
* you may not use this file except in compliance with the License.
6+
* You may obtain a copy of the License at
7+
*
8+
* http://www.apache.org/licenses/LICENSE-2.0
9+
*
10+
* Unless required by applicable law or agreed to in writing, software
11+
* distributed under the License is distributed on an "AS IS" BASIS,
12+
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13+
* See the License for the specific language governing permissions and
14+
* limitations under the License.
15+
*
16+
*/
17+
18+
using Newtonsoft.Json;
19+
20+
namespace IBM.Watson.Assistant.V1.Model
21+
{
22+
/// <summary>
23+
/// An alternative value for the recognized entity.
24+
/// </summary>
25+
public class RuntimeEntityAlternative
26+
{
27+
/// <summary>
28+
/// The entity value that was recognized in the user input.
29+
/// </summary>
30+
[JsonProperty("value", NullValueHandling = NullValueHandling.Ignore)]
31+
public string Value { get; set; }
32+
/// <summary>
33+
/// A decimal percentage that represents Watson's confidence in the recognized entity.
34+
/// </summary>
35+
[JsonProperty("confidence", NullValueHandling = NullValueHandling.Ignore)]
36+
public float? Confidence { get; set; }
37+
}
38+
}

Scripts/Services/Assistant/V1/Model/RuntimeEntityAlternative.cs.meta

Lines changed: 11 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

Scripts/Services/Assistant/V1/Model/RuntimeResponseGeneric.cs

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/**
2-
* Copyright 2018, 2019 IBM Corp. All Rights Reserved.
2+
* (C) Copyright IBM Corp. 2018, 2020.
33
*
44
* Licensed under the Apache License, Version 2.0 (the "License");
55
* you may not use this file except in compliance with the License.
@@ -134,14 +134,13 @@ public class PreferenceValue
134134
[JsonProperty("message_to_human_agent", NullValueHandling = NullValueHandling.Ignore)]
135135
public string MessageToHumanAgent { get; set; }
136136
/// <summary>
137-
/// A label identifying the topic of the conversation, derived from the **user_label** property of the relevant
138-
/// node.
137+
/// A label identifying the topic of the conversation, derived from the **title** property of the relevant node.
139138
/// </summary>
140139
[JsonProperty("topic", NullValueHandling = NullValueHandling.Ignore)]
141140
public virtual string Topic { get; private set; }
142141
/// <summary>
143142
/// The ID of the dialog node that the **topic** property is taken from. The **topic** property is populated
144-
/// using the value of the dialog node's **user_label** property.
143+
/// using the value of the dialog node's **title** property.
145144
/// </summary>
146145
[JsonProperty("dialog_node", NullValueHandling = NullValueHandling.Ignore)]
147146
public string DialogNode { get; set; }

Scripts/Services/Assistant/V2/AssistantService.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -333,4 +333,4 @@ private void OnMessageResponse(RESTConnector.Request req, RESTConnector.Response
333333
((RequestObject<MessageResponse>)req).Callback(response, resp.Error);
334334
}
335335
}
336-
}
336+
}

Scripts/Services/Assistant/V2/Model/MessageContextSkill.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ public class MessageContextSkill
3131
[JsonProperty("user_defined", NullValueHandling = NullValueHandling.Ignore)]
3232
public Dictionary<string, object> UserDefined { get; set; }
3333
/// <summary>
34-
/// For internal use only.
34+
/// System context data used by the skill.
3535
/// </summary>
3636
[JsonProperty("system", NullValueHandling = NullValueHandling.Ignore)]
3737
public Dictionary<string, object> System { get; set; }

Scripts/Services/Assistant/V2/Model/MessageInputOptions.cs

Lines changed: 15 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/**
2-
* Copyright 2018, 2019 IBM Corp. All Rights Reserved.
2+
* (C) Copyright IBM Corp. 2018, 2020.
33
*
44
* Licensed under the Apache License, Version 2.0 (the "License");
55
* you may not use this file except in compliance with the License.
@@ -25,8 +25,9 @@ namespace IBM.Watson.Assistant.V2.Model
2525
public class MessageInputOptions
2626
{
2727
/// <summary>
28-
/// Whether to return additional diagnostic information. Set to `true` to return additional information under
29-
/// the `output.debug` key.
28+
/// Whether to return additional diagnostic information. Set to `true` to return additional information in the
29+
/// `output.debug` property. If you also specify **return_context**=`true`, the returned skill context includes
30+
/// the `system.state` property.
3031
/// </summary>
3132
[JsonProperty("debug", NullValueHandling = NullValueHandling.Ignore)]
3233
public bool? Debug { get; set; }
@@ -42,10 +43,19 @@ public class MessageInputOptions
4243
[JsonProperty("alternate_intents", NullValueHandling = NullValueHandling.Ignore)]
4344
public bool? AlternateIntents { get; set; }
4445
/// <summary>
45-
/// Whether to return session context with the response. If you specify `true`, the response will include the
46-
/// `context` property.
46+
/// Whether to return session context with the response. If you specify `true`, the response includes the
47+
/// `context` property. If you also specify **debug**=`true`, the returned skill context includes the
48+
/// `system.state` property.
4749
/// </summary>
4850
[JsonProperty("return_context", NullValueHandling = NullValueHandling.Ignore)]
4951
public bool? ReturnContext { get; set; }
52+
/// <summary>
53+
/// Whether to return session context, including full conversation state. If you specify `true`, the response
54+
/// includes the `context` property, and the skill context includes the `system.state` property.
55+
///
56+
/// **Note:** If **export**=`true`, the context is returned regardless of the value of **return_context**.
57+
/// </summary>
58+
[JsonProperty("export", NullValueHandling = NullValueHandling.Ignore)]
59+
public bool? Export { get; set; }
5060
}
5161
}

Scripts/Services/Assistant/V2/Model/MessageResponse.cs

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/**
2-
* Copyright 2018, 2019 IBM Corp. All Rights Reserved.
2+
* (C) Copyright IBM Corp. 2018, 2020.
33
*
44
* Licensed under the Apache License, Version 2.0 (the "License");
55
* you may not use this file except in compliance with the License.
@@ -30,8 +30,8 @@ public class MessageResponse
3030
[JsonProperty("output", NullValueHandling = NullValueHandling.Ignore)]
3131
public MessageOutput Output { get; set; }
3232
/// <summary>
33-
/// State information for the conversation. The context is stored by the assistant on a per-session basis. You
34-
/// can use this property to access context variables.
33+
/// Context data for the conversation. The context is stored by the assistant on a per-session basis. You can
34+
/// use this property to access context variables.
3535
///
3636
/// **Note:** The context is included in message responses only if **return_context**=`true` in the message
3737
/// request.

Scripts/Services/CompareComply/V1/CompareComplyService.cs

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -845,9 +845,9 @@ private void OnDeleteFeedbackResponse(RESTConnector.Request req, RESTConnector.R
845845
/// Run Compare and Comply methods over a collection of input documents.
846846
///
847847
/// **Important:** Batch processing requires the use of the [IBM Cloud Object Storage
848-
/// service](https://cloud.ibm.com/docs/services/cloud-object-storage?topic=cloud-object-storage-about#about-ibm-cloud-object-storage).
848+
/// service](https://cloud.ibm.com/docs/cloud-object-storage?topic=cloud-object-storage-about#about-ibm-cloud-object-storage).
849849
/// The use of IBM Cloud Object Storage with Compare and Comply is discussed at [Using batch
850-
/// processing](https://cloud.ibm.com/docs/services/compare-comply?topic=compare-comply-batching#before-you-batch).
850+
/// processing](https://cloud.ibm.com/docs/compare-comply?topic=compare-comply-batching#before-you-batch).
851851
/// </summary>
852852
/// <param name="callback">The callback function that is invoked when the operation completes.</param>
853853
/// <param name="function">The Compare and Comply method to run across the submitted input documents.</param>
@@ -1193,4 +1193,4 @@ private void OnUpdateBatchResponse(RESTConnector.Request req, RESTConnector.Resp
11931193
((RequestObject<BatchStatus>)req).Callback(response, resp.Error);
11941194
}
11951195
}
1196-
}
1196+
}

0 commit comments

Comments
 (0)