Using the Hive Agent Client

Overview

This tutorial will guide you through using the HiveAgentClient, a Python class designed to interact with a Hive Agent's API. The client facilitates various operations such as sending chat messages and sending data to a Hive Agent.

Setup


Ensure you have httpx installed in your environment:


Import the HiveAgentClient in your Python script:


Instantiate the client with the base URL of your Hive Agent API:

base_url = "https://localhost:8000/api/"  # replace with your actual API URL
version = "v1" # optional param
client = HiveAgentClient(base_url, version)


Sending Chat Messages


To send a chat message using the chat method:

async def send_message(user_id, session_id, content):
    try:
        response = await client.chat(user_id=user_id, session_id=session_id, content=content)
        print("Chat response:", response)
    except Exception as e:
        print("Error:", e)


Getting Chat History

To fetch the chat history, you can use the get_chat_history method:

async def fetch_chat_history(user_id, session_id):
    try:
        chat_history = await client.get_chat_history(user_id=user_id, session_id=session_id)
        print("Chat history:", chat_history)
    except Exception as e:
        print("Error:", e)


Creating a Table

Create a new table in the database:

async def create_new_table(table_name, columns):
    try:
        response = await client.create_table(table_name, columns)
        print("Table creation response:", response)
    except Exception as e:
        print("Error:", e)


Inserting Data

Insert data into a specified table:

async def insert_new_data(table_name, data):
    try:
        response = await client.insert_data(table_name, data)
        print("Data insertion response:", response)
    except Exception as e:
        print("Error:", e)


Read Data

To get data from a table with optional filters:

async def retrieve_data(table_name, filters=None):
    try:
        data = await client.read_data(table_name, filters)
        print("Retrieved data:", data)
    except Exception as e:
        print("Error:", e)


Read Specific Data with Filters

To read specific data, use filters:

async def retrieve_filtered_data(table_name):
    filters = {"id": [1], "name": ["Test"]}
    try:
        data = await client.read_data(table_name, filters)
        print("Filtered data:", data)
    except Exception as e:
        print("Error:", e)


Updating Data

To update existing data in a table:

async def update_existing_data(table_name, row_id, new_data):
    try:
        updated_data = await client.update_data(table_name, row_id, new_data)
        print("Updated data:", updated_data)
    except Exception as e:
        print("Error:", e)


Deleting Data

To delete data from a table:

async def delete_existing_data(table_name, row_id):
    try:
        result = await client.delete_data(table_name, row_id)
        print("Delete result:", result)
    except Exception as e:
        print("Error:", e)


Closing the Client

Finally, ensure you close the client to free up resources:

async def close_client():
    await client.close()


Uploading Files

To upload files using the upload_files method:

async def upload_files(file_paths):
    try:
        response = await client.upload_files(file_paths)
        print("Upload response:", response)
    except Exception as e:
        print("Error:", e)


Listing Files

To list all files stored on the server:

async def list_all_files():
    try:
        files = await client.list_files()
        print("Files on server:", files)
    except Exception as e:
        print("Error:", e)


Renaming a File

To rename a specified file on the server:

async def rename_file_on_server(old_filename, new_filename):
    try:
        result = await client.rename_file(old_filename, new_filename)
        print("Rename result:", result)
    except Exception as e:
        print("Error:", e)


Deleting a File

To delete a specified file from the server:

async def delete_file_on_server(filename):
    try:
        result = await client.delete_file(filename)
        print("Delete result:", result)
    except Exception as e:
        print("Error:", e)


So far, we have learnt about the HiveAgentClient and the methods to interact with the HiveAgent API. We performed various operations such as sending chat messages and sending data to a Hive Agent.


Example usage of the HiveAgentClient.


This tutorial demonstrates how to use the HiveAgentClient class in an asynchronous context. By following these steps, you will learn how to send messages, manage database operations, and handle files using the Hive Agent API.


As the first step, Import the asyncio library:


import asyncio


Sending Messages and Fetching Chat History

Now we will send a message and fetch the chat history for a user and session.

async def main():
    await send_message("user123", "session123", "Hello, world!")
    await fetch_chat_history("user123", "session123")


Database Operations

Now we create a new table, insert data, retrieve data, update existing data, and delete data from the database.

await create_new_table("my_table", {"id": "Integer", "name": "String"})
await insert_new_data("my_table", {"name": "Test"})
await retrieve_data("my_table", {"id": [1]})
await update_existing_data("my_table", 1, {"name": "Updated Test"})
await delete_existing_data("my_table", 1)


