AlgorithmiaClient-class {algorithmia}

Client object which makes it easy to interact with the Algorithmia REST API. To create one, call 'getAlgorithmiaClient("YOUR_ALGORITHMIA_API_KEY")'

Description

Client object which makes it easy to interact with the Algorithmia REST API. To create one, call 'getAlgorithmiaClient("YOUR_ALGORITHMIA_API_KEY")'

Fields

apiKey

The API key used when making REST calls to Algorithmia. This should NOT be set inside algorithms.

apiAddress

The Algorithmia API address. In most cases you don't need to set this explicitly since the default will talk to the correct Algorithmia API server.

Methods

algo(algoRef)

Takes an algorithm reference and returns an AlgorithmiaAlgorithm object. An algorithm reference is a string of the form [Algorithm Author]/[Algorithm Name]/[Optional Version] like: 'demo/Hello/0.1.1'. AlgorithmiaAlgorithm objects are used to call algorithms with data.

dir(dataUrl)

Takes a path to a directory and returns a AlgorithmiaDataDirectory object. Data paths are described in detail at: http://docs.algorithmia.com/?java#data-api-specification. AlgorithmiaDataDirectory objects are used to interact with directories.

file(dataUrl)

Takes a path to a file and returns a AlgorithmiaDataFile object. Data paths are described in detail at: http://docs.algorithmia.com/?java#data-api-specification. AlgorithmiaDataFile objects are used to read and write files.

reportInsights(insights)

Takes a list of Algorithmia Insights and reports them for this algorithm execution.