Skip to content

mistral_common.protocol.instruct.normalize

InstructRequestNormalizer(user_message_class, assistant_message_class, tool_message_class, system_message_class, instruct_request_class, model_settings_builder)

Bases: Generic[UserMessageType, AssistantMessageType, ToolMessageType, SystemMessageType, InstructRequestType]

Takes a ChatCompletionRequest and normalizes it into an InstructRequest.

The normalization process does several things such as: - Aggregate consecutive messages of the same role - Aggregate system prompts - Normalize json content - Normalize tool calls

Examples:

>>> normalizer = InstructRequestNormalizer.normalizer()

Parameters:

Name Type Description Default
user_message_class type[UserMessageType]

The class for user messages.

 required
assistant_message_class type[AssistantMessageType]

The class for assistant messages.

 required
tool_message_class type[ToolMessageType]

The class for tool messages.

 required
system_message_class type[SystemMessageType]

The class for system messages.

 required
instruct_request_class type[InstructRequestType]

The class for instruct requests.

 required
model_settings_builder ModelSettingsBuilder | None

The builder for model settings, or None if unsupported.

 required
Source code in src/mistral_common/protocol/instruct/normalize.py 
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
def __init__(
    self,
    user_message_class: type[UserMessageType],
    assistant_message_class: type[AssistantMessageType],
    tool_message_class: type[ToolMessageType],
    system_message_class: type[SystemMessageType],
    instruct_request_class: type[InstructRequestType],
    model_settings_builder: ModelSettingsBuilder | None,
):
    r"""Initializes the normalizer with the appropriate message classes.

    Args:
       user_message_class: The class for user messages.
       assistant_message_class: The class for assistant messages.
       tool_message_class: The class for tool messages.
       system_message_class: The class for system messages.
       instruct_request_class: The class for instruct requests.
       model_settings_builder: The builder for model settings, or None if unsupported.
    """
    self._user_message_class = user_message_class
    self._assistant_message_class = assistant_message_class
    self._tool_message_class = tool_message_class
    self._instruct_request_class = instruct_request_class
    # this is unused but makes creation nicer
    self._system_message_class = system_message_class
    self._model_settings_builder = model_settings_builder

build_settings(request)

Build model settings from a chat completion request.

For pre-v15 normalizers, model settings are all None.

Parameters:

Name Type Description Default
request ChatCompletionRequest

The chat completion request.

 required

Returns:

Type Description
ModelSettings

Returns ModelSettings.none().
Source code in src/mistral_common/protocol/instruct/normalize.py 
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
def build_settings(self, request: ChatCompletionRequest) -> ModelSettings:
    r"""Build model settings from a chat completion request.

    For pre-v15 normalizers, model settings are all `None`.

    Args:
        request: The chat completion request.

    Returns:
        Returns `ModelSettings.none()`.
    """
    if self._model_settings_builder is not None:
        raise InvalidRequestException(
            f"model_settings_builder should be None for {type(self).__name__}, got {self._model_settings_builder}"
        )
    return ModelSettings.none()

from_chat_completion_request(request)

Converts a chat completion request to an instruct request.

Parameters:

Name Type Description Default
request ChatCompletionRequest[UATS]

The chat completion request to convert.

 required

Returns:

Type Description
InstructRequestType

The converted instruct request.

Examples:

