generative_ai.utils_top_level module

Define functionalities for type annotations for top level modules.

class Response(*, query: str, answer: str, source_documents: list[str], used_prompt: str, llm_duration: float)

Bases: BaseModel

Response from large language model with additional captured details.

query

query from user

Type:

str

answer

response from large language model

Type:

str

source_documents

list of source documents retrieved from database

Type:

list[str]

used_prompt

exact prompt passed to large language model

Type:

str

llm_duration

time taken (in seconds) for large language model to generate response

Type:

float

query: str

answer: str

source_documents: list[str]

used_prompt: str

llm_duration: float

model_computed_fields: ClassVar[dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

model_fields: ClassVar[dict[str, FieldInfo]] = {'answer': FieldInfo(annotation=str, required=True), 'llm_duration': FieldInfo(annotation=float, required=True), 'query': FieldInfo(annotation=str, required=True), 'source_documents': FieldInfo(annotation=list[str], required=True), 'used_prompt': FieldInfo(annotation=str, required=True)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].

This replaces Model.__fields__ from Pydantic V1.