Developer Center

Resources to get you started with Algorithmia

Ruby

Updated

Available on GitHub.

The Algorithmia Ruby client provides a native Ruby 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.

To follow along you can create a new Ruby script or you can follow the examples in the Ruby interpreter.

Set Up the Client

The Algorithmia Ruby Client is available on rubygems. Simply add gem algorithmia to your application’s Gemfile and run bundle install or install via:

$ gem install algorithmia

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:

require "algorithmia"

# Authenticate with your API key
api_key = "YOUR_API_KEY"
# Create the Algorithmia client object
client = Algorithmia.client(api_key)

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:

client = Algorithmia.client(api_key, "https://mylocalendpoint")

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 Ruby, we need to first create an algorithm object. With the client already instantiated, we can run the following code to create an object:

algo = client.algo("demo/Hello")

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 result attribute:

response = algo.pipe("HAL 9000")
puts response.result

Which should print the phrase, Hello HAL 9000.

JSON and Ruby

The Ruby client provides some ease-of-use abstractions for working with algorithms with JSON inputs and outputs. When passing a Ruby array or hash into the pipe function, the library will automatically serialize it to JSON. Algorithms will return a JSON type and the result field of the response will contain the appropriate deserialized type.

Let’s look at an example using JSON and the nlp/LDA algorithm. The algorithm docs tell us that the algorithm takes a list of documents and returns a number of topics that are relevant to those documents. The documents can be a list of strings, a Data API file path, or a URL. We’ll call this algorithm using a list of strings, following the format in the algorithm documentation:

algo_json = client.algo("nlp/LDA/1.0.0")
input = {
    :docsList => [
        "It's apple picking season",
        "The apples are ready for picking"
    ]
}
response = algo_json.pipe(input)
puts response.result

The output will be a list of relevant topics and their number of occurrences, which will look something like: [{'picking': 2}, {'apple': 1}, {'apples': 1, 'ready': 1}, {'season': 1}].

Alternatively, if your input is already serialized to JSON, you may call pipe_json instead.

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.

Request Options

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 disable stdout in the response:

algo.set(timeout: 60, stdout: false)

You can find more details in API Docs > Invoke an Algorithm.

Error Handling

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. In Ruby, API errors and Algorithm exceptions will result in calls to pipe throwing an AlgoException:

begin
    client.algo('util/whoopsWrongAlgo').pipe('Hello, world!')
rescue Exception => e
    puts e
end

You can read more about Error Handling in the Algorithm Development section of the dev center.

Limits

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 an image to Algorithmia’s Hosted Data storage provider, and use the dlib/FaceDetection algorithm to detect any faces in the image. The algorithm will create a new copy of the image with bounding boxes drawn around the detected faces, and then return a JSON object with details about the dimensions of the bounding boxes and a URI where you can download the resulting image.

Create a Data Collection

The documentation for “Face Detection” says that it takes a URL or a Data URI of the image to be processed, and a Data URI where the algorithm can store the result. Create a directory to host the input image:

img_directory = client.dir("data://YOUR_USERNAME/img_directory")
if (img_directory.exists? == FALSE)
    img_directory.create
    puts "Created directory"
else
    puts "Error: This directory already exists"
end

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.

We’ll also need to update the directory’s permissions so that it’s publicly accessible. In order to change your data collection permissions you can go to Hosted Data and click on the collection you just created called “nlp_directory” and select from the dropdown at the top of the screen that will show three different types of permissions:

  • My Algorithms (called by any user)
  • Private (accessed only by me)
  • Public (available to anyone)

Set the permissions to Public before moving to the next section.

Upload Data to your Data Collection

Now we’re ready to upload an image file for processing. For this example, we’ll use this photo of a group of friends. Download the image and save it locally as friends.jpg.

Next, create a variable that holds the location where you would like to upload the image as a URI:

img_file = "data://.my/img_directory/friends.jpg"

Then upload your local file to the data collection using the put_file method:

if (client.file(img_file).exists? == FALSE)
    # Upload local file
    img_directory.put_file("your_local_path_to_file/friends.jpg")
    puts "Uploaded local file"
else
    puts "Error: File already exists."
end

This method 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 method.

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. Create the algorithm object, then pass the required inputs—an image URI (which is stored in img_file in the code above) and a URI for the image output—to pipe:

# Create the algorithm object
algo_cv = client.algo("dlib/FaceDetection/0.2.1")

input = {
    :images => [
        {
            :url => "data://.my/img_directory/friends.jpg",
            :output => "data://.algo/temp/detected_faces.png"
        }
    ]
}

# Invoke algorithm with error handling
begin
    response = algo_cv.pipe(input)
    puts response.result
rescue Exception => e
    # Algorithm error if, for example, the input is not correctly formatted
    puts e
end

Once the algorithm has completed, response.result will contain the dimensions of the bounding boxes for any detected faces and the URI for the resulting 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 data://.algo/author/algoName/folder/fileName.

Download the resulting file

The URI included in the algorithm output uses the .algo shortcut, so we’ll need to modify it slightly to download the file by adding the algorithm name and author. Verify that the file that you want to download exists, and try downloading it to a new local file location:

download_uri = "data://.algo/dlib/FaceDetection/temp/detected_faces.png"

# Download the file
if (client.file(download_uri).exists? == TRUE)
    local_file = client.file(download_uri).get_file
    puts local_file.path
end

This copies the file from your data collection and saves it as a temp file on your local machine, storing the filename in the variable local_file. Ruby cleans up temp files when the program or interpreter terminates, so remember to save the file to a new location if you want to keep it.

Alternately, if you just need the contents of the file to be stored in a variable, you can retrieve the remote file’s content without saving the actual file:

# Download contents of file as a string
if client.file(download_uri).exists():
    image_data = client.file(download_uri).get

This will get the image as binary data, saving it to the variable image_data, which might be useful when writing algorithms that are part of an image processing pipeline.

If the file was text (an image, etc.), the get function will retrieve the file’s content as a string. For more methods on how to get a file from a data collection using the Data API go to the API Specification.

Additional Functionality

In addition to the functionality covered in this guide, the Ruby 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.

Next Steps

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.