Skip to content

openai

OpenAITextGenerationTask

Bases: TextGenerationTask

A TextGenerationTask for any chat-completion OpenAI model.

Parameters:

Name Type Description Default
system_prompt str

the system prompt to be used. Defaults to None.

 required
principles Dict[str, List[str]]

the principles to be used for the system prompt. Defaults to None.

 required
principles_distribution Union[Dict[str, float], Literal[balanced], None]

the distribution of principles to be used for the system prompt. Defaults to None.

 required
Source code in src/distilabel/tasks/text_generation/openai.py 
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
class OpenAITextGenerationTask(TextGenerationTask):
    """A `TextGenerationTask` for any chat-completion OpenAI model.

    Args:
        system_prompt (str, optional): the system prompt to be used. Defaults to `None`.
        principles (Dict[str, List[str]], optional): the principles to be used for the system prompt.
            Defaults to `None`.
        principles_distribution (Union[Dict[str, float], Literal["balanced"], None], optional): the
            distribution of principles to be used for the system prompt. Defaults to `None`.
    """

    def generate_prompt(self, input: str) -> List["ChatCompletion"]:
        """Generates a prompt for any chat-completion OpenAI model.

        Args:
            input (str): the input to be used for the prompt.

        Returns:
            List[ChatCompletion]: the generated prompt.

        Examples:
            >>> from distilabel.tasks.text_generation import OpenAITextGenerationTask
            >>> task = OpenAITextGenerationTask(system_prompt="You are a helpful assistant.")
            >>> task.generate_prompt("What are the first 5 Fibonacci numbers?")
            [
                {'role': 'system', 'content': 'You are a helpful assistant.'},
                {'role': 'user', 'content': 'What are the first 5 Fibonacci numbers?'},
            ]
        """
        return Prompt(
            system_prompt=self.system_prompt,
            formatted_prompt=input,
        ).format_as("openai")  # type: ignore

generate_prompt(input)

Generates a prompt for any chat-completion OpenAI model.

Parameters:

Name Type Description Default
input str

the input to be used for the prompt.

 required

Returns:

Type Description
List[ChatCompletion]

List[ChatCompletion]: the generated prompt.

Examples:

>>> from distilabel.tasks.text_generation import OpenAITextGenerationTask
>>> task = OpenAITextGenerationTask(system_prompt="You are a helpful assistant.")
>>> task.generate_prompt("What are the first 5 Fibonacci numbers?")
[
    {'role': 'system', 'content': 'You are a helpful assistant.'},
    {'role': 'user', 'content': 'What are the first 5 Fibonacci numbers?'},
]
Source code in src/distilabel/tasks/text_generation/openai.py 
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
def generate_prompt(self, input: str) -> List["ChatCompletion"]:
    """Generates a prompt for any chat-completion OpenAI model.

    Args:
        input (str): the input to be used for the prompt.

    Returns:
        List[ChatCompletion]: the generated prompt.

    Examples:
        >>> from distilabel.tasks.text_generation import OpenAITextGenerationTask
        >>> task = OpenAITextGenerationTask(system_prompt="You are a helpful assistant.")
        >>> task.generate_prompt("What are the first 5 Fibonacci numbers?")
        [
            {'role': 'system', 'content': 'You are a helpful assistant.'},
            {'role': 'user', 'content': 'What are the first 5 Fibonacci numbers?'},
        ]
    """
    return Prompt(
        system_prompt=self.system_prompt,
        formatted_prompt=input,
    ).format_as("openai")  # type: ignore