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

bon | Use the bon crate to build request parameters reqwest-native-tls | Use the native-tls feature on the reqwest crate reqwest-rustls-tls | Use the rustls-tls feature on the reqwest crate

Documentation for API Endpoints

All URIs are relative to http://localhost

AnalyticsApi | create_analytics_event | POST /analytics/events | Create an analytics event AnalyticsApi | create_analytics_rule | POST /analytics/rules | Creates an analytics rule AnalyticsApi | delete_analytics_rule | DELETE /analytics/rules/{ruleName} | Delete an analytics rule AnalyticsApi | retrieve_analytics_rule | GET /analytics/rules/{ruleName} | Retrieves an analytics rule AnalyticsApi | retrieve_analytics_rules | GET /analytics/rules | Retrieves all analytics rules AnalyticsApi | upsert_analytics_rule | PUT /analytics/rules/{ruleName} | Upserts an analytics rule CollectionsApi | create_collection | POST /collections | Create a new collection CollectionsApi | delete_alias | DELETE /aliases/{aliasName} | Delete an alias CollectionsApi | delete_collection | DELETE /collections/{collectionName} | Delete a collection CollectionsApi | get_alias | GET /aliases/{aliasName} | Retrieve an alias CollectionsApi | get_aliases | GET /aliases | List all aliases CollectionsApi | get_collection | GET /collections/{collectionName} | Retrieve a single collection CollectionsApi | get_collections | GET /collections | List all collections CollectionsApi | update_collection | PATCH /collections/{collectionName} | Update a collection CollectionsApi | upsert_alias | PUT /aliases/{aliasName} | Create or update a collection alias ConversationsApi | create_conversation_model | POST /conversations/models | ConversationsApi | delete_conversation_model | DELETE /conversations/models/{modelId} | Delete a conversation model ConversationsApi | retrieve_all_conversation_models | GET /conversations/models | List all conversation models ConversationsApi | retrieve_conversation_model | GET /conversations/models/{modelId} | Retrieve a conversation model ConversationsApi | update_conversation_model | PUT /conversations/models/{modelId} | Update a conversation model CurationApi | delete_search_override | DELETE /collections/{collectionName}/overrides/{overrideId} | Delete an override associated with a collection CurationApi | get_search_overrides | GET /collections/{collectionName}/overrides | List all collection overrides CurationApi | upsert_search_override | PUT /collections/{collectionName}/overrides/{overrideId} | Create or update an override to promote certain documents over others DebugApi | debug | GET /debug | Print debugging information DocumentsApi | delete_document | DELETE /collections/{collectionName}/documents/{documentId} | Delete a document DocumentsApi | delete_documents | DELETE /collections/{collectionName}/documents | Delete a bunch of documents DocumentsApi | delete_search_override | DELETE /collections/{collectionName}/overrides/{overrideId} | Delete an override associated with a collection DocumentsApi | delete_search_synonym | DELETE /collections/{collectionName}/synonyms/{synonymId} | Delete a synonym associated with a collection DocumentsApi | export_documents | GET /collections/{collectionName}/documents/export | Export all documents in a collection DocumentsApi | get_document | GET /collections/{collectionName}/documents/{documentId} | Retreive a document DocumentsApi | get_search_override | GET /collections/{collectionName}/overrides/{overrideId} | Retrieve a single search override DocumentsApi | get_search_overrides | GET /collections/{collectionName}/overrides | List all collection overrides DocumentsApi | get_search_synonym | GET /collections/{collectionName}/synonyms/{synonymId} | Retrieve a single search synonym DocumentsApi | get_search_synonyms | GET /collections/{collectionName}/synonyms | List all collection synonyms DocumentsApi | import_documents | POST /collections/{collectionName}/documents/import | Import documents into a collection DocumentsApi | index_document | POST /collections/{collectionName}/documents | Index a document DocumentsApi | multi_search | POST /multi_search | send multiple search requests in a single HTTP request DocumentsApi | search_collection | GET /collections/{collectionName}/documents/search | Search for documents in a collection DocumentsApi | update_document | PATCH /collections/{collectionName}/documents/{documentId} | Update a document DocumentsApi | update_documents | PATCH /collections/{collectionName}/documents | Update documents with conditional query DocumentsApi | upsert_search_override | PUT /collections/{collectionName}/overrides/{overrideId} | Create or update an override to promote certain documents over others DocumentsApi | upsert_search_synonym | PUT /collections/{collectionName}/synonyms/{synonymId} | Create or update a synonym HealthApi | health | GET /health | Checks if Typesense server is ready to accept requests. KeysApi | create_key | POST /keys | Create an API Key KeysApi | delete_key | DELETE /keys/{keyId} | Delete an API key given its ID. KeysApi | get_key | GET /keys/{keyId} | Retrieve (metadata about) a key KeysApi | get_keys | GET /keys | Retrieve (metadata about) all keys. OperationsApi | retrieve_api_stats | GET /stats.json | Get stats about API endpoints. OperationsApi | retrieve_metrics | GET /metrics.json | Get current RAM, CPU, Disk & Network usage metrics. OperationsApi | take_snapshot | POST /operations/snapshot | Creates a point-in-time snapshot of a Typesense node's state and data in the specified directory. OperationsApi | vote | POST /operations/vote | Triggers a follower node to initiate the raft voting process, which triggers leader re-election. OverrideApi | get_search_override | GET /collections/{collectionName}/overrides/{overrideId} | Retrieve a single search override PresetsApi | delete_preset | DELETE /presets/{presetId} | Delete a preset. PresetsApi | retrieve_all_presets | GET /presets | Retrieves all presets. PresetsApi | retrieve_preset | GET /presets/{presetId} | Retrieves a preset. PresetsApi | upsert_preset | PUT /presets/{presetId} | Upserts a preset. StopwordsApi | delete_stopwords_set | DELETE /stopwords/{setId} | Delete a stopwords set. StopwordsApi | retrieve_stopwords_set | GET /stopwords/{setId} | Retrieves a stopwords set. StopwordsApi | retrieve_stopwords_sets | GET /stopwords | Retrieves all stopwords sets. StopwordsApi | upsert_stopwords_set | PUT /stopwords/{setId} | Upserts a stopwords set.

