Lib.rs

› 网页编程 › Trieve
#api-client #open-api #api-version

trieve-client

Trieve OpenAPI 规范。本文档描述了通过 Trieve API 可用的所有操作。

所有者 densumesh。

8 个版本 (4 个重大更改)

新版本 0.11.7 2024 年 8 月 17 日
0.11.6 2024 年 7 月 24 日
0.10.10 2024 年 7 月 3 日
0.8.7 2024 年 5 月 21 日
0.5.9 2024 年 4 月 8 日

#40 in #api-version

Download history 134/week @ 2024-05-11 192/week @ 2024-05-18 17/week @ 2024-05-25 4/week @ 2024-06-01 6/week @ 2024-06-08 2/week @ 2024-06-15 3/week @ 2024-06-22 131/week @ 2024-06-29 21/week @ 2024-07-06 1/week @ 2024-07-13 125/week @ 2024-07-20 30/week @ 2024-07-27 1/week @ 2024-08-03

每月 158 次下载
用于 trieve

MIT 许可证

605KB
10K SLoC

Rust 开放API 客户端

Trieve OpenAPI 规范。本文档描述了通过 Trieve API 可用的所有操作。

更多信息，请访问 https://trieve.ai

概览

此 API 客户端由 OpenAPI Generator 项目生成。通过使用来自远程服务器的 openapi-spec，您可以轻松生成 API 客户端。

  • API 版本：0.11.7
  • 包版本：0.11.7
  • 生成器版本：7.4.0
  • 构建包： org.openapitools.codegen.languages.RustClientCodegen

安装

将包放置在您的项目文件夹中名为 openapi 的目录下，并在 Cargo.toml 中的 [dependencies] 下添加以下内容：

openapi = { path = "./openapi" }

API 端点文档

所有 URI 都是相对于 https://api.trieve.ai

