Unlocking AI Potential: A Comprehensive Guide to AI71's API Hub

Comprehensive Guide to AI71's API Hub

Welcome, everyone! Whether you're an AI developer, software engineer, or just starting your coding journey, this tutorial is designed to help you navigate AI71's new API Hub. We'll explore how to interact with the powerful Falcon models, customize their settings, and manage your projects efficiently.

Let's dive in and unlock the full potential of the Falcon models together!

Introduction to AI71’s API Hub

AI71's API Hub is a powerful platform that provides seamless access to advanced AI models. It simplifies the integration of AI capabilities into your applications, offering a range of models and tools to enhance your projects. With this new API Hub, you can leverage cutting-edge technology to build intelligent applications effortlessly.

Features and Functionalities

Home Page Overview

When you first land on the AI71 platform's home page, you'll see three main options to interact with the API:

AI71 Python SDK
OpenAI Python SDK
Curl

Choosing a Model

AI71 offers several powerful models to choose from:

Falcon 180B
Falcon 11B
Falcon 11B VLM

Note: Currently, only tiiuae/falcon-180b-chat, tiiuae/falcon-11b, and tiiuae/falcon-11b-vlm models are operational. The other models will be available soon. In the meantime, you can test tiiuae/falcon-180b-chat, tiiuae/falcon-11b, and tiiuae/falcon-11b-vlm models to get a feel for the platform.

You can select any of these models right from the home page, making it easy to start your AI project with the right tools.

Token Calculator

You'll find a handy token calculator at the right of the home page. Simply input the amount in dollars, and it will automatically calculate the number of tokens you can get. This is a great way to manage your budget and plan your usage.

Each option includes an example to help you get started quickly. You can choose the method that best fits your workflow. Here's a quick look at the home page options:

Sandbox Page

The sandbox page is where you can interact with all the Falcon models in real-time. Here, you can:

Select a Model: Choose from the available models.
Customize the System Prompt: Tailor the prompt to fit your needs.
Adjust Maximum Output Length: Set the output length between 3 and 2048 tokens, depending on the model.
Tweak the Temperature: Adjust the temperature between 0 and 2 to control the randomness of the output.
Adjust Top P: Control the cumulative probability of token sequences.
Adjust Top K: Limit the next token selection to the top K tokens.
Set Frequency Penalty: Penalize new tokens based on their existing frequency in the text.
Define Stop Sequences: Specify sequences where the output should stop.

Maximum output length will differ based on each model.

This flexibility allows you to experiment and find the best settings for your specific use case.

Documentation Page

The documentation page provides detailed instructions on how to use the supported models via different methods:

AI71 Python SDK
OpenAI SDK
LangChain SDK
Curl

Each method comes with a brief description and a usage example to help you get started quickly. Other OpenAI-supported SDKs may work if there is an option to change the Base URL and API key.

Supported Models

AI71 supports several models, each with its specific use case and API call format:

tiiuae/falcon-180B-chat: A 180B parameters causal decoder-only model fine-tuned on Ultrachat, Platypus, and Airoboros datasets.
tiiuae/falcon-11b: A 11B parameters causal decoder-only model.
tiiuae/falcon-11b-vlm: A 11B parameters visual language model.

For more details, you can refer to the AI71 Documentation.

Organization Page

The organization page allows you to create and manage your organization. Here, you can:

Create an Organization: Set up your organization, invite one or more members.
Manage API Keys: Create and manage API keys.
Support: Create and manage support tickets.
Usage: View the usage of created API keys.

This is perfect for teams collaborating on AI projects, providing a centralized place to manage access and resources.

Use Cases

AI71's API Hub can be applied in various scenarios, such as:

Customer Support: Implementing chatbots that can handle customer inquiries and provide support.
Content Creation: Generating content for blogs, social media, and marketing campaigns.
Data Analysis: Automating the analysis of large datasets to derive insights.
Personal Assistants: Developing virtual assistants to help with scheduling, reminders, and information retrieval.

Implementations

Using the AI71 Python SDK

Here's a quick example of how to use the AI71 Python SDK:

First, install the SDK using pip:

Then, you can import the library and interact with any of the models in the Python file you wish to use it in:

Note: Replace with your actual API key. You can find or create your API key in Api Keys under the Organization section.

Using Curl

You can also interact with the API using Curl from the terminal:

Using Langchain SDK

To interact with the Falcon models using the Langchain SDK:

First, install the SDK using pip:

Then you can import the library and interact with any of the models in the Python file you wish to use it in:

Using OpenAI SDK

You can also use the OpenAI SDK to interact with the Falcon models.

First, install the SDK using pip: