File size: 2,485 Bytes
0c97269 c2a8690 0c97269 c2a8690 0c97269 |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 |
# Table of Contents
* [PlanGeneratorAtomicFlow](#PlanGeneratorAtomicFlow)
* [PlanGeneratorAtomicFlow](#PlanGeneratorAtomicFlow.PlanGeneratorAtomicFlow)
* [\_\_init\_\_](#PlanGeneratorAtomicFlow.PlanGeneratorAtomicFlow.__init__)
* [instantiate\_from\_config](#PlanGeneratorAtomicFlow.PlanGeneratorAtomicFlow.instantiate_from_config)
* [run](#PlanGeneratorAtomicFlow.PlanGeneratorAtomicFlow.run)
* [run](#run)
* [\_\_init\_\_](#__init__)
<a id="PlanGeneratorAtomicFlow"></a>
# PlanGeneratorAtomicFlow
<a id="PlanGeneratorAtomicFlow.PlanGeneratorAtomicFlow"></a>
## PlanGeneratorAtomicFlow Objects
```python
class PlanGeneratorAtomicFlow(ChatAtomicFlow)
```
This class wraps around the Chat API to generate plan from a goal.
*Input Interface Non Initialized*:
- `goal`
*Input Interface Initialized*:
- `goal`
*Output Interface*:
- `plan`
*Configuration Parameters*:
- Also refer to ChatAtomicFlow (https://huggingface.co/aiflows/ChatFlowModule/blob/main/ChatAtomicFlow.py)
- `input_interface_non_initialized`: The input interface when the conversation is not initialized.
- `input_interface_initialized`: The input interface when the conversation is initialized.
- `output_interface`: The output interface.
- `backend`: The backend to use for the Chat API.
- `system_message_prompt_template`: The template for the system message prompt.
- `human_message_prompt_template`: The template for the human message prompt.
- `init_human_message_prompt_template`: The initial human message prompt.
<a id="PlanGeneratorAtomicFlow.PlanGeneratorAtomicFlow.__init__"></a>
#### \_\_init\_\_
```python
def __init__(**kwargs)
```
This function instantiates the class.
**Arguments**:
- `kwargs` (`Dict[str, Any]`): The configuration parameters.
<a id="PlanGeneratorAtomicFlow.PlanGeneratorAtomicFlow.instantiate_from_config"></a>
#### instantiate\_from\_config
```python
@classmethod
def instantiate_from_config(cls, config)
```
This function instantiates the class from a configuration.
**Arguments**:
- `config` (`Dict[str, Any]`): The configuration.
**Returns**:
`ChatAtomicFlow`: The instantiated class.
<a id="PlanGeneratorAtomicFlow.PlanGeneratorAtomicFlow.run"></a>
#### run
```python
def run(input_data: Dict[str, Any]) -> Dict[str, Any]
```
This function runs the flow.
**Arguments**:
- `input_data` (`Dict[str, Any]`): The input data.
**Returns**:
`Dict[str, Any]`: The output data.
<a id="run"></a>
# run
<a id="__init__"></a>
# \_\_init\_\_
|