File Management

Now we will upload files, list all files, delete a file on the server, and rename a file on the server.

file_paths = ["path/to/your/file1.txt", "path/to/your/file2.txt"]
await upload_files(file_paths)
await list_all_files()
await delete_file_on_server("file1.txt")
await rename_file_on_server("file2.txt", "renamed_file.txt")
await close_client()


Complete Code Snippet

Now, let's combine all the above sections into a single asynchronous function.

import asyncio

async def main():
    await send_message("user123", "session123", "Hello, world!")
    await fetch_chat_history("user123", "session123")
    
    await create_new_table("my_table", {"id": "Integer", "name": "String"})
    await insert_new_data("my_table", {"name": "Test"})
    await retrieve_data("my_table", {"id": [1]})
    await update_existing_data("my_table", 1, {"name": "Updated Test"})
    await delete_existing_data("my_table", 1)
    
    file_paths = ["path/to/your/file1.txt", "path/to/your/file2.txt"]
    await upload_files(file_paths)
    await list_all_files()
    await delete_file_on_server("file1.txt")
    await rename_file_on_server("file2.txt", "renamed_file.txt")
    await close_client()

asyncio.run(main())


Replace "my_table", {"id": "Integer", "name": "String"}, and other placeholders with your actual data. Replace "path/to/your/file1.txt", "path/to/your/file2.txt", and other placeholders with your actual file paths.


This tutorial provides a basic overview of how to interact with the Hive Agent API using the HiveAgentClient class.

Setup


Ensure you have httpx installed in your environment:


Import the HiveAgentClient in your Python script:


Instantiate the client with the base URL of your Hive Agent API:

base_url = "https://localhost:8000/api/"  # replace with your actual API URL
version = "v1" # optional param
client = HiveAgentClient(base_url, version)


Sending Chat Messages


To send a chat message using the chat method:

async def send_message(user_id, session_id, content):
    try:
        response = await client.chat(user_id=user_id, session_id=session_id, content=content)
        print("Chat response:", response)
    except Exception as e:
        print("Error:", e)


Getting Chat History

To fetch the chat history, you can use the get_chat_history method:

async def fetch_chat_history(user_id, session_id):
    try:
        chat_history = await client.get_chat_history(user_id=user_id, session_id=session_id)
        print("Chat history:", chat_history)
    except Exception as e:
        print("Error:", e)


Creating a Table

Create a new table in the database:

async def create_new_table(table_name, columns):
    try:
        response = await client.create_table(table_name, columns)
        print("Table creation response:", response)
    except Exception as e:
        print("Error:", e)


Inserting Data

Insert data into a specified table:

async def insert_new_data(table_name, data):
    try:
        response = await client.insert_data(table_name, data)
        print("Data insertion response:", response)
    except Exception as e:
        print("Error:", e)


Read Data

To get data from a table with optional filters:

async def retrieve_data(table_name, filters=None):
    try:
        data = await client.read_data(table_name, filters)
        print("Retrieved data:", data)
    except Exception as e:
        print("Error:", e)


Read Specific Data with Filters

To read specific data, use filters:

async def retrieve_filtered_data(table_name):
    filters = {"id": [1], "name": ["Test"]}
    try:
        data = await client.read_data(table_name, filters)
        print("Filtered data:", data)
    except Exception as e:
        print("Error:", e)


Updating Data

To update existing data in a table:

async def update_existing_data(table_name, row_id, new_data):
    try:
        updated_data = await client.update_data(table_name, row_id, new_data)
        print("Updated data:", updated_data)
    except Exception as e:
        print("Error:", e)


Deleting Data

To delete data from a table:

async def delete_existing_data(table_name, row_id):
    try:
        result = await client.delete_data(table_name, row_id)
        print("Delete result:", result)
    except Exception as e:
        print("Error:", e)


Closing the Client

Finally, ensure you close the client to free up resources:

async def close_client():
    await client.close()


Uploading Files

To upload files using the upload_files method:

async def upload_files(file_paths):
    try:
        response = await client.upload_files(file_paths)
        print("Upload response:", response)
    except Exception as e:
        print("Error:", e)


Listing Files

To list all files stored on the server:

async def list_all_files():
    try:
        files = await client.list_files()
        print("Files on server:", files)
    except Exception as e:
        print("Error:", e)


Renaming a File

To rename a specified file on the server:

