Skip to content

Types

ChatRequest

Bases: BaseModel

Represents a chat request.

Parameters:

Name Type Description Default
message str

The message from user.

 required
openai_model str

The OpenAI model to use. Defaults to "ft:gpt-3.5-turbo-1106:aitomatic-inc:gen-agent-v2:8dPNxr8r".

 required
temperature float

The temperature of the model's output. Higher values make the output more random, while lower values make it more focused and deterministic. Defaults to 1.0.

 required
certainty_threshold float

The threshold for considering a question as certain. Defaults to 0.9.

 required
uncertainty_threshold float

The threshold for considering a question as uncertain. Defaults to 0.6.

 required
Source code in docqa/types.py 
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
class ChatRequest(BaseModel):
    """
    Represents a chat request.

    Args:
        message (str): The message from user.
        openai_model (str, optional): The OpenAI model to use. Defaults to
            "ft:gpt-3.5-turbo-1106:aitomatic-inc:gen-agent-v2:8dPNxr8r".
        temperature (float, optional): The temperature of the model's output.
            Higher values make the output more random, while lower values make it
            more focused and deterministic. Defaults to 1.0.
        certainty_threshold (float, optional): The threshold for considering a
            question as certain. Defaults to 0.9.
        uncertainty_threshold (float, optional): The threshold for considering a
            question as uncertain. Defaults to 0.6.
    """

    message: str
    openai_model: str = "ft:gpt-3.5-turbo-1106:aitomatic-inc:gen-agent-v2:8dPNxr8r"
    temperature: float = 1.0
    certainty_threshold: float = 0.9
    uncertainty_threshold: float = 0.6

RetrievalReference

Bases: BaseModel

Represents a reference.

Parameters:

Name Type Description Default
source str

The source of the reference.

 required
content str

The content of the reference.

 required
Source code in docqa/types.py 
28
29
30
31
32
33
34
35
36
37
38
class RetrievalReference(BaseModel):
    """
    Represents a reference.

    Args:
        source (str): The source of the reference.
        content (str): The content of the reference.
    """

    source: str
    content: str

PipelineOutput

Bases: BaseModel

Represents the output of the pipeline.

Parameters:

Name Type Description Default
answer str

The answer to the question.

 required
references list[RetrievalReference]

A list of RetrievalReference objects containing the related references.

 required
metadata dict

Additional metadata associated with the answer.

 required
Source code in docqa/types.py 
41
42
43
44
45
46
47
48
49
50
51
52
53
54
class PipelineOutput(BaseModel):
    """
    Represents the output of the pipeline.

    Args:
        answer (str): The answer to the question.
        references (list[RetrievalReference]): A list of RetrievalReference objects
            containing the related references.
        metadata (dict): Additional metadata associated with the answer.
    """

    answer: str
    references: list[RetrievalReference]
    metadata: dict | None = None