Struct DocumentsApiClient

pub struct DocumentsApiClient { /* private fields */ }

Implementations

impl DocumentsApiClient

pub fn new(configuration: Arc<Configuration>) -> Self

Trait Implementations

impl DocumentsApi for DocumentsApiClient

fn delete_document<'life0, 'async_trait>( &'life0 self, params: DeleteDocumentParams, ) -> Pin<Box<dyn Future<Output = Result<Value, Error<DeleteDocumentError>>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Delete an individual document from a collection by using its ID.

fn delete_documents<'life0, 'async_trait>( &'life0 self, params: DeleteDocumentsParams, ) -> Pin<Box<dyn Future<Output = Result<DeleteDocuments200Response, Error<DeleteDocumentsError>>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Delete a bunch of documents that match a specific filter condition. Use the batch_size parameter to control the number of documents that should deleted at a time. A larger value will speed up deletions, but will impact performance of other operations running on the server.

fn export_documents<'life0, 'async_trait>( &'life0 self, params: ExportDocumentsParams, ) -> Pin<Box<dyn Future<Output = Result<String, Error<ExportDocumentsError>>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Export all documents in a collection in JSON lines format.

fn get_document<'life0, 'async_trait>( &'life0 self, params: GetDocumentParams, ) -> Pin<Box<dyn Future<Output = Result<Value, Error<GetDocumentError>>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Fetch an individual document from a collection by using its ID.

fn get_search_override<'life0, 'async_trait>( &'life0 self, params: GetSearchOverrideParams, ) -> Pin<Box<dyn Future<Output = Result<SearchOverride, Error<GetSearchOverrideError>>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Retrieve the details of a search override, given its id.

fn get_search_synonym<'life0, 'async_trait>( &'life0 self, params: GetSearchSynonymParams, ) -> Pin<Box<dyn Future<Output = Result<SearchSynonym, Error<GetSearchSynonymError>>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Retrieve the details of a search synonym, given its id.

fn import_documents<'life0, 'async_trait>( &'life0 self, params: ImportDocumentsParams, ) -> Pin<Box<dyn Future<Output = Result<String, Error<ImportDocumentsError>>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

The documents to be imported must be formatted in a newline delimited JSON structure. You can feed the output file from a Typesense export operation directly as import.

fn index_document<'life0, 'async_trait>( &'life0 self, params: IndexDocumentParams, ) -> Pin<Box<dyn Future<Output = Result<Value, Error<IndexDocumentError>>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

A document to be indexed in a given collection must conform to the schema of the collection.

fn multi_search<'life0, 'async_trait>( &'life0 self, params: MultiSearchParams, ) -> Pin<Box<dyn Future<Output = Result<MultiSearchResult, Error<MultiSearchError>>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

This is especially useful to avoid round-trip network latencies incurred otherwise if each of these requests are sent in separate HTTP requests. You can also use this feature to do a federated search across multiple collections in a single HTTP request.

fn search_collection<'life0, 'async_trait>( &'life0 self, params: SearchCollectionParams, ) -> Pin<Box<dyn Future<Output = Result<SearchResult, Error<SearchCollectionError>>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Search for documents in a collection that match the search criteria.

fn update_document<'life0, 'async_trait>( &'life0 self, params: UpdateDocumentParams, ) -> Pin<Box<dyn Future<Output = Result<Value, Error<UpdateDocumentError>>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Update an individual document from a collection by using its ID. The update can be partial.

fn update_documents<'life0, 'async_trait>( &'life0 self, params: UpdateDocumentsParams, ) -> Pin<Box<dyn Future<Output = Result<UpdateDocuments200Response, Error<UpdateDocumentsError>>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

The filter_by query parameter is used to filter to specify a condition against which the documents are matched. The request body contains the fields that should be updated for any documents that match the filter condition. This endpoint is only available if the Typesense server is version 0.25.0.rc12 or later.

fn upsert_search_override<'life0, 'async_trait>( &'life0 self, params: UpsertSearchOverrideParams, ) -> Pin<Box<dyn Future<Output = Result<SearchOverride, Error<UpsertSearchOverrideError>>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Create or update an override to promote certain documents over others. Using overrides, you can include or exclude specific documents for a given query.

fn upsert_search_synonym<'life0, 'async_trait>( &'life0 self, params: UpsertSearchSynonymParams, ) -> Pin<Box<dyn Future<Output = Result<SearchSynonym, Error<UpsertSearchSynonymError>>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Create or update a synonym to define search terms that should be considered equivalent.

fn delete_search_override<'life0, 'async_trait>( &'life0 self, params: DeleteSearchOverrideParams, ) -> Pin<Box<dyn Future<Output = Result<SearchOverride, Error<DeleteSearchOverrideError>>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

fn delete_search_synonym<'life0, 'async_trait>( &'life0 self, params: DeleteSearchSynonymParams, ) -> Pin<Box<dyn Future<Output = Result<SearchSynonym, Error<DeleteSearchSynonymError>>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

fn get_search_overrides<'life0, 'async_trait>( &'life0 self, params: GetSearchOverridesParams, ) -> Pin<Box<dyn Future<Output = Result<SearchOverridesResponse, Error<GetSearchOverridesError>>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

fn get_search_synonyms<'life0, 'async_trait>( &'life0 self, params: GetSearchSynonymsParams, ) -> Pin<Box<dyn Future<Output = Result<SearchSynonymsResponse, Error<GetSearchSynonymsError>>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,