Struct reinfer_client::Client

pub struct Client { /* fields omitted */ }

Implementations

impl Client

pub fn new(config: Config) -> Result<Client>

Create a new API client.

pub fn get_sources(&self) -> Result<Vec<Source>>

List all visible sources.

pub fn get_source(&self, source: impl Into<SourceIdentifier>) -> Result<Source>

Get a source by either id or name.

pub fn create_source(
    &self,
    source_name: &SourceFullName,
    options: NewSource<'_>
) -> Result<Source>

Create a new source.

pub fn update_source(
    &self,
    source_name: &SourceFullName,
    options: UpdateSource<'_>
) -> Result<Source>

Update a source.

pub fn delete_source(&self, source: impl Into<SourceIdentifier>) -> Result<()>

Delete a source.

pub fn delete_comments(
    &self,
    source: impl Into<SourceIdentifier>,
    comments: &[CommentId]
) -> Result<()>

Delete comments by id in a source.

pub fn get_comments_iter_page(
    &self,
    source_name: &SourceFullName,
    continuation: Option<&ContinuationKind>,
    to_timestamp: Option<DateTime<Utc>>,
    limit: usize
) -> Result<CommentsIterPage>

Get a page of comments from a source.

pub fn get_comments_iter<'a>(
    &'a self,
    source_name: &'a SourceFullName,
    page_size: Option<usize>,
    timerange: CommentsIterTimerange
) -> CommentsIter<'a>

Iterate through all comments in a source.

pub fn put_comments(
    &self,
    source_name: &SourceFullName,
    comments: &[NewComment]
) -> Result<PutCommentsResponse>

pub fn sync_comments(
    &self,
    source_name: &SourceFullName,
    comments: &[NewComment]
) -> Result<SyncCommentsResponse>

pub fn put_emails(
    &self,
    bucket_name: &BucketFullName,
    emails: &[NewEmail]
) -> Result<PutEmailsResponse>

pub fn put_comment_audio(
    &self,
    source_id: &SourceId,
    comment_id: &CommentId,
    audio_path: impl AsRef<Path>
) -> Result<()>

pub fn get_datasets(&self) -> Result<Vec<Dataset>>

pub fn get_dataset<IdentifierT>(&self, dataset: IdentifierT) -> Result<Dataset> where
    IdentifierT: Into<DatasetIdentifier>, 

pub fn create_dataset(
    &self,
    dataset_name: &DatasetFullName,
    options: NewDataset<'_>
) -> Result<Dataset>

Create a dataset.

pub fn update_dataset(
    &self,
    dataset_name: &DatasetFullName,
    options: UpdateDataset<'_>
) -> Result<Dataset>

Update a dataset.

pub fn delete_dataset<IdentifierT>(&self, dataset: IdentifierT) -> Result<()> where
    IdentifierT: Into<DatasetIdentifier>, 

pub fn get_labellings<'a>(
    &self,
    dataset_name: &DatasetFullName,
    comment_uids: impl Iterator<Item = &'a CommentUid>
) -> Result<Vec<AnnotatedComment>>

Get labellings for a given a dataset and a list of comment UIDs.

pub fn get_labellings_iter<'a>(
    &'a self,
    dataset_name: &'a DatasetFullName,
    source_id: &'a SourceId,
    return_predictions: bool,
    limit: Option<usize>
) -> LabellingsIter<'a>

Iterate through all reviewed comments in a source.

pub fn get_labellings_in_bulk(
    &self,
    dataset_name: &DatasetFullName,
    query_parameters: GetLabellingsInBulk<'_>
) -> Result<GetAnnotationsResponse>

Get reviewed comments in bulk

pub fn update_labelling(
    &self,
    dataset_name: &DatasetFullName,
    comment_uid: &CommentUid,
    labelling: Option<&NewLabelling>,
    entities: Option<&NewEntities>
) -> Result<AnnotatedComment>

Update labellings for a given a dataset and comment UID.

pub fn get_triggers(
    &self,
    dataset_name: &DatasetFullName
) -> Result<Vec<Trigger>>

pub fn get_recent_comments(
    &self,
    dataset_name: &DatasetFullName,
    filter: &CommentFilter,
    limit: usize,
    continuation: Option<&Continuation>
) -> Result<RecentCommentsPage>

pub fn get_current_user(&self) -> Result<User>

pub fn get_users(&self) -> Result<Vec<User>>

pub fn create_user(&self, user: NewUser<'_>) -> Result<User>

pub fn get_statistics(
    &self,
    dataset_name: &DatasetFullName
) -> Result<Statistics>

pub fn create_bucket(
    &self,
    bucket_name: &BucketFullName,
    options: NewBucket<'_>
) -> Result<Bucket>

Create a new bucket.

pub fn get_buckets(&self) -> Result<Vec<Bucket>>

pub fn get_bucket<IdentifierT>(&self, bucket: IdentifierT) -> Result<Bucket> where
    IdentifierT: Into<BucketIdentifier>, 

pub fn delete_bucket<IdentifierT>(&self, bucket: IdentifierT) -> Result<()> where
    IdentifierT: Into<BucketIdentifier>, 

pub fn fetch_trigger_comments(
    &self,
    trigger_name: &TriggerFullName,
    size: u32
) -> Result<TriggerBatch>

pub fn advance_trigger(
    &self,
    trigger_name: &TriggerFullName,
    sequence_id: TriggerSequenceId
) -> Result<()>

pub fn reset_trigger(
    &self,
    trigger_name: &TriggerFullName,
    to_comment_created_at: DateTime<Utc>
) -> Result<()>

Trait Implementations

impl Debug for Client

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.