From 4b000e1348f1eeaad3cb110588464b8377ea83c4 Mon Sep 17 00:00:00 2001 From: Louis Mandel Date: Wed, 13 Dec 2017 11:00:18 -0500 Subject: [PATCH] Update webdocs. --- .../wcs-api-jsoo/Wcs_api_jsoo/Wcs_bot/index.html | 15 --------------- .../Wcs_api_jsoo/Wcs_call/index.html | 16 ---------------- docs/wcs-api-jsoo/Wcs_api_jsoo/index.html | 2 -- .../Wcs_api_jsoo__Wcs_bot/index.html | 15 --------------- docs/wcs-api-jsoo/index.html | 3 --- .../wcs-api-unix/Wcs_api_unix/Wcs_bot/index.html | 15 --------------- docs/wcs-api-unix/Wcs_api_unix/index.html | 2 -- .../Wcs_api_unix__Wcs_call/index.html | 16 ---------------- docs/wcs-api-unix/index.html | 3 --- docs/wcs-api/Wcs_api/Wcs_bot/index.html | 15 +++++++++++++++ .../Wcs_api}/Wcs_call/index.html | 2 +- docs/wcs-api/Wcs_api/index.html | 2 +- .../Wcs_api__Wcs_bot}/index.html | 2 +- .../Wcs_api__Wcs_call}/index.html | 2 +- 14 files changed, 19 insertions(+), 91 deletions(-) delete mode 100644 docs/wcs-api-jsoo/Wcs_api_jsoo/Wcs_bot/index.html delete mode 100644 docs/wcs-api-jsoo/Wcs_api_jsoo/Wcs_call/index.html delete mode 100644 docs/wcs-api-jsoo/Wcs_api_jsoo/index.html delete mode 100644 docs/wcs-api-jsoo/Wcs_api_jsoo__Wcs_bot/index.html delete mode 100644 docs/wcs-api-jsoo/index.html delete mode 100644 docs/wcs-api-unix/Wcs_api_unix/Wcs_bot/index.html delete mode 100644 docs/wcs-api-unix/Wcs_api_unix/index.html delete mode 100644 docs/wcs-api-unix/Wcs_api_unix__Wcs_call/index.html delete mode 100644 docs/wcs-api-unix/index.html create mode 100644 docs/wcs-api/Wcs_api/Wcs_bot/index.html rename docs/{wcs-api-unix/Wcs_api_unix => wcs-api/Wcs_api}/Wcs_call/index.html (90%) rename docs/{wcs-api-unix/Wcs_api_unix__Wcs_bot => wcs-api/Wcs_api__Wcs_bot}/index.html (50%) rename docs/{wcs-api-jsoo/Wcs_api_jsoo__Wcs_call => wcs-api/Wcs_api__Wcs_call}/index.html (90%) diff --git a/docs/wcs-api-jsoo/Wcs_api_jsoo/Wcs_bot/index.html b/docs/wcs-api-jsoo/Wcs_api_jsoo/Wcs_bot/index.html deleted file mode 100644 index e2f0322..0000000 --- a/docs/wcs-api-jsoo/Wcs_api_jsoo/Wcs_bot/index.html +++ /dev/null @@ -1,15 +0,0 @@ - -Wcs_bot (wcs-api-jsoo.Wcs_api_jsoo.Wcs_bot)

Module Wcs_api_jsoo.Wcs_bot

Generic bot runtime.

val user_input_default : unit ‑> string

interpret cred ws_id msg_req executes a complet conversation turn -(including skip_user_input and calls) on the workspace id ws_id -with the message request msg_req. The result is composed of the -workspace id for the next conversation turn, the message response -and the value of the field return in the context if it is -defined.

val exec : ?⁠before:(Wcs_lib.Wcs_t.message_request ‑> Wcs_lib.Wcs_t.message_request) ‑> ?⁠after:(Wcs_lib.Wcs_t.message_response ‑> Wcs_lib.Wcs_t.message_response) ‑> ?⁠user_input:(unit ‑> string) ‑> ?⁠output:(string ‑> unit) ‑> Wcs_lib.Wcs_t.credential ‑> string ‑> Wcs_lib.Wcs_t.json ‑> string ‑> Wcs_lib.Wcs_t.json

