Conversation Bot (WIP)

Generate Conversation(Async)

• Check the diagnostic test to see why this api is also asynchronous

• You can use this API to generate the mcq format exercises

Path: /api/v1/conversations/

Method: POST

Type Definition

• grade: Grade of student

• level: The level for which the conversation needs to be generated

• generation:

  • 1: The child is first time learning English

  • 2: Parents are proficient in English

• demography: demography of student(urban, semi-urban, rural…)

• query: WIth query, you can pass the user's query in the format mentioned in the request data.

• history: In the history parameter, you can pass the chat history of the conversation.

Request Data

{
    "grade": <number>,
    "level": <number>,
    "demography": <string>,
    "generation": <1 | 2>,
    "history": [{"role": <"user">, "message": <string>}, {"role": <"AI">, "message": <string>}]
    "query": [{"role": <"user" | "AI">, "message": <string>}]
}

Response Data

{
    "id": <conversation_id:UUID>,
    "conversation_status_url": "/api/v1/conversations/<conversation_id>/status/",
    "status": “pending” | “in_progress” | “completed” | “failed”,
    "error": <string> | <None>,
    "data": <None>
}

Examples

Request Data

{
  "grade": 2,
  “level”: 3,
  "generation": 1,
  “demography”: "urban",
  "history": [{"role": "user", "message": "Hi Good Morning"}, {"role": "user", "message": "How're you?"}],
  "query": [{"role": "user", "message": "Hi Good Morning"}]
}

Response Data

{
    "id": "1",
    "conversation_status_url": "/api/v1/conversations/<conversation_id>/status/",
    "status": “in_progress”,
    "error": <None>,
    "data": <None>
}

Check the status of the conversation creation

• Use this api to poll/check the status of conversation creation

Path: /api/v1/conversations/<conversation_id>/status/

Method: GET

Request Data

{}

Response Data

{
    "id": <conversation_id:UUID>,
    "conversation_status_url": /api/v1/conversations/<conversation_id>/status/,
    "status": “completed”,
    "error": <None>,
    "data": [
        {
            "role": "user",
            "message": <string>,
            "audio_url": <audio_url>
        },
        {
            "role": "AI",
            "message": <string>,
            "audio_url": <audio_url>
        },
        {
            "role": "user",
            "message": <string>,
            "audio_url": <audio_url>
        },
        {
            "role": "AI",
            "message": <string>,
            "audio_url": <audio_url>
        },
    ]
}

Examples

Request Data

{}

Response Data

{
    "id": <conversation_id:"1">,
    "conversation_status_url": /api/v1/conversations/<conversation_id>/status/,
    "status": “completed”,
    "error": <None>,
    "data": [
        {
            "role": "user",
            "message": "Hello, tell me a song about alphabets",
            "audio_url": <audio_url>
        },
        {
            "role": "AI",
            "message": "A for apple, B for book... ",
            "audio_url": <audio_url>
        },
    ]
}