Skip to content

DateTime formatting #540

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 15 commits into from
Mar 26, 2019
Merged

DateTime formatting #540

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
15 commits
Select commit Hold shift + click to select a range
ae99688
chore: Generate filename param, use MemoryStream rather than FileStre…
mediumTaj Mar 19, 2019
efe45fd
chore: Updates for filename
mediumTaj Mar 19, 2019
00ae811
chore: Regenerated SDK and updated tests based on required filename
mediumTaj Mar 19, 2019
5caa5fe
chore(Speech to Text V1): Handwritten change for Timestamps and Wor…
mediumTaj Mar 20, 2019
3e217fb
chore(Visual Recognition V4): Regenerated using new mapified param fe…
mediumTaj Mar 20, 2019
956e5a5
Merge branch 'v3.0.0' into feature-v3-filenames
mediumTaj Mar 20, 2019
31f9fce
chore: Regenerated with the latest definitions, added formatting of d…
mediumTaj Mar 20, 2019
015ee61
test: Removved positive example filename
mediumTaj Mar 20, 2019
cae3174
chore: Regenerate for DateTime
mediumTaj Mar 20, 2019
f12d235
docs: Update Readme
mediumTaj Mar 20, 2019
9fc29bc
build: Do not download credentials in pull request
mediumTaj Mar 21, 2019
803183b
build: Corrected installSDK script
mediumTaj Mar 21, 2019
7cf16b8
chore: Updated submodule
mediumTaj Mar 21, 2019
f2ce616
docs: Updated import statement in readme
mediumTaj Mar 21, 2019
04d50db
refactor: Updated generator to get correct service name
mediumTaj Mar 22, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion Core
Open in desktop
Submodule Core updated 2 files
+4 −6 Connection/RESTConnector.cs
+3 −1 ThirdParty/MiniJSON/MiniJSON.cs
167 changes: 31 additions & 136 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,13 +32,14 @@ Ensure that you have the following prerequisites:

## Configuring Unity
* Change the build settings in Unity (**File > Build Settings**) to any platform except for web player/Web GL. The IBM Watson SDK for Unity does not support Unity Web Player.
* If using Unity 2018.2 or later you'll need to set Scripting Runtime Version in Build Settings to .NET 4.x equivalent. We need to access security options to enable TLS 1.2.
* If using Unity 2018.2 or later you'll need to set Scripting Runtime Version and Api Compatibility Level in Build Settings to .NET 4.x equivalent. We need to access security options to enable TLS 1.2.

## Getting the Watson SDK and adding it to Unity
You can get the latest SDK release by clicking [here][latest_release].

### Installing the SDK source into your Unity project
Move the **`unity-sdk`** directory into the **`Assets`** directory of your Unity project. _Optional: rename the SDK directory from `unity-sdk` to `Watson`_.
1. Move the **`unity-sdk`** directory into the **`Assets`** directory of your Unity project. _Optional: rename the SDK directory from `unity-sdk` to `Watson`_.
2. Using the command line, from the sdk directory run `git submodule init` and `git submodule update` to get the correct commit of the SDK core.

## Configuring your service credentials
To create instances of Watson services and their credentials, follow the steps below.
Expand Down Expand Up @@ -124,17 +125,12 @@ IEnumerator TokenExample()

_assistant = new Assistant(_credentials);
_assistant.VersionDate = "2018-02-16";
_assistant.ListWorkspaces(OnListWorkspaces, OnFail);
_assistant.ListWorkspaces(OnListWorkspaces);
}

private void OnListWorkspaces(WorkspaceCollection response, Dictionary<string, object> customData)
private void OnListWorkspaces(DetailedResponse<WorkspaceCollection> response, IBMError error)
{
Log.Debug("OnListWorkspaces()", "Response: {0}", customData["json"].ToString());
}

private void OnFail(RESTConnector.Error error, Dictionary<string, object> customData)
{
Log.Debug("OnFail()", "Failed: {0}", error.ToString());
Log.Debug("OnListWorkspaces()", "Response: {0}", response.Response);
}
```

Expand All @@ -153,24 +149,19 @@ void TokenExample()

_assistant = new Assistant(_credentials);
_assistant.VersionDate = "2018-02-16";
_assistant.ListWorkspaces(OnListWorkspaces, OnFail);
_assistant.ListWorkspaces(OnListWorkspaces);
}

private void OnListWorkspaces(WorkspaceCollection response, Dictionary<string, object> customData)
private void OnListWorkspaces(DetailedResponse<WorkspaceCollection> response, IBMError error)
{
Log.Debug("OnListWorkspaces()", "Response: {0}", customData["json"].ToString());
}

private void OnFail(RESTConnector.Error error, Dictionary<string, object> customData)
{
Log.Debug("OnFail()", "Failed: {0}", error.ToString());
Log.Debug("OnListWorkspaces()", "Response: {0}", response.Response);
}
```

