rasa-pro 3.12.0.dev2__py3-none-any.whl → 3.12.0.dev4__py3-none-any.whl

rasa/core/channels/voice_stream/voice_channel.py

@@ -1,32 +1,25 @@
 import asyncio
-import structlog
 import copy
 from dataclasses import asdict, dataclass
 from typing import Any, AsyncIterator, Awaitable, Callable, Dict, List, Optional, Tuple
 
-from rasa.core.channels.voice_stream.util import generate_silence
-from rasa.shared.core.constants import SLOT_SILENCE_TIMEOUT
-from rasa.shared.utils.common import (
-    class_from_module_path,
-    mark_as_beta_feature,
-)
-from rasa.shared.utils.cli import print_error_and_exit
-
+import structlog
+from sanic import Websocket  # type: ignore
 from sanic.exceptions import ServerError, WebsocketClosed
 
 from rasa.core.channels import InputChannel, OutputChannel, UserMessage
-from rasa.core.channels.voice_ready.utils import CallParameters
-from rasa.core.channels.voice_ready.utils import validate_voice_license_scope
+from rasa.core.channels.voice_ready.utils import (
+    CallParameters,
+    validate_voice_license_scope,
+)
 from rasa.core.channels.voice_stream.asr.asr_engine import ASREngine
 from rasa.core.channels.voice_stream.asr.asr_event import (
     ASREvent,
     NewTranscript,
     UserIsSpeaking,
 )
-from sanic import Websocket  # type: ignore
-
-from rasa.core.channels.voice_stream.asr.deepgram import DeepgramASR
 from rasa.core.channels.voice_stream.asr.azure import AzureASR