>>> from mistral_common.protocol.instruct.messages import UserMessage, AssistantMessage
>>> request = ChatCompletionRequest(
...     messages=[
...         UserMessage(content="Hello"),
...         AssistantMessage(content="Hi"),
...     ],
... )
>>> normalizer = InstructRequestNormalizer.normalizer()
>>> instruct_request = normalizer.from_chat_completion_request(request)
Source code in src/mistral_common/protocol/instruct/normalize.py 
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
def from_chat_completion_request(self, request: ChatCompletionRequest[UATS]) -> InstructRequestType:
    r"""Converts a chat completion request to an instruct request.

    Args:
        request: The chat completion request to convert.

    Returns:
        The converted instruct request.

    Examples:
        >>> from mistral_common.protocol.instruct.messages import UserMessage, AssistantMessage
        >>> request = ChatCompletionRequest(
        ...     messages=[
        ...         UserMessage(content="Hello"),
        ...         AssistantMessage(content="Hi"),
        ...     ],
        ... )
        >>> normalizer = InstructRequestNormalizer.normalizer()
        >>> instruct_request = normalizer.from_chat_completion_request(request)
    """
    system_prompt = self._aggregate_system_prompts(request.messages)
    messages = self._aggregate_messages(request.messages)

    settings = self.build_settings(request)
    if settings != ModelSettings.none():
        raise InvalidRequestException(f"Model settings are not supported for {type(self).__name__}, got {settings}")

    return self._instruct_request_class(
        messages=messages,
        system_prompt=system_prompt,
        available_tools=request.tools,
        continue_final_message=request.continue_final_message,
        settings=settings,
    )

normalizer(model_settings_builder=None) staticmethod

Returns a normalizer for the default instruct request.

Parameters:

Name Type Description Default
model_settings_builder ModelSettingsBuilder | None

Must be None for this normalizer version.

 None

Returns:

Type Description
InstructRequestNormalizer

A normalizer for the default instruct request.

Raises:

Type Description
ValueError

If model_settings_builder is not None.

Examples:

>>> normalizer = InstructRequestNormalizer.normalizer()
Source code in src/mistral_common/protocol/instruct/normalize.py 
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
@staticmethod
def normalizer(model_settings_builder: ModelSettingsBuilder | None = None) -> "InstructRequestNormalizer":
    r"""Returns a normalizer for the default instruct request.

    Args:
        model_settings_builder: Must be None for this normalizer version.

    Returns:
        A normalizer for the default instruct request.

    Raises:
        ValueError: If model_settings_builder is not None.

    Examples:
        >>> normalizer = InstructRequestNormalizer.normalizer()
    """
    if model_settings_builder is not None:
        raise ValueError(
            f"model_settings_builder must be None for InstructRequestNormalizer, got {model_settings_builder}"
        )
    return InstructRequestNormalizer(
        UserMessage, AssistantMessage, ToolMessage, SystemMessage, InstructRequest[UATS, Tool], None
    )

InstructRequestNormalizerV13(user_message_class, assistant_message_class, tool_message_class, system_message_class, instruct_request_class, model_settings_builder)

Bases: InstructRequestNormalizerV7

Normalizer for the v13 tokenizer.

It reorders tool messages based on the tool call order.

Examples:

>>> normalizer = InstructRequestNormalizerV13.normalizer()
Source code in src/mistral_common/protocol/instruct/normalize.py 
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
def __init__(
    self,
    user_message_class: type[UserMessageType],
    assistant_message_class: type[AssistantMessageType],
    tool_message_class: type[ToolMessageType],
    system_message_class: type[SystemMessageType],
    instruct_request_class: type[InstructRequestType],
    model_settings_builder: ModelSettingsBuilder | None,
):
    r"""Initializes the normalizer with the appropriate message classes.

    Args:
       user_message_class: The class for user messages.
       assistant_message_class: The class for assistant messages.
       tool_message_class: The class for tool messages.
       system_message_class: The class for system messages.
       instruct_request_class: The class for instruct requests.
       model_settings_builder: The builder for model settings, or None if unsupported.
    """
    self._user_message_class = user_message_class
    self._assistant_message_class = assistant_message_class
    self._tool_message_class = tool_message_class
    self._instruct_request_class = instruct_request_class
    # this is unused but makes creation nicer
    self._system_message_class = system_message_class
    self._model_settings_builder = model_settings_builder

normalizer(model_settings_builder=None) staticmethod

Returns a normalizer for the default instruct request.

Parameters:

Name Type Description Default
model_settings_builder ModelSettingsBuilder | None

Must be None for this normalizer version.

 None

Returns:

Type Description
InstructRequestNormalizerV13

A normalizer for the V13 instruct request.

Raises:

