Interact with the Neum Cloud
NeumClient
allows you to interact with the Neum AI Cloud through a python SDK. It supports the APIs listed below as methods in the client.
search_file
method. Ex. if you ingested an S3 bucket with 10 files, you can pick one and only search against it.
trigger_pipeline
: Trigger a pipeline to runget_pipelines
: Get a list of all pipelines created by a userget_pipeline_runs
: Get a list of all the runs for a given pipelineget_pipeline_run
: Get a specific run for a pipelineget_files
: Get that statuses for all files available within a pipelineget_file
: Get the status for a specific file within a pipelineget_retrievals_by_file_id
: Get retrieval events for a specific file within a pipeline. (Must have tracking enabled)get_retrievals_by_pipeline_id_user_id
: Get retrieval events for a user within a pipeline. (Must have tracking enabled and passed a requested_by
parameter)get_retrievals_by_file_id_user_id
: Get retrieval events for a user within a file. (Must have tracking enabled and passed a requested_by
parameter)get_retrievals_by_user_id
: Get retrieval events for a user across pipelines. (Must have tracking enabled and passed a requested_by
parameter)