Cognitive Services SDK Samples (Ruby)

These samples will show you how to get up and running using the SDKs for various Cognitive Services. They'll cover a few rudimentary use cases and hopefully express best practices for interacting with the data from these APIs.

Features

This project framework provides examples for the following services:

• Using the Computer Vision SDK for the Computer Vision API
• Using the Content Moderator SDK for the Content Moderator API
• Using the Custom Search SDK for the Custom Search API
• Using the Entity Search SDK for the Entity Search API
• Using the Image Search SDK for the Image Search API
• Using the News Search SDK for the News Search API
• Using the Spell Check SDK for the Spell Check API
• Using the Text Analytics SDK for the Text Analytics API
• Using the Video Search SDK for the Video Search API
• Using the Web Search SDK for the Web Search API

Run this sample

1. If you don't already have it, get ruby.

2. Clone the repository.

   git clone https://github.com/Azure-Samples/cognitive-services-ruby-sdk-samples.git
   

3. Install the dependencies.

   cd cognitive-services-ruby-sdk-samples
   bundle install
   

4. Get a cognitive services API key with which to authenticate the SDK's calls. Sign up here by navigating to the right service and acquiring an API key. You can get a trial key for free which will expire after 30 days.

5. Set the following environment variables. You only need to set the environment variables for which you want to run the samples.

You can set the environment variable as:

```
export {your key}={your value}
```

> [AZURE.NOTE] On Windows, use `set` instead of `export`.

3. Run the sample.

   ruby run_samples.rb --sdk={sample_to_run}
   

4. To know the possible values of sdk, you can run the following command:

   ruby run_samples.rb --help
   

To see the code of each example, simply look at the examples in the Samples folder. They are written to be isolated in scope so that you can see only what you're interested in.