Struct reinfer_client::Client [−][src]
Implementations
impl Client
[src]
pub fn new(config: Config) -> Result<Client>
[src]
Create a new API client.
pub fn get_sources(&self) -> Result<Vec<Source>>
[src]
List all visible sources.
pub fn get_source(&self, source: impl Into<SourceIdentifier>) -> Result<Source>
[src]
Get a source by either id or name.
pub fn create_source(
&self,
source_name: &SourceFullName,
options: NewSource<'_>
) -> Result<Source>
[src]
&self,
source_name: &SourceFullName,
options: NewSource<'_>
) -> Result<Source>
Create a new source.
pub fn delete_source(&self, source: impl Into<SourceIdentifier>) -> Result<()>
[src]
Delete a source.
pub fn delete_comments(
&self,
source: impl Into<SourceIdentifier>,
comments: &[CommentId]
) -> Result<()>
[src]
&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>
[src]
&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>ⓘNotable traits for CommentsIter<'a>
impl<'a> Iterator for CommentsIter<'a> type Item = Result<Vec<Comment>>;
[src]
&'a self,
source_name: &'a SourceFullName,
page_size: Option<usize>,
timerange: CommentsIterTimerange
) -> CommentsIter<'a>ⓘ
Notable traits for CommentsIter<'a>
impl<'a> Iterator for CommentsIter<'a> type Item = Result<Vec<Comment>>;
Iterate through all comments in a source.
pub fn put_comments(
&self,
source_name: &SourceFullName,
comments: &[NewComment]
) -> Result<PutCommentsResponse>
[src]
&self,
source_name: &SourceFullName,
comments: &[NewComment]
) -> Result<PutCommentsResponse>
pub fn sync_comments(
&self,
source_name: &SourceFullName,
comments: &[NewComment]
) -> Result<SyncCommentsResponse>
[src]
&self,
source_name: &SourceFullName,
comments: &[NewComment]
) -> Result<SyncCommentsResponse>
pub fn put_emails(
&self,
bucket_name: &BucketFullName,
emails: &[NewEmail]
) -> Result<PutEmailsResponse>
[src]
&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<()>
[src]
&self,
source_id: &SourceId,
comment_id: &CommentId,
audio_path: impl AsRef<Path>
) -> Result<()>
pub fn get_datasets(&self) -> Result<Vec<Dataset>>
[src]
pub fn get_dataset<IdentifierT>(&self, dataset: IdentifierT) -> Result<Dataset> where
IdentifierT: Into<DatasetIdentifier>,
[src]
IdentifierT: Into<DatasetIdentifier>,
pub fn create_dataset(
&self,
dataset_name: &DatasetFullName,
options: NewDataset<'_>
) -> Result<Dataset>
[src]
&self,
dataset_name: &DatasetFullName,
options: NewDataset<'_>
) -> Result<Dataset>
pub fn delete_dataset<IdentifierT>(&self, dataset: IdentifierT) -> Result<()> where
IdentifierT: Into<DatasetIdentifier>,
[src]
IdentifierT: Into<DatasetIdentifier>,
pub fn get_labellings<'a>(
&self,
dataset_name: &DatasetFullName,
comment_uids: impl Iterator<Item = &'a CommentUid>
) -> Result<Vec<AnnotatedComment>>
[src]
&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>ⓘNotable traits for LabellingsIter<'a>
impl<'a> Iterator for LabellingsIter<'a> type Item = Result<Vec<AnnotatedComment>>;
[src]
&'a self,
dataset_name: &'a DatasetFullName,
source_id: &'a SourceId,
return_predictions: bool,
limit: Option<usize>
) -> LabellingsIter<'a>ⓘ
Notable traits for LabellingsIter<'a>
impl<'a> Iterator for LabellingsIter<'a> type Item = Result<Vec<AnnotatedComment>>;
Iterate through all reviewed comments in a source.
pub fn get_labellings_in_bulk(
&self,
dataset_name: &DatasetFullName,
query_parameters: GetLabellingsInBulk<'_>
) -> Result<GetAnnotationsResponse>
[src]
&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>
[src]
&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>>
[src]
&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>
[src]
&self,
dataset_name: &DatasetFullName,
filter: &CommentFilter,
limit: usize,
continuation: Option<&Continuation>
) -> Result<RecentCommentsPage>
pub fn get_current_user(&self) -> Result<User>
[src]
pub fn get_users(&self) -> Result<Vec<User>>
[src]
pub fn create_user(&self, user: NewUser<'_>) -> Result<User>
[src]
pub fn get_statistics(
&self,
dataset_name: &DatasetFullName
) -> Result<Statistics>
[src]
&self,
dataset_name: &DatasetFullName
) -> Result<Statistics>
pub fn create_bucket(
&self,
bucket_name: &BucketFullName,
options: NewBucket<'_>
) -> Result<Bucket>
[src]
&self,
bucket_name: &BucketFullName,
options: NewBucket<'_>
) -> Result<Bucket>
Create a new bucket.
pub fn get_buckets(&self) -> Result<Vec<Bucket>>
[src]
pub fn get_bucket<IdentifierT>(&self, bucket: IdentifierT) -> Result<Bucket> where
IdentifierT: Into<BucketIdentifier>,
[src]
IdentifierT: Into<BucketIdentifier>,
pub fn delete_bucket<IdentifierT>(&self, bucket: IdentifierT) -> Result<()> where
IdentifierT: Into<BucketIdentifier>,
[src]
IdentifierT: Into<BucketIdentifier>,
pub fn fetch_trigger_comments(
&self,
trigger_name: &TriggerFullName,
size: u32
) -> Result<TriggerBatch>
[src]
&self,
trigger_name: &TriggerFullName,
size: u32
) -> Result<TriggerBatch>
pub fn advance_trigger(
&self,
trigger_name: &TriggerFullName,
sequence_id: TriggerSequenceId
) -> Result<()>
[src]
&self,
trigger_name: &TriggerFullName,
sequence_id: TriggerSequenceId
) -> Result<()>
pub fn reset_trigger(
&self,
trigger_name: &TriggerFullName,
to_comment_created_at: DateTime<Utc>
) -> Result<()>
[src]
&self,
trigger_name: &TriggerFullName,
to_comment_created_at: DateTime<Utc>
) -> Result<()>
Trait Implementations
Auto Trait Implementations
impl !RefUnwindSafe for Client
impl Send for Client
impl Sync for Client
impl Unpin for Client
impl !UnwindSafe for Client
Blanket Implementations
impl<T> Any for T where
T: 'static + ?Sized,
[src]
T: 'static + ?Sized,
impl<T> Borrow<T> for T where
T: ?Sized,
[src]
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
T: ?Sized,
pub fn borrow_mut(&mut self) -> &mut T
[src]
impl<T> From<T> for T
[src]
impl<T> Instrument for T
[src]
pub fn instrument(self, span: Span) -> Instrumented<Self>
[src]
pub fn in_current_span(self) -> Instrumented<Self>
[src]
impl<T, U> Into<U> for T where
U: From<T>,
[src]
U: From<T>,
impl<T, U> TryFrom<U> for T where
U: Into<T>,
[src]
U: Into<T>,
type Error = Infallible
The type returned in the event of a conversion error.
pub fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>
[src]
impl<T, U> TryInto<U> for T where
U: TryFrom<T>,
[src]
U: TryFrom<T>,