Read Streaming Response

This page will help you read data from endpoints that return streaming responses.

To handle streaming responses, you can use the following code snippets. The endpoint returns a data stream consisting of events, which can include both partial responses to the user's input and/or unsolicited messages from the server. The streamed data contains different types of events. Each event carries its own specific type identifier. The client must inspect each event to determine its type and process it accordingly.

📘

The code snippet bellow can be used to read the streaming response with the Chat With Resource With Streaming endpoint too!

JavaScript

const response = await fetch('https://api.droxy.ai/v1/chatbot/chat-stream', {
    method: 'POST',
    headers: {
      accept: 'application/json',
      'content-type': 'application/json',
      'x-api-key': '<API_KEY>'
    },
    body: JSON.stringify({
      chatbotId: '<CHATBOT_ID>',
      conversation: [{fromUser: true, text: 'Hello!'}]
    })
  });

  // Throw an error if the response status isn't successful.
  if (!response.ok) {
    const error = await response.json();
    throw Error(error.message);
  }

  // Ensure there is a response body to read from.
  if (!response.body) {
    throw Error('No response body');
  }

  const reader = response.body.getReader();
  const decoder = new TextDecoder();

  try {
    while (true) {
      const { value, done } = await reader.read();
      if (done) break; // Stop reading if the stream is finished.

      // Decode the stream's chunks to an array of strings. Due to buffering, more than one chunk may be available at a time.
      const chunkValues = decoder.decode(value, { stream: true }).split('\n').filter(Boolean);

      for(const chunkValue of chunkValues){
        // Parse the event chunk into JSON.
        const json = JSON.parse(chunkValue);

        // Process the event based on its type.
        switch (json.type) {
          case 'partialResponse':
            // Handle the partial response here.
            console.log('Partial response:', json);
            break;
            
          case 'streamEnd':
            // Handle the end of the stream here.
            console.log('Stream ended:', json);
            break;

          case 'error':
            // Handle any errors while streaming here.
            throw new Error(json.message);
        }
      }
    }
  } catch (error) {
    console.error(`Stream reading failed: ${error}`);
  }

Python

import requests
import json

response = requests.post(
    'https://api.droxy.ai/v1/chatbot/chat-stream',
    headers={
        'accept': 'application/json',
        'content-type': 'application/json',
        'x-api-key': '<API_KEY>'
    },
    data=json.dumps({
        'chatbotId': '<CHATBOT_ID>',
        'conversation': [{'fromUser': True, 'text': 'Hello!'}]
    }),
    stream=True
)

# Raise an error if the response status isn't successful.
if response.status_code != 201:
    error = response.json()
    raise Exception(error.get('message', 'Request failed'))
else:
    try:
        # Process each chunk event in the response stream. Due to buffering, more than one chunk may be available at a time.
        for chunk in response.iter_lines():
            if chunk:
                # Decode the line
                decoded_event = chunk.decode('utf-8')

                # Load the line as JSON and process the message
                event = json.loads(decoded_event)

                # Get the event type
                event_type = event.get("type")

                # Handle the partial response here.
                if event_type == 'partialResponse':
                    print('Partial response:', event)

                # Handle the end of the stream here.
                elif event_type == 'streamEnd':
                    print('Stream ended:', event)
                    break
                
                # Handle any errors while streaming here.
                elif event_type == 'error':
                    raise Exception(f"Error from stream: {event.get('message')}")

    except Exception as e:
        print(f'Error processing stream: {e}')