Type Description
ValueError

If model_settings_builder is not None.
Source code in src/mistral_common/protocol/instruct/normalize.py 
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
@staticmethod
def normalizer(model_settings_builder: ModelSettingsBuilder | None = None) -> "InstructRequestNormalizerV13":
    r"""Returns a normalizer for the default instruct request.

    Args:
        model_settings_builder: Must be None for this normalizer version.

    Returns:
        A normalizer for the V13 instruct request.

    Raises:
        ValueError: If model_settings_builder is not None.
    """
    if model_settings_builder is not None:
        raise ValueError(
            f"model_settings_builder must be None for InstructRequestNormalizerV13, got {model_settings_builder}"
        )
    return InstructRequestNormalizerV13(
        UserMessage, AssistantMessage, ToolMessage, SystemMessage, InstructRequest[UATS, Tool], None
    )

InstructRequestNormalizerV15(user_message_class, assistant_message_class, tool_message_class, system_message_class, instruct_request_class, model_settings_builder)

Bases: InstructRequestNormalizerV13

Normalizer for the v15 tokenizer.

It reorders tool messages based on the tool call order and builds model settings.

Examples:

>>> normalizer = InstructRequestNormalizerV15.normalizer()
Source code in src/mistral_common/protocol/instruct/normalize.py 
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
def __init__(
    self,
    user_message_class: type[UserMessageType],
    assistant_message_class: type[AssistantMessageType],
    tool_message_class: type[ToolMessageType],
    system_message_class: type[SystemMessageType],
    instruct_request_class: type[InstructRequestType],
    model_settings_builder: ModelSettingsBuilder | None,
):
    r"""Initializes the normalizer with the appropriate message classes.

    Args:
       user_message_class: The class for user messages.
       assistant_message_class: The class for assistant messages.
       tool_message_class: The class for tool messages.
       system_message_class: The class for system messages.
       instruct_request_class: The class for instruct requests.
       model_settings_builder: The builder for model settings, or None if unsupported.
    """
    self._user_message_class = user_message_class
    self._assistant_message_class = assistant_message_class
    self._tool_message_class = tool_message_class
    self._instruct_request_class = instruct_request_class
    # this is unused but makes creation nicer
    self._system_message_class = system_message_class
    self._model_settings_builder = model_settings_builder

build_settings(request)

Build model settings using the configured model settings builder.

Parameters:

Name Type Description Default
request ChatCompletionRequest

The chat completion request.

 required

Returns:

Type Description
ModelSettings

The built model settings.

Raises:

Type Description
InvalidRequestException

If no model settings builder is configured.
Source code in src/mistral_common/protocol/instruct/normalize.py 
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
def build_settings(self, request: ChatCompletionRequest) -> ModelSettings:
    r"""Build model settings using the configured model settings builder.

    Args:
        request: The chat completion request.

    Returns:
        The built model settings.

    Raises:
        InvalidRequestException: If no model settings builder is configured.
    """
    if self._model_settings_builder is None:
        raise InvalidRequestException(f"model_settings_builder must not be None for {type(self).__name__}")
    return self._model_settings_builder.build_settings(request)

from_chat_completion_request(request)

Converts a chat completion request to an instruct request.

Parameters:

Name Type Description Default
request ChatCompletionRequest[UATS]

The chat completion request to convert.

 required

Returns:

Type Description
InstructRequestType

The converted instruct request.
Source code in src/mistral_common/protocol/instruct/normalize.py 
545
546
547
548
549
550
551
552
553
554
555
556
557
558
def from_chat_completion_request(self, request: ChatCompletionRequest[UATS]) -> InstructRequestType:  # type: ignore[type-var, misc]
    r"""Converts a chat completion request to an instruct request.

    Args:
        request: The chat completion request to convert.

    Returns:
        The converted instruct request.
    """
    messages = self._aggregate_messages(request.messages)
    settings = self.build_settings(request)
    return self._instruct_request_class(  # type: ignore[no-any-return]
        messages=messages, system_prompt=None, available_tools=request.tools, settings=settings
    )

