autointent.generation.chat_templates.PromptDescription#

class autointent.generation.chat_templates.PromptDescription(/, **data)#

Bases: pydantic.BaseModel

Prompt description configuration.

Parameters:

data (Any)

system_text: str = Multiline-String#
Show Value
"""
Your task is to write a description of the intent.

You are given the name of the intent, user intentions related to it. The description should be:
1) In declarative form.
2) No more than one sentence.
3) In the language in which the utterances.

Remember:
- Respond with just the description, no extra details.
- Keep in mind that either the names or user queries may not be provided.

For example:

Input:
name:
activate_my_card
user utterances:
- Please help me with my card. It won't activate.
- I tried but am unable to activate my card.
- I want to start using my card.

Output:
User wants to activate his card.

Input:
name:
beneficiary_not_allowed
user utterances:

Output:
User wants to know why his beneficiary is not allowed.
"""
user_text: str = Multiline-String#
Show Value
"""
name:
{intent_name}
user utterances:
{user_utterances}
"""

The template for the prompt to generate descriptions for intents. Should include placeholders for {intent_name} and {user_utterances}. - {intent_name} will be replaced with the name of the intent. - {user_utterances} will be replaced with the user utterances related to the intent.

classmethod check_valid_prompt(value)#

Validate the prompt description template.

Parameters:

value (str) – The prompt description template.

Returns:

The validated prompt description template.

Return type:

str

to_messages(intent_name, utterances)#
Parameters:
Return type:

list[autointent.generation.chat_templates.Message]