AlgorithmiaAlgorithm-class {algorithmia}

Algorithm object which enables you to call Algorithmia algorithms. To create one, call: 'client$algo("algoUrl")'

Description

Algorithm object which enables you to call Algorithmia algorithms. To create one, call: 'client$algo("algoUrl")'

Fields

client

Reference to the AlgorithmiaClient object that has the credentials necessary to make API calls.

algoUrl

The unique identifier for an algorithm. Follows the pattern: [Algorithm Author]/[Algorithm Name]/[Optional Version] like: 'demo/Hello/0.1.1'.

queryParameters

Mutable list of parameters to use while making algorithm calls. These can be changed by calling setOptions.

Methods

pipe(input)

Calls an algorithm with the input provided.

setOptions( timeout = 300, stdout = FALSE, output = "default", parameters = list() )

Allows you to set the timeout duration (in seconds), whether you want the stdout that was produced while running the algorithm (this only works when the algorithm author call it), and whether this should run as async (output = 'void') or in raw mode (output = 'raw').