### Username and password
```cs
using IBM.Watson.DeveloperCloud.Services.Assistant.v1;
using IBM.Watson.DeveloperCloud.Utilities;
using IBM.Watson.Assistant.v1;
using IBM.Cloud.SDK.Utilities;

void Start()
{
Expand All @@ -180,37 +171,25 @@ void Start()
```

## Callbacks
Success and failure callbacks are required. You can specify the return type in the callback.
Success callbacks are required. You can specify the return type in the callback.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I like it how failure callbacks are handled by IBMError now 👍

```cs
private void Example()
{
// Call with sepcific callbacks
assistant.Message(OnMessage, OnGetEnvironmentsFail, _workspaceId, "");
discovery.GetEnvironments(OnGetEnvironments, OnFail);
assistant.Message(OnMessage, _workspaceId);
discovery.GetEnvironments(OnGetEnvironments);
}

// OnMessage callback
private void OnMessage(object resp, Dictionary<string, object> customData)
private void OnMessage(DetailedResponse<JObject> resp, IBMError error)
{
Log.Debug("ExampleCallback.OnMessage()", "Response received: {0}", customData["json"].ToString());
Log.Debug("ExampleCallback.OnMessage()", "Response received: {0}", resp.Response);
}

// OnGetEnvironments callback
private void OnGetEnvironments(GetEnvironmentsResponse resp, Dictionary<string, object> customData)
{
Log.Debug("ExampleCallback.OnGetEnvironments()", "Response received: {0}", customData["json"].ToString());
}

// OnMessageFail callback
private void OnMessageFail(RESTConnector.Error error, Dictionary<string, object> customData)
private void OnGetEnvironments(DetailedResponse<GetEnvironmentsResponse> resp, IBMError error)
{
Log.Error("ExampleCallback.OnMessageFail()", "Error received: {0}", error.ToString());
}

// OnGetEnvironmentsFail callback
private void OnGetEnvironmentsFail(RESTConnector.Error error, Dictionary<string, object> customData)
{
Log.Error("ExampleCallback.OnGetEnvironmentsFail()", "Error received: {0}", error.ToString());
Log.Debug("ExampleCallback.OnGetEnvironments()", "Response received: {0}", resp.Response);
}
```

Expand All @@ -219,131 +198,47 @@ Since the success callback signature is generic and the failure callback always
private void Example()
{
// Call with generic callbacks
assistant.Message(OnSuccess, OnMessageFail, "<workspace-id>", "");
discovery.GetEnvironments(OnSuccess, OnFail);
assistant.Message(OnSuccess, "<workspace-id>", "");
discovery.GetEnvironments(OnSuccess);
}

// Generic success callback
private void OnSuccess<T>(T resp, Dictionary<string, object> customData)
{
Log.Debug("ExampleCallback.OnSuccess()", "Response received: {0}", customData["json"].ToString());
}

// Generic fail callback
private void OnFail(RESTConnector.Error error, Dictionary<string, object> customData)
private void OnSuccess<T>(DetailedResponse<T> resp, IBMError error)
{
Log.Error("ExampleCallback.OnFail()", "Error received: {0}", error.ToString());
}
```

## Custom data
Custom data can be passed through a `Dictionary<string, object> customData` in each call. In most cases, the raw json response is returned in the customData under `"json"` entry. In cases where there is no returned json, the entry will contain the success and http response code of the call.

```cs
void Example()
{
Dictionary<string, object> customData = new Dictionary<string, object>();
customData.Add("foo", "bar");
assistant.Message(OnSuccess, OnFail, "<workspace-id>", "", customData);
}

// Generic success callback
private void OnSuccess<T>(T resp, Dictionary<string, object> customData)
{
Log.Debug("ExampleCustomData.OnSuccess()", "Custom Data: {0}", customData["foo"].ToString()); // returns "bar"
}

