Skip to content

Better error handling for SDK #144

@anupam-tiwari

Description

@anupam-tiwari

Expected Behavior

SDK fails to display detailed error message when using client.tasks.create() for uploading videos to index

Actual Behavior

Like the API call, it should return message why the upload failed or have some more information in the response body

Steps to Reproduce

  1. Upload a low resolution or unsupported video to index using local file: video_file parameter in sdk
  2. Upload a low resolution or unsupported video to index using API with files parameter
  3. API reponse which is better:
Image
  1. SDK response which gives no information on that went wrong:
Image

Detailed Description

I noticed this during twelvelabs AI hackathon hosted in NYC during media week, I spent 2 hrs just debugging why my video is not getting pushed to index, with the help of twelvelabs team (james, jin and other folks) we found out the actual cause by using API, since better error display makes API better than SDK. I would like to propose this change to make SDK response messages more useful

Possible Solution

Display better errors when using SDK

steps to reproduce:
main.ipynb

Metadata

Metadata

Assignees

No one assigned

    Labels

    bugSomething isn't working

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions