originchaindb 0.1.22__tar.gz

originchaindb-0.1.22/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Silicoyn Technologies Pvt Ltd
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

originchaindb-0.1.22/PKG-INFO

@@ -0,0 +1,532 @@
+Metadata-Version: 2.4
+Name: originchaindb
+Version: 0.1.22
+Summary: OriginChain HTTP API
+Home-page: 
+Author: OpenAPI Generator community
+Author-email: OpenAPI Generator Community <team@openapitools.org>
+License-Expression: MIT
+Project-URL: Repository, https://github.com/GIT_USER_ID/GIT_REPO_ID
+Keywords: OpenAPI,OpenAPI-Generator,OriginChain HTTP API
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: urllib3<3.0.0,>=2.7.0
+Requires-Dist: python-dateutil>=2.8.2
+Requires-Dist: pydantic>=2.11
+Requires-Dist: typing-extensions>=4.7.1
+Dynamic: author
+Dynamic: license-file
+
+# originchaindb
+The OriginChain database HTTP API. Generated from the engine's routes; do not edit by hand.
+
+This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
+
+- API version: 0.1.0
+- Package version: 0.1.22
+- Generator version: 7.26.0
+- Build package: org.openapitools.codegen.languages.PythonClientCodegen
+
+## Requirements.
+
+Python 3.10+
+
+Packaging uses standard `[project]` metadata and `[dependency-groups]` (PEP 621/735).
+Install the package with `python -m pip install .`; install development dependencies
+with Poetry 2.2 or newer using `poetry install`, or pip 25.1 or newer using
+`python -m pip install --group dev`. The latter installs the group, not the package.
+
+## Installation & Usage
+### pip install
+
+If the python package is hosted on a repository, you can install directly using:
+
+```sh
+pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git
+```
+(you may need to run `pip` with root permission: `sudo pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git`)
+
+Then import the package:
+```python
+import originchaindb
+```
+
+### Setuptools
+
+Install via [Setuptools](http://pypi.python.org/pypi/setuptools).
+
+```sh
+python setup.py install --user
+```
+(or `sudo python setup.py install` to install the package for all users)
+
+Then import the package:
+```python
+import originchaindb
+```
+
+### Tests
+
+Execute `pytest` to run the tests.
+
+## Getting Started
+
+Please follow the [installation procedure](#installation--usage) and then run the following:
+
+```python
+
+import originchaindb
+from originchaindb.rest import ApiException
+from pprint import pprint
+
+# Defining the host is optional and defaults to https://localhost:8080
+# See configuration.py for a list of all supported configuration parameters.
+configuration = originchaindb.Configuration(
+    host = "https://localhost:8080"
+)
+
+# The client must configure the authentication and authorization parameters
+# in accordance with the API server security policy.
+# Examples for each auth method are provided below, use the example that
+# satisfies your auth use case.
+
+# Configure Bearer authorization: bearerAuth
+configuration = originchaindb.Configuration(
+    access_token = os.environ["BEARER_TOKEN"]
+)
+
+
+# Enter a context with an instance of the API client
+with originchaindb.ApiClient(configuration) as api_client:
+    # Create an instance of the API class
+    api_instance = originchaindb.AskApi(api_client)
+    tenant = 'tenant_example' # str | 
+    ask_request = originchaindb.AskRequest() # AskRequest | 
+    explain = 'explain_example' # str |  (optional)
+    x_oc_db_user = 'x_oc_db_user_example' # str | Acting database user (role, grant and row-policy checks). Send with x-oc-db-key. (optional)
+    x_oc_db_key = 'x_oc_db_key_example' # str | API key of the x-oc-db-user user. (optional)
+
+    try:
+        # Answers a natural-language question by compiling it to a query plan and running it.
+        api_response = api_instance.ask(tenant, ask_request, explain=explain, x_oc_db_user=x_oc_db_user, x_oc_db_key=x_oc_db_key)
+        print("The response of AskApi->ask:\n")
+        pprint(api_response)
+    except ApiException as e:
+        print("Exception when calling AskApi->ask: %s\n" % e)
+
+```
+
+## Documentation for API Endpoints
+
+All URIs are relative to *https://localhost:8080*
+
+Class | Method | HTTP request | Description
+------------ | ------------- | ------------- | -------------
+*AskApi* | [**ask**](docs/AskApi.md#ask) | **POST** /v1/tenants/{tenant}/ask | Answers a natural-language question by compiling it to a query plan and running it.
+*AuditApi* | [**audit_export**](docs/AuditApi.md#audit_export) | **GET** /v1/tenants/{tenant}/audit/export | Exports the tenant&#39;s complete audit log as newline-delimited JSON, oldest first, for ingestion into a security monitoring system.
+*AuditApi* | [**audit_list**](docs/AuditApi.md#audit_list) | **GET** /v1/tenants/{tenant}/audit | Returns the most recent entries of the tenant&#39;s tamper-evident audit log, newest first.
+*AuditApi* | [**audit_verify**](docs/AuditApi.md#audit_verify) | **GET** /v1/tenants/{tenant}/audit/verify | Verifies the integrity of the tenant&#39;s hash-chained audit log and reports the first entry that fails, if any.
+*CypherApi* | [**cypher_exec**](docs/CypherApi.md#cypher_exec) | **POST** /v1/tenants/{tenant}/cypher | Runs an openCypher query, read or write, and returns its rows or write counts.
+*DbApi* | [**create_role**](docs/DbApi.md#create_role) | **POST** /v1/tenants/{tenant}/db/roles | Creates a database role, optionally inheriting the privileges of existing roles.
+*DbApi* | [**create_user**](docs/DbApi.md#create_user) | **POST** /v1/tenants/{tenant}/db/users | Creates a database user that authenticates with either a password or a generated API key.
+*DbApi* | [**delete_rls**](docs/DbApi.md#delete_rls) | **DELETE** /v1/tenants/{tenant}/db/rls | Deletes the row-level security policy for a role on a table.
+*DbApi* | [**delete_role**](docs/DbApi.md#delete_role) | **DELETE** /v1/tenants/{tenant}/db/roles/{name} | Deletes a database role, refusing while grants, policies, members or inheriting roles still reference it unless cascade&#x3D;true is passed.
+*DbApi* | [**delete_user**](docs/DbApi.md#delete_user) | **DELETE** /v1/tenants/{tenant}/db/users/{username} | Deletes a database user and all of its credentials.
+*DbApi* | [**list_grants**](docs/DbApi.md#list_grants) | **GET** /v1/tenants/{tenant}/db/grants | Lists every privilege grant in the tenant with the privileges and masked columns each role holds on each object.
+*DbApi* | [**list_rls**](docs/DbApi.md#list_rls) | **GET** /v1/tenants/{tenant}/db/rls | Lists every row-level security policy in the tenant.
+*DbApi* | [**list_roles**](docs/DbApi.md#list_roles) | **GET** /v1/tenants/{tenant}/db/roles | Lists the tenant&#39;s database roles, including the built-in system roles.
+*DbApi* | [**list_users**](docs/DbApi.md#list_users) | **GET** /v1/tenants/{tenant}/db/users | Lists the tenant&#39;s database users with their authentication method, roles and number of API keys.
+*DbApi* | [**matrix**](docs/DbApi.md#matrix) | **GET** /v1/tenants/{tenant}/db/matrix | Returns the effective privilege matrix: for each table, the privileges and masked columns every role resolves to, including inherited roles.
+*DbApi* | [**put_grant**](docs/DbApi.md#put_grant) | **POST** /v1/tenants/{tenant}/db/grants | Grants a role privileges on a table, or on every table with the object *, optionally masking columns, and replaces any existing grant for that role and object.
+*DbApi* | [**put_rls**](docs/DbApi.md#put_rls) | **POST** /v1/tenants/{tenant}/db/rls | Creates or replaces the row-level security policy that limits which rows of a table a role can read.
+*DbApi* | [**revoke_grant**](docs/DbApi.md#revoke_grant) | **DELETE** /v1/tenants/{tenant}/db/grants | Revokes a role&#39;s grant on an object, removing every privilege and column mask it carried.
+*DbApi* | [**rls_effective**](docs/DbApi.md#rls_effective) | **GET** /v1/tenants/{tenant}/db/rls/effective | Shows which row-level security policies apply to a given database user on a table, without running a query as that user.
+*DbApi* | [**rotate_user_key**](docs/DbApi.md#rotate_user_key) | **POST** /v1/tenants/{tenant}/db/users/{username}/api-key | Issues an additional API key for a database user; keys issued earlier remain valid.
+*DiagnosticsApi* | [**report_client_diagnostics**](docs/DiagnosticsApi.md#report_client_diagnostics) | **POST** /v1/tenants/{tenant}/diagnostics | Reports the SDK&#39;s own opt-in diagnostics for its calls to this database; the engine relays them into its telemetry.
+*FtsApi* | [**fts_aggs**](docs/FtsApi.md#fts_aggs) | **POST** /v1/tenants/{tenant}/fts/{table}/_aggs | Runs an aggregation tree over the documents a full-text query matches, or over every document indexed under the field.
+*FtsApi* | [**fts_delete_doc**](docs/FtsApi.md#fts_delete_doc) | **POST** /v1/tenants/{tenant}/fts/{table}/{field}/delete | Removes a document from a table field&#39;s full-text index, including its stored text and facet values.
+*FtsApi* | [**fts_dsl_search**](docs/FtsApi.md#fts_dsl_search) | **POST** /v1/tenants/{tenant}/fts/{table}/_search | Runs a structured full-text query against a table&#39;s index and returns ranked document ids with the total match count.
+*FtsApi* | [**fts_index**](docs/FtsApi.md#fts_index) | **POST** /v1/tenants/{tenant}/fts/{table}/{field} | Indexes the text of one document for full-text search on a table field.
+*FtsApi* | [**fts_index_json**](docs/FtsApi.md#fts_index_json) | **POST** /v1/tenants/{tenant}/fts/{table}/{field}/json | Indexes the string content of a JSON document for full-text search on a table field, optionally limited to the given paths.
+*FtsApi* | [**fts_install_stopwords**](docs/FtsApi.md#fts_install_stopwords) | **POST** /v1/tenants/{tenant}/fts/{table}/{field}/stopwords | Replaces the stopword list for a table field&#39;s full-text index.
+*FtsApi* | [**fts_install_synonyms**](docs/FtsApi.md#fts_install_synonyms) | **POST** /v1/tenants/{tenant}/fts/{table}/{field}/synonyms | Replaces the synonym map for a table field&#39;s full-text index.
+*FtsApi* | [**fts_list**](docs/FtsApi.md#fts_list) | **GET** /v1/tenants/{tenant}/fts | Lists every full-text indexed field in the tenant with its document count and average document length.
+*FtsApi* | [**fts_search**](docs/FtsApi.md#fts_search) | **GET** /v1/tenants/{tenant}/fts/{table}/{field} | Searches the full-text index of a table field by boolean match, phrase or BM25 relevance ranking.
+*FtsApi* | [**fts_set_doc**](docs/FtsApi.md#fts_set_doc) | **POST** /v1/tenants/{tenant}/fts/{table}/{field}/doc | Stores a document&#39;s original text and optional facet values on a full-text field for highlighting and faceting.
+*FtsApi* | [**fts_suggest**](docs/FtsApi.md#fts_suggest) | **POST** /v1/tenants/{tenant}/fts/{table}/_suggest | Returns completion, spelling-correction or phrase-correction suggestions from a full-text field&#39;s term dictionary.
+*GeoApi* | [**geo_config_get**](docs/GeoApi.md#geo_config_get) | **GET** /v1/tenants/{tenant}/geo/{schema} | Returns a schema&#39;s declared geospatial indexes with live point and index counts per field.
+*GeoApi* | [**geo_search**](docs/GeoApi.md#geo_search) | **GET** /v1/tenants/{tenant}/geo/{schema}/{field} | Searches a geospatial field by bounding box, radius or nearest neighbours.
+*GraphApi* | [**graph_all_simple_paths**](docs/GraphApi.md#graph_all_simple_paths) | **GET** /v1/tenants/{tenant}/graph/{schema}/all_simple_paths | Lists the simple paths from one node to another along a relation, up to a depth and path-count limit.
+*GraphApi* | [**graph_all_simple_paths_bidir**](docs/GraphApi.md#graph_all_simple_paths_bidir) | **GET** /v1/tenants/{tenant}/graph/{schema}/all_simple_paths_bidir | Lists the simple paths between two nodes when each hop may follow a relation edge in either direction.
+*GraphApi* | [**graph_betweenness**](docs/GraphApi.md#graph_betweenness) | **GET** /v1/tenants/{tenant}/graph/{schema}/betweenness | Scores every node of a graph schema by betweenness centrality, exactly or by sampling.
+*GraphApi* | [**graph_bfs**](docs/GraphApi.md#graph_bfs) | **GET** /v1/tenants/{tenant}/graph/{schema}/bfs | Walks a relation breadth-first from a node and returns each node reached with its depth.
+*GraphApi* | [**graph_components**](docs/GraphApi.md#graph_components) | **GET** /v1/tenants/{tenant}/graph/{schema}/components | Labels every node in a graph schema with its connected component, treating a self-relation as undirected.
+*GraphApi* | [**graph_dangling**](docs/GraphApi.md#graph_dangling) | **GET** /v1/tenants/{tenant}/graph/{schema}/dangling | Reports edges whose endpoint rows no longer exist for a relation, in bounded, resumable pages.
+*GraphApi* | [**graph_dijkstra**](docs/GraphApi.md#graph_dijkstra) | **GET** /v1/tenants/{tenant}/graph/{schema}/dijkstra | Returns the lowest total weight of a path between two nodes, using caller-supplied edge weights.
+*GraphApi* | [**graph_eigenvector_centrality**](docs/GraphApi.md#graph_eigenvector_centrality) | **GET** /v1/tenants/{tenant}/graph/{schema}/eigenvector_centrality | Scores every node of a graph schema by eigenvector centrality.
+*GraphApi* | [**graph_graphsage**](docs/GraphApi.md#graph_graphsage) | **POST** /v1/tenants/{tenant}/graph/{schema}/graphsage | Trains attribute-aware GraphSAGE node embeddings over a graph schema and optionally persists them for similarity search.
+*GraphApi* | [**graph_graphsage_topk**](docs/GraphApi.md#graph_graphsage_topk) | **GET** /v1/tenants/{tenant}/graph/{schema}/graphsage/{rel}/topk | Returns the nodes most similar to a given node using the persisted GraphSAGE embeddings.
+*GraphApi* | [**graph_k_shortest**](docs/GraphApi.md#graph_k_shortest) | **GET** /v1/tenants/{tenant}/graph/{schema}/k-shortest | Returns up to k loop-free shortest paths between two nodes, ranked by cost.
+*GraphApi* | [**graph_label_propagation**](docs/GraphApi.md#graph_label_propagation) | **GET** /v1/tenants/{tenant}/graph/{schema}/label_propagation | Groups the nodes of a graph schema into communities by label propagation.
+*GraphApi* | [**graph_louvain**](docs/GraphApi.md#graph_louvain) | **GET** /v1/tenants/{tenant}/graph/{schema}/louvain | Detects communities in a graph schema with the Louvain modularity algorithm.
+*GraphApi* | [**graph_neighbors**](docs/GraphApi.md#graph_neighbors) | **GET** /v1/tenants/{tenant}/graph/{schema}/neighbors | Returns the one-hop neighbours of a node along a relation.
+*GraphApi* | [**graph_node2vec**](docs/GraphApi.md#graph_node2vec) | **POST** /v1/tenants/{tenant}/graph/{schema}/node2vec | Trains Node2Vec node embeddings over a graph schema and optionally persists them for similarity search.
+*GraphApi* | [**graph_node2vec_topk**](docs/GraphApi.md#graph_node2vec_topk) | **GET** /v1/tenants/{tenant}/graph/{schema}/node2vec/{rel}/topk | Returns the nodes most similar to a given node using the persisted Node2Vec embeddings.
+*GraphApi* | [**graph_pagerank**](docs/GraphApi.md#graph_pagerank) | **GET** /v1/tenants/{tenant}/graph/{schema}/pagerank | Scores a set of nodes by PageRank over a relation.
+*GraphApi* | [**graph_path**](docs/GraphApi.md#graph_path) | **GET** /v1/tenants/{tenant}/graph/{schema}/path | Reports whether one node can reach another along a relation within a depth limit.
+*GraphApi* | [**graph_random_walk**](docs/GraphApi.md#graph_random_walk) | **GET** /v1/tenants/{tenant}/graph/{schema}/random-walk | Performs a seeded random walk from a start node, optionally Node2Vec-biased.
+*GraphApi* | [**graph_reverse**](docs/GraphApi.md#graph_reverse) | **GET** /v1/tenants/{tenant}/graph/{schema}/reverse | Returns the nodes that point to a node along a relation (its inbound edges).
+*GraphApi* | [**graph_triangles**](docs/GraphApi.md#graph_triangles) | **GET** /v1/tenants/{tenant}/graph/{schema}/triangles | Enumerates every triangle in a graph schema&#39;s self-relation.
+*IngestApi* | [**ingest_file**](docs/IngestApi.md#ingest_file) | **POST** /v1/tenants/{tenant}/ingest/files/{schema} | Uploads a CSV or NDJSON file as multipart form data and loads its rows into an existing table.
+*IngestApi* | [**mysql_ingest_sync**](docs/IngestApi.md#mysql_ingest_sync) | **POST** /v1/tenants/{tenant}/ingest/mysql/sync | Copies one or more tables from a MySQL database into the tenant, creating each destination table if it does not exist, in full or incremental mode.
+*IngestApi* | [**pg_ingest_sync**](docs/IngestApi.md#pg_ingest_sync) | **POST** /v1/tenants/{tenant}/ingest/postgres/sync | Copies tables from an allow-listed external PostgreSQL database into the tenant, as a full copy or an incremental sync.
+*IngestApi* | [**s3_ingest_sync**](docs/IngestApi.md#s3_ingest_sync) | **POST** /v1/tenants/{tenant}/ingest/s3/sync | Loads every CSV and NDJSON object under a prefix of an S3-compatible object storage bucket into an existing table.
+*MigrationsApi* | [**migrations_abort**](docs/MigrationsApi.md#migrations_abort) | **POST** /v1/tenants/{tenant}/migrations/{id}/abort | Aborts an in-progress migration and restores the table&#39;s previous shape.
+*MigrationsApi* | [**migrations_audit**](docs/MigrationsApi.md#migrations_audit) | **GET** /v1/tenants/{tenant}/migrations/_audit | Returns the audit log of migration state transitions for the tenant.
+*MigrationsApi* | [**migrations_cutover**](docs/MigrationsApi.md#migrations_cutover) | **POST** /v1/tenants/{tenant}/migrations/{id}/cutover | Switches a table over to its migrated shape and completes the migration.
+*MigrationsApi* | [**migrations_get**](docs/MigrationsApi.md#migrations_get) | **GET** /v1/tenants/{tenant}/migrations/{id} | Returns the state and progress of one online schema migration.
+*MigrationsApi* | [**migrations_list**](docs/MigrationsApi.md#migrations_list) | **GET** /v1/tenants/{tenant}/migrations | Lists the tenant&#39;s online schema migrations that the caller may see.
+*MigrationsApi* | [**migrations_submit**](docs/MigrationsApi.md#migrations_submit) | **POST** /v1/tenants/{tenant}/migrations | Starts an online schema migration that rewrites a table to its new shape in the background.
+*QueryApi* | [**query_exec**](docs/QueryApi.md#query_exec) | **POST** /v1/tenants/{tenant}/query | Executes a read query plan and returns the matching rows.
+*QueryStatsApi* | [**query_stats**](docs/QueryStatsApi.md#query_stats) | **GET** /v1/tenants/{tenant}/query-stats | Returns per-fingerprint statistics for the tenant&#39;s read queries (call count, latency percentiles, average rows and cache-hit rate), collected in memory since the server last started.
+*RowsApi* | [**row_delete**](docs/RowsApi.md#row_delete) | **DELETE** /v1/tenants/{tenant}/rows/{schema}/{pk} | Deletes one row by primary key outside a transaction; deleting a missing row succeeds with deleted set to false.
+*RowsApi* | [**row_get**](docs/RowsApi.md#row_get) | **GET** /v1/tenants/{tenant}/rows/{schema}/{pk} | Fetches one row by its primary key.
+*RowsApi* | [**row_put_cas**](docs/RowsApi.md#row_put_cas) | **PUT** /v1/tenants/{tenant}/rows/{schema}/{pk} | Writes one row by primary key, optionally as a compare-and-set against the row version given in If-Match.
+*RowsApi* | [**rows_put**](docs/RowsApi.md#rows_put) | **POST** /v1/tenants/{tenant}/rows/{schema} | Writes one row, inserting it or replacing the row that has the same primary key.
+*RowsApi* | [**rows_put_batch**](docs/RowsApi.md#rows_put_batch) | **POST** /v1/tenants/{tenant}/rows/{schema}/_batch | Writes many rows in one request, from a JSON array or a newline-delimited JSON stream.
+*SchemasApi* | [**schemas_delete**](docs/SchemasApi.md#schemas_delete) | **DELETE** /v1/tenants/{tenant}/schemas/{id} | Deletes one table and irreversibly purges all of its rows, indexes and related data.
+*SchemasApi* | [**schemas_delete_all**](docs/SchemasApi.md#schemas_delete_all) | **DELETE** /v1/tenants/{tenant}/schemas | Deletes every table in the tenant and irreversibly purges all of their data.
+*SchemasApi* | [**schemas_get**](docs/SchemasApi.md#schemas_get) | **GET** /v1/tenants/{tenant}/schemas/{id} | Returns the registered TOML manifest for one table.
+*SchemasApi* | [**schemas_list**](docs/SchemasApi.md#schemas_list) | **GET** /v1/tenants/{tenant}/schemas | Lists the table ids registered for the tenant that the caller may see.
+*SchemasApi* | [**schemas_register**](docs/SchemasApi.md#schemas_register) | **POST** /v1/tenants/{tenant}/schemas | Registers a new table from a TOML manifest.
+*SlowQueriesApi* | [**slow_queries**](docs/SlowQueriesApi.md#slow_queries) | **GET** /v1/tenants/{tenant}/slow-queries | Returns the tenant&#39;s most recent read-query executions with their text and latency, newest first, optionally filtered to those at or above a latency threshold.
+*SqlApi* | [**mv_drop**](docs/SqlApi.md#mv_drop) | **DELETE** /v1/tenants/{tenant}/sql/materialized-views/{name} | Drops a materialized view and everything stored for it.
+*SqlApi* | [**mv_install**](docs/SqlApi.md#mv_install) | **POST** /v1/tenants/{tenant}/sql/materialized-views | Creates a materialized view from a SQL SELECT and materializes its initial contents.
+*SqlApi* | [**mv_list**](docs/SqlApi.md#mv_list) | **GET** /v1/tenants/{tenant}/sql/materialized-views | Lists the materialized views installed for the tenant with their refresh mode and base table.
+*SqlApi* | [**mv_read**](docs/SqlApi.md#mv_read) | **GET** /v1/tenants/{tenant}/sql/materialized-views/{name} | Returns the rows of a materialized view, filtered and masked by the caller&#39;s row-level policies.
+*SqlApi* | [**mv_refresh**](docs/SqlApi.md#mv_refresh) | **POST** /v1/tenants/{tenant}/sql/materialized-views/{name}/refresh | Recomputes a materialized view from its base table and replaces its stored rows.
+*SqlApi* | [**sql_exec**](docs/SqlApi.md#sql_exec) | **POST** /v1/tenants/{tenant}/sql | Executes a SQL statement or a semicolon-separated batch and returns rows for queries or a result summary for writes and DDL.
+*SystemApi* | [**capabilities**](docs/SystemApi.md#capabilities) | **GET** /v1/capabilities | Returns the live support matrix of features, index kinds, SQL constructs and wire protocols this engine serves.
+*SystemApi* | [**health**](docs/SystemApi.md#health) | **GET** /health | Reports that the engine process is alive, with a constant JSON body.
+*SystemApi* | [**ready**](docs/SystemApi.md#ready) | **GET** /ready | Reports whether the engine can serve traffic, including write and read readiness and any pressure conditions.
+*SystemApi* | [**version**](docs/SystemApi.md#version) | **GET** /v1/version | Returns the engine&#39;s version, build stamps and storage health.
+*TxApi* | [**tx_begin**](docs/TxApi.md#tx_begin) | **POST** /v1/tenants/{tenant}/tx/begin | Opens a multi-statement transaction at snapshot or serializable isolation and returns its id.
+*TxApi* | [**tx_commit**](docs/TxApi.md#tx_commit) | **POST** /v1/tenants/{tenant}/tx/{tx_id}/commit | Atomically commits every write buffered in the transaction, enforcing foreign-key, check and unique constraints.
+*TxApi* | [**tx_query**](docs/TxApi.md#tx_query) | **POST** /v1/tenants/{tenant}/tx/{tx_id}/query | Runs a read-only query plan inside the transaction at its snapshot, including the transaction&#39;s own buffered writes.
+*TxApi* | [**tx_rollback**](docs/TxApi.md#tx_rollback) | **POST** /v1/tenants/{tenant}/tx/{tx_id}/rollback | Discards every write buffered in the transaction and closes it.
+*TxApi* | [**tx_row_delete**](docs/TxApi.md#tx_row_delete) | **DELETE** /v1/tenants/{tenant}/tx/{tx_id}/rows/{schema}/{pk} | Buffers the deletion of one row, addressed by primary key, in the transaction.
+*TxApi* | [**tx_row_get**](docs/TxApi.md#tx_row_get) | **GET** /v1/tenants/{tenant}/tx/{tx_id}/rows/{schema}/{pk} | Reads one row by primary key at the transaction&#39;s snapshot, seeing the transaction&#39;s own buffered writes first.
+*TxApi* | [**tx_row_put**](docs/TxApi.md#tx_row_put) | **POST** /v1/tenants/{tenant}/tx/{tx_id}/rows/{schema} | Buffers an insert-or-replace of one row in the transaction; it becomes visible to others only after commit.
+*TxApi* | [**tx_status**](docs/TxApi.md#tx_status) | **GET** /v1/tenants/{tenant}/tx/{tx_id} | Returns the current state, snapshot tick and isolation level of a transaction.
+*UsageApi* | [**usage**](docs/UsageApi.md#usage) | **GET** /v1/tenants/{tenant}/usage | Returns the tenant&#39;s configuration, limits and live usage counters.
+*VectorApi* | [**create_ivf_pq_index**](docs/VectorApi.md#create_ivf_pq_index) | **POST** /v1/tenants/{tenant}/vector/{table}/create-ivf-pq-index | Builds a compressed IVF-PQ vector index for a table from a named preset, training it on the table&#39;s stored vectors.
+*VectorApi* | [**vector_delete**](docs/VectorApi.md#vector_delete) | **DELETE** /v1/tenants/{tenant}/vector/{table}/{vec_id} | Deletes one vector from a vector table by id; deleting an id that does not exist still succeeds with deleted set to false.
+*VectorApi* | [**vector_delete_bulk**](docs/VectorApi.md#vector_delete_bulk) | **POST** /v1/tenants/{tenant}/vector/{table}/delete-bulk | Deletes up to 10,000 vectors from a vector table in one request and reports how many were deleted and how many were not found.
+*VectorApi* | [**vector_put**](docs/VectorApi.md#vector_put) | **POST** /v1/tenants/{tenant}/vector/{table}/put | Stores one dense vector, with optional metadata, in a vector collection.
+*VectorApi* | [**vector_put_bulk**](docs/VectorApi.md#vector_put_bulk) | **POST** /v1/tenants/{tenant}/vector/{table}/put_bulk | Stores up to 100,000 dense vectors in a vector collection as one atomic batch.
+*VectorApi* | [**vector_put_sparse**](docs/VectorApi.md#vector_put_sparse) | **POST** /v1/tenants/{tenant}/vector/{table}/put_sparse | Stores one sparse vector (indices, values and dimension), with optional metadata, in a vector collection.
+*VectorApi* | [**vector_topk**](docs/VectorApi.md#vector_topk) | **POST** /v1/tenants/{tenant}/vector/{table}/topk | Returns the k stored vectors nearest to a query vector, optionally filtered by metadata.
+*VectorApi* | [**vector_topk_explain**](docs/VectorApi.md#vector_topk_explain) | **POST** /v1/tenants/{tenant}/vector/{table}/topk_explain | Runs a vector similarity search and returns its hits together with the resolved search configuration.
+*VectorApi* | [**vector_topk_hybrid**](docs/VectorApi.md#vector_topk_hybrid) | **POST** /v1/tenants/{tenant}/vector/{table}/topk_hybrid | Runs a dense and a sparse nearest-neighbour search in one request and returns a single list fused by Reciprocal Rank Fusion.
+*VectorApi* | [**vector_topk_sparse**](docs/VectorApi.md#vector_topk_sparse) | **POST** /v1/tenants/{tenant}/vector/{table}/topk_sparse | Returns the k stored sparse vectors most similar to a sparse query vector, optionally filtered by metadata.
+*VectorIndexesApi* | [**configure_index**](docs/VectorIndexesApi.md#configure_index) | **PATCH** /v1/tenants/{tenant}/vector-indexes/{index} | Updates the deletion protection and tags of a vector index.
+*VectorIndexesApi* | [**configure_namespace**](docs/VectorIndexesApi.md#configure_namespace) | **POST** /v1/tenants/{tenant}/vector-indexes/{index}/namespaces/configure | Sets or removes the declared record capacity of a namespace.
+*VectorIndexesApi* | [**count**](docs/VectorIndexesApi.md#count) | **POST** /v1/tenants/{tenant}/vector-indexes/{index}/records/count | Counts the records of a namespace, exactly, optionally matching a metadata filter.
+*VectorIndexesApi* | [**create_index**](docs/VectorIndexesApi.md#create_index) | **POST** /v1/tenants/{tenant}/vector-indexes | Creates a vector index with its dense, sparse and text configuration, holding an empty default namespace.
+*VectorIndexesApi* | [**create_namespace**](docs/VectorIndexesApi.md#create_namespace) | **POST** /v1/tenants/{tenant}/vector-indexes/{index}/namespaces/create | Creates a namespace in a vector index, optionally with a declared record capacity.
+*VectorIndexesApi* | [**delete**](docs/VectorIndexesApi.md#delete) | **POST** /v1/tenants/{tenant}/vector-indexes/{index}/records/delete | Deletes records by id, or every record of a namespace with all: true.
+*VectorIndexesApi* | [**delete_index**](docs/VectorIndexesApi.md#delete_index) | **DELETE** /v1/tenants/{tenant}/vector-indexes/{index} | Deletes a vector index; its namespaces are erased in the background.
+*VectorIndexesApi* | [**delete_namespace**](docs/VectorIndexesApi.md#delete_namespace) | **POST** /v1/tenants/{tenant}/vector-indexes/{index}/namespaces/delete | Deletes a namespace and erases its records in the background.
+*VectorIndexesApi* | [**describe_index**](docs/VectorIndexesApi.md#describe_index) | **GET** /v1/tenants/{tenant}/vector-indexes/{index} | Returns the configuration of a vector index, addressed by its id or name.
+*VectorIndexesApi* | [**describe_namespace**](docs/VectorIndexesApi.md#describe_namespace) | **POST** /v1/tenants/{tenant}/vector-indexes/{index}/namespaces/describe | Returns a namespace of a vector index with its record counts.
+*VectorIndexesApi* | [**fetch**](docs/VectorIndexesApi.md#fetch) | **POST** /v1/tenants/{tenant}/vector-indexes/{index}/records/fetch | Fetches up to 1,000 records of a namespace by id.
+*VectorIndexesApi* | [**fetch_by_filter**](docs/VectorIndexesApi.md#fetch_by_filter) | **POST** /v1/tenants/{tenant}/vector-indexes/{index}/records/fetch-by-filter | Fetches the records of a namespace that match a metadata filter, one page at a time.
+*VectorIndexesApi* | [**index_stats**](docs/VectorIndexesApi.md#index_stats) | **GET** /v1/tenants/{tenant}/vector-indexes/{index}/stats | Returns per-namespace record counts and totals for a vector index.
+*VectorIndexesApi* | [**list_ids**](docs/VectorIndexesApi.md#list_ids) | **POST** /v1/tenants/{tenant}/vector-indexes/{index}/records/list-ids | Lists the record ids of a namespace in byte order, optionally under a prefix, one page at a time.
+*VectorIndexesApi* | [**list_indexes**](docs/VectorIndexesApi.md#list_indexes) | **POST** /v1/tenants/{tenant}/vector-indexes/list | Lists the vector indexes the caller can see, in name order, with cursor pagination.
+*VectorIndexesApi* | [**list_namespaces**](docs/VectorIndexesApi.md#list_namespaces) | **POST** /v1/tenants/{tenant}/vector-indexes/{index}/namespaces/list | Lists the namespaces of a vector index in name order, with record counts and cursor pagination.
+*VectorIndexesApi* | [**search**](docs/VectorIndexesApi.md#search) | **POST** /v1/tenants/{tenant}/vector-indexes/{index_id}/search | Searches a namespace of a vector index with dense, sparse, lexical or hybrid ranking and an optional metadata filter.
+*VectorIndexesApi* | [**update**](docs/VectorIndexesApi.md#update) | **POST** /v1/tenants/{tenant}/vector-indexes/{index}/records/update | Updates one record by id: metadata, dense or sparse values, and text, optionally conditional on a revision token.
+*VectorIndexesApi* | [**upsert**](docs/VectorIndexesApi.md#upsert) | **POST** /v1/tenants/{tenant}/vector-indexes/{index}/records/upsert | Inserts or replaces up to 1,000 records in a namespace, creating the namespace if it does not exist.
+*VectorsApi* | [**vectors_list**](docs/VectorsApi.md#vectors_list) | **GET** /v1/tenants/{tenant}/vectors | Lists the tenant&#39;s vector tables with their live vector counts.
+*WatchApi* | [**watch_sse**](docs/WatchApi.md#watch_sse) | **GET** /v1/tenants/{tenant}/watch | Streams the live result of a natural-language query as Server-Sent Events, re-sending it whenever the data changes.
+*WebhooksApi* | [**webhook_delete**](docs/WebhooksApi.md#webhook_delete) | **DELETE** /v1/tenants/{tenant}/webhooks/{hook_id} | Deletes a webhook registration, so later deliveries to that hook are refused.
+*WebhooksApi* | [**webhook_get**](docs/WebhooksApi.md#webhook_get) | **GET** /v1/tenants/{tenant}/webhooks/{hook_id} | Returns a registered webhook&#39;s configuration, including the name of its signing-secret setting but never the secret itself.
+*WebhooksApi* | [**webhook_put**](docs/WebhooksApi.md#webhook_put) | **PUT** /v1/tenants/{tenant}/webhooks/{hook_id} | Registers or replaces a webhook that maps incoming JSON payloads onto rows of an existing table, with optional HMAC signature verification.
+*WebhooksApi* | [**webhook_receive**](docs/WebhooksApi.md#webhook_receive) | **POST** /v1/tenants/{tenant}/webhooks/{hook_id} | Receives a delivery for a registered webhook: when the hook has a signature block, the request must carry an HMAC-SHA256 signature of the raw body in the configured header (a missing or invalid signature returns 401), the JSON payload is mapped through the hook&#39;s field mapping, and the resulting rows are written to the destination table; the request also passes the standard bearer-token check.
+
+
+## Documentation For Models
+
+ - [Ask200Response](docs/Ask200Response.md)
+ - [Ask200ResponseExplain](docs/Ask200ResponseExplain.md)
+ - [AskRequest](docs/AskRequest.md)
+ - [AuditExport200Response](docs/AuditExport200Response.md)
+ - [AuditList200Response](docs/AuditList200Response.md)
+ - [AuditList200ResponseEntriesInner](docs/AuditList200ResponseEntriesInner.md)
+ - [AuditVerify200Response](docs/AuditVerify200Response.md)
+ - [Capabilities200Response](docs/Capabilities200Response.md)
+ - [ConfigureIndexRequest](docs/ConfigureIndexRequest.md)
+ - [ConfigureNamespace200Response](docs/ConfigureNamespace200Response.md)
+ - [ConfigureNamespace200ResponsePosition](docs/ConfigureNamespace200ResponsePosition.md)
+ - [ConfigureNamespaceRequest](docs/ConfigureNamespaceRequest.md)
+ - [Count200Response](docs/Count200Response.md)
+ - [CountRequest](docs/CountRequest.md)
+ - [CreateIndex201Response](docs/CreateIndex201Response.md)
+ - [CreateIndex201ResponseEmbedding](docs/CreateIndex201ResponseEmbedding.md)
+ - [CreateIndexRequest](docs/CreateIndexRequest.md)
+ - [CreateIndexRequestTextFieldsInner](docs/CreateIndexRequestTextFieldsInner.md)
+ - [CreateIvfPqIndex200Response](docs/CreateIvfPqIndex200Response.md)
+ - [CreateIvfPqIndexRequest](docs/CreateIvfPqIndexRequest.md)
+ - [CreateNamespace201Response](docs/CreateNamespace201Response.md)
+ - [CreateNamespaceRequest](docs/CreateNamespaceRequest.md)
+ - [CreateRole200Response](docs/CreateRole200Response.md)
+ - [CreateRoleRequest](docs/CreateRoleRequest.md)
+ - [CreateUser200Response](docs/CreateUser200Response.md)
+ - [CreateUserRequest](docs/CreateUserRequest.md)
+ - [CypherExec200Response](docs/CypherExec200Response.md)
+ - [CypherExecRequest](docs/CypherExecRequest.md)
+ - [Delete200Response](docs/Delete200Response.md)
+ - [DeleteIndex202Response](docs/DeleteIndex202Response.md)
+ - [DeleteNamespace202Response](docs/DeleteNamespace202Response.md)
+ - [DeleteNamespace202ResponseReceipt](docs/DeleteNamespace202ResponseReceipt.md)
+ - [DeleteNamespace202ResponseReceiptRecordsInner](docs/DeleteNamespace202ResponseReceiptRecordsInner.md)
+ - [DeleteNamespace202ResponseReceiptRestoreEpoch](docs/DeleteNamespace202ResponseReceiptRestoreEpoch.md)
+ - [DeleteNamespaceRequest](docs/DeleteNamespaceRequest.md)
+ - [DeleteRequest](docs/DeleteRequest.md)
+ - [DeleteRls200Response](docs/DeleteRls200Response.md)
+ - [DeleteRole200Response](docs/DeleteRole200Response.md)
+ - [DeleteRole200ResponseCascaded](docs/DeleteRole200ResponseCascaded.md)
+ - [DeleteUser200Response](docs/DeleteUser200Response.md)
+ - [DescribeNamespaceRequest](docs/DescribeNamespaceRequest.md)
+ - [Error](docs/Error.md)
+ - [ErrorDetail](docs/ErrorDetail.md)
+ - [ErrorError](docs/ErrorError.md)
+ - [Fetch200Response](docs/Fetch200Response.md)
+ - [Fetch200ResponseRecords](docs/Fetch200ResponseRecords.md)
+ - [Fetch200ResponseRecordsText](docs/Fetch200ResponseRecordsText.md)
+ - [FetchByFilter200Response](docs/FetchByFilter200Response.md)
+ - [FetchByFilterRequest](docs/FetchByFilterRequest.md)
+ - [FetchRequest](docs/FetchRequest.md)
+ - [FtsAggs200Response](docs/FtsAggs200Response.md)
+ - [FtsAggsRequest](docs/FtsAggsRequest.md)
+ - [FtsAggsRequestSearch](docs/FtsAggsRequestSearch.md)
+ - [FtsAggsRequestSearchParams](docs/FtsAggsRequestSearchParams.md)
+ - [FtsAggsRequestSearchSearchAfter](docs/FtsAggsRequestSearchSearchAfter.md)
+ - [FtsAggsRequestSearchSortInner](docs/FtsAggsRequestSearchSortInner.md)
+ - [FtsDeleteDocRequest](docs/FtsDeleteDocRequest.md)
+ - [FtsDslSearch200Response](docs/FtsDslSearch200Response.md)
+ - [FtsDslSearch200ResponseHitsInner](docs/FtsDslSearch200ResponseHitsInner.md)
+ - [FtsDslSearchRequest](docs/FtsDslSearchRequest.md)
+ - [FtsIndexJsonRequest](docs/FtsIndexJsonRequest.md)
+ - [FtsIndexRequest](docs/FtsIndexRequest.md)
+ - [FtsInstallStopwordsRequest](docs/FtsInstallStopwordsRequest.md)
+ - [FtsInstallSynonymsRequest](docs/FtsInstallSynonymsRequest.md)
+ - [FtsList200Response](docs/FtsList200Response.md)
+ - [FtsList200ResponseFieldsInner](docs/FtsList200ResponseFieldsInner.md)
+ - [FtsSetDocRequest](docs/FtsSetDocRequest.md)
+ - [FtsSuggest200Response](docs/FtsSuggest200Response.md)
+ - [FtsSuggest200ResponseCompletionsInner](docs/FtsSuggest200ResponseCompletionsInner.md)
+ - [FtsSuggest200ResponseEntriesInner](docs/FtsSuggest200ResponseEntriesInner.md)
+ - [FtsSuggest200ResponseEntriesInnerOptionsInner](docs/FtsSuggest200ResponseEntriesInnerOptionsInner.md)
+ - [FtsSuggest200ResponseOptionsInner](docs/FtsSuggest200ResponseOptionsInner.md)
+ - [FtsSuggestRequest](docs/FtsSuggestRequest.md)
+ - [GeoConfigGet200Response](docs/GeoConfigGet200Response.md)
+ - [GeoConfigGet200ResponseFieldsInner](docs/GeoConfigGet200ResponseFieldsInner.md)
+ - [GeoSearch200Response](docs/GeoSearch200Response.md)
+ - [GeoSearch200ResponseHitsInner](docs/GeoSearch200ResponseHitsInner.md)
+ - [GraphAllSimplePaths200ResponseInner](docs/GraphAllSimplePaths200ResponseInner.md)
+ - [GraphBetweenness200ResponseInner](docs/GraphBetweenness200ResponseInner.md)
+ - [GraphBfs200ResponseInner](docs/GraphBfs200ResponseInner.md)
+ - [GraphComponents200ResponseInner](docs/GraphComponents200ResponseInner.md)
+ - [GraphDangling200Response](docs/GraphDangling200Response.md)
+ - [GraphDangling200ResponseDanglingInner](docs/GraphDangling200ResponseDanglingInner.md)
+ - [GraphDangling200ResponseDanglingInnerMissingInner](docs/GraphDangling200ResponseDanglingInnerMissingInner.md)
+ - [GraphDangling200ResponseEndpointsInner](docs/GraphDangling200ResponseEndpointsInner.md)
+ - [GraphDijkstra200Response](docs/GraphDijkstra200Response.md)
+ - [GraphEigenvectorCentrality200ResponseInner](docs/GraphEigenvectorCentrality200ResponseInner.md)
+ - [GraphGraphsage200Response](docs/GraphGraphsage200Response.md)
+ - [GraphGraphsageRequest](docs/GraphGraphsageRequest.md)
+ - [GraphGraphsageTopk200ResponseInner](docs/GraphGraphsageTopk200ResponseInner.md)
+ - [GraphKShortest200Response](docs/GraphKShortest200Response.md)
+ - [GraphKShortest200ResponsePathsInner](docs/GraphKShortest200ResponsePathsInner.md)
+ - [GraphLabelPropagation200ResponseInner](docs/GraphLabelPropagation200ResponseInner.md)
+ - [GraphLouvain200Response](docs/GraphLouvain200Response.md)
+ - [GraphLouvain200ResponseCommunitiesInner](docs/GraphLouvain200ResponseCommunitiesInner.md)
+ - [GraphNode2vec200Response](docs/GraphNode2vec200Response.md)
+ - [GraphNode2vecRequest](docs/GraphNode2vecRequest.md)
+ - [GraphPath200Response](docs/GraphPath200Response.md)
+ - [GraphRandomWalk200Response](docs/GraphRandomWalk200Response.md)
+ - [GraphTriangles200ResponseInner](docs/GraphTriangles200ResponseInner.md)
+ - [Health200Response](docs/Health200Response.md)
+ - [IndexStats200Response](docs/IndexStats200Response.md)
+ - [IndexStats200ResponseNamespacesInner](docs/IndexStats200ResponseNamespacesInner.md)
+ - [IngestFile200Response](docs/IngestFile200Response.md)
+ - [ListGrants200Response](docs/ListGrants200Response.md)
+ - [ListGrants200ResponseGrantsInner](docs/ListGrants200ResponseGrantsInner.md)
+ - [ListIds200Response](docs/ListIds200Response.md)
+ - [ListIdsRequest](docs/ListIdsRequest.md)
+ - [ListIndexes200Response](docs/ListIndexes200Response.md)
+ - [ListIndexes200ResponseIndexesInner](docs/ListIndexes200ResponseIndexesInner.md)
+ - [ListIndexesRequest](docs/ListIndexesRequest.md)
+ - [ListNamespaces200Response](docs/ListNamespaces200Response.md)
+ - [ListNamespacesRequest](docs/ListNamespacesRequest.md)
+ - [ListRls200Response](docs/ListRls200Response.md)
+ - [ListRls200ResponsePoliciesInner](docs/ListRls200ResponsePoliciesInner.md)
+ - [ListRoles200Response](docs/ListRoles200Response.md)
+ - [ListRoles200ResponseRolesInner](docs/ListRoles200ResponseRolesInner.md)
+ - [ListUsers200Response](docs/ListUsers200Response.md)
+ - [ListUsers200ResponseUsersInner](docs/ListUsers200ResponseUsersInner.md)
+ - [Matrix200Response](docs/Matrix200Response.md)
+ - [Matrix200ResponseObjectsInner](docs/Matrix200ResponseObjectsInner.md)
+ - [Matrix200ResponseObjectsInnerRoles](docs/Matrix200ResponseObjectsInnerRoles.md)
+ - [MigrationsAbort200Response](docs/MigrationsAbort200Response.md)
+ - [MigrationsAudit200ResponseInner](docs/MigrationsAudit200ResponseInner.md)
+ - [MigrationsList200ResponseInner](docs/MigrationsList200ResponseInner.md)
+ - [MigrationsList200ResponseInnerDiffInner](docs/MigrationsList200ResponseInnerDiffInner.md)
+ - [MigrationsList200ResponseInnerDiffInnerAddColumn](docs/MigrationsList200ResponseInnerDiffInnerAddColumn.md)
+ - [MigrationsList200ResponseInnerDiffInnerChangeColumnType](docs/MigrationsList200ResponseInnerDiffInnerChangeColumnType.md)
+ - [MigrationsList200ResponseInnerDiffInnerChangeExtractionPath](docs/MigrationsList200ResponseInnerDiffInnerChangeExtractionPath.md)
+ - [MigrationsList200ResponseInnerDiffInnerDropColumn](docs/MigrationsList200ResponseInnerDiffInnerDropColumn.md)
+ - [MigrationsList200ResponseInnerDiffInnerRenameColumn](docs/MigrationsList200ResponseInnerDiffInnerRenameColumn.md)
+ - [MigrationsList200ResponseInnerDiffInnerSetColumnDefault](docs/MigrationsList200ResponseInnerDiffInnerSetColumnDefault.md)
+ - [MigrationsList200ResponseInnerDiffInnerSetColumnNullability](docs/MigrationsList200ResponseInnerDiffInnerSetColumnNullability.md)
+ - [MigrationsList200ResponseInnerProgress](docs/MigrationsList200ResponseInnerProgress.md)
+ - [MigrationsSubmitRequest](docs/MigrationsSubmitRequest.md)
+ - [MvDrop200Response](docs/MvDrop200Response.md)
+ - [MvInstall200Response](docs/MvInstall200Response.md)
+ - [MvInstallRequest](docs/MvInstallRequest.md)
+ - [MvList200ResponseInner](docs/MvList200ResponseInner.md)
+ - [MvRead200Response](docs/MvRead200Response.md)
+ - [MvRefresh200Response](docs/MvRefresh200Response.md)
+ - [MysqlIngestSync200Response](docs/MysqlIngestSync200Response.md)
+ - [MysqlIngestSync200ResponseResultsInner](docs/MysqlIngestSync200ResponseResultsInner.md)
+ - [MysqlIngestSyncRequest](docs/MysqlIngestSyncRequest.md)
+ - [MysqlIngestSyncRequestTablesInner](docs/MysqlIngestSyncRequestTablesInner.md)
+ - [PgIngestSync200Response](docs/PgIngestSync200Response.md)
+ - [PgIngestSync200ResponseResultsInner](docs/PgIngestSync200ResponseResultsInner.md)
+ - [PgIngestSyncRequest](docs/PgIngestSyncRequest.md)
+ - [PgIngestSyncRequestTablesInner](docs/PgIngestSyncRequestTablesInner.md)
+ - [PutGrant200Response](docs/PutGrant200Response.md)
+ - [PutGrantRequest](docs/PutGrantRequest.md)
+ - [PutRls200Response](docs/PutRls200Response.md)
+ - [PutRlsRequest](docs/PutRlsRequest.md)
+ - [QueryExecRequest](docs/QueryExecRequest.md)
+ - [QueryStats200Response](docs/QueryStats200Response.md)
+ - [QueryStats200ResponseFingerprintsInner](docs/QueryStats200ResponseFingerprintsInner.md)
+ - [Ready200Response](docs/Ready200Response.md)
+ - [Ready200ResponseStorage](docs/Ready200ResponseStorage.md)
+ - [ReportClientDiagnostics202Response](docs/ReportClientDiagnostics202Response.md)
+ - [ReportClientDiagnosticsRequest](docs/ReportClientDiagnosticsRequest.md)
+ - [ReportClientDiagnosticsRequestEventsInner](docs/ReportClientDiagnosticsRequestEventsInner.md)
+ - [RevokeGrant200Response](docs/RevokeGrant200Response.md)
+ - [RevokeGrantRequest](docs/RevokeGrantRequest.md)
+ - [RlsEffective200Response](docs/RlsEffective200Response.md)
+ - [RlsEffective200ResponsePoliciesInner](docs/RlsEffective200ResponsePoliciesInner.md)
+ - [RotateUserKey200Response](docs/RotateUserKey200Response.md)
+ - [RowDelete200Response](docs/RowDelete200Response.md)
+ - [RowPutCas200Response](docs/RowPutCas200Response.md)
+ - [RowsPut200Response](docs/RowsPut200Response.md)
+ - [RowsPutBatch200Response](docs/RowsPutBatch200Response.md)
+ - [S3IngestSync200Response](docs/S3IngestSync200Response.md)
+ - [S3IngestSync200ResponsePerObjectInner](docs/S3IngestSync200ResponsePerObjectInner.md)
+ - [S3IngestSyncRequest](docs/S3IngestSyncRequest.md)
+ - [SchemasDelete200Response](docs/SchemasDelete200Response.md)
+ - [SchemasDeleteAll200Response](docs/SchemasDeleteAll200Response.md)
+ - [SchemasRegister200Response](docs/SchemasRegister200Response.md)
+ - [Search200Response](docs/Search200Response.md)
+ - [Search200ResponseCompleteness](docs/Search200ResponseCompleteness.md)
+ - [Search200ResponseFusion](docs/Search200ResponseFusion.md)
+ - [Search200ResponseHitsInner](docs/Search200ResponseHitsInner.md)
+ - [Search200ResponseHitsInnerComponentsInner](docs/Search200ResponseHitsInnerComponentsInner.md)
+ - [Search200ResponseHitsInnerSparseValues](docs/Search200ResponseHitsInnerSparseValues.md)
+ - [Search200ResponseLegsInner](docs/Search200ResponseLegsInner.md)
+ - [Search200ResponseLegsInnerAnalysis](docs/Search200ResponseLegsInnerAnalysis.md)
+ - [Search200ResponseRead](docs/Search200ResponseRead.md)
+ - [Search200ResponseReadPosition](docs/Search200ResponseReadPosition.md)
+ - [Search200ResponseReadRestoreEpoch](docs/Search200ResponseReadRestoreEpoch.md)
+ - [SearchRequest](docs/SearchRequest.md)
+ - [SearchRequestDense](docs/SearchRequestDense.md)
+ - [SearchRequestFusion](docs/SearchRequestFusion.md)
+ - [SearchRequestFusionWeights](docs/SearchRequestFusionWeights.md)
+ - [SearchRequestLexical](docs/SearchRequestLexical.md)
+ - [SearchRequestSparse](docs/SearchRequestSparse.md)
+ - [SlowQueries200Response](docs/SlowQueries200Response.md)
+ - [SlowQueries200ResponseEntriesInner](docs/SlowQueries200ResponseEntriesInner.md)
+ - [SqlExec200Response](docs/SqlExec200Response.md)
+ - [SqlExec200ResponseCommitPointsInner](docs/SqlExec200ResponseCommitPointsInner.md)
+ - [SqlExec200ResponseReclaim](docs/SqlExec200ResponseReclaim.md)
+ - [SqlExec200ResponseResultsInner](docs/SqlExec200ResponseResultsInner.md)
+ - [SqlExecRequest](docs/SqlExecRequest.md)
+ - [TxBegin200Response](docs/TxBegin200Response.md)
+ - [TxBeginRequest](docs/TxBeginRequest.md)
+ - [TxCommit200Response](docs/TxCommit200Response.md)
+ - [TxCommit200ResponseLsn](docs/TxCommit200ResponseLsn.md)
+ - [TxQuery200Response](docs/TxQuery200Response.md)
+ - [TxQueryRequest](docs/TxQueryRequest.md)
+ - [TxRollback200Response](docs/TxRollback200Response.md)
+ - [TxRowDelete200Response](docs/TxRowDelete200Response.md)
+ - [TxRowGet200Response](docs/TxRowGet200Response.md)
+ - [TxRowPut200Response](docs/TxRowPut200Response.md)
+ - [TxStatus200Response](docs/TxStatus200Response.md)
+ - [Update200Response](docs/Update200Response.md)
+ - [UpdateRequest](docs/UpdateRequest.md)
+ - [UpdateRequestSparseValues](docs/UpdateRequestSparseValues.md)
+ - [Upsert200Response](docs/Upsert200Response.md)
+ - [UpsertRequest](docs/UpsertRequest.md)
+ - [UpsertRequestRecordsInner](docs/UpsertRequestRecordsInner.md)
+ - [Usage200Response](docs/Usage200Response.md)
+ - [Usage200ResponseAddonCallsInner](docs/Usage200ResponseAddonCallsInner.md)
+ - [Usage200ResponseConfiguration](docs/Usage200ResponseConfiguration.md)
+ - [Usage200ResponseLimits](docs/Usage200ResponseLimits.md)
+ - [Usage200ResponseMeter](docs/Usage200ResponseMeter.md)
+ - [Usage200ResponseSchemasInner](docs/Usage200ResponseSchemasInner.md)
+ - [Usage200ResponseUsed](docs/Usage200ResponseUsed.md)
+ - [VectorDelete200Response](docs/VectorDelete200Response.md)
+ - [VectorDeleteBulk200Response](docs/VectorDeleteBulk200Response.md)
+ - [VectorDeleteBulkRequest](docs/VectorDeleteBulkRequest.md)
+ - [VectorPutBulk200Response](docs/VectorPutBulk200Response.md)
+ - [VectorPutBulkRequest](docs/VectorPutBulkRequest.md)
+ - [VectorPutBulkRequestVectorsInner](docs/VectorPutBulkRequestVectorsInner.md)
+ - [VectorPutRequest](docs/VectorPutRequest.md)
+ - [VectorPutSparseRequest](docs/VectorPutSparseRequest.md)
+ - [VectorTopk200ResponseInner](docs/VectorTopk200ResponseInner.md)
+ - [VectorTopkExplain200Response](docs/VectorTopkExplain200Response.md)
+ - [VectorTopkExplain200ResponseCompleteness](docs/VectorTopkExplain200ResponseCompleteness.md)
+ - [VectorTopkExplain200ResponseConfig](docs/VectorTopkExplain200ResponseConfig.md)
+ - [VectorTopkExplainRequest](docs/VectorTopkExplainRequest.md)
+ - [VectorTopkHybridRequest](docs/VectorTopkHybridRequest.md)
+ - [VectorTopkRequest](docs/VectorTopkRequest.md)
+ - [VectorTopkSparseRequest](docs/VectorTopkSparseRequest.md)
+ - [VectorsList200Response](docs/VectorsList200Response.md)
+ - [VectorsList200ResponseTablesInner](docs/VectorsList200ResponseTablesInner.md)
+ - [Version200Response](docs/Version200Response.md)
+ - [Version200ResponseDisk](docs/Version200ResponseDisk.md)
+ - [Version200ResponseLicence](docs/Version200ResponseLicence.md)
+ - [WebhookDelete200Response](docs/WebhookDelete200Response.md)
+ - [WebhookGet200Response](docs/WebhookGet200Response.md)
+ - [WebhookGet200ResponseConfig](docs/WebhookGet200ResponseConfig.md)
+ - [WebhookGet200ResponseConfigSignature](docs/WebhookGet200ResponseConfigSignature.md)
+ - [WebhookPut200Response](docs/WebhookPut200Response.md)
+ - [WebhookPut200ResponseSignature](docs/WebhookPut200ResponseSignature.md)
+ - [WebhookPutRequest](docs/WebhookPutRequest.md)
+ - [WebhookPutRequestSignature](docs/WebhookPutRequestSignature.md)
+ - [WebhookReceive200Response](docs/WebhookReceive200Response.md)
+
+
+<a id="documentation-for-authorization"></a>
+## Documentation For Authorization
+
+
+Authentication schemes defined for the API:
+<a id="bearerAuth"></a>
+### bearerAuth
+
+- **Type**: Bearer authentication
+
+
+## Author
+
+
+