run

Class info

Classes

Name	Children	Inherits
Agent llmling_agent.agent.agent The main agent class.		MessageNode Generic
ImageURLContent llmling_agent.models.content Image from URL.		BaseImageContent

🛈 DocStrings

Functional wrappers for Agent usage.

run_agent async

run_agent(
    prompt: PromptCompatible,
    image_url: str | None = None,
    *,
    output_type: type[TResult],
    **kwargs: Unpack[AgentKwargs]
) -> TResult

run_agent(
    prompt: PromptCompatible, image_url: str | None = None, **kwargs: Unpack[AgentKwargs]
) -> str

run_agent(
    prompt: PromptCompatible,
    image_url: str | None = None,
    *,
    output_type: type[Any] | None = None,
    **kwargs: Unpack[AgentKwargs]
) -> Any

Run prompt through agent and return result.

Source code in src/llmling_agent/functional/run.py

async def run_agent(
    prompt: PromptCompatible,
    image_url: str | None = None,
    *,
    output_type: type[Any] | None = None,
    **kwargs: Unpack[AgentKwargs],
) -> Any:
    """Run prompt through agent and return result."""
    async with Agent[Any, str](**kwargs) as agent:
        if image_url:
            image = ImageURLContent(url=image_url)
            result = await agent.run(prompt, image, output_type=output_type)
        else:
            result = await agent.run(prompt, output_type=output_type)
        return result.content

run_agent_sync

run_agent_sync(
    prompt: PromptCompatible,
    image_url: str | None = None,
    *,
    output_type: type[TResult],
    **kwargs: Unpack[AgentKwargs]
) -> TResult

run_agent_sync(
    prompt: PromptCompatible, image_url: str | None = None, **kwargs: Unpack[AgentKwargs]
) -> str

run_agent_sync(
    prompt: PromptCompatible,
    image_url: str | None = None,
    *,
    output_type: type[Any] | None = None,
    **kwargs: Unpack[AgentKwargs]
) -> Any

Sync wrapper for run_agent.

Source code in src/llmling_agent/functional/run.py

def run_agent_sync(
    prompt: PromptCompatible,
    image_url: str | None = None,
    *,
    output_type: type[Any] | None = None,
    **kwargs: Unpack[AgentKwargs],
) -> Any:
    """Sync wrapper for run_agent."""
    coro = run_agent(prompt, image_url, output_type=output_type, **kwargs)  # type: ignore
    return asyncio.run(coro)