Documentation For Models

• AnalyticsEventCreateResponse

• AnalyticsEventCreateSchema

• AnalyticsRuleDeleteResponse

• AnalyticsRuleParameters

• AnalyticsRuleParametersDestination

• AnalyticsRuleParametersSource

• AnalyticsRuleParametersSourceEventsInner

• AnalyticsRuleSchema

• AnalyticsRuleUpsertSchema

• AnalyticsRulesRetrieveSchema

• ApiKey

• ApiKeySchema

• ApiKeysResponse

• ApiResponse

• ApiStatsResponse

• CollectionAlias

• CollectionAliasSchema

• CollectionAliasesResponse

• CollectionResponse

• CollectionSchema

• CollectionUpdateSchema

• ConversationModelCreateSchema

• ConversationModelSchema

• ConversationModelUpdateSchema

• Debug200Response

• DeleteDocuments200Response

• DeleteStopwordsSet200Response

• DirtyValues

• DocumentIndexParameters

• DropTokensMode

• ErrorResponse

• FacetCounts

• FacetCountsCountsInner

• FacetCountsStats

• Field

• FieldEmbed

• FieldEmbedModelConfig

• HealthStatus

• IndexAction

• MultiSearchCollectionParameters

• MultiSearchParameters

• MultiSearchResult

• MultiSearchSearchesParameter

• PresetDeleteSchema

• PresetSchema

• PresetUpsertSchema

• PresetUpsertSchemaValue

• PresetsRetrieveSchema

• ScopedKeyParameters

• SearchGroupedHit

• SearchHighlight

• SearchOverride

• SearchOverrideExclude

• SearchOverrideInclude

• SearchOverrideRule

• SearchOverrideSchema

• SearchOverridesResponse

• SearchParameters

• SearchResult

• SearchResultConversation

• SearchResultHit

• SearchResultRequestParams

• SearchResultRequestParamsVoiceQuery

• SearchSynonym

• SearchSynonymSchema

• SearchSynonymsResponse

• SnapshotParameters

• StopwordsSetRetrieveSchema

• StopwordsSetSchema

• StopwordsSetUpsertSchema

• StopwordsSetsRetrieveAllSchema

• SuccessStatus

• UpdateDocuments200Response

• VoiceQueryModelCollectionConfig

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

cargo doc --open

Author