exec cred ws_id ctx_init txt_init executes the workspace ws_id -with the initial context ctx_init and the initial input text -txt_init. The execution is completed when the field return is -defined in the context. The return value is the value of the field -return.

val get_credential : string option ‑> Wcs_lib.Wcs_t.credential

get_credential file_name read the credential in json format from -the file file_name. If no file name is provided, the functions looks -up in the environment if the variable WCS_CRED contains the file name -with the credentials. If there is a problem while loading the credentials, -Log.Error is raised.

\ No newline at end of file diff --git a/docs/wcs-api-jsoo/Wcs_api_jsoo/Wcs_call/index.html b/docs/wcs-api-jsoo/Wcs_api_jsoo/Wcs_call/index.html deleted file mode 100644 index c6bb685..0000000 --- a/docs/wcs-api-jsoo/Wcs_api_jsoo/Wcs_call/index.html +++ /dev/null @@ -1,16 +0,0 @@ - -Wcs_call (wcs-api-jsoo.Wcs_api_jsoo.Wcs_call)

Module Wcs_api_jsoo.Wcs_call

Watson Conversation Service API.

Based on the documentation available at: -https://www.ibm.com/watson/developercloud/conversation/api/v1/

Version 2017-05-26.

val version : string
Workspaces

list_workspaces wcs_cred req -List the workspaces associated with a Conversation service instance. -https://www.ibm.com/watson/developercloud/conversation/api/v1/#list_workspaces

create_workspace wcs_cred ws -Create a workspace on the Conversation service instance. -https://www.ibm.com/watson/developercloud/conversation/api/v1/#create_workspace

val delete_workspace : Wcs_lib.Wcs_t.credential ‑> string ‑> unit

delete_workspace wcs_cred ws_id -Delete a workspace from the Conversation service instance. -https://www.ibm.com/watson/developercloud/conversation/api/v1/#delete_workspace

get_workspace wcs_cred req -Get information about a workspace, optionally including all -workspace content. -https://www.ibm.com/watson/developercloud/conversation/api/v1/#get_workspace

val update_workspace : Wcs_lib.Wcs_t.credential ‑> string ‑> Wcs_lib.Wcs_t.workspace ‑> unit

update_workspace wcs_cred ws_id ws -Update an existing workspace with new or modified data. -https://www.ibm.com/watson/developercloud/conversation/api/v1/#update_workspace

Messages

message wcs_cred ws_id req -Get a response to a user's input. -https://www.ibm.com/watson/developercloud/conversation/api/v1/#send_message

Logs
\ No newline at end of file diff --git a/docs/wcs-api-jsoo/Wcs_api_jsoo/index.html b/docs/wcs-api-jsoo/Wcs_api_jsoo/index.html deleted file mode 100644 index 15f7aaa..0000000 --- a/docs/wcs-api-jsoo/Wcs_api_jsoo/index.html +++ /dev/null @@ -1,2 +0,0 @@ - -Wcs_api_jsoo (wcs-api-jsoo.Wcs_api_jsoo)

Module Wcs_api_jsoo

module Wcs_bot : sig ... end
module Wcs_call : sig ... end
\ No newline at end of file diff --git a/docs/wcs-api-jsoo/Wcs_api_jsoo__Wcs_bot/index.html b/docs/wcs-api-jsoo/Wcs_api_jsoo__Wcs_bot/index.html deleted file mode 100644 index d08fa7d..0000000 --- a/docs/wcs-api-jsoo/Wcs_api_jsoo__Wcs_bot/index.html +++ /dev/null @@ -1,15 +0,0 @@ - -Wcs_api_jsoo__Wcs_bot (wcs-api-jsoo.Wcs_api_jsoo__Wcs_bot)

Module Wcs_api_jsoo__Wcs_bot

Generic bot runtime.

val user_input_default : unit ‑> string

interpret cred ws_id msg_req executes a complet conversation turn -(including skip_user_input and calls) on the workspace id ws_id -with the message request msg_req. The result is composed of the -workspace id for the next conversation turn, the message response -and the value of the field return in the context if it is -defined.