async def rename_file_on_server(old_filename, new_filename):
    try:
        result = await client.rename_file(old_filename, new_filename)
        print("Rename result:", result)
    except Exception as e:
        print("Error:", e)


Deleting a File

To delete a specified file from the server:

async def delete_file_on_server(filename):
    try:
        result = await client.delete_file(filename)
        print("Delete result:", result)
    except Exception as e:
        print("Error:", e)


So far, we have learnt about the HiveAgentClient and the methods to interact with the HiveAgent API. We performed various operations such as sending chat messages and sending data to a Hive Agent.


Example usage of the HiveAgentClient.


This tutorial demonstrates how to use the HiveAgentClient class in an asynchronous context. By following these steps, you will learn how to send messages, manage database operations, and handle files using the Hive Agent API.


As the first step, Import the asyncio library:


import asyncio


Sending Messages and Fetching Chat History

Now we will send a message and fetch the chat history for a user and session.

async def main():
    await send_message("user123", "session123", "Hello, world!")
    await fetch_chat_history("user123", "session123")


Database Operations

Now we create a new table, insert data, retrieve data, update existing data, and delete data from the database.

await create_new_table("my_table", {"id": "Integer", "name": "String"})
await insert_new_data("my_table", {"name": "Test"})
await retrieve_data("my_table", {"id": [1]})
await update_existing_data("my_table", 1, {"name": "Updated Test"})
await delete_existing_data("my_table", 1)


File Management

Now we will upload files, list all files, delete a file on the server, and rename a file on the server.

file_paths = ["path/to/your/file1.txt", "path/to/your/file2.txt"]
await upload_files(file_paths)
await list_all_files()
await delete_file_on_server("file1.txt")
await rename_file_on_server("file2.txt", "renamed_file.txt")
await close_client()


Complete Code Snippet

Now, let's combine all the above sections into a single asynchronous function.

import asyncio

async def main():
    await send_message("user123", "session123", "Hello, world!")
    await fetch_chat_history("user123", "session123")
    
    await create_new_table("my_table", {"id": "Integer", "name": "String"})
    await insert_new_data("my_table", {"name": "Test"})
    await retrieve_data("my_table", {"id": [1]})
    await update_existing_data("my_table", 1, {"name": "Updated Test"})
    await delete_existing_data("my_table", 1)
    
    file_paths = ["path/to/your/file1.txt", "path/to/your/file2.txt"]
    await upload_files(file_paths)
    await list_all_files()
    await delete_file_on_server("file1.txt")
    await rename_file_on_server("file2.txt", "renamed_file.txt")
    await close_client()

asyncio.run(main())


Replace "my_table", {"id": "Integer", "name": "String"}, and other placeholders with your actual data. Replace "path/to/your/file1.txt", "path/to/your/file2.txt", and other placeholders with your actual file paths.


This tutorial provides a basic overview of how to interact with the Hive Agent API using the HiveAgentClient class.

Prev

Prev

Next

Next

© Copyright 2024. All rights reserved.

Using the Hive Agent Client

Overview

This tutorial will guide you through using the HiveAgentClient, a Python class designed to interact with a Hive Agent's API. The client facilitates various operations such as sending chat messages and sending data to a Hive Agent.

Setup


Ensure you have httpx installed in your environment:


Import the HiveAgentClient in your Python script:


Instantiate the client with the base URL of your Hive Agent API:

base_url = "https://localhost:8000/api/"  # replace with your actual API URL
version = "v1" # optional param
client = HiveAgentClient(base_url, version)


Sending Chat Messages


To send a chat message using the chat method:

async def send_message(user_id, session_id, content):
    try:
        response = await client.chat(user_id=user_id, session_id=session_id, content=content)
        print("Chat response:", response)
    except Exception as e:
        print("Error:", e)


Getting Chat History

To fetch the chat history, you can use the get_chat_history method:

async def fetch_chat_history(user_id, session_id):
    try:
        chat_history = await client.get_chat_history(user_id=user_id, session_id=session_id)
        print("Chat history:", chat_history)
    except Exception as e:
        print("Error:", e)


Creating a Table

Create a new table in the database:

async def create_new_table(table_name, columns):
    try:
        response = await client.create_table(table_name, columns)
        print("Table creation response:", response)
    except Exception as e:
        print("Error:", e)


Inserting Data

Insert data into a specified table:

async def insert_new_data(table_name, data):
    try:
        response = await client.insert_data(table_name, data)
        print("Data insertion response:", response)
    except Exception as e:
        print("Error:", e)


Read Data

To get data from a table with optional filters:

