dspy.JSONAdapter
dspy.JSONAdapter(callbacks: Optional[list[BaseCallback]] = None)
Bases: ChatAdapter
Source code in dspy/adapters/chat_adapter.py
Functions
__call__(lm: LM, lm_kwargs: dict[str, Any], signature: Type[Signature], demos: list[dict[str, Any]], inputs: dict[str, Any]) -> list[dict[str, Any]]
Source code in dspy/adapters/json_adapter.py
acall(lm: LM, lm_kwargs: dict[str, Any], signature: Type[Signature], demos: list[dict[str, Any]], inputs: dict[str, Any]) -> list[dict[str, Any]]
async
Source code in dspy/adapters/base.py
format(signature: Type[Signature], demos: list[dict[str, Any]], inputs: dict[str, Any]) -> list[dict[str, Any]]
Format the input messages for the LM call.
This method converts the DSPy structured input along with few-shot examples and conversation history into multiturn messages as expected by the LM. For custom adapters, this method can be overridden to customize the formatting of the input messages.
In general we recommend the messages to have the following structure:
[
{"role": "system", "content": system_message},
# Begin few-shot examples
{"role": "user", "content": few_shot_example_1_input},
{"role": "assistant", "content": few_shot_example_1_output},
{"role": "user", "content": few_shot_example_2_input},
{"role": "assistant", "content": few_shot_example_2_output},
...
# End few-shot examples
# Begin conversation history
{"role": "user", "content": conversation_history_1_input},
{"role": "assistant", "content": conversation_history_1_output},
{"role": "user", "content": conversation_history_2_input},
{"role": "assistant", "content": conversation_history_2_output},
...
# End conversation history
{"role": "user", "content": current_input},
]
And system message should contain the field description, field structure, and task description.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
signature
|
Type[Signature]
|
The DSPy signature for which to format the input messages. |
required |
demos
|
list[dict[str, Any]]
|
A list of few-shot examples. |
required |
inputs
|
dict[str, Any]
|
The input arguments to the DSPy module. |
required |
Returns:
Type | Description |
---|---|
list[dict[str, Any]]
|
A list of multiturn messages as expected by the LM. |
Source code in dspy/adapters/base.py
136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 |
|
format_assistant_message_content(signature: Type[Signature], outputs: dict[str, Any], missing_field_message=None) -> str
Source code in dspy/adapters/json_adapter.py
format_conversation_history(signature: Type[Signature], history_field_name: str, inputs: dict[str, Any]) -> list[dict[str, Any]]
Format the conversation history.
This method formats the conversation history and the current input as multiturn messages.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
signature
|
Type[Signature]
|
The DSPy signature for which to format the conversation history. |
required |
history_field_name
|
str
|
The name of the history field in the signature. |
required |
inputs
|
dict[str, Any]
|
The input arguments to the DSPy module. |
required |
Returns:
Type | Description |
---|---|
list[dict[str, Any]]
|
A list of multiturn messages. |
Source code in dspy/adapters/base.py
format_demos(signature: Type[Signature], demos: list[dict[str, Any]]) -> list[dict[str, Any]]
Format the few-shot examples.
This method formats the few-shot examples as multiturn messages.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
signature
|
Type[Signature]
|
The DSPy signature for which to format the few-shot examples. |
required |
demos
|
list[dict[str, Any]]
|
A list of few-shot examples, each element is a dictionary with keys of the input and output fields of the signature. |
required |
Returns:
Type | Description |
---|---|
list[dict[str, Any]]
|
A list of multiturn messages. |
Source code in dspy/adapters/base.py
format_field_description(signature: Type[Signature]) -> str
Source code in dspy/adapters/chat_adapter.py
format_field_structure(signature: Type[Signature]) -> str
Source code in dspy/adapters/json_adapter.py
format_field_with_value(fields_with_values: Dict[FieldInfoWithName, Any], role: str = 'user') -> str
Formats the values of the specified fields according to the field's DSPy type (input or output), annotation (e.g. str, int, etc.), and the type of the value itself. Joins the formatted values into a single string, which is a multiline string if there are multiple fields.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
fields_with_values
|
Dict[FieldInfoWithName, Any]
|
A dictionary mapping information about a field to its corresponding value. |
required |
Returns: The joined formatted values of the fields, represented as a string.