val exec : ?⁠before:(Wcs_lib.Wcs_t.message_request ‑> Wcs_lib.Wcs_t.message_request) ‑> ?⁠after:(Wcs_lib.Wcs_t.message_response ‑> Wcs_lib.Wcs_t.message_response) ‑> ?⁠user_input:(unit ‑> string) ‑> ?⁠output:(string ‑> unit) ‑> Wcs_lib.Wcs_t.credential ‑> string ‑> Wcs_lib.Wcs_t.json ‑> string ‑> Wcs_lib.Wcs_t.json

exec cred ws_id ctx_init txt_init executes the workspace ws_id -with the initial context ctx_init and the initial input text -txt_init. The execution is completed when the field return is -defined in the context. The return value is the value of the field -return.

val get_credential : string option ‑> Wcs_lib.Wcs_t.credential

get_credential file_name read the credential in json format from -the file file_name. If no file name is provided, the functions looks -up in the environment if the variable WCS_CRED contains the file name -with the credentials. If there is a problem while loading the credentials, -Log.Error is raised.

\ No newline at end of file diff --git a/docs/wcs-api-jsoo/index.html b/docs/wcs-api-jsoo/index.html deleted file mode 100644 index 5714282..0000000 --- a/docs/wcs-api-jsoo/index.html +++ /dev/null @@ -1,3 +0,0 @@ - -wcs_api_jsoo-generated (wcs-api-jsoo.wcs_api_jsoo-generated)

Library wcs-api-jsoo

-The entry point for this library is module Wcs_api_jsoo.

\ No newline at end of file diff --git a/docs/wcs-api-unix/Wcs_api_unix/Wcs_bot/index.html b/docs/wcs-api-unix/Wcs_api_unix/Wcs_bot/index.html deleted file mode 100644 index 329edf5..0000000 --- a/docs/wcs-api-unix/Wcs_api_unix/Wcs_bot/index.html +++ /dev/null @@ -1,15 +0,0 @@ - -Wcs_bot (wcs-api-unix.Wcs_api_unix.Wcs_bot)

Module Wcs_api_unix.Wcs_bot

Generic bot runtime.

val user_input_default : unit ‑> string

interpret cred ws_id msg_req executes a complet conversation turn -(including skip_user_input and calls) on the workspace id ws_id -with the message request msg_req. The result is composed of the -workspace id for the next conversation turn, the message response -and the value of the field return in the context if it is -defined.

val exec : ?⁠before:(Wcs_lib.Wcs_t.message_request ‑> Wcs_lib.Wcs_t.message_request) ‑> ?⁠after:(Wcs_lib.Wcs_t.message_response ‑> Wcs_lib.Wcs_t.message_response) ‑> ?⁠user_input:(unit ‑> string) ‑> ?⁠output:(string ‑> unit) ‑> Wcs_lib.Wcs_t.credential ‑> string ‑> Wcs_lib.Wcs_t.json ‑> string ‑> Wcs_lib.Wcs_t.json

exec cred ws_id ctx_init txt_init executes the workspace ws_id -with the initial context ctx_init and the initial input text -txt_init. The execution is completed when the field return is -defined in the context. The return value is the value of the field -return.

val get_credential : string option ‑> Wcs_lib.Wcs_t.credential

get_credential file_name read the credential in json format from -the file file_name. If no file name is provided, the functions looks -up in the environment if the variable WCS_CRED contains the file name -with the credentials. If there is a problem while loading the credentials, -Log.Error is raised.

\ No newline at end of file diff --git a/docs/wcs-api-unix/Wcs_api_unix/index.html b/docs/wcs-api-unix/Wcs_api_unix/index.html deleted file mode 100644 index ac6c10b..0000000 --- a/docs/wcs-api-unix/Wcs_api_unix/index.html +++ /dev/null @@ -1,2 +0,0 @@ - -Wcs_api_unix (wcs-api-unix.Wcs_api_unix)

Module Wcs_api_unix

module Wcs_bot : sig ... end
module Wcs_call : sig ... end
\ No newline at end of file diff --git a/docs/wcs-api-unix/Wcs_api_unix__Wcs_call/index.html b/docs/wcs-api-unix/Wcs_api_unix__Wcs_call/index.html deleted file mode 100644 index 3dce7a5..0000000 --- a/docs/wcs-api-unix/Wcs_api_unix__Wcs_call/index.html +++ /dev/null @@ -1,16 +0,0 @@ - -Wcs_api_unix__Wcs_call (wcs-api-unix.Wcs_api_unix__Wcs_call)

