Skip to content

Latest commit

 

History

History
102 lines (73 loc) · 2.42 KB

File metadata and controls

102 lines (73 loc) · 2.42 KB
title CrewAI SDK
description The CopilotKit CrewAI SDK for Python allows you to build and run CrewAI agents with CopilotKit.

{ /*

  • ATTENTION! DO NOT MODIFY THIS FILE!
  • This page is auto-generated. If you want to make any changes to this page, changes must be made at:
  • sdk-python/copilotkit/crewai/crewai_sdk.py */ }

copilotkit_predict_state

Stream tool calls as state to CopilotKit.

To emit a tool call as streaming CrewAI state, pass the destination key in state,
the tool name and optionally the tool argument. (If you don't pass the argument name,
all arguments are emitted under the state key.)

```python
from copilotkit.crewai import copilotkit_predict_state

await copilotkit_predict_state(
    {
        "steps": {
            "tool_name": "SearchTool",
            "tool_argument": "steps",
        },
    }
)
```

Parameters

The configuration to predict the state.

Returns

Always return True.

copilotkit_emit_message

Manually emits a message to CopilotKit. Useful in longer running nodes to update the user. Important: You still need to return the messages from the node.

### Examples

```python
from copilotkit.crewai import copilotkit_emit_message

message = "Step 1 of 10 complete"
await copilotkit_emit_message(message)

# Return the message from the node
return {
    "messages": [AIMessage(content=message)]
}
```

Parameters

The message to emit.

Returns

Always return True.

copilotkit_emit_tool_call

Manually emits a tool call to CopilotKit.

```python
from copilotkit.crewai import copilotkit_emit_tool_call

await copilotkit_emit_tool_call(name="SearchTool", args={"steps": 10})
```

Parameters

The name of the tool to emit. The arguments to emit.

Returns

Always return True.