// Generic fail callback
private void OnFail(RESTConnector.Error error, Dictionary<string, object> customData)
{
Log.Error("ExampleCustomData.OnFail()", "Error received: {0}", error.ToString()); // returns error string
Log.Debug("ExampleCustomData.OnFail()", "Custom Data: {0}", customData["foo"].ToString()); // returns "bar"
Log.Debug("ExampleCallback.OnSuccess()", "Response received: {0}", resp.Response);
}
```

## Custom Request Headers
You can send custom request headers by adding them to the `customData` object.
You can send custom request headers by adding them to the service.

```cs
void Example()
{
// Create customData object
Dictionary<string, object> customData = new Dictionary<string, object>();
// Create a dictionary of custom headers
Dictionary<string, string> customHeaders = new Dictionary<string, string>();
// Add to the header dictionary
customHeaders.Add("X-Watson-Metadata", "customer_id=some-assistant-customer-id");
// Add the header dictionary to the custom data object
customData.Add(Constants.String.CUSTOM_REQUEST_HEADERS, customHeaders);

assistant.Message(OnSuccess, OnFail, "<workspace-id>", customData: customData);
assistant.AddHeader("X-Watson-Metadata", "customer_id=some-assistant-customer-id");
assistant.Message(OnSuccess, "<workspace-id>");
}
```

## Response Headers
You can get responseheaders in the `customData` object in the callback.
You can get response headers in the `headers` object in the DetailedResponse.

```cs
void Example()
{
assistant.Message(OnMessage, OnFail, "<workspace-id>");
assistant.Message(OnMessage, "<workspace-id>");
}

private void OnMessage(object resp, Dictionary<string, object> customData)
private void OnMessage(DetailedResponse<JOBject> resp, IBMError error)
{
// List all headers in the response headers object
if (customData.ContainsKey(Constants.String.RESPONSE_HEADERS))
foreach (KeyValuePair<string, string> kvp in resp.Headers)
{
foreach (KeyValuePair<string, string> kvp in customData[Constants.String.RESPONSE_HEADERS] as Dictionary<string, string>)
{
Log.Debug("ExampleCustomHeader.OnMessage()", "{0}: {1}", kvp.Key, kvp.Value);
}
Log.Debug("ExampleCustomHeader.OnMessage()", "{0}: {1}", kvp.Key, kvp.Value);
}
}
```

## Authentication Tokens

**Authenticating with the `X-Watson-Authorization-Token` header is deprecated. The token continues to work with Cloud Foundry services, but is not supported for services that use Identity and Access Management (IAM) authentication. For details see [Authenticating with IAM tokens](https://console.bluemix.net/docs/services/watson/getting-started-iam.html#iam) or the [README](#IAM) in the IBM Watson SDK you use.**

You use tokens to write applications that make authenticated requests to IBM Watson™ services without embedding service credentials in every call.

You can write an authentication proxy in IBM Cloud that obtains and returns a token to your client application, which can then use the token to call the service directly. This proxy eliminates the need to channel all service requests through an intermediate server-side application, which is otherwise necessary to avoid exposing your service credentials from your client application.

```cs
using IBM.Watson.DeveloperCloud.Services.Assistant.v1;
using IBM.Watson.DeveloperCloud.Utilities;

void Start()
{
Credentials credentials = new Credentials(<service-url>)
{
AuthenticationToken = <authentication-token>
};
Assistant _assistant = new Assistant(credentials);
}
```

There is a helper class included to obtain tokens from within your Unity application.

```cs
using IBM.Watson.DeveloperCloud.Utilities;

AuthenticationToken _authenticationToken;

void Start()
{
if (!Utility.GetToken(OnGetToken, <service-url>, <service-username>, <service-password>))
Log.Debug("ExampleGetToken.Start()", "Failed to get token.");
}

private void OnGetToken(AuthenticationToken authenticationToken, string customData)
{
_authenticationToken = authenticationToken;
Log.Debug("ExampleGetToken.OnGetToken()", "created: {0} | time to expiration: {1} minutes | token: {2}", _authenticationToken.Created, _authenticationToken.TimeUntilExpiration, _authenticationToken.Token);
}
```

## Streaming outside of US South region
Watson services have upgraded their hosts to TLS 1.2. The US South region has a TLS 1.0 endpoint that will work for streaming but if you are streaming in other regions you will need to use Unity 2018.2 and set Scripting Runtime Version in Build Settings to .NET 4.x equivalent. In lower versions of Unity you will need to create the Speech to Text instance in US South.

Expand All @@ -366,7 +261,7 @@ The Watson Unity SDK does not support IBM Cloud Private because connection via p
Documentation can be found [here][documentation]. You can also access the documentation by selecting API Reference the Watson menu (**Watson -> API Reference**).

## Getting started videos
You can view Getting Started videos for the IBM Watson SDK for Unity on [YouTube](https://www.youtube.com/watch?v=Sa5hmukwHV8&list=PLZDyxLlNKRY8MdgiUq45cZztn_f0EVz6c).
You can view Getting Started videos for the IBM Watson SDK for Unity on [YouTube](https://www.youtube.com/watch?v=sNPsdUWSi34&list=PLZDyxLlNKRY9b2vurEhkSoNWZN5c5l4Nr).

## Questions

Expand Down
Loading