All notable changes to this project will be documented in this file.
The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.
- Introduce (optional) support for setting custom metadata (properties) on
Data
instances. Seecustom_metadata
parameter documentation forNyxClient.create_data()
. Thenyx_client.properties
module contains helpers for creating properties. An example:client.create_data( "my_dataset", ..., custom_metadata=[ Property.lang_string(SOME_NAMESPACE+"pred1", "good morning", "en"), Property.string(SOME_NAMESPACE+"pred2", "plain string"), Property.literal(SOME_NAMESPACE+"pred3", b64encode(b"binary blob").decode("ascii"), "base64Binary"), Property.uri(RDF_TYPE, NS+"SomeClass"), ], )
- Add
Connections
class to allow referencing data from 3rd party storage:NyxClient.get_connections
returns a list of connections, andNyxClient.create_data
andNyxClient.update_data
take an optionalconnection_id
to set
- Configuration (env) files are now found relative to the current working directory instead of
nyx_client
installation directory. (There is no change if the configuration file has been specified using an absolute path.) env_file
forBaseNyxConfig.from_env
andNyxConfigExtended.from_env
is still optional but now defaults to.env
(instead ofNone
), to clearly illustrate what the default search path will be.
Circle
object added, along side methods onNyxClient
to get, create, update and delete circles, to enabled selective sharing of dataNyxClient.create_data
now creates data privately by default. Additional parameters ofcircles
andaccess_control
have been added, to enable selective sharing of the data
NyxClient.create_data
had a bug where the download url was sent to the API in an incorrect format.
NyxClient.create_data
andNyxClient.update_data
now make size and download url optional
NyxClient.create_data
andNyxClient.update_data
now support a passing a file to be uploaded either a file, or a download_url must be provided
- Nyx SDK is now two packages
nyx-client
for simple API interactions, andnyx-extras
for AI specific tooling Data
now takes more arguments, matching what is in the UI- All configs;
BaseNyxConfig
andNyxConfigExtended
(ReplacesOpenAiNyxConfig
andCohereNyxConfig
) are now constructed from params by default, old functionality is exposed viaBaseNyxConfig.from_env()
NyxClient
most methods to retrieve data have been replaced in preference ofget_data()
that supports multiple combined filtersNyxClient
is now only initalized with an optionalBaseNyxConfig
, and no-longer takes anenv_file
NyxClient.get_data_by_name
has been renamed toget_my_data_by_name
Data
no longer has methoddownload()
useas_string()
oras_bytes()
if it's a binaryNyxClient
property lists likeget_categories()
have been replaced withcategories()
(etc)
NyxClient
now supportssubscribe()
,unsubscribe()
andupdate_data()
NyxLangChain
has moved to packagenyx-extras
, and no longer takes anenv_file
Parser
has moved to packagenyx-extras
- EI-3331 - Bump iotics-identity to 2.1.2 for security (#15)
- EI-3364 - NyxClient.get_data_for_creators creator not returned (#18)
- EI-3364 - NyxClient.get_subscribed_categories query error
- Allow download in bytes (#11)
- EI-3339 change highlevel example default to openai (#16)
- Upper casing can break AI when looking for sources (#13)
- Override default sample rows; set to 0; plays havoc with getting a defined list of subscriptions (#7)
- JSON/Excel parsing has invalid param (#7)
- Initial public release