Skip to content

API_DOC.md

Latest commit

 

History

History
58 lines (44 loc) · 2.47 KB

API_DOC.md

File metadata and controls

58 lines (44 loc) · 2.47 KB

API Documentation

Overview

This document provides details about the API endpoints available in the sunbird-va-api project. The API is designed to facilitate interactions with an AI assistant, including translation and document search functionalities.

Endpoints

1. answer (GET)

Handles chat sessions between a user and the AI assistant.

  • URL: /api/chat/

  • Method: GET

  • Query Parameters:

    • session_id: The unique identifier for the chat session.
    • query: The user's query to the AI assistant.
    • source_lang: The source language of the query. Defaults to mr. (Will depend on the transcribe endpoint's response)
    • target_lang: The target language of the query. Defaults to mr. (Can use other languages as well for testing)

  • Response:

    • A StreamingHttpResponse that streams translated messages from the AI assistant.

  • Description:

    • This endpoint initiates a chat session with the AI assistant. It uses the agrinet_agent to process the query and streams the response back to the user. The response is translated to the target language using the BhashiniTranslator.

2. suggestions (GET)

Handles suggestions for questions for the farmer to ask.

  • URL: /api/suggestions/

  • Method: GET

  • Query Parameters:

    • session_id: The unique identifier for the chat session.
    • target_lang: The target language of the query. Defaults to mr. (Can use other languages as well for testing)

  • Response:

    • A Response object that contains the suggestions for questions for the farmer to ask.

    • Each suggestion is a dictionary with the following keys:

      • question: The question for the farmer to ask.
      • context: The context of the question.

      NOTE:

      • Look at open-webui's Suggestions UI for reference.
      • When clicked, the question and context should be combined using '{question} {context}' format.

3. transcribe (POST)

Handles transcription of audio to text.

  • URL: /api/transcribe/

  • Method: POST

  • Query Parameters:

    • audio_content: The base64 encoded audio content.
    • service_type: The service type to use for transcription. Defaults to bhashini. Options: bhashini, whisper

  • Response:

    • A json object with the following keys:
      • status: The status of the transcription. (success or error)
      • text: The transcription of the audio.
      • lang_code: The language code of the transcription. --> Use this for source_lang in chat endpoint.