[Bug]: Question handler API call does not work as documented about quivr HOT 1 OPEN

Hey @devorem! Great to see you back around here 😊 Let's dive into what's been bugging you.

Based on the error message you're receiving, it seems that the brain_id field is indeed required for the Question handler API call. This field is used to identify the specific "brain" (or knowledge base) that the question should be routed to for processing.

The brain_id should be added in the request as part of the JSON payload. For example, if there's an endpoint that expects a request body, you would include 'brain_id' like so:

{
  "model": "some_model",
  "brain_id": "specific_brain_id",
  "chat_id": "some_chat_id",
  ...
}

The exact structure of the API request that the APIBrainQA class expects is defined within the get_api_call_response_as_text method. This method outlines how the API request is constructed and sent, including the method type (GET, DELETE, POST, PUT, PATCH), the API URL, parameters, search parameters, and headers (which may include secrets).

Here is the relevant code snippet:

def get_api_call_response_as_text(
    self, method, api_url, params, search_params, secrets
) -> str:
    headers = {}

    api_url_with_search_params = api_url
    if search_params:
        api_url_with_search_params += "?"
        for search_param in search_params:
            api_url_with_search_params += (
                f"{search_param}={search_params[search_param]}&"
            )

    for secret in secrets:
        headers[secret] = secrets[secret]

    try:
        if method in ["GET", "DELETE"]:
            response = requests.request(
                method,
                url=api_url_with_search_params,
                params=params or None,
                headers=headers or None,
            )
        elif method in ["POST", "PUT", "PATCH"]:
            response = requests.request(
                method,
                url=api_url_with_search_params,
                json=params or None,
                headers=headers or None,
            )
        else:
            raise ValueError(f"Invalid method: {method}")
    return response.text

This method is where the API request structure is defined and handled within the APIBrainQA class. You can find this in the backend/modules/brain/api_brain_qa.py file.

I hope this helps! If you have any other questions, feel free to ask.

Sources

• backend/modules/brain/api_brain_qa.py

from quivr.