类 方法 HTTP 请求 描述
AnalyticsApi get_cluster_analytics POST /api/analytics/search/cluster 获取集群分析
AnalyticsApi get_ctr_analytics POST /api/analytics/ctr 获取 CTR 分析
AnalyticsApi get_rag_analytics POST /api/analytics/rag 获取 RAG 分析
AnalyticsApi get_recommendation_analytics POST /api/analytics/recommendations 获取推荐分析
AnalyticsApi get_search_analytics POST /api/analytics/search 获取搜索分析
AnalyticsApi send_ctr_data PUT /api/analytics/ctr 发送 CTR 数据
AnalyticsApi set_query_rating PUT /api/analytics/search 评分查询
AuthApi callback GET /api/auth/callback OpenID Connect 回调
AuthApi get_me GET /api/auth/me 获取我
AuthApi login GET /api/auth 登录
AuthApi logout DELETE /api/auth 注销
ChunkApi autocomplete POST /api/chunk/autocomplete 自动完成
ChunkApi count_chunks POST /api/chunk/count 计算超过阈值的块数
ChunkApi create_chunk POST /api/chunk 创建或更新块
ChunkApi delete_chunk DELETE /api/chunk/{chunk_id} 删除块
ChunkApi delete_chunk_by_tracking_id DELETE /api/chunk/tracking_id/{tracking_id} 通过跟踪 ID 删除块
ChunkApi generate_off_chunks POST /api/chunk/generate 在指定块上执行RAG
ChunkApi get_chunk_by_id GET /api/chunk/{chunk_id} 通过ID获取块
ChunkApi get_chunk_by_tracking_id GET /api/chunk/tracking_id/{tracking_id} 通过跟踪ID获取块
ChunkApi get_chunks_by_ids POST /api/chunks 通过ID获取块
ChunkApi get_chunks_by_tracking_ids POST /api/chunks/tracking 通过跟踪ID获取块
ChunkApi get_recommended_chunks POST /api/chunk/recommend 获取推荐块
ChunkApi get_suggested_queries POST /api/chunk/suggestions 生成建议查询
ChunkApi scroll_dataset_chunks POST /api/chunks/scroll 滚动块
ChunkApi search_chunks POST /api/chunk/search 搜索
ChunkApi update_chunk PUT /api/chunk 更新块
ChunkApi update_chunk_by_tracking_id PUT /api/chunk/tracking_id/update 通过跟踪ID更新块
ChunkGroupApi add_chunk_to_group POST /api/chunk_group/chunk/{group_id} 将块添加到组
ChunkGroupApi add_chunk_to_group_by_tracking_id POST /api/chunk_group/tracking_id/{tracking_id} 通过跟踪ID将块添加到组
ChunkGroupApi create_chunk_group POST /api/chunk_group 创建或更新组或组
ChunkGroupApi delete_chunk_group DELETE /api/chunk_group/{group_id} 删除组
ChunkGroupApi delete_group_by_tracking_id DELETE /api/chunk_group/tracking_id/{tracking_id} 通过跟踪ID删除组
ChunkGroupApi get_chunk_group GET /api/chunk_group/{group_id} 获取组
ChunkGroupApi get_chunks_in_group GET /api/chunk_group/{group_id}/{page} 获取组中的块
ChunkGroupApi get_chunks_in_group_by_tracking_id GET /api/chunk_group/tracking_id/{group_tracking_id}/{page} 通过跟踪ID获取组中的块
ChunkGroupApi get_group_by_tracking_id GET /api/chunk_group/tracking_id/{tracking_id} 通过跟踪ID获取组
ChunkGroupApi get_groups_for_chunks POST /api/chunk_group/chunks 获取块的组
ChunkGroupApi get_groups_for_dataset GET /api/dataset/groups/{dataset_id}/{page} 获取数据集的组
ChunkGroupApi get_recommended_groups POST /api/chunk_group/recommend 获取推荐组
ChunkGroupApi remove_chunk_from_group DELETE /api/chunk_group/chunk/{group_id} 从组中移除块
ChunkGroupApi search_over_groups POST /api/chunk_group/group_oriented_search 在组上搜索
ChunkGroupApi search_within_group POST /api/chunk_group/search 在组内搜索
ChunkGroupApi update_chunk_group PUT /api/chunk_group 更新组
ChunkGroupApi update_group_by_tracking_id PUT /api/chunk_group/tracking_id/{tracking_id} 通过跟踪ID更新组
DatasetApi clear_dataset PUT /api/dataset/clear/{dataset_id} 清除数据集
DatasetApi create_dataset POST /api/dataset 创建数据集
DatasetApi delete_dataset DELETE /api/dataset/{dataset_id} 删除数据集
DatasetApi delete_dataset_by_tracking_id DELETE /api/dataset/tracking_id/{tracking_id} 通过跟踪ID删除数据集
DatasetApi get_all_tags POST /api/dataset/get_all_tags 获取所有标签
DatasetApi get_dataset GET /api/dataset/{dataset_id} 通过ID获取数据集
DatasetApi get_datasets_from_organization GET /api/dataset/organization/{organization_id} 从组织获取数据集
DatasetApi get_usage_by_dataset_id GET /api/dataset/usage/{dataset_id} 通过数据集ID获取使用情况
DatasetApi update_dataset PUT /api/dataset 通过ID或跟踪ID更新数据集
EventsApi get_events POST /api/events 获取数据集的事件
FileApi delete_file_handler DELETE /api/file/{file_id} 删除文件
FileApi get_dataset_files_handler GET /api/dataset/files/{dataset_id}/{page} 获取数据集的文件
FileApi get_file_handler GET /api/file/{file_id} 获取文件
FileApi upload_file_handler POST /api/file 上传文件
HealthApi 健康检查 GET /api/health 健康检查
InvitationApi post_invitation POST /api/invitation 发送邀请
MessageApi create_message POST /api/message 创建消息
MessageApi edit_message PUT /api/message 编辑消息
MessageApi get_all_topic_messages GET /api/messages/{messages_topic_id} 获取特定主题的所有消息
MessageApi regenerate_message DELETE /api/message 重新生成消息
MessageApi regenerate_message_patch PATCH /api/message 重新生成消息
MetricsApi get_metrics POST /metrics 获取 Prometheus 指标
OrganizationApi create_organization POST /api/organization 创建组织
OrganizationApi delete_organization DELETE /api/organization/{organization_id} 删除组织
OrganizationApi get_organization GET /api/organization/{organization_id} 获取组织
OrganizationApi get_organization_usage GET /api/organization/usage/{organization_id} 获取组织使用情况
OrganizationApi get_organization_users GET /api/organization/users/{organization_id} 获取组织用户
OrganizationApi update_all_org_dataset_configs POST /api/organization/update_dataset_configs 更新所有数据集配置
OrganizationApi update_organization PUT /api/organization 更新组织
StripeApi cancel_subscription DELETE /api/stripe/subscription/{subscription_id} 取消订阅
StripeApi create_setup_checkout_session POST /api/stripe/checkout/setup/{organization_id} 创建结账会话设置
StripeApi direct_to_payment_link GET /api/stripe/payment_link/{plan_id}/{organization_id} 结账
StripeApi get_all_invoices GET /api/stripe/invoices/{organization_id} 获取所有发票
StripeApi get_all_plans GET /api/stripe/plans 获取所有计划
StripeApi update_subscription_plan PATCH /api/stripe/subscription_plan/{subscription_id}/{plan_id} 更新订阅计划
TopicApi create_topic POST /api/topic 创建主题
TopicApi delete_topic DELETE /api/topic/{topic_id} 删除主题
TopicApi get_all_topics_for_owner_id GET /api/topic/owner/{owner_id} 获取所有主题（按所有者ID）
TopicApi update_topic PUT /api/topic 更新主题
UserApi delete_user_api_key DELETE /api/user/api_key/{api_key_id} 删除用户API密钥
UserApi set_user_api_key POST /api/user/api_key 设置用户API密钥
UserApi update_user PUT /api/user 更新用户

模型文档

要获取crate生成的文档，请使用

cargo doc --open

作者

[email protected]

依赖关系

~4-19MB
~255K SLoC