AzureML (version 0.2.10)

endpointHelp: Display AzureML Web Service Endpoint Help Screens

Description

Download and return help for the specified AzureML web service endpoint.

Usage

endpointHelp(e, type = c("apidocument", "r-snippet", "score", "jobs", "update"))

Arguments

e

an AzureML web service endpoint from the endpoints function.

type

the type of help to display.

Value

The help text is returned. If type="apidocument", then the help is returned as a list from a parsed JSON document describing the service.

See Also

Other discovery functions: discoverSchema; endpoints, getEndpoints; getWebServices, services; workspace

Examples

## Not run: 
# workspace_id <- ""          # Your AzureML workspace id
# authorization_token <- ""   # Your AzureML authorization token
# 
# ws <- workspace(
#   id = workspace_id,
#   auth = authorization_token
# )
# 
# s <- services(ws)
# e <- endpoints(ws, s[1,])
# endpointHelp(e[1,])
# 
# Particularly useful way to see expected service input and output:
# endpointHelp(e[1,])$definitions
# 
# 
# ## End(Not run)