Skip to content

Output Parsing

Output parser

llama_cpp_agent.output_parser

is_empty_or_whitespace(s)

Checks if a string is empty or contains only whitespace.

Parameters:

  • s (str) –

    The input string.

Returns:

  • bool –

    True if the string is empty or contains only whitespace, False otherwise.

Source code in llama_cpp_agent/output_parser.py 
35
36
37
38
39
40
41
42
43
44
45
def is_empty_or_whitespace(s):
    """
    Checks if a string is empty or contains only whitespace.

    Args:
        s (str): The input string.

    Returns:
        bool: True if the string is empty or contains only whitespace, False otherwise.
    """
    return not s.strip()

parse_json_response(response)

Parses a JSON response string.

Parameters:

  • response (str) –

    The JSON response string.

Returns:

  • dict –

    The parsed JSON object.

Source code in llama_cpp_agent/output_parser.py 
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
def parse_json_response(response: str):
    """
    Parses a JSON response string.

    Args:
        response (str): The JSON response string.

    Returns:
        dict: The parsed JSON object.
    """

    response_lines = response.split("\n")
    while is_empty_or_whitespace(response_lines[0]):
        response_lines.pop(0)
    response = "\n".join(response_lines)
    json_object = sanitize_and_load_json(response.strip())
    return json_object

parse_json_response_with_markdown_code_block_or_triple_quoted_string(json_response, marker)

Parses a JSON response string followed by a Markdown code block or triple-quoted string.

Parameters:

  • json_response (str) –

    The JSON response string followed by a Markdown code block or triple-quoted string.

  • marker (str) –

    Triple quotes (''') or triple back ticks (```)

Returns:

  • –

    Tuple[dict, str]: The parsed JSON object and the content of the Markdown code block or triple-quoted string.

Source code in llama_cpp_agent/output_parser.py 
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
def parse_json_response_with_markdown_code_block_or_triple_quoted_string(
        json_response, marker
):
    """
    Parses a JSON response string followed by a Markdown code block or triple-quoted string.

    Args:
        json_response (str): The JSON response string followed by a Markdown code block or triple-quoted string.
        marker(str): Triple quotes (''') or triple back ticks (```)

    Returns:
        Tuple[dict, str]: The parsed JSON object and the content of the Markdown code block or triple-quoted string.
    """
    response_lines = json_response.split("\n")

    if is_empty_or_whitespace(response_lines[0]):
        response_lines.pop(0)

    # Get the first line JSON object
    response = response_lines[0]
    # Remove the first line
    response_lines.pop(0)
    count = len(response_lines)
    for _ in range(count):
        if response_lines[0].startswith(marker):
            break
        else:
            line = response_lines.pop(0)
            response += "\n" + line

    if len(response_lines) == 0:
        return None, None
    # Remove the first line Markdown code block marker
    response_lines.pop(0)
    # Remove the last line Markdown code block marker
    response_lines.pop(-1)
    response_lines.pop(-1)
    # Combine lines into a single string
    markdown_code_block_content = "\n".join(response_lines)
    json_object = parse_json_response(response)

    return json_object, markdown_code_block_content

extract_object_from_response(response, object_clas)

Extracts an object of the specified class from a JSON response string.

Parameters:

  • response (str) –

    The JSON response string.

  • object_clas (type) –

    The class of the object to be extracted.

Returns:

  • object_clas –

    An instance of the specified class.

Source code in llama_cpp_agent/output_parser.py 
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
def extract_object_from_response(response: str, object_clas: type):
    """
    Extracts an object of the specified class from a JSON response string.

    Args:
        response (str): The JSON response string.
        object_clas (type): The class of the object to be extracted.

    Returns:
        object_clas: An instance of the specified class.
    """
    obj = parse_json_response(response)
    cls = object_clas
    obj = cls(**obj)
    return obj