normalizer(model_settings_builder=None) staticmethod

Returns a normalizer for the V15 instruct request.

Parameters:

Name Type Description Default
model_settings_builder ModelSettingsBuilder | None

The builder for model settings.

 None

Returns:

Type Description
InstructRequestNormalizerV15

A normalizer for the V15 instruct request.
Source code in src/mistral_common/protocol/instruct/normalize.py 
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
@staticmethod
def normalizer(model_settings_builder: ModelSettingsBuilder | None = None) -> "InstructRequestNormalizerV15":
    r"""Returns a normalizer for the V15 instruct request.

    Args:
        model_settings_builder: The builder for model settings.

    Returns:
        A normalizer for the V15 instruct request.
    """
    return InstructRequestNormalizerV15(
        UserMessage,
        AssistantMessage,
        ToolMessage,
        SystemMessage,
        InstructRequest,
        model_settings_builder,
    )

InstructRequestNormalizerV7(user_message_class, assistant_message_class, tool_message_class, system_message_class, instruct_request_class, model_settings_builder)

Bases: InstructRequestNormalizer

Normalizer for the v7 tokenizer.

Examples:

>>> normalizer = InstructRequestNormalizerV7.normalizer()
Source code in src/mistral_common/protocol/instruct/normalize.py 
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
def __init__(
    self,
    user_message_class: type[UserMessageType],
    assistant_message_class: type[AssistantMessageType],
    tool_message_class: type[ToolMessageType],
    system_message_class: type[SystemMessageType],
    instruct_request_class: type[InstructRequestType],
    model_settings_builder: ModelSettingsBuilder | None,
):
    r"""Initializes the normalizer with the appropriate message classes.

    Args:
       user_message_class: The class for user messages.
       assistant_message_class: The class for assistant messages.
       tool_message_class: The class for tool messages.
       system_message_class: The class for system messages.
       instruct_request_class: The class for instruct requests.
       model_settings_builder: The builder for model settings, or None if unsupported.
    """
    self._user_message_class = user_message_class
    self._assistant_message_class = assistant_message_class
    self._tool_message_class = tool_message_class
    self._instruct_request_class = instruct_request_class
    # this is unused but makes creation nicer
    self._system_message_class = system_message_class
    self._model_settings_builder = model_settings_builder

from_chat_completion_request(request)

Converts a chat completion request to an instruct request.

Parameters:

Name Type Description Default
request ChatCompletionRequest[UATS]

The chat completion request to convert.

 required

Returns:

Type Description
InstructRequestType

The converted instruct request.

Examples:

>>> from mistral_common.protocol.instruct.messages import UserMessage, AssistantMessage
>>> request = ChatCompletionRequest(
...     messages=[
...         UserMessage(content="Hello"),
...         AssistantMessage(content="Hi"),
...     ],
... )
>>> normalizer = InstructRequestNormalizerV7.normalizer()
>>> instruct_request = normalizer.from_chat_completion_request(request)
Source code in src/mistral_common/protocol/instruct/normalize.py 
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
def from_chat_completion_request(self, request: ChatCompletionRequest[UATS]) -> InstructRequestType:  # type: ignore[type-var, misc]
    r"""Converts a chat completion request to an instruct request.

    Args:
        request: The chat completion request to convert.

    Returns:
        The converted instruct request.

    Examples:
        >>> from mistral_common.protocol.instruct.messages import UserMessage, AssistantMessage
        >>> request = ChatCompletionRequest(
        ...     messages=[
        ...         UserMessage(content="Hello"),
        ...         AssistantMessage(content="Hi"),
        ...     ],
        ... )
        >>> normalizer = InstructRequestNormalizerV7.normalizer()
        >>> instruct_request = normalizer.from_chat_completion_request(request)
    """
    messages = self._aggregate_messages(request.messages)
    settings = self.build_settings(request)
    if settings != ModelSettings.none():
        raise InvalidRequestException(f"Model settings are not supported for {type(self).__name__}, got {settings}")
    return self._instruct_request_class(  # type: ignore[no-any-return]
        messages=messages, system_prompt=None, available_tools=request.tools, settings=settings
    )

