# 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](https://openapi-generator.tech) project. By using the [openapi-spec](https://openapis.org) 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 Feature | Description --------|------------ *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* Class | Method | HTTP request | Description ------------ | ------------- | ------------- | ------------- *AnalyticsApi* | [**create_analytics_event**](docs/AnalyticsApi.md#create_analytics_event) | **POST** /analytics/events | Create an analytics event *AnalyticsApi* | [**create_analytics_rule**](docs/AnalyticsApi.md#create_analytics_rule) | **POST** /analytics/rules | Creates an analytics rule *AnalyticsApi* | [**delete_analytics_rule**](docs/AnalyticsApi.md#delete_analytics_rule) | **DELETE** /analytics/rules/{ruleName} | Delete an analytics rule *AnalyticsApi* | [**retrieve_analytics_rule**](docs/AnalyticsApi.md#retrieve_analytics_rule) | **GET** /analytics/rules/{ruleName} | Retrieves an analytics rule *AnalyticsApi* | [**retrieve_analytics_rules**](docs/AnalyticsApi.md#retrieve_analytics_rules) | **GET** /analytics/rules | Retrieves all analytics rules *AnalyticsApi* | [**upsert_analytics_rule**](docs/AnalyticsApi.md#upsert_analytics_rule) | **PUT** /analytics/rules/{ruleName} | Upserts an analytics rule *CollectionsApi* | [**create_collection**](docs/CollectionsApi.md#create_collection) | **POST** /collections | Create a new collection *CollectionsApi* | [**delete_alias**](docs/CollectionsApi.md#delete_alias) | **DELETE** /aliases/{aliasName} | Delete an alias *CollectionsApi* | [**delete_collection**](docs/CollectionsApi.md#delete_collection) | **DELETE** /collections/{collectionName} | Delete a collection *CollectionsApi* | [**get_alias**](docs/CollectionsApi.md#get_alias) | **GET** /aliases/{aliasName} | Retrieve an alias *CollectionsApi* | [**get_aliases**](docs/CollectionsApi.md#get_aliases) | **GET** /aliases | List all aliases *CollectionsApi* | [**get_collection**](docs/CollectionsApi.md#get_collection) | **GET** /collections/{collectionName} | Retrieve a single collection *CollectionsApi* | [**get_collections**](docs/CollectionsApi.md#get_collections) | **GET** /collections | List all collections *CollectionsApi* | [**update_collection**](docs/CollectionsApi.md#update_collection) | **PATCH** /collections/{collectionName} | Update a collection *CollectionsApi* | [**upsert_alias**](docs/CollectionsApi.md#upsert_alias) | **PUT** /aliases/{aliasName} | Create or update a collection alias *ConversationsApi* | [**create_conversation_model**](docs/ConversationsApi.md#create_conversation_model) | **POST** /conversations/models | *ConversationsApi* | [**delete_conversation_model**](docs/ConversationsApi.md#delete_conversation_model) | **DELETE** /conversations/models/{modelId} | Delete a conversation model *ConversationsApi* | [**retrieve_all_conversation_models**](docs/ConversationsApi.md#retrieve_all_conversation_models) | **GET** /conversations/models | List all conversation models *ConversationsApi* | [**retrieve_conversation_model**](docs/ConversationsApi.md#retrieve_conversation_model) | **GET** /conversations/models/{modelId} | Retrieve a conversation model *ConversationsApi* | [**update_conversation_model**](docs/ConversationsApi.md#update_conversation_model) | **PUT** /conversations/models/{modelId} | Update a conversation model *CurationApi* | [**delete_search_override**](docs/CurationApi.md#delete_search_override) | **DELETE** /collections/{collectionName}/overrides/{overrideId} | Delete an override associated with a collection *CurationApi* | [**get_search_overrides**](docs/CurationApi.md#get_search_overrides) | **GET** /collections/{collectionName}/overrides | List all collection overrides *CurationApi* | [**upsert_search_override**](docs/CurationApi.md#upsert_search_override) | **PUT** /collections/{collectionName}/overrides/{overrideId} | Create or update an override to promote certain documents over others *DebugApi* | [**debug**](docs/DebugApi.md#debug) | **GET** /debug | Print debugging information *DocumentsApi* | [**delete_document**](docs/DocumentsApi.md#delete_document) | **DELETE** /collections/{collectionName}/documents/{documentId} | Delete a document *DocumentsApi* | [**delete_documents**](docs/DocumentsApi.md#delete_documents) | **DELETE** /collections/{collectionName}/documents | Delete a bunch of documents *DocumentsApi* | [**delete_search_override**](docs/DocumentsApi.md#delete_search_override) | **DELETE** /collections/{collectionName}/overrides/{overrideId} | Delete an override associated with a collection *DocumentsApi* | [**delete_search_synonym**](docs/DocumentsApi.md#delete_search_synonym) | **DELETE** /collections/{collectionName}/synonyms/{synonymId} | Delete a synonym associated with a collection *DocumentsApi* | [**export_documents**](docs/DocumentsApi.md#export_documents) | **GET** /collections/{collectionName}/documents/export | Export all documents in a collection *DocumentsApi* | [**get_document**](docs/DocumentsApi.md#get_document) | **GET** /collections/{collectionName}/documents/{documentId} | Retreive a document *DocumentsApi* | [**get_search_override**](docs/DocumentsApi.md#get_search_override) | **GET** /collections/{collectionName}/overrides/{overrideId} | Retrieve a single search override *DocumentsApi* | [**get_search_overrides**](docs/DocumentsApi.md#get_search_overrides) | **GET** /collections/{collectionName}/overrides | List all collection overrides *DocumentsApi* | [**get_search_synonym**](docs/DocumentsApi.md#get_search_synonym) | **GET** /collections/{collectionName}/synonyms/{synonymId} | Retrieve a single search synonym *DocumentsApi* | [**get_search_synonyms**](docs/DocumentsApi.md#get_search_synonyms) | **GET** /collections/{collectionName}/synonyms | List all collection synonyms *DocumentsApi* | [**import_documents**](docs/DocumentsApi.md#import_documents) | **POST** /collections/{collectionName}/documents/import | Import documents into a collection *DocumentsApi* | [**index_document**](docs/DocumentsApi.md#index_document) | **POST** /collections/{collectionName}/documents | Index a document *DocumentsApi* | [**multi_search**](docs/DocumentsApi.md#multi_search) | **POST** /multi_search | send multiple search requests in a single HTTP request *DocumentsApi* | [**search_collection**](docs/DocumentsApi.md#search_collection) | **GET** /collections/{collectionName}/documents/search | Search for documents in a collection *DocumentsApi* | [**update_document**](docs/DocumentsApi.md#update_document) | **PATCH** /collections/{collectionName}/documents/{documentId} | Update a document *DocumentsApi* | [**update_documents**](docs/DocumentsApi.md#update_documents) | **PATCH** /collections/{collectionName}/documents | Update documents with conditional query *DocumentsApi* | [**upsert_search_override**](docs/DocumentsApi.md#upsert_search_override) | **PUT** /collections/{collectionName}/overrides/{overrideId} | Create or update an override to promote certain documents over others *DocumentsApi* | [**upsert_search_synonym**](docs/DocumentsApi.md#upsert_search_synonym) | **PUT** /collections/{collectionName}/synonyms/{synonymId} | Create or update a synonym *HealthApi* | [**health**](docs/HealthApi.md#health) | **GET** /health | Checks if Typesense server is ready to accept requests. *KeysApi* | [**create_key**](docs/KeysApi.md#create_key) | **POST** /keys | Create an API Key *KeysApi* | [**delete_key**](docs/KeysApi.md#delete_key) | **DELETE** /keys/{keyId} | Delete an API key given its ID. *KeysApi* | [**get_key**](docs/KeysApi.md#get_key) | **GET** /keys/{keyId} | Retrieve (metadata about) a key *KeysApi* | [**get_keys**](docs/KeysApi.md#get_keys) | **GET** /keys | Retrieve (metadata about) all keys. *OperationsApi* | [**retrieve_api_stats**](docs/OperationsApi.md#retrieve_api_stats) | **GET** /stats.json | Get stats about API endpoints. *OperationsApi* | [**retrieve_metrics**](docs/OperationsApi.md#retrieve_metrics) | **GET** /metrics.json | Get current RAM, CPU, Disk & Network usage metrics. *OperationsApi* | [**take_snapshot**](docs/OperationsApi.md#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**](docs/OperationsApi.md#vote) | **POST** /operations/vote | Triggers a follower node to initiate the raft voting process, which triggers leader re-election. *OverrideApi* | [**get_search_override**](docs/OverrideApi.md#get_search_override) | **GET** /collections/{collectionName}/overrides/{overrideId} | Retrieve a single search override *PresetsApi* | [**delete_preset**](docs/PresetsApi.md#delete_preset) | **DELETE** /presets/{presetId} | Delete a preset. *PresetsApi* | [**retrieve_all_presets**](docs/PresetsApi.md#retrieve_all_presets) | **GET** /presets | Retrieves all presets. *PresetsApi* | [**retrieve_preset**](docs/PresetsApi.md#retrieve_preset) | **GET** /presets/{presetId} | Retrieves a preset. *PresetsApi* | [**upsert_preset**](docs/PresetsApi.md#upsert_preset) | **PUT** /presets/{presetId} | Upserts a preset. *StopwordsApi* | [**delete_stopwords_set**](docs/StopwordsApi.md#delete_stopwords_set) | **DELETE** /stopwords/{setId} | Delete a stopwords set. *StopwordsApi* | [**retrieve_stopwords_set**](docs/StopwordsApi.md#retrieve_stopwords_set) | **GET** /stopwords/{setId} | Retrieves a stopwords set. *StopwordsApi* | [**retrieve_stopwords_sets**](docs/StopwordsApi.md#retrieve_stopwords_sets) | **GET** /stopwords | Retrieves all stopwords sets. *StopwordsApi* | [**upsert_stopwords_set**](docs/StopwordsApi.md#upsert_stopwords_set) | **PUT** /stopwords/{setId} | Upserts a stopwords set. ## Documentation For Models - [AnalyticsEventCreateResponse](docs/AnalyticsEventCreateResponse.md) - [AnalyticsEventCreateSchema](docs/AnalyticsEventCreateSchema.md) - [AnalyticsRuleDeleteResponse](docs/AnalyticsRuleDeleteResponse.md) - [AnalyticsRuleParameters](docs/AnalyticsRuleParameters.md) - [AnalyticsRuleParametersDestination](docs/AnalyticsRuleParametersDestination.md) - [AnalyticsRuleParametersSource](docs/AnalyticsRuleParametersSource.md) - [AnalyticsRuleParametersSourceEventsInner](docs/AnalyticsRuleParametersSourceEventsInner.md) - [AnalyticsRuleSchema](docs/AnalyticsRuleSchema.md) - [AnalyticsRuleUpsertSchema](docs/AnalyticsRuleUpsertSchema.md) - [AnalyticsRulesRetrieveSchema](docs/AnalyticsRulesRetrieveSchema.md) - [ApiKey](docs/ApiKey.md) - [ApiKeySchema](docs/ApiKeySchema.md) - [ApiKeysResponse](docs/ApiKeysResponse.md) - [ApiResponse](docs/ApiResponse.md) - [ApiStatsResponse](docs/ApiStatsResponse.md) - [CollectionAlias](docs/CollectionAlias.md) - [CollectionAliasSchema](docs/CollectionAliasSchema.md) - [CollectionAliasesResponse](docs/CollectionAliasesResponse.md) - [CollectionResponse](docs/CollectionResponse.md) - [CollectionSchema](docs/CollectionSchema.md) - [CollectionUpdateSchema](docs/CollectionUpdateSchema.md) - [ConversationModelCreateSchema](docs/ConversationModelCreateSchema.md) - [ConversationModelSchema](docs/ConversationModelSchema.md) - [ConversationModelUpdateSchema](docs/ConversationModelUpdateSchema.md) - [Debug200Response](docs/Debug200Response.md) - [DeleteDocuments200Response](docs/DeleteDocuments200Response.md) - [DeleteStopwordsSet200Response](docs/DeleteStopwordsSet200Response.md) - [DirtyValues](docs/DirtyValues.md) - [DocumentIndexParameters](docs/DocumentIndexParameters.md) - [DropTokensMode](docs/DropTokensMode.md) - [ErrorResponse](docs/ErrorResponse.md) - [FacetCounts](docs/FacetCounts.md) - [FacetCountsCountsInner](docs/FacetCountsCountsInner.md) - [FacetCountsStats](docs/FacetCountsStats.md) - [Field](docs/Field.md) - [FieldEmbed](docs/FieldEmbed.md) - [FieldEmbedModelConfig](docs/FieldEmbedModelConfig.md) - [HealthStatus](docs/HealthStatus.md) - [IndexAction](docs/IndexAction.md) - [MultiSearchCollectionParameters](docs/MultiSearchCollectionParameters.md) - [MultiSearchParameters](docs/MultiSearchParameters.md) - [MultiSearchResult](docs/MultiSearchResult.md) - [MultiSearchSearchesParameter](docs/MultiSearchSearchesParameter.md) - [PresetDeleteSchema](docs/PresetDeleteSchema.md) - [PresetSchema](docs/PresetSchema.md) - [PresetUpsertSchema](docs/PresetUpsertSchema.md) - [PresetUpsertSchemaValue](docs/PresetUpsertSchemaValue.md) - [PresetsRetrieveSchema](docs/PresetsRetrieveSchema.md) - [ScopedKeyParameters](docs/ScopedKeyParameters.md) - [SearchGroupedHit](docs/SearchGroupedHit.md) - [SearchHighlight](docs/SearchHighlight.md) - [SearchOverride](docs/SearchOverride.md) - [SearchOverrideExclude](docs/SearchOverrideExclude.md) - [SearchOverrideInclude](docs/SearchOverrideInclude.md) - [SearchOverrideRule](docs/SearchOverrideRule.md) - [SearchOverrideSchema](docs/SearchOverrideSchema.md) - [SearchOverridesResponse](docs/SearchOverridesResponse.md) - [SearchParameters](docs/SearchParameters.md) - [SearchResult](docs/SearchResult.md) - [SearchResultConversation](docs/SearchResultConversation.md) - [SearchResultHit](docs/SearchResultHit.md) - [SearchResultRequestParams](docs/SearchResultRequestParams.md) - [SearchResultRequestParamsVoiceQuery](docs/SearchResultRequestParamsVoiceQuery.md) - [SearchSynonym](docs/SearchSynonym.md) - [SearchSynonymSchema](docs/SearchSynonymSchema.md) - [SearchSynonymsResponse](docs/SearchSynonymsResponse.md) - [SnapshotParameters](docs/SnapshotParameters.md) - [StopwordsSetRetrieveSchema](docs/StopwordsSetRetrieveSchema.md) - [StopwordsSetSchema](docs/StopwordsSetSchema.md) - [StopwordsSetUpsertSchema](docs/StopwordsSetUpsertSchema.md) - [StopwordsSetsRetrieveAllSchema](docs/StopwordsSetsRetrieveAllSchema.md) - [SuccessStatus](docs/SuccessStatus.md) - [UpdateDocuments200Response](docs/UpdateDocuments200Response.md) - [VoiceQueryModelCollectionConfig](docs/VoiceQueryModelCollectionConfig.md) To get access to the crate's generated documentation, use: ``` cargo doc --open ``` ## Author