typesense_codegen 0.30.0

Types for typesense generated with openapi spec
Documentation

Rust API client for openapi

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: 30.0
  • Package version: 30.0
  • Generator version: 7.14.0
  • Build package: org.openapitools.codegen.languages.RustClientCodegen

Installation

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

openapi = { path = "./openapi" }

Documentation for API Endpoints

All URIs are relative to http://localhost:8108

Class Method HTTP request Description
AnalyticsApi create_analytics_event POST /analytics/events Create an analytics event
AnalyticsApi create_analytics_rule POST /analytics/rules Create analytics rule(s)
AnalyticsApi delete_analytics_rule DELETE /analytics/rules/{ruleName} Delete an analytics rule
AnalyticsApi flush_analytics POST /analytics/flush Flush in-memory analytics to disk
AnalyticsApi get_analytics_events GET /analytics/events Retrieve analytics events
AnalyticsApi get_analytics_status GET /analytics/status Get analytics subsystem status
AnalyticsApi retrieve_analytics_rule GET /analytics/rules/{ruleName} Retrieves an analytics rule
AnalyticsApi retrieve_analytics_rules GET /analytics/rules Retrieve 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 Create a conversation model
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
CurationSetsApi delete_curation_set DELETE /curation_sets/{curationSetName} Delete a curation set
CurationSetsApi delete_curation_set_item DELETE /curation_sets/{curationSetName}/items/{itemId} Delete a curation set item
CurationSetsApi retrieve_curation_set GET /curation_sets/{curationSetName} Retrieve a curation set
CurationSetsApi retrieve_curation_set_item GET /curation_sets/{curationSetName}/items/{itemId} Retrieve a curation set item
CurationSetsApi retrieve_curation_set_items GET /curation_sets/{curationSetName}/items List items in a curation set
CurationSetsApi retrieve_curation_sets GET /curation_sets List all curation sets
CurationSetsApi upsert_curation_set PUT /curation_sets/{curationSetName} Create or update a curation set
CurationSetsApi upsert_curation_set_item PUT /curation_sets/{curationSetName}/items/{itemId} Create or update a curation set item
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 export_documents GET /collections/{collectionName}/documents/export Export all documents in a collection
DocumentsApi get_document GET /collections/{collectionName}/documents/{documentId} Retrieve a document
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
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.
NlSearchModelsApi create_nl_search_model POST /nl_search_models Create a NL search model
NlSearchModelsApi delete_nl_search_model DELETE /nl_search_models/{modelId} Delete a NL search model
NlSearchModelsApi retrieve_all_nl_search_models GET /nl_search_models List all NL search models
NlSearchModelsApi retrieve_nl_search_model GET /nl_search_models/{modelId} Retrieve a NL search model
NlSearchModelsApi update_nl_search_model PUT /nl_search_models/{modelId} Update a NL search model
OperationsApi clear_cache POST /operations/cache/clear Clear the cached responses of search requests in the LRU cache.
OperationsApi compact_db POST /operations/db/compact Compacting the on-disk database
OperationsApi get_schema_changes GET /operations/schema_changes Get the status of in-progress schema change operations
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 toggle_slow_request_log POST /config Toggle Slow Request Log
OperationsApi vote POST /operations/vote Triggers a follower node to initiate the raft voting process, which triggers leader re-election.
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.
StemmingApi get_stemming_dictionary GET /stemming/dictionaries/{dictionaryId} Retrieve a stemming dictionary
StemmingApi import_stemming_dictionary POST /stemming/dictionaries/import Import a stemming dictionary
StemmingApi list_stemming_dictionaries GET /stemming/dictionaries List all stemming dictionaries
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.
SynonymsApi delete_synonym_set DELETE /synonym_sets/{synonymSetName} Delete a synonym set
SynonymsApi delete_synonym_set_item DELETE /synonym_sets/{synonymSetName}/items/{itemId} Delete a synonym set item
SynonymsApi retrieve_synonym_set GET /synonym_sets/{synonymSetName} Retrieve a synonym set
SynonymsApi retrieve_synonym_set_item GET /synonym_sets/{synonymSetName}/items/{itemId} Retrieve a synonym set item
SynonymsApi retrieve_synonym_set_items GET /synonym_sets/{synonymSetName}/items List items in a synonym set
SynonymsApi retrieve_synonym_sets GET /synonym_sets List all synonym sets
SynonymsApi upsert_synonym_set PUT /synonym_sets/{synonymSetName} Create or update a synonym set
SynonymsApi upsert_synonym_set_item PUT /synonym_sets/{synonymSetName}/items/{itemId} Create or update a synonym set item

Documentation For Models

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

cargo doc --open

Author