normalizer(model_settings_builder=None) staticmethod

Returns a normalizer for the default instruct request.

Parameters:

Name Type Description Default
model_settings_builder ModelSettingsBuilder | None

Must be None for this normalizer version.

 None

Returns:

Type Description
InstructRequestNormalizerV7

A normalizer for the V7 instruct request.

Raises:

Type Description
ValueError

If model_settings_builder is not None.

Examples:

>>> normalizer = InstructRequestNormalizerV7.normalizer()
Source code in src/mistral_common/protocol/instruct/normalize.py 
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
@staticmethod
def normalizer(model_settings_builder: ModelSettingsBuilder | None = None) -> "InstructRequestNormalizerV7":
    r"""Returns a normalizer for the default instruct request.

    Args:
        model_settings_builder: Must be None for this normalizer version.

    Returns:
        A normalizer for the V7 instruct request.

    Raises:
        ValueError: If model_settings_builder is not None.

    Examples:
        >>> normalizer = InstructRequestNormalizerV7.normalizer()
    """
    if model_settings_builder is not None:
        raise ValueError(
            f"model_settings_builder must be None for InstructRequestNormalizerV7, got {model_settings_builder}"
        )
    return InstructRequestNormalizerV7(
        UserMessage, AssistantMessage, ToolMessage, SystemMessage, InstructRequest[UATS, Tool], None
    )

get_normalizer(version, model_settings_builder=None)

Gets the appropriate normalizer for the given tokenizer version.

Parameters:

Name Type Description Default
version TokenizerVersion

The tokenizer version to get the normalizer for.

 required
model_settings_builder ModelSettingsBuilder | None

The builder for model settings, or None if unsupported.

 None

Returns:

Type Description
InstructRequestNormalizer

The appropriate normalizer for the given tokenizer version.

Examples:

>>> normalizer = get_normalizer(TokenizerVersion.v1)
Source code in src/mistral_common/protocol/instruct/normalize.py 
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
def get_normalizer(
    version: TokenizerVersion, model_settings_builder: ModelSettingsBuilder | None = None
) -> InstructRequestNormalizer:
    r"""Gets the appropriate normalizer for the given tokenizer version.

    Args:
        version: The tokenizer version to get the normalizer for.
        model_settings_builder: The builder for model settings, or None if unsupported.

    Returns:
        The appropriate normalizer for the given tokenizer version.

    Examples:
        >>> normalizer = get_normalizer(TokenizerVersion.v1)
    """
    match version:
        case TokenizerVersion.v1 | TokenizerVersion.v2 | TokenizerVersion.v3:
            normalizer_cls = InstructRequestNormalizer
        case TokenizerVersion.v7:
            normalizer_cls = InstructRequestNormalizerV7
        case TokenizerVersion.v11 | TokenizerVersion.v13:
            normalizer_cls = InstructRequestNormalizerV13
        case TokenizerVersion.v15:
            normalizer_cls = InstructRequestNormalizerV15
        case _:
            assert_never(version)

    return normalizer_cls.normalizer(model_settings_builder=model_settings_builder)

normalizer_for_tokenizer_version(version, model_settings_builder=None)

Deprecated in favor to get_normalizer, will be removed in 1.12.0.

Source code in src/mistral_common/protocol/instruct/normalize.py 
561
562
563
564
565
566
567
568
569
570
def normalizer_for_tokenizer_version(
    version: TokenizerVersion, model_settings_builder: ModelSettingsBuilder | None = None
) -> InstructRequestNormalizer:
    r"""Deprecated in favor to `get_normalizer`, will be removed in 1.12.0."""
    warnings.warn(
        "`normalizer_for_tokenizer_version` is deprecated and will be removed in 1.12.0. "
        "Please call `get_normalizer` instead.",
        FutureWarning,
    )
    return get_normalizer(version=version, model_settings_builder=model_settings_builder)