Crate typesense_rs

Source
Expand description

§Rust API client for typesense-rs

An open source search engine for building delightful search experiences.

§Overview

This API client was generated by the OpenAPI Generator project. By using the openapi-spec from a remote server, you can easily generate an API client.

  • API version: 27.0
  • Package version: 27.0
  • Generator version: 7.9.0-SNAPSHOT
  • Build package: org.openapitools.codegen.languages.RustClientCodegen

§Installation

Put the package under your project folder in a directory named typesense-rs and add the following to Cargo.toml under [dependencies]:

typesense-rs = "27.0.1"

§Features

FeatureDescription
bonUse the bon crate to build request parameters
reqwest-native-tlsUse the native-tls feature on the reqwest crate
reqwest-rustls-tlsUse the rustls-tls feature on the reqwest crate

§Documentation for API Endpoints

All URIs are relative to http://localhost

ClassMethodHTTP requestDescription
AnalyticsApicreate_analytics_eventPOST /analytics/eventsCreate an analytics event
AnalyticsApicreate_analytics_rulePOST /analytics/rulesCreates an analytics rule
AnalyticsApidelete_analytics_ruleDELETE /analytics/rules/{ruleName}Delete an analytics rule
AnalyticsApiretrieve_analytics_ruleGET /analytics/rules/{ruleName}Retrieves an analytics rule
AnalyticsApiretrieve_analytics_rulesGET /analytics/rulesRetrieves all analytics rules
AnalyticsApiupsert_analytics_rulePUT /analytics/rules/{ruleName}Upserts an analytics rule
CollectionsApicreate_collectionPOST /collectionsCreate a new collection
CollectionsApidelete_aliasDELETE /aliases/{aliasName}Delete an alias
CollectionsApidelete_collectionDELETE /collections/{collectionName}Delete a collection
CollectionsApiget_aliasGET /aliases/{aliasName}Retrieve an alias
CollectionsApiget_aliasesGET /aliasesList all aliases
CollectionsApiget_collectionGET /collections/{collectionName}Retrieve a single collection
CollectionsApiget_collectionsGET /collectionsList all collections
CollectionsApiupdate_collectionPATCH /collections/{collectionName}Update a collection
CollectionsApiupsert_aliasPUT /aliases/{aliasName}Create or update a collection alias
ConversationsApicreate_conversation_modelPOST /conversations/models
ConversationsApidelete_conversation_modelDELETE /conversations/models/{modelId}Delete a conversation model
ConversationsApiretrieve_all_conversation_modelsGET /conversations/modelsList all conversation models
ConversationsApiretrieve_conversation_modelGET /conversations/models/{modelId}Retrieve a conversation model
ConversationsApiupdate_conversation_modelPUT /conversations/models/{modelId}Update a conversation model
CurationApidelete_search_overrideDELETE /collections/{collectionName}/overrides/{overrideId}Delete an override associated with a collection
CurationApiget_search_overridesGET /collections/{collectionName}/overridesList all collection overrides
CurationApiupsert_search_overridePUT /collections/{collectionName}/overrides/{overrideId}Create or update an override to promote certain documents over others
DebugApidebugGET /debugPrint debugging information
DocumentsApidelete_documentDELETE /collections/{collectionName}/documents/{documentId}Delete a document
DocumentsApidelete_documentsDELETE /collections/{collectionName}/documentsDelete a bunch of documents
DocumentsApidelete_search_overrideDELETE /collections/{collectionName}/overrides/{overrideId}Delete an override associated with a collection
DocumentsApidelete_search_synonymDELETE /collections/{collectionName}/synonyms/{synonymId}Delete a synonym associated with a collection
DocumentsApiexport_documentsGET /collections/{collectionName}/documents/exportExport all documents in a collection
DocumentsApiget_documentGET /collections/{collectionName}/documents/{documentId}Retreive a document
DocumentsApiget_search_overrideGET /collections/{collectionName}/overrides/{overrideId}Retrieve a single search override
DocumentsApiget_search_overridesGET /collections/{collectionName}/overridesList all collection overrides
DocumentsApiget_search_synonymGET /collections/{collectionName}/synonyms/{synonymId}Retrieve a single search synonym
DocumentsApiget_search_synonymsGET /collections/{collectionName}/synonymsList all collection synonyms
DocumentsApiimport_documentsPOST /collections/{collectionName}/documents/importImport documents into a collection
DocumentsApiindex_documentPOST /collections/{collectionName}/documentsIndex a document
DocumentsApimulti_searchPOST /multi_searchsend multiple search requests in a single HTTP request
DocumentsApisearch_collectionGET /collections/{collectionName}/documents/searchSearch for documents in a collection
DocumentsApiupdate_documentPATCH /collections/{collectionName}/documents/{documentId}Update a document
DocumentsApiupdate_documentsPATCH /collections/{collectionName}/documentsUpdate documents with conditional query
DocumentsApiupsert_search_overridePUT /collections/{collectionName}/overrides/{overrideId}Create or update an override to promote certain documents over others
DocumentsApiupsert_search_synonymPUT /collections/{collectionName}/synonyms/{synonymId}Create or update a synonym
HealthApihealthGET /healthChecks if Typesense server is ready to accept requests.
KeysApicreate_keyPOST /keysCreate an API Key
KeysApidelete_keyDELETE /keys/{keyId}Delete an API key given its ID.
KeysApiget_keyGET /keys/{keyId}Retrieve (metadata about) a key
KeysApiget_keysGET /keysRetrieve (metadata about) all keys.
OperationsApiretrieve_api_statsGET /stats.jsonGet stats about API endpoints.
OperationsApiretrieve_metricsGET /metrics.jsonGet current RAM, CPU, Disk & Network usage metrics.
OperationsApitake_snapshotPOST /operations/snapshotCreates a point-in-time snapshot of a Typesense node’s state and data in the specified directory.
OperationsApivotePOST /operations/voteTriggers a follower node to initiate the raft voting process, which triggers leader re-election.
OverrideApiget_search_overrideGET /collections/{collectionName}/overrides/{overrideId}Retrieve a single search override
PresetsApidelete_presetDELETE /presets/{presetId}Delete a preset.
PresetsApiretrieve_all_presetsGET /presetsRetrieves all presets.
PresetsApiretrieve_presetGET /presets/{presetId}Retrieves a preset.
PresetsApiupsert_presetPUT /presets/{presetId}Upserts a preset.
StopwordsApidelete_stopwords_setDELETE /stopwords/{setId}Delete a stopwords set.
StopwordsApiretrieve_stopwords_setGET /stopwords/{setId}Retrieves a stopwords set.
StopwordsApiretrieve_stopwords_setsGET /stopwordsRetrieves all stopwords sets.
StopwordsApiupsert_stopwords_setPUT /stopwords/{setId}Upserts a stopwords set.

§Documentation For Models

To get access to the crate’s generated documentation, use:

cargo doc --open

§Author

Modules§

apis
models