The Algorithmia R client provides a native R interface to the Algorithmia API, letting developers manage and call algorithms, work with data in object stores using Algorithmia Data Sources, and access other features of the Algorithmia platform.
This guide will cover setting up the client, calling an algorithm using direct user input, calling an algorithm that accesses data through Algorithmia Data Sources, and using Algorithmia’s Hosted Data service. For complete details about the Algorithmia API, please refer to the API Docs.
The code in this guide can be run directly in an R interpreter or used in your own scripts.
Set Up the Client
The official Algorithmia R client is available on CRAN and includes links to vignettes and the reference manual at: Algorithmia on CRAN
Open up the R shell to install the Algorithmia R Client (or use RStudio to install):
You can find the source code for the client on GitHub.
To use the client you’ll need an API key, which Algorithmia uses for fine-grained authentication across the platform. For this example, we’ll use the
default-key that was created along with your account, which has a broad set of permissions. Log in to Algorithmia and navigate to Home > API Keys to find your key, or read the API keys documentation for more information.
Once the client is installed, you can import it into your code and instantiate the client object:
Specifying an On-Premises or Private Cloud Endpoint
This feature is available to Algorithmia Enterprise users only.
If you are running Algorithmia Enterprise, you can specify the API endpoint when you create the client object:
Alternately, you can ensure that each of your servers interacting with your Algorithmia Enterprise instance have an environment variable named
ALGORITHMIA_API and the client will use it. The fallback API endpoint is always the hosted Algorithmia marketplace service at https://api.algorithmia.com/
Calling an Algorithm
Algorithms take three basic types of input whether they are invoked directly through the API or by using a client library: strings, JSON, and binary data. In addition, individual algorithms might have their own I/O requirements, such as using different data types for input and output, or accepting multiple types of input, so consult the input and output sections of an algorithm’s documentation for specifics.
The first algorithm we’ll call is a demo version of the algorithm used in the Algorithm Development Getting Started guide, which is available at demo/Hello. Looking at the algorithm’s documentation, it takes a string as input and returns a string.
In order to call an Algorithm from R, we need to first create an algorithm object. With the client already instantiated, we can run the following code to create an object:
Then, we can use the
$pipe() method to call the algorithm. We’ll provide our input as the argument to the function, and then print the output using the
Which should print the phrase, “Hello World”
JSON and R
The R client provides some ease of use abstractions for working with algorithms that have JSON inputs and outputs. When passing a R list or vector into an algorithm using the
$pipe() function, the library will automatically serialize it to JSON. Algorithms will return a JSON object where the
result field of the response contains a list or vector, as appropriate.
Let’s look at an example using JSON and the nlp/LDA algorithm. The algorithm docs tell us that the algorithm takes a group of documents and returns a number of topics which are relevant to those documents. The documents can be a JSON object with the key
docsList and a list of strings as the value, a Data API file path, or a URL. We’ll provide a named list with an element
docsList that contains a vector of strings to be processed, which will be serialized into the appropriate JSON object before being passed to the algorithm.
The output will be a list with named elements for each relevant word, and the number of occurrances:
You might have noticed that in this example we included a version number when instantiating the algorithm. Pinning your code to a specific version of the algorithm can be especially important in a production environment where the underlying implementation might change from version to version.
The client exposes options that can configure algorithm requests. This includes support for changing the timeout or indicating that the API should include
stdout in the response. In the following example, we set the timeout to 60 seconds and disabling
stdout in the response:
To be able to better develop across languages, Algorithmia has created a set of standardized errors that can be returned by either the platform or by the algorithm being run. We can then catch these errors as follows:
Your account can make up to 80 Algorithmia requests at the same time (this limit can be raised if needed).
Working with Algorithmia Data Sources
For some algorithms, passing input to the algorithm at request time is sufficient, while others might have larger data requirements or need to preserve state between calls. Application developers can use Algorithmia’s Hosted Data to store data as text, JSON, or binary, and access it via the Algorithmia Data API.
The Data API defines connectors to a variety of storage providers, including Algorithmia Hosted Data, Amazon S3, Google Cloud Storage, Azure Storage Blobs, and Dropbox. After creating a connection in Data Sources, you can use the API to create, update, and delete directories and files and manage permissions across providers by making use of Data URIs in your code.
In this example, we’ll upload a text document to Algorithmia’s Hosted Data storage provider, and use the nlp/CleanDocuments algorithm to pre-process the document for use in other algorithms. “Clean Documents” will remove HTML tags, emojis and other utf-8 encodings, along with all non-punctuation symbols and symoblics, then return a JSON object with a URI where you can download the resulting document.
Create a Data Collection
The documentation for nlp/CleanDocuments says that it takes a URL or a Data URI of the documents to be processed, and returns a Data URI where the result can be downloaded. We’ll create a directory to host the input documents, then update its permissions so that it’s publicly accessible:
Instead of your username you can also use ‘.my’ when calling algorithms. For more information about the ‘.my’ pseudonym check out the Hosted Data Guide.
Upload Data to your Data Collection
Now we’re ready to upload an text document for processing. For this example, we’ll use the first chapter of Jack London’s Burning Daylight. Since the “Clean Documents” algorithm can process multiple documents in the same text file, it requires each document to be separated by the delimiter
""". The algorithm will throw an error if the delimiter isn’t present. You can download the first chapter with the delimiter already added here: Chapter One Burning Daylight, by Jack London.
Next, create a variable that holds the URI location where you would like to upload the document:
Then upload your local file to the data collection using the
This function call will replace a file if it already exists at the specified location. If you wish to avoid replacing a file, check if the file exists before using this function.
Confirm that the file was created by navigating to Algorithmia’s Hosted Data Source and finding your data collection and file.
You can also upload your data through the UI on Algorithmia’s “Hosted Data Source”. For instructions on how to do this go to the Hosted Data Guide.
Call the Algorithm
Once the file has been uploaded, you are ready to call the algorithm. Instantiate the algorithm, then pass the URI for the file you want to process as the input:
Once the algorithm has completed,
response$result will contain a URI for the processed file, which you can then download (or provide as input to another algorithm in a pipeline).
Algorithms can create and store data in folders named with the algorithm name in the Algorithm Data collection. To access this folder from within an executing algorithm, the
.algo shortcut can be used, as in the input example above. When accessing data from a client context, the algorithm author and name can be used along with the
.algo shortcut to download data, in the format
Download the resulting file
We can download the resulting file using the URI returned in the algorithm output. First, verify that the file that you want to download exists, and download it to a new local file:
This copies the file from your data collection and saves it as a file on your local machine, storing the filename in the variable
Alternately, if you just need the JSON content of the processed file to be stored in a variable, you can retrieve the remote file’s content without saving the actual file:
This will get the file as a JSON object, saving it to the variable
processed_text, which might be useful when writing algorithms that are part of a text processing pipeline.
If the file was an image or some other binary data type, you could instead use the function
.getRaw() to retrieve the file’s content as raw bytes. For more methods on how to get a file using the Data API from a data collection refer to the API Specification.
Publishing Algorithmia Insights
This feature is available to Algorithmia Enterprise users only.
Inference-related metrics (a feature of Algorithmia Insights) can be reported via using the
report_insights method of the Algorithmia client.
In addition to the functionality covered in this guide, the R Client Library provides a complete interface to the Algorithmia platform, including managing algorithms, administering organizations, and working with source control. You can also visit the API Docs to view the complete API specification.
If you’re a data scientist or developer who will be building and deploying new algorithms, you can move on to the Algorithm Development > Getting Started guide.