Module Wcs_api_unix__Wcs_call

Watson Conversation Service API.

Based on the documentation available at: -https://www.ibm.com/watson/developercloud/conversation/api/v1/

Version 2017-05-26.

val version : string
Workspaces

list_workspaces wcs_cred req -List the workspaces associated with a Conversation service instance. -https://www.ibm.com/watson/developercloud/conversation/api/v1/#list_workspaces

create_workspace wcs_cred ws -Create a workspace on the Conversation service instance. -https://www.ibm.com/watson/developercloud/conversation/api/v1/#create_workspace

val delete_workspace : Wcs_lib.Wcs_t.credential ‑> string ‑> unit

delete_workspace wcs_cred ws_id -Delete a workspace from the Conversation service instance. -https://www.ibm.com/watson/developercloud/conversation/api/v1/#delete_workspace

get_workspace wcs_cred req -Get information about a workspace, optionally including all -workspace content. -https://www.ibm.com/watson/developercloud/conversation/api/v1/#get_workspace

val update_workspace : Wcs_lib.Wcs_t.credential ‑> string ‑> Wcs_lib.Wcs_t.workspace ‑> unit

update_workspace wcs_cred ws_id ws -Update an existing workspace with new or modified data. -https://www.ibm.com/watson/developercloud/conversation/api/v1/#update_workspace

Messages

message wcs_cred ws_id req -Get a response to a user's input. -https://www.ibm.com/watson/developercloud/conversation/api/v1/#send_message

Logs
\ No newline at end of file diff --git a/docs/wcs-api-unix/index.html b/docs/wcs-api-unix/index.html deleted file mode 100644 index 6870be5..0000000 --- a/docs/wcs-api-unix/index.html +++ /dev/null @@ -1,3 +0,0 @@ - -wcs_api_unix-generated (wcs-api-unix.wcs_api_unix-generated)

Library wcs-api-unix

-The entry point for this library is module Wcs_api_unix.

\ No newline at end of file diff --git a/docs/wcs-api/Wcs_api/Wcs_bot/index.html b/docs/wcs-api/Wcs_api/Wcs_bot/index.html new file mode 100644 index 0000000..d3f773a --- /dev/null +++ b/docs/wcs-api/Wcs_api/Wcs_bot/index.html @@ -0,0 +1,15 @@ + +Wcs_bot (wcs-api.Wcs_api.Wcs_bot)

Module Wcs_api.Wcs_bot

Generic bot runtime.

val user_input_default : unit ‑> string

interpret cred ws_id msg_req executes a complet conversation turn +(including skip_user_input and calls) on the workspace id ws_id +with the message request msg_req. The result is composed of the +workspace id for the next conversation turn, the message response +and the value of the field return in the context if it is +defined.

val exec : ?⁠before:(Wcs_lib.Wcs_t.message_request ‑> Wcs_lib.Wcs_t.message_request) ‑> ?⁠after:(Wcs_lib.Wcs_t.message_response ‑> Wcs_lib.Wcs_t.message_response) ‑> ?⁠user_input:(unit ‑> string) ‑> ?⁠output:(string ‑> unit) ‑> Wcs_lib.Wcs_t.credential ‑> string ‑> Wcs_lib.Wcs_t.json ‑> string ‑> Wcs_lib.Wcs_t.json

exec cred ws_id ctx_init txt_init executes the workspace ws_id +with the initial context ctx_init and the initial input text +txt_init. The execution is completed when the field return is +defined in the context. The return value is the value of the field +return.

val get_credential : string option ‑> Wcs_lib.Wcs_t.credential

get_credential file_name read the credential in json format from +the file file_name. If no file name is provided, the functions looks +up in the environment if the variable WCS_CRED contains the file name +with the credentials. If there is a problem while loading the credentials, +Log.Error is raised.

\ No newline at end of file diff --git a/docs/wcs-api-unix/Wcs_api_unix/Wcs_call/index.html b/docs/wcs-api/Wcs_api/Wcs_call/index.html similarity index 90% rename from docs/wcs-api-unix/Wcs_api_unix/Wcs_call/index.html rename to docs/wcs-api/Wcs_api/Wcs_call/index.html index addd4c1..c91703a 100644 --- a/docs/wcs-api-unix/Wcs_api_unix/Wcs_call/index.html +++ b/docs/wcs-api/Wcs_api/Wcs_call/index.html @@ -1,5 +1,5 @@ -Wcs_call (wcs-api-unix.Wcs_api_unix.Wcs_call)

