0.3.1

New Features

• Query the available classifications on the platform
• Upload CNN classifiers to the platform for batch running on Arbimon
• Experimental package rfcxtf for testing TensorFlow models before upload to the platform

0.2.5

New features

• Added RFCX_API_URL environment variable to support alternative API environments

0.2.4

Modified functionality:

• Avoid using media API and switch to downloading single or ranges of segments/recordings
  • Renamed download_audio_files to download_segments (breaking change)
  • Renamed download_audio_file to download_segment (breaking change)
• Can use datetime or string (in ISO9 format) as arguments on any timestamp fields
• Renamed confusing only_public argument to include_public on get streams

0.2.3

Modified functionality:

• streams(): Add ability to custom retrieve fields
• projects(): Add ability to custom retrieve fields

Bug fix:

• Fix streams() to not use only_public and only_delete as default

Documentation: https://rfcx.github.io/rfcx-sdk-python/

0.2.2

New functionality:

• stream(): Get stream information

Bug fixes:

• Fix only_public and only_delete to call boolean fields on API correctly

0.2.1

New functionality:

• projects(): Get project list

Modified functionality:

• Rename authentication() to authenticate()
• Rename download_file() to download_audio_file()
• Rename download_file_segments() to download_audio_files()
• streams(): Add ability to get stream by name query

Bug fixes:

• Update stream segment to use new API endpoint
• Fix download_audio_files() not download audio properly

0.2.0

Modified functionality:

• authentication(): Update authentication flow to popup browser and get user token automatically

0.0.12

New functionality:

• Get a list of detections allow to filter by classifier id list
  Example: client.detections(start="2020-12-01T00:00:00.000Z", end="2020-12-31T23:59:59.999Z", classifications=["chainsaw", "gunshot"], classifiers=[94,95], stream=["xxxxxx", "yyyyyy"], limit=50, offset=0)

0.0.11

New functionality:

• Get a list of streams (all parameters are optional)
  Example: client.streams(organizations=None, projects=None, created_by=None, keyword=None, is_public=True, is_deleted=False, limit=1000, offset=0)

• Get audio information list from a specific stream
  Example: client.stream_segments(stream="xxxxxx", start="2020-12-01T00:00:00.000Z", end="2020-12-31T23:59:59.999Z", limit=50, offset=0 )

• Download audio on specific time range
  Example: client.download_file_segments(dest_path="./audio", stream="xxxxxx", min_date="2020-12-01T00:00:00.000Z", max_date="2020-12-31T23:59:59.999Z", gain=1, file_ext="opus", parallel=True)

• Get a list of annotations (from a given stream)
  Example: client.annotations(start="2020-12-01T00:00:00.000Z", end="2020-12-31T23:59:59.999Z", classifications=["chainsaw", "gunshot"], stream="xxxxxx", limit=50, offset=0)

• Get a list of detections
  Example: client.detections(start="2020-12-01T00:00:00.000Z", end="2020-12-31T23:59:59.999Z", classifications=["chainsaw", "gunshot"], stream=["xxxxxx", "yyyyyy"], limit=50, offset=0)

• Ingest a local audio to RFCx (to a given stream)
  Example: client.ingest_file(stream="xxxxxx", filepath="example.wav", timestamp="2021-03-05T12:00:00.000Z")

Modified functionality:

• download_file(): update parameters to have dest_path, stream_id, start_time, end_time, gain, and file_ext

Deprecated functionality:

• guardians(): Get list of guardians from a sites - use streams() instead

• guardianAudio(): Get audio information list from specific guardian - use streamSegments() instead.

• tags(): Get tags information from RFCx - use annotations() instead.

• downloadGuardianAudio(): Download audio - use downloadStreamSegments() instead.

0.0.10

Bug fix:

• Handle parallel download audio min_date and max_date to available for datetime data type