Create a Custom Agent from a File Using CustomGPT.ai RAG API’s Python SDK – A Developer’s Guide

Watch the demo video at the top for a live walkthrough and explanation of this guide! (coming soon)

1. Introduction

Hi there! In this guide, we’ll show you how to create a custom agent using the CustomGPTs RAG APIs Python SDK implementation. Unlike our previous tutorials that used REST APIs, this guide will walk you through the process using the SDK. You’ll learn how to install the SDK, create a chatbot from a file, fetch project details to ensure your chatbot is active, start a conversation, and finally send messages. This guide is designed specifically for developers who want to leverage the power of the CustomGPT API with an easier, more Pythonic interface.

Make sure you have read our Getting Started with CustomGPT.ai for New Developers blog to get an overview of the entire platform.

By the end, you’ll be able to programmatically inspect where your chatbot’s content comes from. For full API reference, see the CustomGPT API docs.

Notebook link – https://github.com/Poll-The-People/customgpt-cookbook/blob/main/examples/SDK_Create_bot_from_file.ipynb

2. Setting Up the Environment

Before creating your chatbot, you need to set up the SDK in your Google Colab notebook. The first step is to install the customgpt-client package.

!pip install customgpt-client

What This Does:

• Installation:
  Installs the CustomGPT client SDK so you can use its classes and functions to interact with the API directly through Python.
  
• SDK Benefits:
  This SDK simplifies the way you interact with the API by handling many of the lower-level details for you.
  

Now that the SDK is installed, let’s move on to creating your custom chatbot using a sitemap and a file.

3. Creating Your Custom Chat Bot Using a Sitemap

First, we’ll start with a basic example that uses a sitemap to create your chatbot (or “project” in earlier terms). Set your API key to authenticate your SDK calls.

from customgpt_client import CustomGPT
CustomGPT.api_key = "YOUR_API_KEY"

Get API keys

To get your API key, there are two ways:

Method 1 – Via Agent

1. Agent > All Agents.
2. Select your agent and go to deploy, click on the API key section and create an API. 

Method 2 – Via Profile section.

1. Go to profile (top right corner of your screen)
2. Click on My Profile
3. You will see the screen something like this (below screenshot). Here you can click on “Create API key”, give it a name and copy the key.

Please save this secret key somewhere safe and accessible. For security reasons, You won’t be able to view it again through your CustomGPT.ai account. If you lose this secret key, you’ll need to generate a new one.

What This Does:

• Setting API Key:
  Configures the SDK with your API key (replace “YOUR_API_KEY” with your actual API token) so that every request is authenticated.

Next, we create a project (agent) using a file as an input source.

4. Creating a Project from a File

In this example, we’ll create a project using a file upload. We use Google Colab’s file upload feature to select the file, then pass the file content to the SDK

from google.colab import files
from customgpt_client.types import File

# Give a name to your project
project_name = 'Example ChatBot using Sitemap'
uploaded_file = files.upload()

file_content = next(iter(uploaded_file.values()))
print(file_content)

create_project = CustomGPT.Project.create(
    project_name=project_name, 
    file=File(payload=file_content, file_name='Yes.doc')
)
print(create_project)

What This Does:

• File Upload:
  Uses the files.upload() function from Google Colab to let you select a file from your local system.
  
• Reading File Content:
  Retrieves the file content from the uploaded files dictionary.
  
• Project Creation:
  Calls the CustomGPT.Project.create method with the project name and a File object. The File object takes two parameters:
  
  • payload: The binary content of your file.
    
  • file_name: The name of the file (here, ‘Yes.doc’).
    
• Output:
  Prints the response, which contains details about the newly created project/agent.
  

After creating the project, let’s verify that our chatbot is active by fetching its details

5. Fetching Project Details

Before sending any messages, it’s a good practice to check if the chatbot (agent) is active. This is done by retrieving the project details and checking the is_chat_active flag

# Check status of the project if chat bot is active
data = create_project.parsed.data

# Get project id from response for created project
project_id = data.id

