{"id":23439333,"url":"https://github.com/RelevanceAI/relevanceai","last_synced_at":"2025-08-26T01:33:11.422Z","repository":{"id":36973362,"uuid":"383121608","full_name":"RelevanceAI/relevanceai","owner":"RelevanceAI","description":"Home of the AI workforce - Multi-agent system, AI agents \u0026 tools","archived":false,"fork":false,"pushed_at":"2025-05-04T16:12:34.000Z","size":72328,"stargazers_count":232,"open_issues_count":0,"forks_count":36,"subscribers_count":14,"default_branch":"main","last_synced_at":"2025-05-22T19:08:55.208Z","etag":null,"topics":["clustering","computer-vision","embeddings","natural-language-processing","nlp","python","search","search-engine","unstructured-data","vector-database","vector-search"],"latest_commit_sha":null,"homepage":"https://sdk.relevanceai.com","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/RelevanceAI.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2021-07-05T11:45:10.000Z","updated_at":"2025-05-20T18:22:18.000Z","dependencies_parsed_at":"2023-11-07T15:28:16.442Z","dependency_job_id":"87d99ad4-d3a2-416a-a21f-163167f70cca","html_url":"https://github.com/RelevanceAI/relevanceai","commit_stats":null,"previous_names":[],"tags_count":98,"template":false,"template_full_name":null,"purl":"pkg:github/RelevanceAI/relevanceai","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/RelevanceAI%2Frelevanceai","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/RelevanceAI%2Frelevanceai/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/RelevanceAI%2Frelevanceai/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/RelevanceAI%2Frelevanceai/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/RelevanceAI","download_url":"https://codeload.github.com/RelevanceAI/relevanceai/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/RelevanceAI%2Frelevanceai/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":272159384,"owners_count":24883773,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-08-25T02:00:12.092Z","response_time":1107,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["clustering","computer-vision","embeddings","natural-language-processing","nlp","python","search","search-engine","unstructured-data","vector-database","vector-search"],"created_at":"2024-12-23T15:01:46.477Z","updated_at":"2025-08-26T01:33:11.393Z","avatar_url":"https://github.com/RelevanceAI.png","language":"Python","readme":"## Relevance AI - The home of your AI Workforce\n\n🔥 Use Relevance to build AI agents for your AI workforce\n\n[Sign up for a free account -\u003e](https://app.relevanceai.com)\n\n## 🧠 Documentation\n\n| Type      | Link |\n| ------------- | ----------- |\n| Home Page | [Home Page](https://relevanceai.com/) |\n| Platform | [Platform](https://app.relevanceai.com/) |\n| Developer Documentation | [Documentation](https://sdk.relevanceai.com/) |\n\n# Relevance AI SDK\n\nWelcome to the Relevance AI SDK! This guide will help you set up and start using the SDK to interact with your AI agents, tools, and knowledge.\n\n## Installation\n\nTo get started, you'll need to install the RelevanceAI library in a Python 3 environment. Run the following command in your terminal:\n\n```bash\npip install relevanceai\n```\n\n## Create an Account\n\nBefore using the SDK, ensure you have an account with Relevance AI.\n\n1. Sign up for a free account at [Relevance AI](https://app.relevanceai.com) and log in.\n2. Create a new secret key at [SDK Login](https://app.relevanceai.com/login/sdk). Scroll to the bottom of the integrations page, click on \"+ Create new secret key,\" and select \"Admin\" permissions.\n\n## Set Up Your Client\n\nTo interact with Relevance AI, you'll need to set up a client. Start by importing the library:\n\n```python\nfrom relevanceai import RelevanceAI\nclient = RelevanceAI()\n```\n\n### Validate Client Credentials\n\nYou can validate your client credentials by storing them as environment variables and loading them into your project using `python-dotenv` or the `os` library:\n\n```env\nRAI_API_KEY=\nRAI_REGION=\nRAI_PROJECT=\n```\n\n```python\nfrom dotenv import load_dotenv\nload_dotenv()\n\nfrom relevanceai import RelevanceAI\nclient = RelevanceAI()\n```\n\nAlternatively, pass the credentials directly to the client:\n\n```python\nfrom relevanceai import RelevanceAI\nclient = RelevanceAI(\n    api_key=\"your_api_key\", \n    region=\"your_region\", \n    project=\"your_project\"\n)\n```\n\nYou are now ready to start using Relevance AI via the Python SDK.\n\n## Quickstart\n\n### Using Agents \u0026 Tasks\n\nList all the agents in your project:\n\n```python\nfrom relevanceai import RelevanceAI\nclient = RelevanceAI()\n\nagents = client.agents.list_agents()\nprint(agents)\n# Example output: [Agent(agent_id=\"xxxxxxxx\", name=\"Sales Qualifier\"), ...]\n```\n\nRetrieve and interact with a specific agent:\n\n```python\nmy_agent = client.agents.retrieve_agent(agent_id=\"xxxxxxxx\")\n\nmessage = \"Let's qualify this lead:\\n\\nName: Ethan Trang\\n\\nCompany: Relevance AI\\n\\nEmail: ethan@relevanceai.com\"\n\n# Trigger a task with the agent\ntask = my_agent.trigger_task(message=message)\nprint(f\"Task started with ID: {task.conversation_id}\")\n\n# View task progress\nsteps = my_agent.view_task_steps(conversation_id=task.conversation_id)\n```\n\n### Using Tools\n\nList all the tools in your project:\n\n```python\ntools = client.tools.list_tools()\nprint(tools)\n# Example output: [Tool(tool_id=\"xxxxxxxx\", title=\"Search Website\"), ...]\n```\n\nRetrieve and interact with a specific tool:\n\n```python\nmy_tool = client.tools.retrieve_tool(tool_id=\"xxxxxxxx\")\n\n# Check tool parameters schema\nparams_schema = my_tool.get_params_schema()\n\n# Trigger the tool\nresult = my_tool.trigger(params={\"search_query\": \"AI automation\"})\n```\n\n### Managing Knowledge Sets\n\nWork with knowledge sets to store and retrieve data:\n\n```python\n# List knowledge sets\nknowledge_sets = client.knowledge.list_knowledge()\n\n# Retrieve data from a knowledge set\ndata = client.knowledge.retrieve_knowledge(knowledge_set=\"my_dataset\")\n```\n\n### Managing Tasks\n\nTrack and manage ongoing tasks:\n\n```python\n# Get task metadata\nmetadata = client.tasks.get_metadata(conversation_id=\"xxxxxxxx\")\n\n# Delete a completed task\nclient.tasks.delete_task(conversation_id=\"xxxxxxxx\")\n```\n\n## Explore More\n\nExplore all the methods available for agents, tasks, tools, and knowledge with the [documentation](https://sdk.relevanceai.com/)\n","funding_links":[],"categories":["Python"],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FRelevanceAI%2Frelevanceai","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FRelevanceAI%2Frelevanceai","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FRelevanceAI%2Frelevanceai/lists"}