Module Wcs_api_unix.Wcs_call

Watson Conversation Service API.

Based on the documentation available at: +Wcs_call (wcs-api.Wcs_api.Wcs_call)

Module Wcs_api.Wcs_call

Watson Conversation Service API.

Based on the documentation available at: https://www.ibm.com/watson/developercloud/conversation/api/v1/

Version 2017-05-26.

val version : string
Workspaces

list_workspaces wcs_cred req List the workspaces associated with a Conversation service instance. https://www.ibm.com/watson/developercloud/conversation/api/v1/#list_workspaces

create_workspace wcs_cred ws diff --git a/docs/wcs-api/Wcs_api/index.html b/docs/wcs-api/Wcs_api/index.html index baf79ec..32d1a74 100644 --- a/docs/wcs-api/Wcs_api/index.html +++ b/docs/wcs-api/Wcs_api/index.html @@ -1,2 +1,2 @@ -Wcs_api (wcs-api.Wcs_api)

Module Wcs_api

module Wcs_bot_factory : sig ... end
module Wcs_call_factory : sig ... end
\ No newline at end of file +Wcs_api (wcs-api.Wcs_api)

Module Wcs_api

module Wcs_bot : sig ... end
module Wcs_bot_factory : sig ... end
module Wcs_call : sig ... end
module Wcs_call_factory : sig ... end
\ No newline at end of file diff --git a/docs/wcs-api-unix/Wcs_api_unix__Wcs_bot/index.html b/docs/wcs-api/Wcs_api__Wcs_bot/index.html similarity index 50% rename from docs/wcs-api-unix/Wcs_api_unix__Wcs_bot/index.html rename to docs/wcs-api/Wcs_api__Wcs_bot/index.html index 7432fbf..ca46805 100644 --- a/docs/wcs-api-unix/Wcs_api_unix__Wcs_bot/index.html +++ b/docs/wcs-api/Wcs_api__Wcs_bot/index.html @@ -1,5 +1,5 @@ -Wcs_api_unix__Wcs_bot (wcs-api-unix.Wcs_api_unix__Wcs_bot)

Module Wcs_api_unix__Wcs_bot

Generic bot runtime.

val user_input_default : unit ‑> string

interpret cred ws_id msg_req executes a complet conversation turn +Wcs_api__Wcs_bot (wcs-api.Wcs_api__Wcs_bot)

Module Wcs_api__Wcs_bot

Generic bot runtime.

val user_input_default : unit ‑> string

interpret cred ws_id msg_req executes a complet conversation turn (including skip_user_input and calls) on the workspace id ws_id with the message request msg_req. The result is composed of the workspace id for the next conversation turn, the message response diff --git a/docs/wcs-api-jsoo/Wcs_api_jsoo__Wcs_call/index.html b/docs/wcs-api/Wcs_api__Wcs_call/index.html similarity index 90% rename from docs/wcs-api-jsoo/Wcs_api_jsoo__Wcs_call/index.html rename to docs/wcs-api/Wcs_api__Wcs_call/index.html index 715da6c..8f1dc17 100644 --- a/docs/wcs-api-jsoo/Wcs_api_jsoo__Wcs_call/index.html +++ b/docs/wcs-api/Wcs_api__Wcs_call/index.html @@ -1,5 +1,5 @@ -Wcs_api_jsoo__Wcs_call (wcs-api-jsoo.Wcs_api_jsoo__Wcs_call)

Module Wcs_api_jsoo__Wcs_call

Watson Conversation Service API.

Based on the documentation available at: +Wcs_api__Wcs_call (wcs-api.Wcs_api__Wcs_call)

Module Wcs_api__Wcs_call

Watson Conversation Service API.

Based on the documentation available at: https://www.ibm.com/watson/developercloud/conversation/api/v1/

Version 2017-05-26.

val version : string
Workspaces

list_workspaces wcs_cred req List the workspaces associated with a Conversation service instance. https://www.ibm.com/watson/developercloud/conversation/api/v1/#list_workspaces

create_workspace wcs_cred ws