# Check if chat bot is active using `is_chat_active` flag in project detail response
# GET project details
get_project = CustomGPT.Project.get(project_id=project_id)

project_data = get_project.parsed
is_chat_active = project_data.data.is_chat_active

print(is_chat_active)

# One can poll this GET project details API to check if chat bot is active before starting a conversation

What This Does:

• Extracting Project ID:
  Parses the response from the project creation to get the unique project ID.
  
• Fetching Details:
  Calls CustomGPT.Project.get with the project ID to retrieve detailed information about your project.
  
• Checking Activation Status:
  Extracts the is_chat_active flag to see if your chatbot is active. You can poll this endpoint to continuously check the activation status before initiating a conversation.
  
• Output:
  Prints the status so you know if the chatbot is ready to receive messages.

Now that we’ve verified your project is active, it’s time to start a conversation with your chatbot.

6. Creating a Conversation

Before you send any messages, create a conversation within your project. This conversation acts as a session for interacting with your chatbot.

# Create a conversation to send a message to
project_conversataion = CustomGPT.Conversation.create(
    project_id=project_id, 
    name="My First Conversation"
)

project_data = project_conversataion.parsed
print(project_data)

What This Does:

• Conversation Creation:
  Uses CustomGPT.Conversation.create to start a new conversation within your project, assigning it a name (“My First Conversation”).
  
• Session Management:
  The conversation response includes a session ID that is crucial for tracking the chat history.
  
• Output:
  Prints the details of the newly created conversation.

With the conversation successfully created, we are ready to send a message to your chatbot.

7. Sending a Message to Your Chatbot

Now you’ll send a message to your chatbot and receive its response. In this example, the message is sent with streaming enabled, so you can see real-time updates.

session_id = project_data.data.session_id

# Define the prompt and custom persona for the chatbot
prompt = "Who do you work for and what are you called and who is vanka in 10 words."
custom_persona = (
    "You are a custom chatbot assistant called *Story Teller*, a friendly story teller "
    "who works for Test and answers questions based on the given context. "
    "Be as helpful as possible. Always prioritize the customer. Escalate complex issues. "
    "Stay on topic. Use appropriate language, Acknowledge limitations."
)

stream_response = CustomGPT.Conversation.send(
    project_id=project_id, 
    session_id=session_id, 
    prompt=prompt, 
    custom_persona=custom_persona, 
    stream=True
)
for event in stream_response.events():
    print(event.data)

session_id = project_data.data.session_id

What This Does:

• Retrieve Session ID:
  Gets the session ID from the conversation details to ensure the message is part of the correct session.
  
• Set Prompt & Custom Persona:
  
  • The prompt is the question you want to ask the chatbot.
    
  • The custom persona adds context to the chatbot’s responses (here, it’s set as a friendly “Story Teller”).
    
• Send Message with Streaming:
  
  • Uses CustomGPT.Conversation.send to send the message with the streaming flag set to True.
    
  • This enables you to see real-time events as the chatbot processes the message.
    
• Output:
  
  • Iterates over the streamed events and prints the data from each event.

This completes the process of sending a message to your custom chatbot using the CustomGPT SDK. With the SDK, interacting with the chatbot becomes more streamlined and Pythonic

8. Conclusion

Congratulations, developer! In this guide, you learned how to:

• Install and set up the CustomGPT Python SDK.
  
• Create a custom agent (project) from a file using Google Colab’s file upload.
  
• Fetch project details to verify that your chatbot is active.
  
• Create a conversation within your project.
  
• Send a message to your chatbot with streaming enabled, incorporating a custom persona.
  
• By transitioning to the CustomGPT Python SDK, you simplify many interactions with the API, making it easier to build, manage, and scale your chatbot solutions. If you have any questions or need further assistance, feel free to consult the official CustomGPT SDK documentation or join our developer community.

Happy coding, and enjoy building your custom chatbot with the CustomGPT SDK!

Priyansh Khodiyar

Priyansh is Developer Relations Advocate who loves technology, writer about them, creates deeply researched content about them.