> ## Documentation Index
> Fetch the complete documentation index at: https://docs.camel-ai.org/llms.txt
> Use this file to discover all available pages before exploring further.

# Camel.data collectors.base

<a id="camel.data_collectors.base" />

<a id="camel.data_collectors.base.CollectorData" />

## CollectorData

```python theme={"system"}
class CollectorData:
```

<a id="camel.data_collectors.base.CollectorData.__init__" />

### **init**

```python theme={"system"}
def __init__(
    self,
    id: UUID,
    name: str,
    role: Literal['user', 'assistant', 'system', 'tool'],
    message: Optional[str] = None,
    function_call: Optional[Dict[str, Any]] = None
):
```

Create a data item store information about a message.
Used by the data collector.

**Parameters:**

* **id** (UUID): The id of the message.
* **name** (str): The name of the agent.
* **role** (`Literal["user", "assistant", "system", "function"]`): The role of the message.
* **message** (Optional\[str], optional): The message. (default: :obj:`None`)
* **function\_call** (Optional\[Dict\[str, Any]], optional): The function call. (default: :obj:`None`)

<a id="camel.data_collectors.base.CollectorData.from_context" />

### from\_context

```python theme={"system"}
def from_context(name, context: Dict[str, Any]):
```

Create a data collector from a context.

**Parameters:**

* **name** (str): The name of the agent.
* **context** (Dict\[str, Any]): The context.

**Returns:**

CollectorData: The data collector.

<a id="camel.data_collectors.base.BaseDataCollector" />

## BaseDataCollector

```python theme={"system"}
class BaseDataCollector(ABC):
```

Base class for data collectors.

<a id="camel.data_collectors.base.BaseDataCollector.__init__" />

### **init**

```python theme={"system"}
def __init__(self):
```

Create a data collector.

<a id="camel.data_collectors.base.BaseDataCollector.step" />

### step

```python theme={"system"}
def step(
    self,
    role: Literal['user', 'assistant', 'system', 'tool'],
    name: Optional[str] = None,
    message: Optional[str] = None,
    function_call: Optional[Dict[str, Any]] = None
):
```

Record a message.

**Parameters:**

* **role** (`Literal["user", "assistant", "system", "tool"]`): The role of the message.
* **name** (Optional\[str], optional): The name of the agent. (default: :obj:`None`)
* **message** (Optional\[str], optional): The message to record. (default: :obj:`None`)
* **function\_call** (Optional\[Dict\[str, Any]], optional): The function call to record. (default: :obj:`None`)

**Returns:**

Self: The data collector.

<a id="camel.data_collectors.base.BaseDataCollector.record" />

### record

```python theme={"system"}
def record(self, agent: Union[List[ChatAgent], ChatAgent]):
```

Record agents.

**Parameters:**

* **agent** (Union\[List\[ChatAgent], ChatAgent]): The agent(s) to inject.

<a id="camel.data_collectors.base.BaseDataCollector.start" />

### start

```python theme={"system"}
def start(self):
```

Start recording.

<a id="camel.data_collectors.base.BaseDataCollector.stop" />

### stop

```python theme={"system"}
def stop(self):
```

Stop recording.

<a id="camel.data_collectors.base.BaseDataCollector.recording" />

### recording

```python theme={"system"}
def recording(self):
```

Whether the collector is recording.

<a id="camel.data_collectors.base.BaseDataCollector.reset" />

### reset

```python theme={"system"}
def reset(self, reset_agents: bool = True):
```

Reset the collector.

**Parameters:**

* **reset\_agents** (bool, optional): Whether to reset the agents. Defaults to True.

<a id="camel.data_collectors.base.BaseDataCollector.convert" />

### convert

```python theme={"system"}
def convert(self):
```

Convert the collected data.

<a id="camel.data_collectors.base.BaseDataCollector.llm_convert" />

### llm\_convert

```python theme={"system"}
def llm_convert(self, converter: Any, prompt: Optional[str] = None):
```

Convert the collected data.

<a id="camel.data_collectors.base.BaseDataCollector.get_agent_history" />

### get\_agent\_history

```python theme={"system"}
def get_agent_history(self, name: str):
```

Get the message history of an agent.

**Parameters:**

* **name** (str): The name of the agent.

**Returns:**

List\[CollectorData]: The message history of the agent