Release notes

Streamlined response structure for the Embed API

• Embed API: The structure of the responses has been streamlined across all endpoints to provide a more consistent and intuitive experience:
  • Standardized object naming:
    • The video_embeddings field has been renamed to video_embedding.
    • The video_embedding object now encapsulates the embeddings, related metadata, and additional information.
  • Enhanced response structure:
    • The embedding vectors are now nested under an array named segments.
    • The metadata objects have been moved under their respective parent embedding objects.
    • The is_success boolean has been removed.
  • Affected endpoints:
    • All video embedding endpoints the endpoint for creating video embedding tasks.
    • Create embeddings for text, image, and audio.
    • Retrieve video information.
• Embed API: You can now retrieve vector embeddings for any indexed video by setting embed=true in your GET /indexes/{index-id}/videos/{video-id} requests.