async def retrieve_data(table_name, filters=None):
    try:
        data = await client.read_data(table_name, filters)
        print("Retrieved data:", data)
    except Exception as e:
        print("Error:", e)


Read Specific Data with Filters

To read specific data, use filters:

async def retrieve_filtered_data(table_name):
    filters = {"id": [1], "name": ["Test"]}
    try:
        data = await client.read_data(table_name, filters)
        print("Filtered data:", data)
    except Exception as e:
        print("Error:", e)


Updating Data

To update existing data in a table:

async def update_existing_data(table_name, row_id, new_data):
    try:
        updated_data = await client.update_data(table_name, row_id, new_data)
        print("Updated data:", updated_data)
    except Exception as e:
        print("Error:", e)


Deleting Data

To delete data from a table:

async def delete_existing_data(table_name, row_id):
    try:
        result = await client.delete_data(table_name, row_id)
        print("Delete result:", result)
    except Exception as e:
        print("Error:", e)


Closing the Client

Finally, ensure you close the client to free up resources:

async def close_client():
    await client.close()


Uploading Files

To upload files using the upload_files method:

async def upload_files(file_paths):
    try:
        response = await client.upload_files(file_paths)
        print("Upload response:", response)
    except Exception as e:
        print("Error:", e)


Listing Files

To list all files stored on the server:

async def list_all_files():
    try:
        files = await client.list_files()
        print("Files on server:", files)
    except Exception as e:
        print("Error:", e)


Renaming a File

To rename a specified file on the server:

async def rename_file_on_server(old_filename, new_filename):
    try:
        result = await client.rename_file(old_filename, new_filename)
        print("Rename result:", result)
    except Exception as e:
        print("Error:", e)


Deleting a File

To delete a specified file from the server:

async def delete_file_on_server(filename):
    try:
        result = await client.delete_file(filename)
        print("Delete result:", result)
    except Exception as e:
        print("Error:", e)


So far, we have learnt about the HiveAgentClient and the methods to interact with the HiveAgent API. We performed various operations such as sending chat messages and sending data to a Hive Agent.


Example usage of the HiveAgentClient.


This tutorial demonstrates how to use the HiveAgentClient class in an asynchronous context. By following these steps, you will learn how to send messages, manage database operations, and handle files using the Hive Agent API.


As the first step, Import the asyncio library:


import asyncio


Sending Messages and Fetching Chat History

Now we will send a message and fetch the chat history for a user and session.

async def main():
    await send_message("user123", "session123", "Hello, world!")
    await fetch_chat_history("user123", "session123")


Database Operations

Now we create a new table, insert data, retrieve data, update existing data, and delete data from the database.

await create_new_table("my_table", {"id": "Integer", "name": "String"})
await insert_new_data("my_table", {"name": "Test"})
await retrieve_data("my_table", {"id": [1]})
await update_existing_data("my_table", 1, {"name": "Updated Test"})
await delete_existing_data("my_table", 1)


File Management

Now we will upload files, list all files, delete a file on the server, and rename a file on the server.

file_paths = ["path/to/your/file1.txt", "path/to/your/file2.txt"]
await upload_files(file_paths)
await list_all_files()
await delete_file_on_server("file1.txt")
await rename_file_on_server("file2.txt", "renamed_file.txt")
await close_client()


Complete Code Snippet

Now, let's combine all the above sections into a single asynchronous function.

import asyncio

async def main():
    await send_message("user123", "session123", "Hello, world!")
    await fetch_chat_history("user123", "session123")
    
    await create_new_table("my_table", {"id": "Integer", "name": "String"})
    await insert_new_data("my_table", {"name": "Test"})
    await retrieve_data("my_table", {"id": [1]})
    await update_existing_data("my_table", 1, {"name": "Updated Test"})
    await delete_existing_data("my_table", 1)
    
    file_paths = ["path/to/your/file1.txt", "path/to/your/file2.txt"]
    await upload_files(file_paths)
    await list_all_files()
    await delete_file_on_server("file1.txt")
    await rename_file_on_server("file2.txt", "renamed_file.txt")
    await close_client()

asyncio.run(main())


Replace "my_table", {"id": "Integer", "name": "String"}, and other placeholders with your actual data. Replace "path/to/your/file1.txt", "path/to/your/file2.txt", and other placeholders with your actual file paths.


This tutorial provides a basic overview of how to interact with the Hive Agent API using the HiveAgentClient class.

Prev

Next

© Copyright 2024. All rights reserved.