Here’s a step-by-step guide to creating a new custom handler in SuperAgentX, inheriting from BaseHandler (superagentx.handler.base.BaseHandler), to enhance and extend the system’s functionality.
Step 1: Creating a New Handler
Now, we will create a new class FileHandler that inherits from BaseHandler. This class will handle reading a text file
and filtering the contents based on a search query.Here’s the FileHandler implementation:
import asyncioimport aiofilesfrom superagentx.handler.base import BaseHandlerfrom superagentx.handler.decorators import toolclass FileHandler(BaseHandler): def __init__(self, file_path: str): """ Initializes the FileHandler with the given file path. Args: file_path (str): The path to the text file to be read. """ super().__init__() # Call the parent class's constructor self.file_path = file_path # Store the file path for later use
Step 2: Define Handler Method(s).
Now, let’s define a method inside the handler to perform an action, like processing data from the given method.
This tool (superagentx.handler.decorators.tool) decorator is used to preserve llm tool function
when you wrap it in a new function, often used in custom decorators.
Write a docstring for the method based on the parameters provided. The docstring should be clear, detailed,
and understandable by an LLM (Large Language Model). The description should be 3 to 4 lines long with a brief
explanation, and parameter can be in a single line.
@tool async def read_file(self): """ Reads the contents of the file specified by the file path. Returns: list: A list of lines from the file. """ try: async with aiofiles.open(self.file_path, 'r') as file: lines = await file.readlines() return lines except FileNotFoundError: print(f"Error: The file at {self.file_path} was not found.") return [] @tool async def search( self, query: str ): """ Searches for lines in the file that contain the provided query. Args: query (str): The string to search for in the file. Returns: list: A list of lines containing the query. """ lines = await self.read_file() # Get lines from the file filtered_lines = [line for line in lines if query.lower() in line.lower()] # Filter lines by query return filtered_lines
Step 3: Testing the Handler
To test the FileHandler class, create a sample text file and use the handler to search for specific terms.
create the sample.txt file
Create a file named sample.txt in the same directory as your script with the following content:
Hello, welcome to the file handler example.This file contains several lines of text.You can search through it using queries.The FileHandler will help you find matching lines.
Use the FileHandler class to search for the term "file":
# Create an instance of FileHandler with the path to your text filefile_handler = FileHandler(file_path='sample.txt')# Search for the term 'file' in the filesearch_result = file_handler.search('file')# Print the search resultsprint("Search Results:")for line in search_result: print(line.strip()) # Strip removes the newline character
Full Code
import asyncioimport aiofilesfrom superagentx.handler.base import BaseHandlerfrom superagentx.handler.decorators import toolclass FileHandler(BaseHandler): def __init__(self, file_path: str): """ Initializes the FileHandler with the given file path. Args: file_path (str): The path to the text file to be read. """ super().__init__() # Call the parent class's constructor self.file_path = file_path # Store the file path for later use @tool async def read_file(self): """ Reads the contents of the file specified by the file path. Returns: list: A list of lines from the file. """ try: async with aiofiles.open(self.file_path, 'r') as file: lines = await file.readlines() return lines except FileNotFoundError: print(f"Error: The file at {self.file_path} was not found.") return [] @tool async def search( self, query: str ): """ Searches for lines in the file that contain the provided query. Args: query (str): The string to search for in the file. Returns: list: A list of lines containing the query. """ lines = await self.read_file() # Get lines from the file filtered_lines = [line for line in lines if query.lower() in line.lower()] # Filter lines by query return filtered_lines# Create an instance of FileHandler with the path to your text filefile_handler = FileHandler(file_path='sample.txt')if __name__ == "__main__": # Search for the term 'file' in the file search_result = asyncio.run(file_handler.search('file')) # Print the search results print("Search Results:") for line in search_result: print(line.strip()) # Strip removes the newline character
Expected Output:
When you run this code, it will output:
Search Results:This file contains several lines of text.You can search through it using queries.The FileHandler will help you find matching lines.
{"docsConfig":{"$schema":"https://mintlify.com/docs.json","theme":"mint","name":"Starter Kit","colors":{"primary":"#0b5394","light":"#E6FFA2","dark":"#a3df02"},"favicon":"favicon.svg","logo":{"light":"https://mintcdn.com/superagentx/2i9VWqt1zKxPBKhG/logo/fulllogo_transparent_nobuffer.png?fit=max\u0026auto=format\u0026n=2i9VWqt1zKxPBKhG\u0026q=85\u0026s=31bf8d9efc0bdfafd3878db74a471ed6","dark":"https://mintcdn.com/superagentx/2i9VWqt1zKxPBKhG/logo/fullLogo_transparent_dark_nobuffer.png?fit=max\u0026auto=format\u0026n=2i9VWqt1zKxPBKhG\u0026q=85\u0026s=4872c2b61dae65e9be6242300f3e1dc3"},"background":{"decoration":null,"color":{"light":"#fff","dark":"#0f1117"}},"navbar":{"primary":{"type":"github","href":"https://github.com/superagentxai/superagentX/"}},"footer":{"socials":{"x":"https://x.com/superagentxai","github":"https://github.com/superagentxai/superagentX/"}},"styling":{"latex":false},"navigation":{"global":{"anchors":[{"anchor":"Documentation","href":"https://docs.superagentx.ai/introduction","icon":"book-open-cover"},{"anchor":"Community","href":"https://discord.gg/hX5pAzKGXD","icon":"discord"},{"anchor":"Github","href":"https://github.com/superagentxai/superagentX/","icon":"github"}]},"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"superagentx","hasAudioNarration":false,"actualSubdomain":"superagentx","customDomains":["docs.superagentx.ai"],"gitSource":{"type":"github","owner":"superagentxai","repo":"superagentx","deployBranch":"master","contentDirectory":"docs","isPrivate":true,"mountPath":"","label":""},"entitlements":{},"buildId":"6ae9225fededbeecc47eaedc:success","clientVersion":"0.0.4177","searchFilterCounts":[{"language":"default","tag":"Documentation","count":87},{"language":"default","tag":"Handlers (Tools)","count":69},{"language":"default","tag":"AWS","count":14},{"language":"default","tag":"Key Components","count":11},{"language":"default","tag":"Gcp","count":10},{"language":"default","tag":"Microsoft Azure","count":7},{"language":"default","tag":"E-Commerce Handler","count":4},{"language":"default","tag":"Pipe Interface","count":4},{"language":"default","tag":"Get Started","count":3},{"language":"default","tag":"Google","count":2}]},"assistantConfig":{},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[],"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"examples/create_handler","slug":"/examples/create_handler","pageMetadata":{"title":"Create Handler","icon":"wrench","description":null,"href":"/examples/create_handler"},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={code:`code`,p:`p`,pre:`pre`,span:`span`,..._provideComponents(),...props.components},{CodeBlock,Heading,Tip}=_components;if(!CodeBlock)_missingMdxReference(`CodeBlock`,true);if(!Heading)_missingMdxReference(`Heading`,true);if(!Tip)_missingMdxReference(`Tip`,true);return _jsxs(_Fragment,{children:[_jsxs(_components.p,{children:[`Here’s a step-by-step guide to creating a new custom handler in `,_jsx(_components.code,{children:`SuperAgentX`}),`, inheriting from `,_jsx(_components.code,{children:`BaseHandler`}),` (`,_jsx(_components.code,{children:`superagentx.handler.base.BaseHandler`}),`), to enhance and extend the system’s functionality.`]}),`\n`,_jsx(Heading,{level:`3`,id:`step-1-creating-a-new-handler`,children:`Step 1: Creating a New Handler`}),`\n`,_jsxs(_components.p,{children:[`Now, we will create a new class `,_jsx(_components.code,{children:`FileHandler`}),` that inherits from `,_jsx(_components.code,{children:`BaseHandler`}),`. This class will handle reading a text file\nand filtering the contents based on a search query.`]}),`\n`,_jsx(_components.p,{children:`Here’s the FileHandler implementation:`}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`17`,language:`python`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`python`,children:_jsxs(_components.code,{language:`python`,numberOfLines:`17`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#C586C0`},children:`import`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` asyncio`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#C586C0`},children:`import`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` aiofiles`})]}),`\n`,_jsx(_components.span,{className:`line`}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#C586C0`},children:`from`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` superagentx.handler.base `}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#C586C0`},children:`import`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` BaseHandler`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#C586C0`},children:`from`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` superagentx.handler.decorators `}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#C586C0`},children:`import`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` tool`})]}),`\n`,_jsx(_components.span,{className:`line`}),`\n`,_jsx(_components.span,{className:`line`}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#569CD6`},children:`class`}),_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#4EC9B0`},children:` FileHandler`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`(`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#4EC9B0`},children:`BaseHandler`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`):`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#569CD6`},children:` def`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#DCDCAA`},children:` __init__`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`(`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:`self`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`, `}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:`file_path`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#4EC9B0`},children:`str`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`):`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"\"\"`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` Initializes the FileHandler with the given file path.`})}),`\n`,_jsx(_components.span,{className:`line`}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` Args:`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` file_path (str): The path to the text file to be read.`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"\"\"`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#4EC9B0`},children:` super`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`().`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#DCDCAA`},children:`__init__`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`() `}),_jsx(_components.span,{style:{color:`#6E7781`,\"--shiki-dark\":`#6A9955`},children:`# Call the parent class's constructor`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` self`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`.file_path `}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:`=`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` file_path `}),_jsx(_components.span,{style:{color:`#6E7781`,\"--shiki-dark\":`#6A9955`},children:`# Store the file path for later use`})]}),`\n`]})})}),`\n`,_jsx(Heading,{level:`3`,id:`step-2-define-handler-methods`,children:`Step 2: Define Handler Method(s).`}),`\n`,_jsxs(_components.p,{children:[`Now, let’s define a method inside the handler to perform an action, like processing data from the given method.\nThis `,_jsx(_components.code,{children:`tool`}),` (`,_jsx(_components.code,{children:`superagentx.handler.decorators.tool`}),`) decorator is used to preserve llm tool function\nwhen you wrap it in a new function, often used in custom decorators.`]}),`\n`,_jsx(Tip,{children:_jsx(_components.p,{children:`Write a docstring for the method based on the parameters provided. The docstring should be clear, detailed,\nand understandable by an LLM (Large Language Model). The description should be 3 to 4 lines long with a brief\nexplanation, and parameter can be in a single line.`})}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`33`,language:`python`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`python`,children:_jsxs(_components.code,{language:`python`,numberOfLines:`33`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#8250DF`,\"--shiki-dark\":`#DCDCAA`},children:` @tool`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#569CD6`},children:` async`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#569CD6`},children:` def`}),_jsx(_components.span,{style:{color:`#8250DF`,\"--shiki-dark\":`#DCDCAA`},children:` read_file`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`(`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:`self`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`):`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"\"\"`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` Reads the contents of the file specified by the file path.`})}),`\n`,_jsx(_components.span,{className:`line`}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` Returns:`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` list: A list of lines from the file.`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"\"\"`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#C586C0`},children:` try`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`:`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#C586C0`},children:` async`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#C586C0`},children:` with`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` aiofiles.open(`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:`self`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`.file_path, `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`'r'`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`) `}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#C586C0`},children:`as`}),_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#D4D4D4`},children:` file`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`:`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` lines `}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:`=`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#C586C0`},children:` await`}),_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#D4D4D4`},children:` file`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`.readlines()`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#C586C0`},children:` return`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` lines`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#C586C0`},children:` except`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#4EC9B0`},children:` FileNotFoundError`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`:`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#DCDCAA`},children:` print`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`(`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#569CD6`},children:`f`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"Error: The file at `}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#569CD6`},children:`{`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:`self`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`.file_path`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#569CD6`},children:`}`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` was not found.\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`)`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#C586C0`},children:` return`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` []`})]}),`\n`,_jsx(_components.span,{className:`line`}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#8250DF`,\"--shiki-dark\":`#DCDCAA`},children:` @tool`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#569CD6`},children:` async`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#569CD6`},children:` def`}),_jsx(_components.span,{style:{color:`#8250DF`,\"--shiki-dark\":`#DCDCAA`},children:` search`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`(`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:` self`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:` query`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#4EC9B0`},children:`str`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` ):`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"\"\"`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` Searches for lines in the file that contain the provided query.`})}),`\n`,_jsx(_components.span,{className:`line`}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` Args:`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` query (str): The string to search for in the file.`})}),`\n`,_jsx(_components.span,{className:`line`}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` Returns:`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` list: A list of lines containing the query.`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"\"\"`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` lines `}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:`=`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#C586C0`},children:` await`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` self`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`.read_file() `}),_jsx(_components.span,{style:{color:`#6E7781`,\"--shiki-dark\":`#6A9955`},children:`# Get lines from the file`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` filtered_lines `}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:`=`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` [line `}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#C586C0`},children:`for`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` line `}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#C586C0`},children:`in`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` lines `}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#C586C0`},children:`if`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` query.lower() `}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#569CD6`},children:`in`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` line.lower()] `}),_jsx(_components.span,{style:{color:`#6E7781`,\"--shiki-dark\":`#6A9955`},children:`# Filter lines by query`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#C586C0`},children:` return`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` filtered_lines`})]}),`\n`]})})}),`\n`,_jsx(Heading,{level:`3`,id:`step-3-testing-the-handler`,children:`Step 3: Testing the Handler`}),`\n`,_jsx(_components.p,{children:`To test the FileHandler class, create a sample text file and use the handler to search for specific terms.`}),`\n`,_jsx(Heading,{level:`2`,id:`create-the-sample-txt-file`,children:`create the sample.txt file`}),`\n`,_jsxs(_components.p,{children:[`Create a file named `,_jsx(_components.code,{children:`sample.txt`}),` in the same directory as your script with the following content:`]}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`5`,language:`text`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`text`,children:_jsxs(_components.code,{language:`text`,numberOfLines:`5`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`Hello, welcome to the file handler example.`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`This file contains several lines of text.`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`You can search through it using queries.`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`The FileHandler will help you find matching lines.`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{})})]})})}),`\n`,_jsxs(Heading,{level:`3`,id:`use-the-filehandler-class-to-search-for-the-term-file`,children:[`Use the `,_jsx(_components.code,{children:`FileHandler`}),` class to search for the term `,_jsx(_components.code,{children:`\"file\"`}),`:`]}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`10`,language:`python`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`python`,children:_jsxs(_components.code,{language:`python`,numberOfLines:`10`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#6E7781`,\"--shiki-dark\":`#6A9955`},children:`# Create an instance of FileHandler with the path to your text file`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`file_handler `}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:`=`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` FileHandler(`}),_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#9CDCFE`},children:`file_path`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:`=`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`'sample.txt'`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`)`})]}),`\n`,_jsx(_components.span,{className:`line`}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#6E7781`,\"--shiki-dark\":`#6A9955`},children:`# Search for the term 'file' in the file`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`search_result `}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:`=`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` file_handler.search(`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`'file'`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`)`})]}),`\n`,_jsx(_components.span,{className:`line`}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#6E7781`,\"--shiki-dark\":`#6A9955`},children:`# Print the search results`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#DCDCAA`},children:`print`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`(`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"Search Results:\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`)`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#C586C0`},children:`for`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` line `}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#C586C0`},children:`in`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` search_result:`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#DCDCAA`},children:` print`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`(line.strip()) `}),_jsx(_components.span,{style:{color:`#6E7781`,\"--shiki-dark\":`#6A9955`},children:`# Strip removes the newline character`})]}),`\n`]})})}),`\n`,_jsx(Heading,{level:`3`,id:`full-code`,children:`Full Code`}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`66`,language:`python`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`python`,children:_jsxs(_components.code,{language:`python`,numberOfLines:`66`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#C586C0`},children:`import`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` asyncio`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#C586C0`},children:`import`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` aiofiles`})]}),`\n`,_jsx(_components.span,{className:`line`}),`\n`,_jsx(_components.span,{className:`line`}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#C586C0`},children:`from`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` superagentx.handler.base `}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#C586C0`},children:`import`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` BaseHandler`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#C586C0`},children:`from`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` superagentx.handler.decorators `}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#C586C0`},children:`import`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` tool`})]}),`\n`,_jsx(_components.span,{className:`line`}),`\n`,_jsx(_components.span,{className:`line`}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#569CD6`},children:`class`}),_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#4EC9B0`},children:` FileHandler`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`(`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#4EC9B0`},children:`BaseHandler`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`):`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#569CD6`},children:` def`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#DCDCAA`},children:` __init__`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`(`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:`self`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`, `}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:`file_path`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#4EC9B0`},children:`str`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`):`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"\"\"`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` Initializes the FileHandler with the given file path.`})}),`\n`,_jsx(_components.span,{className:`line`}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` Args:`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` file_path (str): The path to the text file to be read.`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"\"\"`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#4EC9B0`},children:` super`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`().`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#DCDCAA`},children:`__init__`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`() `}),_jsx(_components.span,{style:{color:`#6E7781`,\"--shiki-dark\":`#6A9955`},children:`# Call the parent class's constructor`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` self`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`.file_path `}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:`=`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` file_path `}),_jsx(_components.span,{style:{color:`#6E7781`,\"--shiki-dark\":`#6A9955`},children:`# Store the file path for later use`})]}),`\n`,_jsx(_components.span,{className:`line`}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#8250DF`,\"--shiki-dark\":`#DCDCAA`},children:` @tool`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#569CD6`},children:` async`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#569CD6`},children:` def`}),_jsx(_components.span,{style:{color:`#8250DF`,\"--shiki-dark\":`#DCDCAA`},children:` read_file`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`(`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:`self`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`):`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"\"\"`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` Reads the contents of the file specified by the file path.`})}),`\n`,_jsx(_components.span,{className:`line`}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` Returns:`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` list: A list of lines from the file.`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"\"\"`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#C586C0`},children:` try`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`:`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#C586C0`},children:` async`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#C586C0`},children:` with`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` aiofiles.open(`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:`self`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`.file_path, `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`'r'`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`) `}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#C586C0`},children:`as`}),_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#D4D4D4`},children:` file`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`:`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` lines `}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:`=`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#C586C0`},children:` await`}),_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#D4D4D4`},children:` file`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`.readlines()`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#C586C0`},children:` return`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` lines`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#C586C0`},children:` except`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#4EC9B0`},children:` FileNotFoundError`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`:`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#DCDCAA`},children:` print`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`(`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#569CD6`},children:`f`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"Error: The file at `}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#569CD6`},children:`{`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:`self`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`.file_path`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#569CD6`},children:`}`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` was not found.\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`)`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#C586C0`},children:` return`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` []`})]}),`\n`,_jsx(_components.span,{className:`line`}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#8250DF`,\"--shiki-dark\":`#DCDCAA`},children:` @tool`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#569CD6`},children:` async`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#569CD6`},children:` def`}),_jsx(_components.span,{style:{color:`#8250DF`,\"--shiki-dark\":`#DCDCAA`},children:` search`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`(`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:` self`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:` query`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#4EC9B0`},children:`str`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` ):`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"\"\"`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` Searches for lines in the file that contain the provided query.`})}),`\n`,_jsx(_components.span,{className:`line`}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` Args:`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` query (str): The string to search for in the file.`})}),`\n`,_jsx(_components.span,{className:`line`}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` Returns:`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` list: A list of lines containing the query.`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"\"\"`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` lines `}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:`=`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#C586C0`},children:` await`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` self`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`.read_file() `}),_jsx(_components.span,{style:{color:`#6E7781`,\"--shiki-dark\":`#6A9955`},children:`# Get lines from the file`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` filtered_lines `}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:`=`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` [line `}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#C586C0`},children:`for`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` line `}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#C586C0`},children:`in`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` lines `}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#C586C0`},children:`if`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` query.lower() `}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#569CD6`},children:`in`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` line.lower()] `}),_jsx(_components.span,{style:{color:`#6E7781`,\"--shiki-dark\":`#6A9955`},children:`# Filter lines by query`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#C586C0`},children:` return`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` filtered_lines`})]}),`\n`,_jsx(_components.span,{className:`line`}),`\n`,_jsx(_components.span,{className:`line`}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#6E7781`,\"--shiki-dark\":`#6A9955`},children:`# Create an instance of FileHandler with the path to your text file`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`file_handler `}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:`=`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` FileHandler(`}),_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#9CDCFE`},children:`file_path`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:`=`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`'sample.txt'`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`)`})]}),`\n`,_jsx(_components.span,{className:`line`}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#C586C0`},children:`if`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#9CDCFE`},children:` __name__`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:` ==`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"__main__\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`:`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#6E7781`,\"--shiki-dark\":`#6A9955`},children:` # Search for the term 'file' in the file`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` search_result `}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:`=`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` asyncio.run(file_handler.search(`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`'file'`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`))`})]}),`\n`,_jsx(_components.span,{className:`line`}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#6E7781`,\"--shiki-dark\":`#6A9955`},children:` # Print the search results`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#DCDCAA`},children:` print`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`(`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"Search Results:\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`)`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#C586C0`},children:` for`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` line `}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#C586C0`},children:`in`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` search_result:`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#DCDCAA`},children:` print`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`(line.strip()) `}),_jsx(_components.span,{style:{color:`#6E7781`,\"--shiki-dark\":`#6A9955`},children:`# Strip removes the newline character`})]}),`\n`,_jsx(_components.span,{className:`line`}),`\n`]})})}),`\n`,_jsx(Heading,{level:`3`,id:`expected-output`,children:`Expected Output:`}),`\n`,_jsx(_components.p,{children:`When you run this code, it will output:`}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`6`,language:`text`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`text`,children:_jsxs(_components.code,{language:`text`,numberOfLines:`6`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`Search Results:`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`This file contains several lines of text.`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`You can search through it using queries.`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`The FileHandler will help you find matching lines.`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{})})]})})})]})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent};function _missingMdxReference(id,component){throw new Error(`Expected `+(component?`component`:`object`)+\" `\"+id+\"` to be defined: you likely forgot to import, pass, or provide it.\")}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Create Handler","icon":"wrench","description":null,"href":"/examples/create_handler"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[{"title":"Step 1: Creating a New Handler","slug":"step-1-creating-a-new-handler","depth":3,"children":[]},{"title":"Step 2: Define Handler Method(s).","slug":"step-2-define-handler-methods","depth":3,"children":[]},{"title":"Step 3: Testing the Handler","slug":"step-3-testing-the-handler","depth":3,"children":[]},{"title":"create the sample.txt file","slug":"create-the-sample-txt-file","depth":2,"children":[{"title":"Use the FileHandler class to search for the term \"file\":","slug":"use-the-filehandler-class-to-search-for-the-term-file","depth":3,"children":[]},{"title":"Full Code","slug":"full-code","depth":3,"children":[]},{"title":"Expected Output:","slug":"expected-output","depth":3,"children":[]}]}],"codeExamples":{}},"jsLinks":[],"subdomain":"superagentx","siteName":"Starter Kit","title":"Create Handler - Starter Kit","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-04-11T03:02:38.090Z","originalFileLocation":"examples/create_handler.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"application-name\" content=\"Starter Kit\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/superagentx/P8JDN35vsfMW-pWR/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/superagentx/P8JDN35vsfMW-pWR/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/superagentx/P8JDN35vsfMW-pWR/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/superagentx/P8JDN35vsfMW-pWR/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/superagentx/P8JDN35vsfMW-pWR/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/superagentx/P8JDN35vsfMW-pWR/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/superagentx/P8JDN35vsfMW-pWR/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/superagentx/P8JDN35vsfMW-pWR/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/superagentx/P8JDN35vsfMW-pWR/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Create Handler - Starter Kit\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Starter Kit\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.superagentx.ai/examples/create_handler\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://superagentx.mintlify.site/_mintlify/api/og/v2?division=Handlers+%28Tools%29\u0026amp;title=Create+Handler\u0026amp;theme=87851ecb0c799d755a0ef12f\u0026amp;signature=54122c9f132d7ec241221636ef84b623c075a8a1f2dd88539bff6e7eff4173fd\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Create Handler - Starter Kit\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://superagentx.mintlify.site/_mintlify/api/og/v2?division=Handlers+%28Tools%29\u0026amp;title=Create+Handler\u0026amp;theme=87851ecb0c799d755a0ef12f\u0026amp;signature=54122c9f132d7ec241221636ef84b623c075a8a1f2dd88539bff6e7eff4173fd\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/superagentx/P8JDN35vsfMW-pWR/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Starter Kit\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#0b5394\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.superagentx.ai/examples/create_handler\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/examples/create_handler.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.superagentx.ai/#organization\",\"name\":\"Starter Kit\",\"url\":\"https://docs.superagentx.ai\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/superagentx/2i9VWqt1zKxPBKhG/logo/fulllogo_transparent_nobuffer.png?fit=max\u0026auto=format\u0026n=2i9VWqt1zKxPBKhG\u0026q=85\u0026s=31bf8d9efc0bdfafd3878db74a471ed6\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.superagentx.ai#website\",\"name\":\"Starter Kit\",\"url\":\"https://docs.superagentx.ai\",\"publisher\":{\"@id\":\"https://docs.superagentx.ai/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.superagentx.ai/examples/create_handler#webpage\",\"url\":\"https://docs.superagentx.ai/examples/create_handler\",\"name\":\"Create Handler\",\"dateModified\":\"2026-04-11T03:02:38.090Z\",\"isPartOf\":{\"@id\":\"https://docs.superagentx.ai#website\"},\"breadcrumb\":{\"@id\":\"https://docs.superagentx.ai/examples/create_handler#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.superagentx.ai/examples/create_handler#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Starter Kit\",\"item\":\"https://docs.superagentx.ai\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Create Handler\",\"item\":\"https://docs.superagentx.ai/examples/create_handler\"}]},{\"@type\":[\"Article\",\"TechArticle\"],\"@id\":\"https://docs.superagentx.ai/examples/create_handler#article\",\"headline\":\"Create Handler\",\"name\":\"Create Handler\",\"url\":\"https://docs.superagentx.ai/examples/create_handler\",\"mainEntityOfPage\":{\"@id\":\"https://docs.superagentx.ai/examples/create_handler#webpage\"},\"dateModified\":\"2026-04-11T03:02:38.090Z\",\"publisher\":{\"@id\":\"https://docs.superagentx.ai/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.superagentx.ai#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Starter Kit\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"Starter Kit\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/examples/create_handler.md","siteName":"Starter Kit","nav":{"global":{"anchors":[{"anchor":"Documentation","href":"https://docs.superagentx.ai/introduction","icon":"book-open-cover"},{"anchor":"Community","href":"https://discord.gg/hX5pAzKGXD","icon":"discord"},{"anchor":"Github","href":"https://github.com/superagentxai/superagentX/","icon":"github"}]},"tabs":[{"tab":"Documentation","groups":[{"group":"Get Started","pages":[{"title":"Introduction","icon":"house","href":"/introduction"},{"title":"Installation","icon":"screwdriver-wrench","href":"/installation"},{"title":"Quickstart","icon":"rocket","href":"/quickstart"}]},{"group":"Key Components","pages":[{"title":"Pipe","icon":"code-fork","href":"/pipe"},{"title":"Agent","icon":"robot","href":"/agent"},{"title":"Memory","icon":"memory","href":"/memory"},{"title":"LLMClient","icon":"microchip-ai","href":"/llm"},{"title":"Engines","icon":"engine","href":"/engines"},{"title":"PromptTemplate","icon":"rectangle-terminal","href":"/prompt"},{"title":"Handler","icon":"bars-progress","href":"/handler"},{"title":"MCP","icon":"square-m","href":"/mcp"},{"title":"Conversation","icon":"head-side-brain","href":"/conversation"},{"title":"Human Approval","icon":"h","href":"/human_approval"},{"title":"Storage","icon":"container-storage","href":"/storage"}]},{"group":"Pipe Interface","pages":[{"title":"IO Console","icon":"terminal","href":"/io-console"},{"title":"Rest API","icon":"gears","href":"/restapi"},{"title":"WebSocket","icon":"webhook","href":"/websocket"},{"title":"Voice Pipe","icon":"microphone-lines","description":null,"href":"/voice_pipe"}]},{"group":"Handlers (Tools)","pages":[{"title":"Create Handler","icon":"wrench","href":"/examples/create_handler"},{"group":"AWS","icon":"aws","pages":[{"title":"S3 Handler","icon":"bucket","description":null,"href":"/examples/handlers/aws/s3"},{"title":"EC2 Handler","icon":"server","href":"/examples/handlers/aws/ec2"},{"title":"RDS Handler","icon":"database","href":"/examples/handlers/aws/rds"},{"title":"ECS Handler","icon":"container-storage","href":"/examples/handlers/aws/ecs"},{"title":"API Gateway Handler","icon":"cloud","href":"/examples/handlers/aws/api_gateway"},{"title":"elasticache handler","icon":"server","href":"/examples/handlers/aws/elasticache"},{"title":"CloudFront Handler","icon":"globe","href":"/examples/handlers/aws/cloudfront"},{"title":"CloudWatch Handler","icon":"chart-bar","href":"/examples/handlers/aws/cloudwatch"},{"title":"ELB Handler","icon":"server","href":"/examples/handlers/aws/elb"},{"title":"AWS Helper","icon":"key","href":"/examples/handlers/aws/helper"},{"title":"IAM Handler","icon":"shield","href":"/examples/handlers/aws/iam"},{"title":"Security Groups Handler","icon":"lock","href":"/examples/handlers/aws/security_groups"},{"title":"Serverless Handler","icon":"lambda","href":"/examples/handlers/aws/serverless"},{"title":"AWS Cognito Handler","icon":"a","href":"/examples/handlers/aws/cognito"}]},{"group":"Microsoft Azure","icon":"A","pages":[{"title":"Application Gateway","icon":"window","href":"/examples/handlers/azure/application_gateway"},{"title":"Cloud Functions","icon":"cloud","href":"/examples/handlers/azure/cloud_functions"},{"title":"Entra IAM Handler","icon":"shield","href":"/examples/handlers/azure/iam"},{"title":"Load Balancer Handler","icon":"network-wired","href":"/examples/handlers/azure/load_balancer"},{"title":"NSG Handler","icon":"shield","href":"/examples/handlers/azure/nsg"},{"title":"Storage Handler","icon":"database","href":"/examples/handlers/azure/storage"},{"title":"VM Handler","icon":"server","href":"/examples/handlers/azure/vm"}]},{"group":"cybersecurity","icon":"shield","pages":[{"title":"Snyk Handler","icon":"shield","href":"/examples/handlers/cybersecurity/snyk"}]},{"group":"datadog","icon":"D","pages":[{"title":"Datadog Incidents","icon":"shield-dog","href":"/examples/handlers/datadog/incidents"}]},{"group":"Atlassian","icon":"atlassian","pages":[{"title":"Confluence Handler","icon":"confluence","href":"/examples/handlers/atlassian/confluence"},{"title":"Jira Handler","icon":"jira","href":"/examples/handlers/atlassian/jira"}]},{"group":"Gcp","icon":"G","pages":[{"title":"API Gateway Handler","icon":"server","href":"/examples/handlers/Gcp/api_gateway"},{"title":"Calendar Handler","icon":"calendar","href":"/examples/handlers/Gcp/calendar"},{"title":"Cloud Run Handler","icon":"cloud","href":"/examples/handlers/Gcp/cloud_run"},{"title":"Compute Handler","icon":"server","href":"/examples/handlers/Gcp/compute"},{"title":"Firewall Handler","icon":"shield-check","href":"/examples/handlers/Gcp/firewall"},{"title":"Gmail Handler","icon":"inbox","href":"/examples/handlers/Gcp/gmail"},{"title":"IAM Handler","icon":"shield","href":"/examples/handlers/Gcp/iam"},{"title":"Load Balancer Handler","icon":"split","href":"/examples/handlers/Gcp/loadbalancer"},{"title":"Security Role Handler","icon":"shield","href":"/examples/handlers/Gcp/security_role"},{"title":"Storage Handler","icon":"database","href":"/examples/handlers/Gcp/storage"}]},{"title":"Content Creator","icon":"clipboard","href":"/examples/handlers/content_creator"},{"title":"Csv Handler","icon":"file-csv","href":"/examples/handlers/csv_cli"},{"group":"E-Commerce Handler","icon":"cart-shopping","pages":[{"title":"Amazon Handler","icon":"amazon","href":"/examples/handlers/E-commerce/amazon"},{"title":"Flipkart Handler","icon":"circle-f","href":"/examples/handlers/E-commerce/flipkart"},{"title":"Walmart Handler","icon":"basket-shopping","href":"/examples/handlers/E-commerce/walmart"},{"title":"Best Buy Handler","icon":"shopping-cart","href":"/examples/handlers/E-commerce/best_buy"}]},{"title":"Exa Search Handler","icon":"draw-polygon","href":"/examples/handlers/exa"},{"title":"Elastic Search Handler","icon":"circle-e","href":"/examples/handlers/elastic"},{"title":"E-mail Handler","icon":"envelope-open-text","href":"/examples/handlers/email"},{"title":"Financial Data Handler","icon":"chart-mixed-up-circle-dollar","href":"/examples/handlers/financial_data"},{"group":"Google","icon":"circle-g","pages":[{"title":"Calender Handler","icon":"calendar-days","href":"/examples/handlers/Google/calender"},{"title":"Gmail Handler","icon":"square-m","href":"/examples/handlers/Google/gmail"}]},{"group":"Extract","icon":"file-import","pages":[{"title":"AI Handler","icon":"brain","href":"/examples/handlers/extract/ai"}]},{"title":"Hubspot Handler","icon":"chart-network","href":"/examples/handlers/hubspot"},{"title":"Openapi Handler","icon":"webhook","href":"/examples/handlers/openapi"},{"title":"Scrape Handler","icon":"spider","href":"/examples/handlers/scrape"},{"title":"Serper_dev Handler","icon":"circle-s","href":"/examples/handlers/serper_dev"},{"title":"Sql Handler","icon":"database","href":"/examples/handlers/sql"},{"title":"Visualization","icon":"chart-bar","href":"/examples/handlers/visualization"},{"title":"Weather Handler","icon":"cloud-bolt-sun","href":"/examples/handlers/weather"},{"title":"Wikipedia Handler","icon":"wikipedia-w","href":"/examples/handlers/wikipedia"},{"title":"ServiceNow Handler","icon":"server","href":"/examples/handlers/servicenow"},{"title":"ZohoHIRS Handler","icon":"users","href":"/examples/handlers/zohohirs"},{"title":"Slack Handler","icon":"slack","href":"/examples/handlers/slack"},{"title":"GitLab Handler","icon":"gitlab","href":"/examples/handlers/gitlab"},{"title":"GitHub Handler","icon":"github","href":"/examples/handlers/github"},{"title":"Twitter Handler","icon":"twitter","href":"/examples/handlers/twitter"},{"title":"Asana Handler","icon":"a","href":"/examples/handlers/asana"},{"title":"Taiga Handler","icon":"t","href":"/examples/handlers/taiga"},{"title":"HuggingFace Runner","icon":"face-smiling-hands","href":"/examples/handlers/hugging_face"},{"title":"Universal ML Handler","icon":"head-side-gear","href":"/examples/handlers/ml_handler"},{"title":"WhatsApp Handler","icon":"whatsapp","href":"/examples/handlers/whatsapp"},{"title":"Zoho Help Desk Handler","icon":"z","href":"/examples/handlers/zoho_help_desk"}]}]},{"tab":"Examples","pages":[{"title":"Examples","href":"/examples-reference/introduction"}]}]},"basePath":"","title":"Create Handler - Starter Kit","deploymentId":"dpl_HhUetB7eHHDAmK9T1Teip38TgFx9","buildId":"dpl_HhUetB7eHHDAmK9T1Teip38TgFx9","dynamics":[],"chunks":[]}