File size: 2,045 Bytes
fcaa164 |
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 |
# ========= Copyright 2023-2024 @ CAMEL-AI.org. All Rights Reserved. =========
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
# ========= Copyright 2023-2024 @ CAMEL-AI.org. All Rights Reserved. =========
import textwrap
from typing import Optional, Type
from pydantic import BaseModel
from camel.messages import OpenAIMessage
def try_modify_message_with_format(
message: OpenAIMessage,
response_format: Optional[Type[BaseModel]],
) -> None:
r"""Modifies the content of the message to include the instruction of using
the response format.
The message will not be modified in the following cases:
- response_format is None
- message content is not a string
- message role is assistant
Args:
response_format (Optional[Type[BaseModel]]): The Pydantic model class.
message (OpenAIMessage): The message to be modified.
"""
if response_format is None:
return
if not isinstance(message["content"], str):
return
if message["role"] == "assistant":
return
json_schema = response_format.model_json_schema()
updated_prompt = textwrap.dedent(
f"""\
{message["content"]}
Please generate a JSON response adhering to the following JSON schema:
{json_schema}
Make sure the JSON response is valid and matches the EXACT structure defined in the schema. Your result should ONLY be a valid json object, WITHOUT ANY OTHER TEXT OR COMMENTS.
""" # noqa: E501
)
message["content"] = updated_prompt
|