Lib.rs

› Web programming › Trieve
#api-client #open-api #trieve

trieve-client

Trieve OpenAPI Specification. This document describes all of the operations available through the Trieve API.

Owned by densumesh.

8 releases (4 breaking)

0.11.7 Aug 17, 2024
0.11.6 Jul 24, 2024
0.10.10 Jul 3, 2024
0.8.7 May 21, 2024
0.5.9 Apr 8, 2024

#1985 in Web programming

50 downloads per month
Used in trieve

MIT license

605KB
10K SLoC

Rust API client for openapi

Trieve OpenAPI Specification. This document describes all of the operations available through the Trieve API.

For more information, please visit https://trieve.ai

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: 0.11.7
  • Package version: 0.11.7
  • Generator version: 7.4.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 https://api.trieve.ai

Class Method HTTP request Description
AnalyticsApi get_cluster_analytics POST /api/analytics/search/cluster Get Cluster Analytics
AnalyticsApi get_ctr_analytics POST /api/analytics/ctr Get CTR Analytics
AnalyticsApi get_rag_analytics POST /api/analytics/rag Get RAG Analytics
AnalyticsApi get_recommendation_analytics POST /api/analytics/recommendations Get Recommendation Analytics
AnalyticsApi get_search_analytics POST /api/analytics/search Get Search Analytics
AnalyticsApi send_ctr_data PUT /api/analytics/ctr Send CTR Data
AnalyticsApi set_query_rating PUT /api/analytics/search Rate Query
AuthApi callback GET /api/auth/callback OpenID Connect callback
AuthApi get_me GET /api/auth/me Get Me
AuthApi login GET /api/auth Login
AuthApi logout DELETE /api/auth Logout
ChunkApi autocomplete POST /api/chunk/autocomplete Autocomplete
ChunkApi count_chunks POST /api/chunk/count Count chunks above threshold
ChunkApi create_chunk POST /api/chunk Create or Upsert Chunk or Chunks
ChunkApi delete_chunk DELETE /api/chunk/{chunk_id} Delete Chunk
ChunkApi delete_chunk_by_tracking_id DELETE /api/chunk/tracking_id/{tracking_id} Delete Chunk By Tracking Id
ChunkApi generate_off_chunks POST /api/chunk/generate RAG on Specified Chunks
ChunkApi get_chunk_by_id GET /api/chunk/{chunk_id} Get Chunk By Id
ChunkApi get_chunk_by_tracking_id GET /api/chunk/tracking_id/{tracking_id} Get Chunk By Tracking Id
ChunkApi get_chunks_by_ids POST /api/chunks Get Chunks By Ids
ChunkApi get_chunks_by_tracking_ids POST /api/chunks/tracking Get Chunks By Tracking Ids
ChunkApi get_recommended_chunks POST /api/chunk/recommend Get Recommended Chunks
ChunkApi get_suggested_queries POST /api/chunk/suggestions Generate suggested queries
ChunkApi scroll_dataset_chunks POST /api/chunks/scroll Scroll Chunks
ChunkApi search_chunks POST /api/chunk/search Search
ChunkApi update_chunk PUT /api/chunk Update Chunk
ChunkApi update_chunk_by_tracking_id PUT /api/chunk/tracking_id/update Update Chunk By Tracking Id
ChunkGroupApi add_chunk_to_group POST /api/chunk_group/chunk/{group_id} Add Chunk to Group
ChunkGroupApi add_chunk_to_group_by_tracking_id POST /api/chunk_group/tracking_id/{tracking_id} Add Chunk to Group by Tracking ID
ChunkGroupApi create_chunk_group POST /api/chunk_group Create or Upsert Group or Groups
ChunkGroupApi delete_chunk_group DELETE /api/chunk_group/{group_id} Delete Group
ChunkGroupApi delete_group_by_tracking_id DELETE /api/chunk_group/tracking_id/{tracking_id} Delete Group by Tracking ID
ChunkGroupApi get_chunk_group GET /api/chunk_group/{group_id} Get Group
ChunkGroupApi get_chunks_in_group GET /api/chunk_group/{group_id}/{page} Get Chunks in Group
ChunkGroupApi get_chunks_in_group_by_tracking_id GET /api/chunk_group/tracking_id/{group_tracking_id}/{page} Get Chunks in Group by Tracking ID
ChunkGroupApi get_group_by_tracking_id GET /api/chunk_group/tracking_id/{tracking_id} Get Group by Tracking ID
ChunkGroupApi get_groups_for_chunks POST /api/chunk_group/chunks Get Groups for Chunks
ChunkGroupApi get_groups_for_dataset GET /api/dataset/groups/{dataset_id}/{page} Get Groups for Dataset
ChunkGroupApi get_recommended_groups POST /api/chunk_group/recommend Get Recommended Groups
ChunkGroupApi remove_chunk_from_group DELETE /api/chunk_group/chunk/{group_id} Remove Chunk from Group
ChunkGroupApi search_over_groups POST /api/chunk_group/group_oriented_search Search Over Groups
ChunkGroupApi search_within_group POST /api/chunk_group/search Search Within Group
ChunkGroupApi update_chunk_group PUT /api/chunk_group Update Group
ChunkGroupApi update_group_by_tracking_id PUT /api/chunk_group/tracking_id/{tracking_id} Update Group by Tracking ID
DatasetApi clear_dataset PUT /api/dataset/clear/{dataset_id} Clear Dataset
DatasetApi create_dataset POST /api/dataset Create Dataset
DatasetApi delete_dataset DELETE /api/dataset/{dataset_id} Delete Dataset
DatasetApi delete_dataset_by_tracking_id DELETE /api/dataset/tracking_id/{tracking_id} Delete Dataset by Tracking ID
DatasetApi get_all_tags POST /api/dataset/get_all_tags Get All Tags
DatasetApi get_dataset GET /api/dataset/{dataset_id} Get Dataset By ID
DatasetApi get_datasets_from_organization GET /api/dataset/organization/{organization_id} Get Datasets from Organization
DatasetApi get_usage_by_dataset_id GET /api/dataset/usage/{dataset_id} Get Usage By Dataset ID
DatasetApi update_dataset PUT /api/dataset Update Dataset by ID or Tracking ID
EventsApi get_events POST /api/events Get events for the dataset
FileApi delete_file_handler DELETE /api/file/{file_id} Delete File
FileApi get_dataset_files_handler GET /api/dataset/files/{dataset_id}/{page} Get Files for Dataset
FileApi get_file_handler GET /api/file/{file_id} Get File
FileApi upload_file_handler POST /api/file Upload File
HealthApi health_check GET /api/health Health Check
InvitationApi post_invitation POST /api/invitation Send Invitation
MessageApi create_message POST /api/message Create message
MessageApi edit_message PUT /api/message Edit message
MessageApi get_all_topic_messages GET /api/messages/{messages_topic_id} Get all messages for a given topic
MessageApi regenerate_message DELETE /api/message Regenerate message
MessageApi regenerate_message_patch PATCH /api/message Regenerate message
MetricsApi get_metrics POST /metrics Get Prometheus Metrics
OrganizationApi create_organization POST /api/organization Create Organization
OrganizationApi delete_organization DELETE /api/organization/{organization_id} Delete Organization
OrganizationApi get_organization GET /api/organization/{organization_id} Get Organization
OrganizationApi get_organization_usage GET /api/organization/usage/{organization_id} Get Organization Usage
OrganizationApi get_organization_users GET /api/organization/users/{organization_id} Get Organization Users
OrganizationApi update_all_org_dataset_configs POST /api/organization/update_dataset_configs Update All Dataset Configurations
OrganizationApi update_organization PUT /api/organization Update Organization
StripeApi cancel_subscription DELETE /api/stripe/subscription/{subscription_id} Cancel Subscription
StripeApi create_setup_checkout_session POST /api/stripe/checkout/setup/{organization_id} Create checkout session setup
StripeApi direct_to_payment_link GET /api/stripe/payment_link/{plan_id}/{organization_id} Checkout
StripeApi get_all_invoices GET /api/stripe/invoices/{organization_id} Get All Invoices
StripeApi get_all_plans GET /api/stripe/plans Get All Plans
StripeApi update_subscription_plan PATCH /api/stripe/subscription_plan/{subscription_id}/{plan_id} Update Subscription Plan
TopicApi create_topic POST /api/topic Create Topic
TopicApi delete_topic DELETE /api/topic/{topic_id} Delete Topic
TopicApi get_all_topics_for_owner_id GET /api/topic/owner/{owner_id} Get All Topics for Owner ID
TopicApi update_topic PUT /api/topic Update Topic
UserApi delete_user_api_key DELETE /api/user/api_key/{api_key_id} Delete User Api Key
UserApi set_user_api_key POST /api/user/api_key Set User Api Key
UserApi update_user PUT /api/user Update User

Documentation For Models

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

cargo doc --open

Author

developers@trieve.ai

Dependencies

~5–19MB
~244K SLoC