+from rasa.core.channels.voice_stream.asr.deepgram import DeepgramASR
 from rasa.core.channels.voice_stream.audio_bytes import HERTZ, RasaAudioBytes
 from rasa.core.channels.voice_stream.call_state import (
     CallState,
@@ -34,9 +27,16 @@ from rasa.core.channels.voice_stream.call_state import (
     call_state,
 )
 from rasa.core.channels.voice_stream.tts.azure import AzureTTS
-from rasa.core.channels.voice_stream.tts.tts_engine import TTSEngine, TTSError
 from rasa.core.channels.voice_stream.tts.cartesia import CartesiaTTS
 from rasa.core.channels.voice_stream.tts.tts_cache import TTSCache
+from rasa.core.channels.voice_stream.tts.tts_engine import TTSEngine, TTSError
+from rasa.core.channels.voice_stream.util import generate_silence
+from rasa.shared.core.constants import SLOT_SILENCE_TIMEOUT
+from rasa.shared.utils.cli import print_error_and_exit
+from rasa.shared.utils.common import (
+    class_from_module_path,
+    mark_as_beta_feature,
+)
 from rasa.utils.io import remove_emojis
 
 logger = structlog.get_logger(__name__)

rasa/core/channels/webexteams.py

@@ -1,13 +1,12 @@
 import logging
+from typing import Any, Awaitable, Callable, Dict, Optional, Text
+
 from sanic import Blueprint, response
 from sanic.request import Request
-from typing import Text, Optional, Dict, Any, Callable, Awaitable
-
 from sanic.response import HTTPResponse
 from webexteamssdk import WebexTeamsAPI, Webhook
 
-from rasa.core.channels.channel import InputChannel
-from rasa.core.channels.channel import UserMessage, OutputChannel
+from rasa.core.channels.channel import InputChannel, OutputChannel, UserMessage
 
 logger = logging.getLogger(__name__)
 

rasa/core/evaluation/marker.py

@@ -1,13 +1,14 @@
-from rasa.shared.core.domain import Domain
-from typing import Optional, Text, List
+import logging
+from typing import List, Optional, Text
+
 from rasa.core.evaluation.marker_base import (
-    OperatorMarker,
     ConditionMarker,
-    MarkerRegistry,
     Marker,
+    MarkerRegistry,
+    OperatorMarker,
 )
-from rasa.shared.core.events import ActionExecuted, SlotSet, UserUttered, Event
-import logging
+from rasa.shared.core.domain import Domain
+from rasa.shared.core.events import ActionExecuted, Event, SlotSet, UserUttered
 
 logger = logging.getLogger(__name__)
 

rasa/core/evaluation/marker_base.py

@@ -1,42 +1,41 @@
 from __future__ import annotations
+
+import csv
+import logging
 import os
+import os.path
 from abc import ABC, abstractmethod
+from dataclasses import dataclass
+from pathlib import Path
 from typing import (
+    TYPE_CHECKING,
+    Any,
+    AsyncIterator,
     Dict,
     Iterator,
+    List,
     Optional,
     Set,
     Text,
-    List,
     Tuple,
     Type,
     TypeVar,
-    TYPE_CHECKING,
     Union,
-    Any,
-    AsyncIterator,
 )
 
-from pathlib import Path
-from dataclasses import dataclass
-
 import rasa.shared.core.constants
 import rasa.shared.nlu.constants
-import rasa.shared.utils.io
 import rasa.shared.utils.common
-from rasa.shared.data import is_likely_yaml_file
-from rasa.shared.exceptions import InvalidConfigException, RasaException
-from rasa.shared.core.events import ActionExecuted, UserUttered, Event
+import rasa.shared.utils.io
 from rasa import telemetry
+from rasa.shared.constants import DOCS_URL_MARKERS
 from rasa.shared.core.domain import Domain
+from rasa.shared.core.events import ActionExecuted, Event, UserUttered
 from rasa.shared.core.trackers import DialogueStateTracker
+from rasa.shared.data import is_likely_yaml_file
+from rasa.shared.exceptions import InvalidConfigException, RasaException
 from rasa.shared.utils.yaml import read_yaml_file
 from rasa.utils.io import WriteRow
-from rasa.shared.constants import DOCS_URL_MARKERS
-
-import logging
-import csv
-import os.path
 
 if TYPE_CHECKING:
     from rasa.core.evaluation.marker import OrMarker

rasa/core/evaluation/marker_stats.py

@@ -1,14 +1,13 @@
 from __future__ import annotations
-from typing import Dict, Text, Union, List, Tuple
 
-from rasa.utils.io import WriteRow
-from pathlib import Path
 import csv
+from pathlib import Path
+from typing import Dict, List, Text, Tuple, Union
 
 import numpy as np
 
-
 from rasa.core.evaluation.marker_base import EventMetaData
+from rasa.utils.io import WriteRow
 
 
 def compute_statistics(

rasa/core/evaluation/marker_tracker_loader.py

@@ -1,9 +1,10 @@
 import random
-from rasa.shared.exceptions import RasaException
-from rasa.shared.core.trackers import DialogueStateTracker
-from typing import Any, Iterable, List, Text, Optional, AsyncIterator
-from rasa.core.tracker_store import TrackerStore
+from typing import Any, AsyncIterator, Iterable, List, Optional, Text
+
 import rasa.shared.utils.io
+from rasa.core.tracker_store import TrackerStore
+from rasa.shared.core.trackers import DialogueStateTracker
+from rasa.shared.exceptions import RasaException
 
 STRATEGY_ALL = "all"
 STRATEGY_FIRST_N = "first_n"

rasa/core/exporter.py

@@ -1,7 +1,7 @@
+import datetime
 import logging
 import uuid
-import datetime
-from typing import AsyncIterator, Text, Optional, List, Set, Dict, Any
+from typing import Any, AsyncIterator, Dict, List, Optional, Set, Text
 
 from tqdm import tqdm
 
@@ -11,12 +11,12 @@ from rasa.core.brokers.broker import EventBroker
 from rasa.core.brokers.pika import PikaEventBroker
 from rasa.core.constants import RASA_EXPORT_PROCESS_ID_HEADER_NAME
 from rasa.core.tracker_store import TrackerStore
-from rasa.shared.core.trackers import EventVerbosity
 from rasa.exceptions import (
-    NoEventsToMigrateError,
     NoConversationsInTrackerStoreError,
+    NoEventsToMigrateError,
     PublishingError,
 )
+from rasa.shared.core.trackers import EventVerbosity
 
 logger = logging.getLogger(__name__)
 

rasa/core/featurizers/precomputation.py

@@ -1,20 +1,20 @@
 from __future__ import annotations
-from typing import Optional, Text, Dict, List, Union, Iterable, Any
-from collections.abc import ValuesView, KeysView
 
-from rasa.engine.graph import GraphComponent
-from rasa.engine.storage.storage import ModelStorage
+from collections.abc import KeysView, ValuesView
+from typing import Any, Dict, Iterable, List, Optional, Text, Union
+
+import rasa.shared.utils.io
+from rasa.engine.graph import ExecutionContext, GraphComponent
 from rasa.engine.storage.resource import Resource
-from rasa.engine.graph import ExecutionContext
+from rasa.engine.storage.storage import ModelStorage
 from rasa.shared.core.domain import Domain, SubState
-from rasa.shared.core.events import ActionExecuted, UserUttered, Event
+from rasa.shared.core.events import ActionExecuted, Event, UserUttered
 from rasa.shared.core.trackers import DialogueStateTracker
 from rasa.shared.core.training_data.structures import StoryGraph
 from rasa.shared.nlu.constants import ACTION_NAME, ACTION_TEXT, INTENT, TEXT
+from rasa.shared.nlu.training_data.features import Features
 from rasa.shared.nlu.training_data.message import Message
 from rasa.shared.nlu.training_data.training_data import TrainingData
-from rasa.shared.nlu.training_data.features import Features
-import rasa.shared.utils.io
 
 # TODO: make precomputations (MessageContainerForCoreFeaturization) cacheable
 

rasa/core/featurizers/single_state_featurizer.py

@@ -1,5 +1,5 @@
 import logging
-from typing import List, Optional, Dict, Text, Set, Any
+from typing import Any, Dict, List, Optional, Set, Text
 
 import numpy as np
 import scipy.sparse
@@ -8,18 +8,18 @@ from rasa.core.featurizers.precomputation import MessageContainerForCoreFeaturiz
 from rasa.nlu.extractors.extractor import EntityTagSpec
 from rasa.nlu.utils import bilou_utils
 from rasa.nlu.utils.bilou_utils import BILOU_PREFIXES
-from rasa.shared.core.domain import SubState, State, Domain
-from rasa.shared.core.constants import PREVIOUS_ACTION, ACTIVE_LOOP, USER, SLOTS
+from rasa.shared.core.constants import ACTIVE_LOOP, PREVIOUS_ACTION, SLOTS, USER
+from rasa.shared.core.domain import Domain, State, SubState
 from rasa.shared.core.trackers import is_prev_action_listen_in_state
 from rasa.shared.nlu.constants import (
+    ACTION_NAME,
+    ACTION_TEXT,
     ENTITIES,
+    ENTITY_ATTRIBUTE_TYPE,
+    ENTITY_TAGS,
     FEATURE_TYPE_SENTENCE,
-    ACTION_TEXT,
-    ACTION_NAME,
     INTENT,
     NO_ENTITY_TAG,
-    ENTITY_ATTRIBUTE_TYPE,
-    ENTITY_TAGS,
     TEXT,
 )
 from rasa.shared.nlu.training_data.features import Features

rasa/core/featurizers/tracker_featurizers.py

@@ -5,20 +5,20 @@ from abc import abstractmethod
 from collections import defaultdict
 from pathlib import Path
 from typing import (
-    Tuple,
+    Any,
+    Callable,
+    ClassVar,
+    DefaultDict,
+    Dict,
+    Iterator,
     List,
     Optional,
-    Dict,
+    Set,
     Text,
+    Tuple,
+    Type,
     Union,
-    Any,
-    Iterator,
-    Set,
-    DefaultDict,
     cast,
-    Type,
-    Callable,
-    ClassVar,
 )
 
 import numpy as np
@@ -30,15 +30,15 @@ from rasa.core.exceptions import InvalidTrackerFeaturizerUsageError
 from rasa.core.featurizers.precomputation import MessageContainerForCoreFeaturization
 from rasa.core.featurizers.single_state_featurizer import SingleStateFeaturizer
 from rasa.shared.core.constants import (
-    USER,
     ACTION_UNLIKELY_INTENT_NAME,
     PREVIOUS_ACTION,
+    USER,
 )
-from rasa.shared.core.domain import State, Domain
-from rasa.shared.core.events import Event, ActionExecuted, UserUttered
+from rasa.shared.core.domain import Domain, State
+from rasa.shared.core.events import ActionExecuted, Event, UserUttered
 from rasa.shared.core.trackers import DialogueStateTracker
 from rasa.shared.exceptions import RasaException
-from rasa.shared.nlu.constants import TEXT, INTENT, ENTITIES, ACTION_NAME
+from rasa.shared.nlu.constants import ACTION_NAME, ENTITIES, INTENT, TEXT
 from rasa.shared.nlu.training_data.features import Features
 from rasa.utils.tensorflow.constants import LABEL_PAD_ID
 from rasa.utils.tensorflow.model_data import ragged_array_to_ndarray

rasa/core/http_interpreter.py

@@ -1,10 +1,9 @@
-import aiohttp
-
 import copy
 import logging
-import structlog
+from typing import Any, Dict, Optional, Text
 
-from typing import Text, Dict, Any, Optional
+import aiohttp
+import structlog
 
 from rasa.core import constants
 from rasa.core.channels import UserMessage

rasa/core/information_retrieval/__init__.py

@@ -1,7 +1,7 @@
 from rasa.core.information_retrieval.information_retrieval import (  # noqa: F401
     InformationRetrieval,
+    InformationRetrievalException,
     SearchResult,
     SearchResultList,
-    InformationRetrievalException,
     create_from_endpoint_config,
 )

rasa/core/information_retrieval/faiss.py

@@ -1,18 +1,18 @@
 from pathlib import Path
-from typing import TYPE_CHECKING, List, Optional, Text, Any, Dict
+from typing import TYPE_CHECKING, Any, Dict, List, Optional, Text
 
 import structlog
 from langchain.text_splitter import RecursiveCharacterTextSplitter
-from langchain_community.document_loaders.text import TextLoader
 from langchain_community.document_loaders.directory import DirectoryLoader
+from langchain_community.document_loaders.text import TextLoader
 from langchain_community.vectorstores.faiss import FAISS
-from rasa.utils.endpoints import EndpointConfig
 
 from rasa.core.information_retrieval import (
-    SearchResultList,
     InformationRetrieval,
     InformationRetrievalException,
+    SearchResultList,
 )
+from rasa.utils.endpoints import EndpointConfig
 from rasa.utils.ml_utils import persist_faiss_vector_store
 
 if TYPE_CHECKING:

rasa/core/information_retrieval/information_retrieval.py

@@ -1,13 +1,13 @@
 from __future__ import annotations
 
+import importlib
 from dataclasses import dataclass
-from typing import TYPE_CHECKING, List, Text, Any, Optional
+from typing import TYPE_CHECKING, Any, List, Optional, Text
 
 import structlog
 
 from rasa.shared.exceptions import RasaException
 from rasa.utils.endpoints import EndpointConfig
-import importlib
 
 if TYPE_CHECKING:
     from langchain.schema import Document

rasa/core/information_retrieval/milvus.py

@@ -1,14 +1,14 @@
-from typing import Text, Any, Dict
+from typing import Any, Dict, Text
 
 import structlog
 from langchain_community.vectorstores.milvus import Milvus
-from rasa.utils.endpoints import EndpointConfig
 
 from rasa.core.information_retrieval import (
-    SearchResultList,
     InformationRetrieval,
     InformationRetrievalException,
+    SearchResultList,
 )
+from rasa.utils.endpoints import EndpointConfig
 
 logger = structlog.get_logger()
 

rasa/core/information_retrieval/qdrant.py

@@ -1,16 +1,16 @@
-from typing import Text, Any, Dict
+from typing import Any, Dict, Text
 
 import structlog
 from langchain_community.vectorstores.qdrant import Qdrant
 from pydantic import ValidationError
 from qdrant_client import QdrantClient
-from rasa.utils.endpoints import EndpointConfig
 
 from rasa.core.information_retrieval import (
-    SearchResultList,
     InformationRetrieval,
     InformationRetrievalException,
+    SearchResultList,
 )
+from rasa.utils.endpoints import EndpointConfig
 
 logger = structlog.get_logger()
 

rasa/core/jobs.py

@@ -3,6 +3,7 @@ import logging
 
 from apscheduler.schedulers.asyncio import AsyncIOScheduler
 from pytz import UnknownTimeZoneError, utc
+
 import rasa.shared.utils.io
 
 __scheduler = None

rasa/core/lock.py

@@ -1,9 +1,8 @@
 import json
 import logging
-from collections import deque
-
 import time
-from typing import Text, Optional, Union, Deque, Dict, Any
+from collections import deque
+from typing import Any, Deque, Dict, Optional, Text, Union
 
 logger = logging.getLogger(__name__)
 

rasa/core/lock_store.py

@@ -1,16 +1,16 @@
 from __future__ import annotations
+
 import asyncio
-from contextlib import asynccontextmanager
 import json
 import logging
 import os
-
+from contextlib import asynccontextmanager
 from typing import AsyncGenerator, Dict, Optional, Text, Union
 
-from rasa.shared.exceptions import RasaException, ConnectionException
 import rasa.shared.utils.common
 from rasa.core.constants import DEFAULT_LOCK_LIFETIME
 from rasa.core.lock import TicketLock
+from rasa.shared.exceptions import ConnectionException, RasaException
 from rasa.utils.endpoints import EndpointConfig
 
 logger = logging.getLogger(__name__)

rasa/core/migrate.py

@@ -1,28 +1,31 @@
 import copy
 import shutil
 from pathlib import Path
-from typing import List, Dict, Text, Any, Tuple, Optional, Union
+from typing import Any, Dict, List, Optional, Text, Tuple, Union
 
 from ruamel.yaml.scalarstring import DoubleQuotedScalarString
 
-import rasa.shared.utils.io
 import rasa.shared.utils.cli
-from rasa.shared.constants import REQUIRED_SLOTS_KEY, IGNORED_INTENTS
+import rasa.shared.utils.io
+from rasa.shared.constants import (
+    IGNORED_INTENTS,
+    LATEST_TRAINING_DATA_FORMAT_VERSION,
+    REQUIRED_SLOTS_KEY,
+)
 from rasa.shared.core.constants import (
     ACTIVE_LOOP,
-    REQUESTED_SLOT,
-    SlotMappingType,
     MAPPING_TYPE,
+    REQUESTED_SLOT,
     SLOT_MAPPINGS,
+    SlotMappingType,
 )
-from rasa.shared.constants import LATEST_TRAINING_DATA_FORMAT_VERSION
-from rasa.shared.core.domain import KEY_ENTITIES, KEY_SLOTS, KEY_FORMS, Domain
+from rasa.shared.core.domain import KEY_ENTITIES, KEY_FORMS, KEY_SLOTS, Domain
 from rasa.shared.exceptions import RasaException
 from rasa.shared.utils.yaml import (
     KEY_TRAINING_DATA_FORMAT_VERSION,
     read_yaml,
-    write_yaml,
     read_yaml_file,
+    write_yaml,
 )
 
 ORIGINAL_DOMAIN = "original_domain"  # not a default, fixed

rasa/core/nlg/__init__.py

@@ -1,3 +1,3 @@
+from rasa.core.nlg.callback import CallbackNaturalLanguageGenerator  # noqa: F401
 from rasa.core.nlg.generator import NaturalLanguageGenerator  # noqa: F401
 from rasa.core.nlg.response import TemplatedNaturalLanguageGenerator  # noqa: F401
-from rasa.core.nlg.callback import CallbackNaturalLanguageGenerator  # noqa: F401

rasa/core/nlg/callback.py

@@ -1,6 +1,6 @@
 import json
 import logging
-from typing import List, Text, Any, Dict, Optional
+from typing import Any, Dict, List, Optional, Text
 
 from rasa.core.constants import DEFAULT_REQUEST_TIMEOUT
 from rasa.core.nlg.generator import NaturalLanguageGenerator, ResponseVariationFilter
@@ -100,8 +100,7 @@ class CallbackNaturalLanguageGenerator(NaturalLanguageGenerator):
     @staticmethod
     def validate_response(content: Optional[Dict[Text, Any]]) -> bool:
         """Validate the NLG response. Raises exception on failure."""
-        from jsonschema import validate
-        from jsonschema import ValidationError
+        from jsonschema import ValidationError, validate
 
         try:
             if content is None or content == "":

rasa/core/nlg/contextual_response_rephraser.py

@@ -2,22 +2,31 @@ from typing import Any, Dict, Optional, Text
 
 import structlog
 from jinja2 import Template
+
 from rasa import telemetry
 from rasa.core.nlg.response import TemplatedNaturalLanguageGenerator
 from rasa.core.nlg.summarize import summarize_conversation
 from rasa.shared.constants import (
     LLM_CONFIG_KEY,
     MODEL_CONFIG_KEY,
+    MODEL_GROUP_ID_CONFIG_KEY,
     MODEL_NAME_CONFIG_KEY,
+    OPENAI_PROVIDER,
     PROMPT_CONFIG_KEY,
     PROVIDER_CONFIG_KEY,
-    OPENAI_PROVIDER,
     TIMEOUT_CONFIG_KEY,
-    MODEL_GROUP_ID_CONFIG_KEY,
 )
 from rasa.shared.core.domain import KEY_RESPONSES_TEXT, Domain
 from rasa.shared.core.events import BotUttered, UserUttered
 from rasa.shared.core.trackers import DialogueStateTracker
+from rasa.shared.nlu.constants import (
+    KEY_COMPONENT_NAME,
+    KEY_LLM_RESPONSE_METADATA,
+    KEY_PROMPT_NAME,
+    KEY_USER_PROMPT,
+    PROMPTS,
+)
+from rasa.shared.providers.llm.llm_response import LLMResponse
 from rasa.shared.utils.health_check.llm_health_check_mixin import LLMHealthCheckMixin
 from rasa.shared.utils.llm import (
     DEFAULT_OPENAI_GENERATE_MODEL_NAME,
@@ -27,8 +36,6 @@ from rasa.shared.utils.llm import (
     get_prompt_template,
     llm_factory,
     resolve_model_client_config,
-)
-from rasa.shared.utils.llm import (
     tracker_as_readable_transcript,
 )
 from rasa.utils.endpoints import EndpointConfig
@@ -124,6 +131,39 @@ class ContextualResponseRephraser(
             ContextualResponseRephraser.__name__,
         )
 
+    @classmethod
+    def _add_prompt_and_llm_metadata_to_response(
+        cls,
+        response: Dict[str, Any],
+        prompt_name: str,
+        user_prompt: str,
+        llm_response: Optional["LLMResponse"] = None,
+    ) -> Dict[str, Any]:
+        """Stores the prompt and LLMResponse metadata to response.
+
+        Args:
+            response: The response to add the prompt and LLMResponse metadata to.
+            prompt_name: A name identifying prompt usage.
+            user_prompt: The user prompt that was sent to the LLM.
+            llm_response: The response object from the LLM (None if no response).
+        """
+        from rasa.dialogue_understanding.utils import record_commands_and_prompts
+
+        if not record_commands_and_prompts:
+            return response
+
+        prompt_data: Dict[Text, Any] = {
+            KEY_COMPONENT_NAME: cls.__name__,
+            KEY_PROMPT_NAME: prompt_name,
+            KEY_USER_PROMPT: user_prompt,
+            KEY_LLM_RESPONSE_METADATA: llm_response.to_dict() if llm_response else None,
+        }
+
+        prompts = response.get(PROMPTS, [])
+        prompts.append(prompt_data)
+        response[PROMPTS] = prompts
+        return response
+
     def _last_message_if_human(self, tracker: DialogueStateTracker) -> Optional[str]:
         """Returns the latest message from the tracker.
 
@@ -142,20 +182,20 @@ class ContextualResponseRephraser(
                 return None
         return None
 
-    async def _generate_llm_response(self, prompt: str) -> Optional[str]:
-        """Use LLM to generate a response.
+    async def _generate_llm_response(self, prompt: str) -> Optional[LLMResponse]:
+        """Use LLM to generate a response, returning an LLMResponse object
+        containing both the generated text (choices) and metadata.
 
         Args:
-            prompt: the prompt to send to the LLM
+            prompt: The prompt to send to the LLM.
 
         Returns:
-            generated text
+            An LLMResponse object if successful, otherwise None.
         """
         llm = llm_factory(self.llm_config, DEFAULT_LLM_CONFIG)
 
         try:
-            llm_response = await llm.acompletion(prompt)
-            return llm_response.choices[0]
+            return await llm.acompletion(prompt)
         except Exception as e:
             # unfortunately, langchain does not wrap LLM exceptions which means
             # we have to catch all exceptions here
@@ -255,11 +295,21 @@ class ContextualResponseRephraser(
             or self.llm_property(MODEL_NAME_CONFIG_KEY),
             llm_model_group_id=self.llm_property(MODEL_GROUP_ID_CONFIG_KEY),
         )
-        if not (updated_text := await self._generate_llm_response(prompt)):
-            # If the LLM fails to generate a response, we
-            # return the original response.
+        llm_response = await self._generate_llm_response(prompt)
+        llm_response = LLMResponse.ensure_llm_response(llm_response)
+
+        response = self._add_prompt_and_llm_metadata_to_response(
+            response=response,
+            prompt_name="rephrase_prompt",
+            user_prompt=prompt,
+            llm_response=llm_response,
+        )
+
+        if not (llm_response and llm_response.choices and llm_response.choices[0]):
+            # If the LLM fails to generate a response, return the original response.
             return response
 
+        updated_text = llm_response.choices[0]
         structlogger.debug(
             "nlg.rewrite.complete",
             response_text=response_text,