Skip to content

Instantly share code, notes, and snippets.

@skeptrunedev

skeptrunedev/trieve-mintlify-docs-chunks.json

Created June 27, 2024 00:02
Show Gist options
  • Save skeptrunedev/dc34aa54f7810c913794ad045cc767d2 to your computer and use it in GitHub Desktop.
Save skeptrunedev/dc34aa54f7810c913794ad045cc767d2 to your computer and use it in GitHub Desktop.
Download ZIP
Trieve Docs Chunks for Mintlify
Raw
trieve-mintlify-docs-chunks.json
[
{
"id": "df1a46f4-0737-427e-890c-69b10d5a4833",
"link": "api-reference/chunk/get-recommended-chunks",
"qdrant_point_id": "99ed2fa9-1bad-45be-b13b-171e9bd0c8f2",
"created_at": "2024-06-21T05:04:57.406160",
"updated_at": "2024-06-21T05:04:57.406160",
"chunk_html": "Get Recommended Chunks\nGet Recommended Chunks\n\nGet recommendations of chunks similar to the positive samples in the request and dissimilar to the negative. You must provide at least one of either positive_chunk_ids or positive_tracking_ids.",
"metadata": {
"openapi": "post /api/chunk/recommend",
"title": "Get Recommended Chunks"
},
"tracking_id": "api-reference/chunk/get-recommended-chunks-Get-Recommended-Chunks-Get-Recom",
"time_stamp": null,
"dataset_id": "fd92b3c5-079c-4bfb-b806-3c4f49b87b31",
"weight": 0,
"location": null,
"image_urls": null,
"tag_set": "page",
"num_value": null,
"group_tracking_ids": ["api-reference/chunk/get-recommended-chunks"]
},
{
"id": "139e729e-9e80-4700-a3b8-e9bdc630d782",
"link": "guides/searching-with-trieve",
"qdrant_point_id": "161d8eaf-e470-436b-817b-c6f5b17c219c",
"created_at": "2024-06-21T05:05:00.071116",
"updated_at": "2024-06-21T05:05:00.071117",
"chunk_html": "Different Search Paradigms\nWe offer three different search strategies for you to choose from: Search over chunks : This strategy allows you to search all of your chunks independently. This is useful when your chunks are independent and do not need to be grouped together. Search within groups : This strategy lets you constrain your results to within a selected group. This is useful for searching distinct groups within your dataset independently. Search over groups : This strategy allows you to search over the groups of chunks within your dataset. This returns the groups and the top chunks within each group that matched your query, providing better search quality for datasets with highly related chunks within groups. You can use the search UI at search.trieve.ai to A/B test which search method works best for you.",
"metadata": { "title": "Different Search Paradigms" },
"tracking_id": "guides/searching-with-trieve-Different-Search-Paradigms",
"time_stamp": null,
"dataset_id": "fd92b3c5-079c-4bfb-b806-3c4f49b87b31",
"weight": 0,
"location": null,
"image_urls": null,
"tag_set": "",
"num_value": null,
"group_tracking_ids": ["guides/searching-with-trieve"]
},
{
"id": "6b4db6e4-c366-42aa-b664-0b02eadd5d18",
"link": "api-reference/health/health-check",
"qdrant_point_id": "a0ed17bb-68a7-420d-a8c7-5d4b9e1c84be",
"created_at": "2024-06-21T05:04:59.853726",
"updated_at": "2024-06-21T05:04:59.853727",
"chunk_html": "Health Check\nHealth Check\n\nConfirmation that the service is healthy and can make embedding vectors",
"metadata": { "openapi": "get /api/health", "title": "Health Check" },
"tracking_id": "api-reference/health/health-check-Health-Check-Health-Check-Confi",
"time_stamp": null,
"dataset_id": "fd92b3c5-079c-4bfb-b806-3c4f49b87b31",
"weight": 0,
"location": null,
"image_urls": null,
"tag_set": "page",
"num_value": null,
"group_tracking_ids": ["api-reference/health/health-check"]
},
{
"id": "e65be33c-3f97-4b13-a9ac-0d68cdb87fbf",
"link": "api-reference/health/health-check",
"qdrant_point_id": "512350e2-b8fa-4b08-8696-ed753180e9bb",
"created_at": "2024-06-21T05:04:59.884829",
"updated_at": "2024-06-21T05:04:59.884830",
"chunk_html": "\n\nREST Endpoint GET /api/health\n\nSummary: Health Check \n\nDescription: Health Check\n\nConfirmation that the service is healthy and can make embedding vectors\n\nSecurity methods: \n\nRequest params: \n\nRequest body: N/A\n\n\nResponses: \n200: N/A\n400: any\n\tDescription: N/A\n\tExample: \"<any>\"\n\n",
"metadata": {},
"tracking_id": "api-reference/health/health-check-API-Metadata:-get-/api/health",
"time_stamp": null,
"dataset_id": "fd92b3c5-079c-4bfb-b806-3c4f49b87b31",
"weight": 0,
"location": null,
"image_urls": null,
"tag_set": "code",
"num_value": null,
"group_tracking_ids": ["api-reference/health/health-check"]
},
{
"id": "da576643-0f31-43fc-94ee-989c244fd2fe",
"link": "quickstart",
"qdrant_point_id": "f2fd487c-bf4a-4fe4-b933-23e325eee4b0",
"created_at": "2024-06-21T05:05:00.892191",
"updated_at": "2024-06-21T05:05:01.069679",
"chunk_html": "Using Trieve CLI\nTo upload a sample dataset, run the following command:",
"metadata": { "title": "Using Trieve CLI" },
"tracking_id": "quickstart-Using-Trieve-CLI",
"time_stamp": null,
"dataset_id": "fd92b3c5-079c-4bfb-b806-3c4f49b87b31",
"weight": 0,
"location": null,
"image_urls": null,
"tag_set": "",
"num_value": null,
"group_tracking_ids": ["quickstart"]
},
{
"id": "33b6e005-10b3-47bb-95fe-894f5b4160b7",
"link": "quickstart",
"qdrant_point_id": "5a60a8f3-b7ae-4eaf-ac9c-63896a09c3b5",
"created_at": "2024-06-21T05:05:00.835012",
"updated_at": "2024-06-21T05:05:00.874277",
"chunk_html": "Authenticate the CLI\nTo authenticate the CLI, you simply need to run the following command and follow the instructions:",
"metadata": { "title": "Authenticate the CLI" },
"tracking_id": "quickstart-Authenticate-the-CLI",
"time_stamp": null,
"dataset_id": "fd92b3c5-079c-4bfb-b806-3c4f49b87b31",
"weight": 0,
"location": null,
"image_urls": null,
"tag_set": "",
"num_value": null,
"group_tracking_ids": ["quickstart"]
},
{
"id": "9ab3fe84-5be1-4015-b783-5b3fc6a38653",
"link": "examples/job-board",
"qdrant_point_id": "28907715-7130-4df4-be60-fc90987c4287",
"created_at": "2024-06-21T05:04:59.091286",
"updated_at": "2024-06-21T05:04:59.091287",
"chunk_html": "Build Search for a Job Board\nThis guide will help you set up and run a demo using a sample job listing dataset on the Trieve platform. Follow the steps below to get everything working.",
"metadata": { "title": "Build Search for a Job Board" },
"tracking_id": "examples/job-board-Build-Search-for-a-Job-Board",
"time_stamp": null,
"dataset_id": "fd92b3c5-079c-4bfb-b806-3c4f49b87b31",
"weight": 0,
"location": null,
"image_urls": null,
"tag_set": "",
"num_value": null,
"group_tracking_ids": ["examples/job-board"]
},
{
"id": "eaaed2bf-77ef-473a-9df2-1c99cff9fbb5",
"link": "guides/recommending-with-trieve",
"qdrant_point_id": "bfdfc1d7-e2f5-42a3-821f-3c66fda1f379",
"created_at": "2024-06-21T05:05:00.272602",
"updated_at": "2024-06-21T05:05:00.272602",
"chunk_html": "Different Recommendation Strategies\nWe offer different recommendation strategies for users to choose from: average_vector : Averages the vectors of the positive examples and finds the most similar chunks. This strategy averages all the positive and negative examples separately, then combines them into a single vector. It then searches for chunks that are most similar to this combined vector. best_score : Finds chunks that are most similar to any of the positive examples provided. This strategy measures each example against every other example, then selects the best positive and best negative scores.",
"metadata": { "title": "Different Recommendation Strategies" },
"tracking_id": "guides/recommending-with-trieve-Different-Recommendation-Strategies",
"time_stamp": null,
"dataset_id": "fd92b3c5-079c-4bfb-b806-3c4f49b87b31",
"weight": 0,
"location": null,
"image_urls": null,
"tag_set": "",
"num_value": null,
"group_tracking_ids": ["guides/recommending-with-trieve"]
},
{
"id": "6fb64812-aef0-4368-b600-a76e27775115",
"link": "quickstart",
"qdrant_point_id": "5959d118-b9be-4fcc-93bd-b6d94f1ca3d9",
"created_at": "2024-06-21T05:05:01.495698",
"updated_at": "2024-06-21T05:05:01.495698",
"chunk_html": "One-off on specific chunks\nCheck the API reference for the generate_from_chunks endpoint to see details on how to perform LLM inference with a specific set of chunks in the context window.",
"metadata": { "title": "One-off on specific chunks" },
"tracking_id": "quickstart-One-off-on-specific-chunks",
"time_stamp": null,
"dataset_id": "fd92b3c5-079c-4bfb-b806-3c4f49b87b31",
"weight": 0,
"location": null,
"image_urls": null,
"tag_set": "",
"num_value": null,
"group_tracking_ids": ["quickstart"]
},
{
"id": "00be2221-2000-4fbf-aa84-ac411f73d352",
"link": "api-reference/auth/logout",
"qdrant_point_id": "0bf39ed1-c017-48c8-b06c-6a8d8e2a6f32",
"created_at": "2024-06-21T05:04:56.592673",
"updated_at": "2024-06-21T05:04:56.592673",
"chunk_html": "Logout\nLogout\n\nInvalidate your current auth credential stored typically stored in a cookie. This does not invalidate your API key.",
"metadata": { "openapi": "delete /api/auth", "title": "Logout" },
"tracking_id": "api-reference/auth/logout-Logout-Logout-Invalidate-your-c",
"time_stamp": null,
"dataset_id": "fd92b3c5-079c-4bfb-b806-3c4f49b87b31",
"weight": 0,
"location": null,
"image_urls": null,
"tag_set": "page",
"num_value": null,
"group_tracking_ids": ["api-reference/auth/logout"]
},
{
"id": "84f2a768-2016-4804-9114-fa09841ca1d4",
"link": "examples/ecommerce",
"qdrant_point_id": "40a9cdd7-59e0-47fe-ba49-34a73100f5c6",
"created_at": "2024-06-21T05:04:58.669259",
"updated_at": "2024-06-21T05:04:58.726558",
"chunk_html": "Types\nThe first step is to define all the types",
"metadata": { "title": "Types" },
"tracking_id": "examples/ecommerce-Types",
"time_stamp": null,
"dataset_id": "fd92b3c5-079c-4bfb-b806-3c4f49b87b31",
"weight": 0,
"location": null,
"image_urls": null,
"tag_set": "",
"num_value": null,
"group_tracking_ids": ["examples/ecommerce"]
},
{
"id": "f3549cdc-5ede-4313-985b-a365c52d9e71",
"link": "quickstart",
"qdrant_point_id": "5900e2d1-edb6-4c10-9634-74f410b5294a",
"created_at": "2024-06-21T05:05:01.468458",
"updated_at": "2024-06-21T05:05:01.468459",
"chunk_html": "On chat.trieve.ai\nYou can try RAG on the sample data you added by visiting chat.trieve.ai and entering a query in the chat box.",
"metadata": { "title": "On chat.trieve.ai" },
"tracking_id": "quickstart-On-chat.trieve.ai",
"time_stamp": null,
"dataset_id": "fd92b3c5-079c-4bfb-b806-3c4f49b87b31",
"weight": 0,
"location": null,
"image_urls": null,
"tag_set": "",
"num_value": null,
"group_tracking_ids": ["quickstart"]
},
{
"id": "dc3a9916-d17c-4751-9baa-0f3218e456b3",
"link": "guides/searching-with-trieve",
"qdrant_point_id": "a1c9a8da-6ea5-4e2c-8290-dc49e00c635b",
"created_at": "2024-06-21T05:05:00.100764",
"updated_at": "2024-06-21T05:05:00.100764",
"chunk_html": "Important Parameters\nquery : The user query that is embedded and searched against the dataset. search_type : Can be semantic , fulltext , or hybrid. Semantic : Uses cosine distance to determine the most relevant results. Fulltext : Uses a SPLADE model to find the most relevant results. Hybrid : Uses a reranker model that pulls one page of results from both fulltext and semantic searches to find the most relevant results. page : The page of chunks to fetch. Pages are 1-indexed. page_size : This lets you tune the number of results that are returned. highlight_results : Enables subsentence highlighting of relevant portions of the text. slim_chunks : Excludes chunk_html from the returned results to reduce network bandwidth. Useful for large chunks. recency_bias : A value from 0-1 that tunes how much the recency of chunks (based on the timestamp field) affects the ranking. filters : Apply filters to get exactly the results you want. To optimize for the lowest latency, set highlight_results and get_total_pages to false and set slim_chunks to true . If you are willing to sacrifice some search quality for speed, use the fulltext search mode.",
"metadata": { "title": "Important Parameters" },
"tracking_id": "guides/searching-with-trieve-Important-Parameters",
"time_stamp": null,
"dataset_id": "fd92b3c5-079c-4bfb-b806-3c4f49b87b31",
"weight": 0,
"location": null,
"image_urls": null,
"tag_set": "",
"num_value": null,
"group_tracking_ids": ["guides/searching-with-trieve"]
},
{
"id": "69e50917-00f2-4b75-b180-8c30b2ff13ef",
"link": "api-reference/chunk_group/search-within-group",
"qdrant_point_id": "2a2549ae-c77f-4c7c-9865-442736b2a7d9",
"created_at": "2024-06-21T05:04:58.780756",
"updated_at": "2024-06-21T05:04:58.780756",
"chunk_html": "Search Within Group\nSearch Within Group\n\nThis route allows you to search only within a group. This is useful for when you only want search results to contain chunks which are members of a specific group. If choosing hybrid search, the results will be re-ranked using BAAI/bge-reranker-large.",
"metadata": {
"openapi": "post /api/chunk_group/search",
"title": "Search Within Group"
},
"tracking_id": "api-reference/chunk_group/search-within-group-Search-Within-Group-Search-Withi",
"time_stamp": null,
"dataset_id": "fd92b3c5-079c-4bfb-b806-3c4f49b87b31",
"weight": 0,
"location": null,
"image_urls": null,
"tag_set": "page",
"num_value": null,
"group_tracking_ids": ["api-reference/chunk_group/search-within-group"]
},
{
"id": "af117781-9cde-46e2-9ed2-cf81a4773249",
"link": "guides/recommending-with-trieve",
"qdrant_point_id": "994f6d82-088f-42c8-9618-66cbefb95ebc",
"created_at": "2024-06-21T05:05:00.300804",
"updated_at": "2024-06-21T05:05:00.300805",
"chunk_html": "Important Parameters\npositive_examples and positive_tracking_ids : Provide the IDs of chunks of which similar ones will be recommended. negative_examples and negative_tracking_ids : Provide the IDs of chunks of which dissimilar ones will be avoided. recommendation_type : Can be either semantic or fulltext. Semantic : Uses cosine distance. Fulltext : Uses a SPLADE model. strategy : Can be either average_vector or best_score. slim_chunks : Reduces the size of the returned chunks by excluding unnecessary fields. filters : Apply filters to get exactly the results you want. View the explanation on how to filter in the searching with Trieve guide.",
"metadata": { "title": "Important Parameters" },
"tracking_id": "guides/recommending-with-trieve-Important-Parameters",
"time_stamp": null,
"dataset_id": "fd92b3c5-079c-4bfb-b806-3c4f49b87b31",
"weight": 0,
"location": null,
"image_urls": null,
"tag_set": "",
"num_value": null,
"group_tracking_ids": ["guides/recommending-with-trieve"]
},
{
"id": "b1a4edd6-7ae0-402c-b1bc-cd361a6ef65f",
"link": "api-reference/stripe/update-subscription-plan",
"qdrant_point_id": "39c3e7fb-8ee8-4be8-86de-6b4835a909f7",
"created_at": "2024-06-21T05:04:57.692403",
"updated_at": "2024-06-21T05:04:57.692403",
"chunk_html": "Update Subscription Plan\nUpdate Subscription Plan\n\nUpdate a subscription to a new plan",
"metadata": {
"openapi": "patch /api/stripe/subscription_plan/{subscription_id}/{plan_id}",
"title": "Update Subscription Plan"
},
"tracking_id": "api-reference/stripe/update-subscription-plan-Update-Subscription-Plan-Update-",
"time_stamp": null,
"dataset_id": "fd92b3c5-079c-4bfb-b806-3c4f49b87b31",
"weight": 0,
"location": null,
"image_urls": null,
"tag_set": "page",
"num_value": null,
"group_tracking_ids": ["api-reference/stripe/update-subscription-plan"]
},
{
"id": "8b1e6ce7-cec1-458c-94a3-2e5801276215",
"link": "quickstart",
"qdrant_point_id": "c75e2e06-e367-4e8a-8bab-e897fc785d5f",
"created_at": "2024-06-21T05:05:00.996058",
"updated_at": "2024-06-21T05:05:00.996058",
"chunk_html": "Upload sample data\nOn the free tier you are able to create up to 1000 chunks and upload 512 mb worth of files.",
"metadata": { "title": "Upload sample data" },
"tracking_id": "quickstart-Upload-sample-data",
"time_stamp": null,
"dataset_id": "fd92b3c5-079c-4bfb-b806-3c4f49b87b31",
"weight": 0,
"location": null,
"image_urls": null,
"tag_set": "",
"num_value": null,
"group_tracking_ids": ["quickstart"]
},
{
"id": "5dc96d44-6d39-4e43-9239-f965baa7933f",
"link": "guides/RAG-with-trieve",
"qdrant_point_id": "de034b1b-93ce-4d96-8c6e-9deb48cb3b91",
"created_at": "2024-06-21T05:04:59.679583",
"updated_at": "2024-06-21T05:04:59.679583",
"chunk_html": "Overview\nWe provide functionality to do conversational search over your data using the Retrieve and Generate (RAG) model. This model allows you to chat with your data in a conversational manner, asking questions and getting responses in a natural language format. This is mainly done through our RAG on specified chunks route and RAG route.",
"metadata": { "title": "Overview" },
"tracking_id": "guides/RAG-with-trieve-Overview",
"time_stamp": null,
"dataset_id": "fd92b3c5-079c-4bfb-b806-3c4f49b87b31",
"weight": 0,
"location": null,
"image_urls": null,
"tag_set": "",
"num_value": null,
"group_tracking_ids": ["guides/RAG-with-trieve"]
},
{
"id": "b5f846b4-77db-4c28-8d31-f5e7b649e47e",
"link": "api-reference/auth/logout",
"qdrant_point_id": "cc9917a6-03ad-48ff-a399-a5512034f3d4",
"created_at": "2024-06-21T05:04:56.641329",
"updated_at": "2024-06-21T05:04:56.641329",
"chunk_html": "\n\nREST Endpoint DELETE /api/auth\n\nSummary: Logout \n\nDescription: Logout\n\nInvalidate your current auth credential stored typically stored in a cookie. This does not invalidate your API key.\n\nSecurity methods: \n\nRequest params: \n\nRequest body: N/A\n\n\nResponses: \n204: N/A\n\n",
"metadata": {},
"tracking_id": "api-reference/auth/logout-API-Metadata:-delete-/api/auth",
"time_stamp": null,
"dataset_id": "fd92b3c5-079c-4bfb-b806-3c4f49b87b31",
"weight": 0,
"location": null,
"image_urls": null,
"tag_set": "code",
"num_value": null,
"group_tracking_ids": ["api-reference/auth/logout"]
},
{
"id": "f8e5800d-2432-4958-8527-ae3a09bb49cf",
"link": "api-reference/stripe/cancel-subscription",
"qdrant_point_id": "44edd35b-6c7c-4f91-bfe2-fd101c90a8f6",
"created_at": "2024-06-21T05:04:57.488146",
"updated_at": "2024-06-21T05:04:57.488147",
"chunk_html": "Cancel Subscription\nCancel Subscription\n\nCancel a subscription by its id",
"metadata": {
"openapi": "delete /api/stripe/subscription/{subscription_id}",
"title": "Cancel Subscription"
},
"tracking_id": "api-reference/stripe/cancel-subscription-Cancel-Subscription-Cancel-Subsc",
"time_stamp": null,
"dataset_id": "fd92b3c5-079c-4bfb-b806-3c4f49b87b31",
"weight": 0,
"location": null,
"image_urls": null,
"tag_set": "page",
"num_value": null,
"group_tracking_ids": ["api-reference/stripe/cancel-subscription"]
},
{
"id": "8074c534-dbbf-4973-b8e0-8cff2368618a",
"link": "api-reference/invitation/send-invitation",
"qdrant_point_id": "e407c012-aa29-44f7-9c79-b9dde7c0c0f6",
"created_at": "2024-06-21T05:04:59.925320",
"updated_at": "2024-06-21T05:04:59.925320",
"chunk_html": "Send Invitation\nSend Invitation\n\nInvitations act as a way to invite users to join an organization. After a user is invited, they will automatically be added to the organization with the role specified in the invitation once they set their. Auth'ed user or api key must have an admin or owner role for the specified dataset's organization.",
"metadata": {
"openapi": "post /api/invitation",
"title": "Send Invitation"
},
"tracking_id": "api-reference/invitation/send-invitation-Send-Invitation-Send-Invitation-",
"time_stamp": null,
"dataset_id": "fd92b3c5-079c-4bfb-b806-3c4f49b87b31",
"weight": 0,
"location": null,
"image_urls": null,
"tag_set": "page",
"num_value": null,
"group_tracking_ids": ["api-reference/invitation/send-invitation"]
},
{
"id": "ab9e4df0-7635-492d-ab81-9df81596a8d0",
"link": "examples/job-board",
"qdrant_point_id": "a2bb80e7-3557-4f97-852e-3d6b57cfee8d",
"created_at": "2024-06-21T05:04:59.434216",
"updated_at": "2024-06-21T05:04:59.475831",
"chunk_html": "Instantiating the Trieve Client\nWe have to first instantiate the client with our credentials before we can use it:",
"metadata": { "title": "Instantiating the Trieve Client" },
"tracking_id": "examples/job-board-Instantiating-the-Trieve-Client",
"time_stamp": null,
"dataset_id": "fd92b3c5-079c-4bfb-b806-3c4f49b87b31",
"weight": 0,
"location": null,
"image_urls": null,
"tag_set": "",
"num_value": null,
"group_tracking_ids": ["examples/job-board"]
},
{
"id": "49ec4ac3-a2d2-4a39-b89c-aa90428e02db",
"link": "examples/ecommerce",
"qdrant_point_id": "93fca814-4634-4739-be0d-d1ea00e63a13",
"created_at": "2024-06-21T05:04:58.908083",
"updated_at": "2024-06-21T05:04:58.958303",
"chunk_html": "Instantiating the Trieve Client\nWe have to first instantiate the client with our credentials before we can use it:",
"metadata": { "title": "Instantiating the Trieve Client" },
"tracking_id": "examples/ecommerce-Instantiating-the-Trieve-Client",
"time_stamp": null,
"dataset_id": "fd92b3c5-079c-4bfb-b806-3c4f49b87b31",
"weight": 0,
"location": null,
"image_urls": null,
"tag_set": "",
"num_value": null,
"group_tracking_ids": ["examples/ecommerce"]
},
{
"id": "54a145f4-4cee-4c95-8b3d-7506ca42f62a",
"link": "api-reference/dataset/create-dataset",
"qdrant_point_id": "fc38eab6-c7ce-42fe-a4c0-2062cec1e501",
"created_at": "2024-06-21T05:04:59.025099",
"updated_at": "2024-06-21T05:04:59.025100",
"chunk_html": "Create dataset\nCreate dataset\n\nCreate a new dataset. The auth'ed user must be an owner of the organization to create a dataset.",
"metadata": { "openapi": "post /api/dataset", "title": "Create dataset" },
"tracking_id": "api-reference/dataset/create-dataset-Create-dataset-Create-dataset-C",
"time_stamp": null,
"dataset_id": "fd92b3c5-079c-4bfb-b806-3c4f49b87b31",
"weight": 0,
"location": null,
"image_urls": null,
"tag_set": "page",
"num_value": null,
"group_tracking_ids": ["api-reference/dataset/create-dataset"]
},
{
"id": "911ddc59-1658-41c8-ade9-7aa67005a4ac",
"link": "api-reference/chunk_group/add-chunk-to-group-by-tracking-id",
"qdrant_point_id": "bde36270-6faa-48b8-9b3e-8192983cf244",
"created_at": "2024-06-21T05:04:57.794858",
"updated_at": "2024-06-21T05:04:57.794858",
"chunk_html": "\n(deprecated) \nREST Endpoint POST /api/chunk_group/tracking_id/{tracking_id}\n\nSummary: Add Chunk to Group by Tracking ID \n\nDescription: Add Chunk to Group by Tracking ID\n\nRoute to add a chunk to a group by tracking id. Auth'ed user or api key must have an admin or owner role for the specified dataset's organization.\n\nSecurity methods: \nheader: apiKey\n\nRequest params: \npath params:\ntracking_id:\n\tstring\n\tDescription: Id of the group to add the chunk to as a bookmark\n\tExample: \"<string>\"\n\nheader params:\nTR-Dataset:\n\tstring\n\tDescription: The dataset id to use for the request\n\tExample: \"<string>\"\n\n\nRequest body: any\n\tDescription: N/A\n\tExample: \"<any>\"\n\n\nResponses: \n204: N/A\n400: any\n\tDescription: N/A\n\tExample: \"<any>\"\n\n",
"metadata": {},
"tracking_id": "api-reference/chunk_group/add-chunk-to-group-by-tracking-id-API-Metadata:-post-/api/chunk_group/tracking_id/{tracking_id}",
"time_stamp": null,
"dataset_id": "fd92b3c5-079c-4bfb-b806-3c4f49b87b31",
"weight": 0,
"location": null,
"image_urls": null,
"tag_set": "code",
"num_value": null,
"group_tracking_ids": [
"api-reference/chunk_group/add-chunk-to-group-by-tracking-id"
]
},
{
"id": "45d969d9-cd28-49af-86de-28f30684892d",
"link": "api-reference/topic/create-topic",
"qdrant_point_id": "2de9e224-7945-48c4-9d30-f0f50620a0ad",
"created_at": "2024-06-21T05:04:57.765068",
"updated_at": "2024-06-21T05:04:57.765068",
"chunk_html": "Create Topic\nCreate Topic\n\nCreate a new chat topic. Topics are attached to a owner_id's and act as a coordinator for conversation message history of gen-AI chat sessions. Auth'ed user or api key must have an admin or owner role for the specified dataset's organization.",
"metadata": { "openapi": "post /api/topic", "title": "Create Topic" },
"tracking_id": "api-reference/topic/create-topic-Create-Topic-Create-Topic-Creat",
"time_stamp": null,
"dataset_id": "fd92b3c5-079c-4bfb-b806-3c4f49b87b31",
"weight": 0,
"location": null,
"image_urls": null,
"tag_set": "page",
"num_value": null,
"group_tracking_ids": ["api-reference/topic/create-topic"]
},
{
"id": "89e3344f-81c8-4fd2-bddd-419bc024b75c",
"link": "api-reference/invitation/send-invitation",
"qdrant_point_id": "e6f12170-72c5-4bc9-b4ba-15a6cf625144",
"created_at": "2024-06-21T05:04:59.955541",
"updated_at": "2024-06-21T05:04:59.955542",
"chunk_html": "\n\nREST Endpoint POST /api/invitation\n\nSummary: Send Invitation \n\nDescription: Send Invitation\n\nInvitations act as a way to invite users to join an organization. After a user is invited, they will automatically be added to the organization with the role specified in the invitation once they set their. Auth'ed user or api key must have an admin or owner role for the specified dataset's organization.\n\nSecurity methods: \nheader: apiKey\n\nRequest params: \nheader params:\nTR-Organization:\n\tstring\n\tDescription: The organization id to use for the request\n\tExample: \"<string>\"\n\n\nRequest body: any\n\tDescription: N/A\n\tExample: \"<any>\"\n\n\nResponses: \n204: N/A\n400: any\n\tDescription: N/A\n\tExample: \"<any>\"\n\n",
"metadata": {},
"tracking_id": "api-reference/invitation/send-invitation-API-Metadata:-post-/api/invitation",
"time_stamp": null,
"dataset_id": "fd92b3c5-079c-4bfb-b806-3c4f49b87b31",
"weight": 0,
"location": null,
"image_urls": null,
"tag_set": "code",
"num_value": null,
"group_tracking_ids": ["api-reference/invitation/send-invitation"]
},
{
"id": "0b2efbe3-c9c7-4cd8-9a36-021988be8534",
"link": "api-reference/user/set-user-api-key",
"qdrant_point_id": "e2df856b-3e06-4bea-badd-a7d0296c9f87",
"created_at": "2024-06-21T05:04:58.155699",
"updated_at": "2024-06-21T05:04:58.155699",
"chunk_html": "\n\nREST Endpoint POST /api/user/api_key\n\nSummary: Set User Api Key \n\nDescription: Set User Api Key\n\nCreate a new api key for the auth'ed user. Successful response will contain the newly created api key. If a write role is assigned the api key will have permission level of the auth'ed user who calls this endpoint.\n\nSecurity methods: \nheader: apiKey\n\nRequest params: \n\nRequest body: any\n\tDescription: N/A\n\tExample: \"<any>\"\n\n\nResponses: \n200: any\n\tDescription: N/A\n\tExample: \"<any>\"\n400: any\n\tDescription: N/A\n\tExample: \"<any>\"\n\n",
"metadata": {},
"tracking_id": "api-reference/user/set-user-api-key-API-Metadata:-post-/api/user/api_key",
"time_stamp": null,
"dataset_id": "fd92b3c5-079c-4bfb-b806-3c4f49b87b31",
"weight": 0,
"location": null,
"image_urls": null,
"tag_set": "code",
"num_value": null,
"group_tracking_ids": ["api-reference/user/set-user-api-key"]
},
{
"id": "a8143435-d936-48cf-8a1c-01c3631dc29b",
"link": "examples/job-board",
"qdrant_point_id": "24d76457-1af7-483e-b938-a0cfe176743e",
"created_at": "2024-06-21T05:04:59.124673",
"updated_at": "2024-06-21T05:04:59.346114",
"chunk_html": "Steps to Set Up the Demo\nClone the repository: Install the required dependencies: This demo uses Bun as a runtime. Install Bun by running: Install the dependencies by running: Create an account on Trieve: Go to Trieve Dashboard and create an account. Create a new dataset and copy the dataset ID. You can either create a dataset on the Trieve Dashboard or use our CLI Create a new API key and copy the API key. Create an .env file in the root of the project and add the following environment variables: Download the dataset Run the demo: View the results Head over to https://search.trieve.ai and select your dataset. Try out a few sample queries like software engineer at google or show me some listings knowing I have experience as a mechanic",
"metadata": { "title": "Steps to Set Up the Demo" },
"tracking_id": "examples/job-board-Steps-to-Set-Up-the-Demo",
"time_stamp": null,
"dataset_id": "fd92b3c5-079c-4bfb-b806-3c4f49b87b31",
"weight": 0,
"location": null,
"image_urls": null,
"tag_set": "",
"num_value": null,
"group_tracking_ids": ["examples/job-board"]
},
{
"id": "28a841a4-bc66-490b-aad4-5dd5c1cf0ce4",
"link": "api-reference/events/get-events-for-the-dataset",
"qdrant_point_id": "3a13f25c-e77f-4664-9697-39b2a54fb115",
"created_at": "2024-06-21T05:04:59.532210",
"updated_at": "2024-06-21T05:04:59.532210",
"chunk_html": "\n\nREST Endpoint POST /api/events\n\nSummary: Get events for the dataset \n\nDescription: Get events for the dataset\n\nGet events for the dataset specified by the TR-Dataset header.\n\nSecurity methods: \nheader: apiKey\n\nRequest params: \nheader params:\nTR-Dataset:\n\tstring\n\tDescription: The dataset id to use for the request\n\tExample: \"<string>\"\n\n\nRequest body: any\n\tDescription: N/A\n\tExample: \"<any>\"\n\n\nResponses: \n200: any\n\tDescription: N/A\n\tExample: \"<any>\"\n400: any\n\tDescription: N/A\n\tExample: \"<any>\"\n\n",
"metadata": {},
"tracking_id": "api-reference/events/get-events-for-the-dataset-API-Metadata:-post-/api/events",
"time_stamp": null,
"dataset_id": "fd92b3c5-079c-4bfb-b806-3c4f49b87b31",
"weight": 0,
"location": null,
"image_urls": null,
"tag_set": "code",
"num_value": null,
"group_tracking_ids": ["api-reference/events/get-events-for-the-dataset"]
},
{
"id": "296e144a-389c-4371-a9ad-a7f661ff4d47",
"link": "api-reference/file/delete-file",
"qdrant_point_id": "f6d8d43c-2e97-4e49-9547-b0946c2ec685",
"created_at": "2024-06-21T05:04:59.596334",
"updated_at": "2024-06-21T05:04:59.596335",
"chunk_html": "\n\nREST Endpoint DELETE /api/file/{file_id}\n\nSummary: Delete File \n\nDescription: Delete File\n\nDelete a file from S3 attached to the server based on its id. This will disassociate chunks from the file, but only delete them all together if you specify delete_chunks to be true. Auth'ed user or api key must have an admin or owner role for the specified dataset's organization.\n\nSecurity methods: \nheader: apiKey\n\nRequest params: \npath params:\nfile_id:\n\tstring\n\tDescription: The id of the file to delete\n\tExample: \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n\nheader params:\nTR-Dataset:\n\tstring\n\tDescription: The dataset id to use for the request\n\tExample: \"<string>\"\n\n\nRequest body: N/A\n\n\nResponses: \n204: N/A\n400: any\n\tDescription: N/A\n\tExample: \"<any>\"\n\n",
"metadata": {},
"tracking_id": "api-reference/file/delete-file-API-Metadata:-delete-/api/file/{file_id}",
"time_stamp": null,
"dataset_id": "fd92b3c5-079c-4bfb-b806-3c4f49b87b31",
"weight": 0,
"location": null,
"image_urls": null,
"tag_set": "code",
"num_value": null,
"group_tracking_ids": ["api-reference/file/delete-file"]
},
{
"id": "fa7da060-c6ae-4bdf-ab6c-c1e0ebfd244e",
"link": "api-reference/chunk_group/delete-group",
"qdrant_point_id": "8a2456ad-7fa1-446d-9eee-f1e4d585a1cb",
"created_at": "2024-06-21T05:04:58.081688",
"updated_at": "2024-06-21T05:04:58.081688",
"chunk_html": "\n\nREST Endpoint DELETE /api/chunk_group/{group_id}\n\nSummary: Delete Group \n\nDescription: Delete Group\n\nThis will delete a chunk_group. If you set delete_chunks to true, it will also delete the chunks within the group. Auth'ed user or api key must have an admin or owner role for the specified dataset's organization.\n\nSecurity methods: \nheader: apiKey\n\nRequest params: \npath params:\ngroup_id:\n\tstring\n\tDescription: Id of the group you want to fetch.\n\tExample: \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n\nquery params:\ndelete_chunks:\n\tboolean\n\tDescription: Delete the chunks within the group\n\tExample: true\n\nheader params:\nTR-Dataset:\n\tstring\n\tDescription: The dataset id to use for the request\n\tExample: \"<string>\"\n\n\nRequest body: N/A\n\n\nResponses: \n204: N/A\n400: any\n\tDescription: N/A\n\tExample: \"<any>\"\n\n",
"metadata": {},
"tracking_id": "api-reference/chunk_group/delete-group-API-Metadata:-delete-/api/chunk_group/{group_id}",
"time_stamp": null,
"dataset_id": "fd92b3c5-079c-4bfb-b806-3c4f49b87b31",
"weight": 0,
"location": null,
"image_urls": null,
"tag_set": "code",
"num_value": null,
"group_tracking_ids": ["api-reference/chunk_group/delete-group"]
},
{
"id": "a23e9d5f-2845-46ab-961a-53efaef14a32",
"link": "api-reference/chunk/get-chunks-by-ids",
"qdrant_point_id": "920922be-2a28-436e-9337-40cb6103670c",
"created_at": "2024-06-21T05:04:57.272258",
"updated_at": "2024-06-21T05:04:57.272258",
"chunk_html": "Get Chunks By Ids\nGet Chunks By Ids\n\nGet multiple chunks by multiple ids.",
"metadata": { "openapi": "post /api/chunks", "title": "Get Chunks By Ids" },
"tracking_id": "api-reference/chunk/get-chunks-by-ids-Get-Chunks-By-Ids-Get-Chunks-By-",
"time_stamp": null,
"dataset_id": "fd92b3c5-079c-4bfb-b806-3c4f49b87b31",
"weight": 0,
"location": null,
"image_urls": null,
"tag_set": "page",
"num_value": null,
"group_tracking_ids": ["api-reference/chunk/get-chunks-by-ids"]
},
{
"id": "5a7a65ee-eae3-4f7a-b61b-811f0e8142fe",
"link": "api-reference/chunk/get-recommended-chunks",
"qdrant_point_id": "bc1ef58a-81a1-4364-a1ec-eae3667cb4f3",
"created_at": "2024-06-21T05:04:57.446925",
"updated_at": "2024-06-21T05:04:57.446926",
"chunk_html": "\n\nREST Endpoint POST /api/chunk/recommend\n\nSummary: Get Recommended Chunks \n\nDescription: Get Recommended Chunks\n\nGet recommendations of chunks similar to the positive samples in the request and dissimilar to the negative. You must provide at least one of either positive_chunk_ids or positive_tracking_ids.\n\nSecurity methods: \nheader: apiKey\n\nRequest params: \nheader params:\nTR-Dataset:\n\tstring\n\tDescription: The dataset id to use for the request\n\tExample: \"<string>\"\n\n\nRequest body: any\n\tDescription: N/A\n\tExample: \"<any>\"\n\n\nResponses: \n200: array\n\tDescription: N/A\n\tExample: [\"<any>\"]\n400: any\n\tDescription: N/A\n\tExample: \"<any>\"\n\n",
"metadata": {},
"tracking_id": "api-reference/chunk/get-recommended-chunks-API-Metadata:-post-/api/chunk/recommend",
"time_stamp": null,
"dataset_id": "fd92b3c5-079c-4bfb-b806-3c4f49b87b31",
"weight": 0,
"location": null,
"image_urls": null,
"tag_set": "code",
"num_value": null,
"group_tracking_ids": ["api-reference/chunk/get-recommended-chunks"]
},
{
"id": "80d24f50-40ef-4d53-8dbe-ecddc9d40d98",
"link": "api-reference/chunk_group/add-chunk-to-group-by-tracking-id",
"qdrant_point_id": "ed4a6203-8b41-4391-9f76-71b880d2707f",
"created_at": "2024-06-21T05:04:57.759834",
"updated_at": "2024-06-21T05:04:57.759835",
"chunk_html": "Add Chunk to Group by Tracking ID\nAdd Chunk to Group by Tracking ID\n\nRoute to add a chunk to a group by tracking id. Auth'ed user or api key must have an admin or owner role for the specified dataset's organization.",
"metadata": {
"openapi": "post /api/chunk_group/tracking_id/{tracking_id}",
"title": "Add Chunk to Group by Tracking ID"
},
"tracking_id": "api-reference/chunk_group/add-chunk-to-group-by-tracking-id-Add-Chunk-to-Group-by-Tracking-I",
"time_stamp": null,
"dataset_id": "fd92b3c5-079c-4bfb-b806-3c4f49b87b31",
"weight": 0,
"location": null,
"image_urls": null,
"tag_set": "page",
"num_value": null,
"group_tracking_ids": [
"api-reference/chunk_group/add-chunk-to-group-by-tracking-id"
]
},
{
"id": "ea0a1d69-45b7-4c3c-8b1b-f371c32dbe1a",
"link": "api-reference/chunk/rag-on-specified-chunks",
"qdrant_point_id": "72386826-8319-422a-862c-2aac5003984f",
"created_at": "2024-06-21T05:04:57.525751",
"updated_at": "2024-06-21T05:04:57.525752",
"chunk_html": "\n\nREST Endpoint POST /api/chunk/generate\n\nSummary: RAG on Specified Chunks \n\nDescription: RAG on Specified Chunks\n\nThis endpoint exists as an alternative to the topic+message concept where our API handles chat memory. With this endpoint, the user is responsible for providing the context window and the prompt. See more in the \"search before generate\" page at docs.trieve.ai.\n\nSecurity methods: \nheader: apiKey\n\nRequest params: \nheader params:\nTR-Dataset:\n\tstring\n\tDescription: The dataset id to use for the request\n\tExample: \"<string>\"\n\n\nRequest body: any\n\tDescription: N/A\n\tExample: \"<any>\"\n\n\nResponses: \n200: string\n\tDescription: N/A\n\tExample: \"<string>\"\n400: any\n\tDescription: N/A\n\tExample: \"<any>\"\n\n",
"metadata": {},
"tracking_id": "api-reference/chunk/rag-on-specified-chunks-API-Metadata:-post-/api/chunk/generate",
"time_stamp": null,
"dataset_id": "fd92b3c5-079c-4bfb-b806-3c4f49b87b31",
"weight": 0,
"location": null,
"image_urls": null,
"tag_set": "code",
"num_value": null,
"group_tracking_ids": ["api-reference/chunk/rag-on-specified-chunks"]
},
{
"id": "1333145b-4445-44c7-84b0-8660c6993afb",
"link": "api-reference/chunk/search",
"qdrant_point_id": "b612418d-238a-442c-9cef-a6dfa1356e17",
"created_at": "2024-06-21T05:04:57.557388",
"updated_at": "2024-06-21T05:04:57.557388",
"chunk_html": "Search\nSearch\n\nThis route provides the primary search functionality for the API. It can be used to search for chunks by semantic similarity, full-text similarity, or a combination of both. Results' `chunk_html` values will be modified with `<b><mark>` tags for sub-sentence highlighting.",
"metadata": { "openapi": "post /api/chunk/search", "title": "Search" },
"tracking_id": "api-reference/chunk/search-Search-Search-This-route-provid",
"time_stamp": null,
"dataset_id": "fd92b3c5-079c-4bfb-b806-3c4f49b87b31",
"weight": 0,
"location": null,
"image_urls": null,
"tag_set": "page",
"num_value": null,
"group_tracking_ids": ["api-reference/chunk/search"]
},
{
"id": "669a79db-4e1c-4095-88ba-d15478555eb4",
"link": "api-reference/chunk/generate-suggested-queries",
"qdrant_point_id": "ca354aaf-6c93-42d3-b329-395cb6c1ce71",
"created_at": "2024-06-21T05:04:57.092382",
"updated_at": "2024-06-21T05:04:57.092383",
"chunk_html": "\n\nREST Endpoint POST /api/chunk/gen_suggestions\n\nSummary: Generate suggested queries \n\nDescription: Generate suggested queries\n\nThis endpoint will generate 3 suggested queries based off a hybrid search using RAG with the query provided in the request body and return them as a JSON object.\n\nSecurity methods: \nheader: apiKey\n\nRequest params: \nheader params:\nTR-Dataset:\n\tstring\n\tDescription: The dataset id to use for the request\n\tExample: \"<string>\"\n\n\nRequest body: any\n\tDescription: N/A\n\tExample: \"<any>\"\n\n\nResponses: \n200: any\n\tDescription: N/A\n\tExample: \"<any>\"\n400: any\n\tDescription: N/A\n\tExample: \"<any>\"\n\n",
"metadata": {},
"tracking_id": "api-reference/chunk/generate-suggested-queries-API-Metadata:-post-/api/chunk/gen_suggestions",
"time_stamp": null,
"dataset_id": "fd92b3c5-079c-4bfb-b806-3c4f49b87b31",
"weight": 0,
"location": null,
"image_urls": null,
"tag_set": "code",
"num_value": null,
"group_tracking_ids": ["api-reference/chunk/generate-suggested-queries"]
},
{
"id": "7be6bc3a-8b10-4cde-b336-37f461c98020",
"link": "api-reference/chunk_group/get-recommended-groups",
"qdrant_point_id": "d5efadde-b4b4-438e-b001-6ce24f53d3aa",
"created_at": "2024-06-21T05:04:58.545678",
"updated_at": "2024-06-21T05:04:58.545679",
"chunk_html": "Get Recommended Groups\nGet Recommended Groups\n\nRoute to get recommended groups. This route will return groups which are similar to the groups in the request body. You must provide at least one positive group id or group tracking id.",
"metadata": {
"openapi": "post /api/chunk_group/recommend",
"title": "Get Recommended Groups"
},
"tracking_id": "api-reference/chunk_group/get-recommended-groups-Get-Recommended-Groups-Get-Recom",
"time_stamp": null,
"dataset_id": "fd92b3c5-079c-4bfb-b806-3c4f49b87b31",
"weight": 0,
"location": null,
"image_urls": null,
"tag_set": "page",
"num_value": null,
"group_tracking_ids": ["api-reference/chunk_group/get-recommended-groups"]
},
{
"id": "c4b48582-d9ae-4d36-a34e-46d550c9ef06",
"link": "api-reference/topic/create-topic",
"qdrant_point_id": "be0b203c-cddc-4d2e-813c-ac8aed3a4c09",
"created_at": "2024-06-21T05:04:57.799387",
"updated_at": "2024-06-21T05:04:57.799387",
"chunk_html": "\n\nREST Endpoint POST /api/topic\n\nSummary: Create Topic \n\nDescription: Create Topic\n\nCreate a new chat topic. Topics are attached to a owner_id's and act as a coordinator for conversation message history of gen-AI chat sessions. Auth'ed user or api key must have an admin or owner role for the specified dataset's organization.\n\nSecurity methods: \nheader: apiKey\n\nRequest params: \nheader params:\nTR-Dataset:\n\tstring\n\tDescription: The dataset id to use for the request\n\tExample: \"<string>\"\n\n\nRequest body: any\n\tDescription: N/A\n\tExample: \"<any>\"\n\n\nResponses: \n200: any\n\tDescription: N/A\n\tExample: \"<any>\"\n400: any\n\tDescription: N/A\n\tExample: \"<any>\"\n\n",
"metadata": {},
"tracking_id": "api-reference/topic/create-topic-API-Metadata:-post-/api/topic",
"time_stamp": null,
"dataset_id": "fd92b3c5-079c-4bfb-b806-3c4f49b87b31",
"weight": 0,
"location": null,
"image_urls": null,
"tag_set": "code",
"num_value": null,
"group_tracking_ids": ["api-reference/topic/create-topic"]
},
{
"id": "0ab5b84f-6215-4c4f-998e-b7c5a69862c3",
"link": "api-reference/topic/update-topic",
"qdrant_point_id": "29e92f05-8c5e-43e9-bfef-55fbe2de1dfc",
"created_at": "2024-06-21T05:04:57.976922",
"updated_at": "2024-06-21T05:04:57.976922",
"chunk_html": "Update Topic\nUpdate Topic\n\nUpdate an existing chat topic. Currently, only the name of the topic can be updated. Auth'ed user or api key must have an admin or owner role for the specified dataset's organization.",
"metadata": { "openapi": "put /api/topic", "title": "Update Topic" },
"tracking_id": "api-reference/topic/update-topic-Update-Topic-Update-Topic-Updat",
"time_stamp": null,
"dataset_id": "fd92b3c5-079c-4bfb-b806-3c4f49b87b31",
"weight": 0,
"location": null,
"image_urls": null,
"tag_set": "page",
"num_value": null,
"group_tracking_ids": ["api-reference/topic/update-topic"]
},
{
"id": "11600cac-189b-4f91-981e-854a45a411c9",
"link": "examples/ecommerce",
"qdrant_point_id": "3584b571-c467-48e4-80de-e03eec43ca0a",
"created_at": "2024-06-21T05:04:58.372085",
"updated_at": "2024-06-21T05:04:58.424928",
"chunk_html": "CSV Metadata\nThis should extract multiple lines that have",
"metadata": { "title": "CSV Metadata" },
"tracking_id": "examples/ecommerce-CSV-Metadata",
"time_stamp": null,
"dataset_id": "fd92b3c5-079c-4bfb-b806-3c4f49b87b31",
"weight": 0,
"location": null,
"image_urls": null,
"tag_set": "",
"num_value": null,
"group_tracking_ids": ["examples/ecommerce"]
},
{
"id": "6412649b-6343-4713-bc00-e8b2bcbf2e28",
"link": "api-reference/chunk/get-chunk-by-tracking-id",
"qdrant_point_id": "a203038c-5e75-4c8f-94fe-3e2a1e0ad4b8",
"created_at": "2024-06-21T05:04:57.239083",
"updated_at": "2024-06-21T05:04:57.239084",
"chunk_html": "\n\nREST Endpoint GET /api/chunk/tracking_id/{tracking_id}\n\nSummary: Get Chunk By Tracking Id \n\nDescription: Get Chunk By Tracking Id\n\nGet a singular chunk by tracking_id. This is useful for when you are coordinating with an external system and want to use your own id as the primary reference for a chunk.\n\nSecurity methods: \nheader: apiKey\n\nRequest params: \npath params:\ntracking_id:\n\tstring\n\tDescription: tracking_id of the chunk you want to fetch\n\tExample: \"<string>\"\n\nheader params:\nTR-Dataset:\n\tstring\n\tDescription: The dataset id to use for the request\n\tExample: \"<string>\"\n\n\nRequest body: N/A\n\n\nResponses: \n200: any\n\tDescription: N/A\n\tExample: \"<any>\"\n400: any\n\tDescription: N/A\n\tExample: \"<any>\"\n404: any\n\tDescription: N/A\n\tExample: \"<any>\"\n\n",
"metadata": {},
"tracking_id": "api-reference/chunk/get-chunk-by-tracking-id-API-Metadata:-get-/api/chunk/tracking_id/{tracking_id}",
"time_stamp": null,
"dataset_id": "fd92b3c5-079c-4bfb-b806-3c4f49b87b31",
"weight": 0,
"location": null,
"image_urls": null,
"tag_set": "code",
"num_value": null,
"group_tracking_ids": ["api-reference/chunk/get-chunk-by-tracking-id"]
},
{
"id": "b7d94a81-54ba-40fd-9274-5cbf02a36bb9",
"link": "api-reference/chunk_group/get-chunks-in-group",
"qdrant_point_id": "79a2ce82-9e7b-442e-8f3b-dad94ddc29a5",
"created_at": "2024-06-21T05:04:58.237469",
"updated_at": "2024-06-21T05:04:58.237469",
"chunk_html": "\n\nREST Endpoint GET /api/chunk_group/{group_id}/{page}\n\nSummary: Get Chunks in Group \n\nDescription: Get Chunks in Group\n\nRoute to get all chunks for a group. The response is paginated, with each page containing 10 chunks. Page is 1-indexed.\n\nSecurity methods: \nheader: apiKey\n\nRequest params: \npath params:\ngroup_id:\n\tstring\n\tDescription: Id of the group you want to fetch.\n\tExample: \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\npage:\n\tinteger\n\tDescription: The page of chunks to get from the group\n\tExample: 1\n\tnull\n\tDescription: The page of chunks to get from the group\n\tExample: null\n\nheader params:\nTR-Dataset:\n\tstring\n\tDescription: The dataset id to use for the request\n\tExample: \"<string>\"\n\n\nRequest body: N/A\n\n\nResponses: \n200: any\n\tDescription: N/A\n\tExample: \"<any>\"\n400: any\n\tDescription: N/A\n\tExample: \"<any>\"\n404: any\n\tDescription: N/A\n\tExample: \"<any>\"\n\n",
"metadata": {},
"tracking_id": "api-reference/chunk_group/get-chunks-in-group-API-Metadata:-get-/api/chunk_group/{group_id}/{page}",
"time_stamp": null,
"dataset_id": "fd92b3c5-079c-4bfb-b806-3c4f49b87b31",
"weight": 0,
"location": null,
"image_urls": null,
"tag_set": "code",
"num_value": null,
"group_tracking_ids": ["api-reference/chunk_group/get-chunks-in-group"]
},
{
"id": "cb2154a5-047d-45ce-a400-7dacaa479691",
"link": "examples/ecommerce",
"qdrant_point_id": "7fa5c33e-a00d-4a70-b2ca-11bf9bf0a895",
"created_at": "2024-06-21T05:04:58.453643",
"updated_at": "2024-06-21T05:04:58.542119",
"chunk_html": "Image CSV Data\nThe images.csv is formatted as the following.",
"metadata": { "title": "Image CSV Data" },
"tracking_id": "examples/ecommerce-Image-CSV-Data",
"time_stamp": null,
"dataset_id": "fd92b3c5-079c-4bfb-b806-3c4f49b87b31",
"weight": 0,
"location": null,
"image_urls": null,
"tag_set": "",
"num_value": null,
"group_tracking_ids": ["examples/ecommerce"]
},
{
"id": "15f8df27-0ff2-4671-93d4-e7af64f50d56",
"link": "api-reference/stripe/get-all-plans",
"qdrant_point_id": "b17045bd-8fe9-4476-96a8-5702cb1513b8",
"created_at": "2024-06-21T05:04:57.664862",
"updated_at": "2024-06-21T05:04:57.664862",
"chunk_html": "\n\nREST Endpoint GET /api/stripe/plans\n\nSummary: Get All Plans \n\nDescription: Get All Plans\n\nGet a list of all plans\n\nSecurity methods: \n\nRequest params: \n\nRequest body: N/A\n\n\nResponses: \n200: array\n\tDescription: N/A\n\tExample: [\"<any>\"]\n400: any\n\tDescription: N/A\n\tExample: \"<any>\"\n\n",
"metadata": {},
"tracking_id": "api-reference/stripe/get-all-plans-API-Metadata:-get-/api/stripe/plans",
"time_stamp": null,
"dataset_id": "fd92b3c5-079c-4bfb-b806-3c4f49b87b31",
"weight": 0,
"location": null,
"image_urls": null,
"tag_set": "code",
"num_value": null,
"group_tracking_ids": ["api-reference/stripe/get-all-plans"]
},
{
"id": "eee8cc98-f7e1-444a-a4d2-9389b4be95d0",
"link": "api-reference/chunk_group/get-group-by-tracking-id",
"qdrant_point_id": "d41884b1-a3c8-46bc-b4a6-4d409d496b43",
"created_at": "2024-06-21T05:04:58.268775",
"updated_at": "2024-06-21T05:04:58.268776",
"chunk_html": "Get Group by Tracking ID\nGet Group by Tracking ID\n\nFetch the group with the given tracking id.\nget_group_by_tracking_id",
"metadata": {
"openapi": "get /api/chunk_group/tracking_id/{tracking_id}",
"title": "Get Group by Tracking ID"
},
"tracking_id": "api-reference/chunk_group/get-group-by-tracking-id-Get-Group-by-Tracking-ID-Get-Gro",
"time_stamp": null,
"dataset_id": "fd92b3c5-079c-4bfb-b806-3c4f49b87b31",
"weight": 0,
"location": null,
"image_urls": null,
"tag_set": "page",
"num_value": null,
"group_tracking_ids": ["api-reference/chunk_group/get-group-by-tracking-id"]
},
{
"id": "14875194-1448-452a-bc58-f3ae0fa4dd90",
"link": "api-reference/chunk_group/update-group-by-tracking-id",
"qdrant_point_id": "a1439fe1-c7b3-4a12-b481-a47676491a44",
"created_at": "2024-06-21T05:04:58.908252",
"updated_at": "2024-06-21T05:04:58.908252",
"chunk_html": "\n(deprecated) \nREST Endpoint PUT /api/chunk_group/tracking_id/{tracking_id}\n\nSummary: Update Group by Tracking ID \n\nDescription: Update Group by Tracking ID\n\nUpdate a chunk_group with the given tracking id. Auth'ed user or api key must have an admin or owner role for the specified dataset's organization.\n\nSecurity methods: \nheader: apiKey\n\nRequest params: \npath params:\ntracking_id:\n\tstring\n\tDescription: Tracking id of the chunk_group to update\n\tExample: \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n\nheader params:\nTR-Dataset:\n\tstring\n\tDescription: The dataset id to use for the request\n\tExample: \"<string>\"\n\n\nRequest body: any\n\tDescription: N/A\n\tExample: \"<any>\"\n\n\nResponses: \n204: N/A\n400: any\n\tDescription: N/A\n\tExample: \"<any>\"\n\n",
"metadata": {},
"tracking_id": "api-reference/chunk_group/update-group-by-tracking-id-API-Metadata:-put-/api/chunk_group/tracking_id/{tracking_id}",
"time_stamp": null,
"dataset_id": "fd92b3c5-079c-4bfb-b806-3c4f49b87b31",
"weight": 0,
"location": null,
"image_urls": null,
"tag_set": "code",
"num_value": null,
"group_tracking_ids": [
"api-reference/chunk_group/update-group-by-tracking-id"
]
},
{
"id": "3fa4004d-8288-4b15-8c89-b3bb39558f82",
"link": "api-reference/file/get-files-for-dataset",
"qdrant_point_id": "8f7724f7-293f-4ec3-b100-fee2c1ceb7e1",
"created_at": "2024-06-21T05:04:59.722193",
"updated_at": "2024-06-21T05:04:59.722194",
"chunk_html": "Get Files for Dataset\nGet Files for Dataset\n\nGet all files which belong to a given dataset specified by the dataset_id parameter. 10 files are returned per page.",
"metadata": {
"openapi": "get /api/dataset/files/{dataset_id}/{page}",
"title": "Get Files for Dataset"
},
"tracking_id": "api-reference/file/get-files-for-dataset-Get-Files-for-Dataset-Get-Files-",
"time_stamp": null,
"dataset_id": "fd92b3c5-079c-4bfb-b806-3c4f49b87b31",
"weight": 0,
"location": null,
"image_urls": null,
"tag_set": "page",
"num_value": null,
"group_tracking_ids": ["api-reference/file/get-files-for-dataset"]
},
{
"id": "004c4122-9dbe-47f1-a72a-382929f8adc1",
"link": "api-reference/file/upload-file",
"qdrant_point_id": "a7fc9390-b2e9-4b0f-b49a-579928794ce7",
"created_at": "2024-06-21T05:04:59.786821",
"updated_at": "2024-06-21T05:04:59.786821",
"chunk_html": "Upload File\nUpload File\n\nUpload a file to S3 attached to the server. The file will be converted to HTML with tika and chunked algorithmically, images will be OCR'ed with tesseract. The resulting chunks will be indexed and searchable. Optionally, you can only upload the file and manually create chunks associated to the file after. See docs.trieve.ai and/or contact us for more details and tips. Auth'ed user must be an admin or owner of the dataset's organization to upload a file.",
"metadata": { "openapi": "post /api/file", "title": "Upload File" },
"tracking_id": "api-reference/file/upload-file-Upload-File-Upload-File-Upload-",
"time_stamp": null,
"dataset_id": "fd92b3c5-079c-4bfb-b806-3c4f49b87b31",
"weight": 0,
"location": null,
"image_urls": null,
"tag_set": "page",
"num_value": null,
"group_tracking_ids": ["api-reference/file/upload-file"]
},
{
"id": "a756eee7-0bf8-43d4-b939-302845c50a89",
"link": "api-reference/file/upload-file",
"qdrant_point_id": "b914229c-14ae-49e2-924e-123e6b8ee6d0",
"created_at": "2024-06-21T05:04:59.822159",
"updated_at": "2024-06-21T05:04:59.822160",
"chunk_html": "\n\nREST Endpoint POST /api/file\n\nSummary: Upload File \n\nDescription: Upload File\n\nUpload a file to S3 attached to the server. The file will be converted to HTML with tika and chunked algorithmically, images will be OCR'ed with tesseract. The resulting chunks will be indexed and searchable. Optionally, you can only upload the file and manually create chunks associated to the file after. See docs.trieve.ai and/or contact us for more details and tips. Auth'ed user must be an admin or owner of the dataset's organization to upload a file.\n\nSecurity methods: \nheader: apiKey\n\nRequest params: \nheader params:\nTR-Dataset:\n\tstring\n\tDescription: The dataset id to use for the request\n\tExample: \"<string>\"\n\n\nRequest body: any\n\tDescription: N/A\n\tExample: \"<any>\"\n\n\nResponses: \n200: any\n\tDescription: N/A\n\tExample: \"<any>\"\n400: any\n\tDescription: N/A\n\tExample: \"<any>\"\n\n",
"metadata": {},
"tracking_id": "api-reference/file/upload-file-API-Metadata:-post-/api/file",
"time_stamp": null,
"dataset_id": "fd92b3c5-079c-4bfb-b806-3c4f49b87b31",
"weight": 0,
"location": null,
"image_urls": null,
"tag_set": "code",
"num_value": null,
"group_tracking_ids": ["api-reference/file/upload-file"]
},
{
"id": "8e4ae460-4176-404f-9f8f-2ca1ca1c6809",
"link": "guides/create-chunk",
"qdrant_point_id": "ececd46f-d412-4fd1-9c7a-69bd0fc4bfb2",
"created_at": "2024-06-21T05:04:59.927098",
"updated_at": "2024-06-21T05:04:59.927098",
"chunk_html": "Overview\nWe provide an easy interface for users to upload their chunks individually so that users should have control over how they chunk their data",
"metadata": { "title": "Overview" },
"tracking_id": "guides/create-chunk-Overview",
"time_stamp": null,
"dataset_id": "fd92b3c5-079c-4bfb-b806-3c4f49b87b31",
"weight": 0,
"location": null,
"image_urls": null,
"tag_set": "",
"num_value": null,
"group_tracking_ids": ["guides/create-chunk"]
},
{
"id": "e50eb596-8b1a-4db9-8d7c-5147a05f8a7a",
"link": "introduction",
"qdrant_point_id": "765e99da-0667-4eba-834b-2293b1dfa159",
"created_at": "2024-06-21T05:05:00.666108",
"updated_at": "2024-06-21T05:05:00.666108",
"chunk_html": "Introduction\nIntroduction\nTrieve is infrastructure for building search, recommendations, and RAG experiences. Semantic search and RAG are powerful primitives, but can take months to implement and deploy when accounting for big details like chunking, maximal marginal relevance, filters, weighting, model-selection, and more. With Trieve, you can complete and deploy a ChatGPT like experience or a semantic search engine on your data in a matter of hours. Build semantic search and RAG fast.",
"metadata": { "title": "Introduction" },
"tracking_id": "introduction-Introduction-Introduction-Trieve",
"time_stamp": null,
"dataset_id": "fd92b3c5-079c-4bfb-b806-3c4f49b87b31",
"weight": 0,
"location": null,
"image_urls": null,
"tag_set": "page",
"num_value": null,
"group_tracking_ids": ["introduction"]
},
{
"id": "c7e7a82e-7ee1-4445-b80f-5a178a321221",
"link": "quickstart",
"qdrant_point_id": "738ee5ac-eaca-4a0c-92e7-85773691cdfd",
"created_at": "2024-06-21T05:05:00.739489",
"updated_at": "2024-06-21T05:05:00.739490",
"chunk_html": "Create an account\nTo get started, sign up for a free account at dashboard.trieve.ai . With a free account, you can upload up to 1000 chunks and 512 mb of files.",
"metadata": { "title": "Create an account" },
"tracking_id": "quickstart-Create-an-account",
"time_stamp": null,
"dataset_id": "fd92b3c5-079c-4bfb-b806-3c4f49b87b31",
"weight": 0,
"location": null,
"image_urls": null,
"tag_set": "",
"num_value": null,
"group_tracking_ids": ["quickstart"]
},
{
"id": "27b5447a-ca00-40cd-8342-fcbd28d75f1e",
"link": "api-reference/chunk_group/get-chunks-in-group",
"qdrant_point_id": "35b0cc13-35ca-4173-a5db-9d90ea17eb84",
"created_at": "2024-06-21T05:04:58.188805",
"updated_at": "2024-06-21T05:04:58.188805",
"chunk_html": "Get Chunks in Group\nGet Chunks in Group\n\nRoute to get all chunks for a group. The response is paginated, with each page containing 10 chunks. Page is 1-indexed.",
"metadata": {
"openapi": "get /api/chunk_group/{group_id}/{page}",
"title": "Get Chunks in Group"
},
"tracking_id": "api-reference/chunk_group/get-chunks-in-group-Get-Chunks-in-Group-Get-Chunks-i",
"time_stamp": null,
"dataset_id": "fd92b3c5-079c-4bfb-b806-3c4f49b87b31",
"weight": 0,
"location": null,
"image_urls": null,
"tag_set": "page",
"num_value": null,
"group_tracking_ids": ["api-reference/chunk_group/get-chunks-in-group"]
},
{
"id": "3f2a200b-ee9e-4d1b-b1ec-f9264cde882b",
"link": "api-reference/message/get-all-messages-for-a-given-topic",
"qdrant_point_id": "8d5d38e1-82ad-489e-8b04-45fd05fb3d21",
"created_at": "2024-06-21T05:04:56.949231",
"updated_at": "2024-06-21T05:04:56.949231",
"chunk_html": "\n\nREST Endpoint GET /api/messages/{messages_topic_id}\n\nSummary: Get all messages for a given topic \n\nDescription: Get all messages for a given topic\n\nGet all messages for a given topic. If the topic is a RAG topic then the response will include Chunks first on each message. The structure will look like `[chunks]||mesage`. See docs.trieve.ai for more information.\n\nSecurity methods: \nheader: apiKey\n\nRequest params: \npath params:\nmessages_topic_id:\n\tstring\n\tDescription: The ID of the topic to get messages for.\n\tExample: \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n\nheader params:\nTR-Dataset:\n\tstring\n\tDescription: The dataset id to use for the request\n\tExample: \"<string>\"\n\n\nRequest body: N/A\n\n\nResponses: \n200: array\n\tDescription: N/A\n\tExample: [\"<any>\"]\n400: any\n\tDescription: N/A\n\tExample: \"<any>\"\n\n",
"metadata": {},
"tracking_id": "api-reference/message/get-all-messages-for-a-given-topic-API-Metadata:-get-/api/messages/{messages_topic_id}",
"time_stamp": null,
"dataset_id": "fd92b3c5-079c-4bfb-b806-3c4f49b87b31",
"weight": 0,
"location": null,
"image_urls": null,
"tag_set": "code",
"num_value": null,
"group_tracking_ids": [
"api-reference/message/get-all-messages-for-a-given-topic"
]
},
{
"id": "358cebed-1a1f-4e72-bdfd-b969b0906c55",
"link": "api-reference/organization/create-organization",
"qdrant_point_id": "fb077d63-1eb7-41fc-bec7-a8f1bf52347a",
"created_at": "2024-06-21T05:04:57.109042",
"updated_at": "2024-06-21T05:04:57.109042",
"chunk_html": "\n\nREST Endpoint POST /api/organization\n\nSummary: Create Organization \n\nDescription: Create Organization\n\nCreate a new organization. The auth'ed user who creates the organization will be the default owner of the organization.\n\nSecurity methods: \nheader: apiKey\n\nRequest params: \n\nRequest body: any\n\tDescription: N/A\n\tExample: \"<any>\"\n\n\nResponses: \n200: any\n\tDescription: N/A\n\tExample: \"<any>\"\n400: any\n\tDescription: N/A\n\tExample: \"<any>\"\n\n",
"metadata": {},
"tracking_id": "api-reference/organization/create-organization-API-Metadata:-post-/api/organization",
"time_stamp": null,
"dataset_id": "fd92b3c5-079c-4bfb-b806-3c4f49b87b31",
"weight": 0,
"location": null,
"image_urls": null,
"tag_set": "code",
"num_value": null,
"group_tracking_ids": ["api-reference/organization/create-organization"]
},
{
"id": "39e920a9-0d64-44b3-960b-86d919a15e95",
"link": "api-reference/organization/get-organization",
"qdrant_point_id": "d3aff00f-2f40-4ad2-bc8c-e60099824796",
"created_at": "2024-06-21T05:04:57.392772",
"updated_at": "2024-06-21T05:04:57.392772",
"chunk_html": "\n\nREST Endpoint GET /api/organization/{organization_id}\n\nSummary: Get Organization \n\nDescription: Get Organization\n\nFetch the details of an organization by its id. Auth'ed user or api key must have an admin or owner role for the specified dataset's organization.\n\nSecurity methods: \nheader: apiKey\n\nRequest params: \npath params:\norganization_id:\n\tstring\n\tDescription: The id of the organization you want to fetch.\n\tExample: \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n\nheader params:\nTR-Organization:\n\tstring\n\tDescription: The organization id to use for the request\n\tExample: \"<string>\"\n\n\nRequest body: N/A\n\n\nResponses: \n200: any\n\tDescription: N/A\n\tExample: \"<any>\"\n400: any\n\tDescription: N/A\n\tExample: \"<any>\"\n404: any\n\tDescription: N/A\n\tExample: \"<any>\"\n\n",
"metadata": {},
"tracking_id": "api-reference/organization/get-organization-API-Metadata:-get-/api/organization/{organization_id}",
"time_stamp": null,
"dataset_id": "fd92b3c5-079c-4bfb-b806-3c4f49b87b31",
"weight": 0,
"location": null,
"image_urls": null,
"tag_set": "code",
"num_value": null,
"group_tracking_ids": ["api-reference/organization/get-organization"]
},
{
"id": "8dce326b-57b4-46a5-9ad5-995aeffb9c15",
"link": "api-reference/chunk/rag-on-specified-chunks",
"qdrant_point_id": "019991c4-8458-45f1-be0d-1e579c51ca9e",
"created_at": "2024-06-21T05:04:57.480943",
"updated_at": "2024-06-21T05:04:57.480943",
"chunk_html": "RAG on Specified Chunks\nRAG on Specified Chunks\n\nThis endpoint exists as an alternative to the topic+message concept where our API handles chat memory. With this endpoint, the user is responsible for providing the context window and the prompt. See more in the \"search before generate\" page at docs.trieve.ai.",
"metadata": {
"openapi": "post /api/chunk/generate",
"title": "RAG on Specified Chunks"
},
"tracking_id": "api-reference/chunk/rag-on-specified-chunks-RAG-on-Specified-Chunks-RAG-on-S",
"time_stamp": null,
"dataset_id": "fd92b3c5-079c-4bfb-b806-3c4f49b87b31",
"weight": 0,
"location": null,
"image_urls": null,
"tag_set": "page",
"num_value": null,
"group_tracking_ids": ["api-reference/chunk/rag-on-specified-chunks"]
},
{
"id": "2f8a8147-b835-4bad-a6cb-41003b2f42c0",
"link": "api-reference/chunk/update-chunk",
"qdrant_point_id": "b20840e2-7baf-4174-95a8-80af97cab466",
"created_at": "2024-06-21T05:04:57.728084",
"updated_at": "2024-06-21T05:04:57.728084",
"chunk_html": "\n\nREST Endpoint PUT /api/chunk\n\nSummary: Update Chunk \n\nDescription: Update Chunk\n\nUpdate a chunk. If you try to change the tracking_id of the chunk to have the same tracking_id as an existing chunk, the request will fail. Auth'ed user or api key must have an admin or owner role for the specified dataset's organization.\n\nSecurity methods: \nheader: apiKey\n\nRequest params: \nheader params:\nTR-Dataset:\n\tstring\n\tDescription: The dataset id to use for the request\n\tExample: \"<string>\"\n\n\nRequest body: any\n\tDescription: N/A\n\tExample: \"<any>\"\n\n\nResponses: \n204: N/A\n400: any\n\tDescription: N/A\n\tExample: \"<any>\"\n\n",
"metadata": {},
"tracking_id": "api-reference/chunk/update-chunk-API-Metadata:-put-/api/chunk",
"time_stamp": null,
"dataset_id": "fd92b3c5-079c-4bfb-b806-3c4f49b87b31",
"weight": 0,
"location": null,
"image_urls": null,
"tag_set": "code",
"num_value": null,
"group_tracking_ids": ["api-reference/chunk/update-chunk"]
},
{
"id": "ded21321-719b-448d-83b4-fe26fbbe28e9",
"link": "api-reference/user/delete-user-api-key",
"qdrant_point_id": "e7355e28-1bcc-4ac9-96b3-74a78776284e",
"created_at": "2024-06-21T05:04:58.050838",
"updated_at": "2024-06-21T05:04:58.050838",
"chunk_html": "Delete User Api Key\nDelete User Api Key\n\nDelete an api key for the auth'ed user.",
"metadata": {
"openapi": "delete /api/user/api_key/{api_key_id}",
"title": "Delete User Api Key"
},
"tracking_id": "api-reference/user/delete-user-api-key-Delete-User-Api-Key-Delete-User-",
"time_stamp": null,
"dataset_id": "fd92b3c5-079c-4bfb-b806-3c4f49b87b31",
"weight": 0,
"location": null,
"image_urls": null,
"tag_set": "page",
"num_value": null,
"group_tracking_ids": ["api-reference/user/delete-user-api-key"]
},
{
"id": "0b9e5bb8-19b1-4837-a453-07409116db91",
"link": "api-reference/chunk_group/get-group-by-tracking-id",
"qdrant_point_id": "a590fd7e-3d0b-4d01-9410-76e086c0b690",
"created_at": "2024-06-21T05:04:58.298490",
"updated_at": "2024-06-21T05:04:58.298491",
"chunk_html": "\n\nREST Endpoint GET /api/chunk_group/tracking_id/{tracking_id}\n\nSummary: Get Group by Tracking ID \n\nDescription: Get Group by Tracking ID\n\nFetch the group with the given tracking id.\nget_group_by_tracking_id\n\nSecurity methods: \nheader: apiKey\n\nRequest params: \npath params:\ntracking_id:\n\tstring\n\tDescription: The tracking id of the group to fetch.\n\tExample: \"<string>\"\n\nheader params:\nTR-Dataset:\n\tstring\n\tDescription: The dataset id to use for the request\n\tExample: \"<string>\"\n\n\nRequest body: N/A\n\n\nResponses: \n200: any\n\tDescription: N/A\n\tExample: \"<any>\"\n400: any\n\tDescription: N/A\n\tExample: \"<any>\"\n404: any\n\tDescription: N/A\n\tExample: \"<any>\"\n\n",
"metadata": {},
"tracking_id": "api-reference/chunk_group/get-group-by-tracking-id-API-Metadata:-get-/api/chunk_group/tracking_id/{tracking_id}",
"time_stamp": null,
"dataset_id": "fd92b3c5-079c-4bfb-b806-3c4f49b87b31",
"weight": 0,
"location": null,
"image_urls": null,
"tag_set": "code",
"num_value": null,
"group_tracking_ids": ["api-reference/chunk_group/get-group-by-tracking-id"]
},
{
"id": "8af12b96-f164-4bf2-b5aa-a7e4dca94f1a",
"link": "api-reference/chunk_group/get-group",
"qdrant_point_id": "70775de9-7814-4877-8602-add62f263b95",
"created_at": "2024-06-21T05:04:58.369769",
"updated_at": "2024-06-21T05:04:58.369769",
"chunk_html": "\n\nREST Endpoint GET /api/chunk_group/{group_id}\n\nSummary: Get Group \n\nDescription: Get Group\n\nFetch the group with the given id.\nget_group\n\nSecurity methods: \nheader: apiKey\n\nRequest params: \npath params:\ngroup_id:\n\tstring\n\tDescription: Id of the group you want to fetch.\n\tExample: \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n\nheader params:\nTR-Dataset:\n\tstring\n\tDescription: The dataset id to use for the request\n\tExample: \"<string>\"\n\n\nRequest body: N/A\n\n\nResponses: \n200: any\n\tDescription: N/A\n\tExample: \"<any>\"\n400: any\n\tDescription: N/A\n\tExample: \"<any>\"\n404: any\n\tDescription: N/A\n\tExample: \"<any>\"\n\n",
"metadata": {},
"tracking_id": "api-reference/chunk_group/get-group-API-Metadata:-get-/api/chunk_group/{group_id}",
"time_stamp": null,
"dataset_id": "fd92b3c5-079c-4bfb-b806-3c4f49b87b31",
"weight": 0,
"location": null,
"image_urls": null,
"tag_set": "code",
"num_value": null,
"group_tracking_ids": ["api-reference/chunk_group/get-group"]
},
{
"id": "6627fd8d-5ded-4bd1-9eed-499fb74c4993",
"link": "api-reference/chunk_group/search-within-group",
"qdrant_point_id": "f071b0d5-ec0c-445d-8a58-867f2494a972",
"created_at": "2024-06-21T05:04:58.824806",
"updated_at": "2024-06-21T05:04:58.824806",
"chunk_html": "\n\nREST Endpoint POST /api/chunk_group/search\n\nSummary: Search Within Group \n\nDescription: Search Within Group\n\nThis route allows you to search only within a group. This is useful for when you only want search results to contain chunks which are members of a specific group. If choosing hybrid search, the results will be re-ranked using BAAI/bge-reranker-large.\n\nSecurity methods: \nheader: apiKey\n\nRequest params: \nheader params:\nTR-Dataset:\n\tstring\n\tDescription: The dataset id to use for the request\n\tExample: \"<string>\"\n\n\nRequest body: any\n\tDescription: N/A\n\tExample: \"<any>\"\n\n\nResponses: \n200: any\n\tDescription: N/A\n\tExample: \"<any>\"\n400: any\n\tDescription: N/A\n\tExample: \"<any>\"\n\n",
"metadata": {},
"tracking_id": "api-reference/chunk_group/search-within-group-API-Metadata:-post-/api/chunk_group/search",
"time_stamp": null,
"dataset_id": "fd92b3c5-079c-4bfb-b806-3c4f49b87b31",
"weight": 0,
"location": null,
"image_urls": null,
"tag_set": "code",
"num_value": null,
"group_tracking_ids": ["api-reference/chunk_group/search-within-group"]
},
{
"id": "ba62d2a1-7107-4e26-abf6-420c64f0af1d",
"link": "api-reference/dataset/delete-dataset-by-tracking-id",
"qdrant_point_id": "081e97e8-bc92-4dd2-85a7-bb1878873783",
"created_at": "2024-06-21T05:04:59.091500",
"updated_at": "2024-06-21T05:04:59.091500",
"chunk_html": "Delete Dataset by Tracking ID\nDelete Dataset by Tracking ID\n\nDelete a dataset by its tracking id. The auth'ed user must be an owner of the organization to delete a dataset.",
"metadata": {
"openapi": "delete /api/dataset/tracking_id/{tracking_id}",
"title": "Delete Dataset by Tracking ID"
},
"tracking_id": "api-reference/dataset/delete-dataset-by-tracking-id-Delete-Dataset-by-Tracking-ID-De",
"time_stamp": null,
"dataset_id": "fd92b3c5-079c-4bfb-b806-3c4f49b87b31",
"weight": 0,
"location": null,
"image_urls": null,
"tag_set": "page",
"num_value": null,
"group_tracking_ids": [
"api-reference/dataset/delete-dataset-by-tracking-id"
]
},
{
"id": "b9a94026-2f9e-4fdf-a114-eaa92a5cc08c",
"link": "api-reference/dataset/delete-dataset",
"qdrant_point_id": "f030e4bc-e5e1-4053-81d3-f6beab75ee72",
"created_at": "2024-06-21T05:04:59.157782",
"updated_at": "2024-06-21T05:04:59.157782",
"chunk_html": "Delete Dataset\nDelete Dataset\n\nDelete a dataset. The auth'ed user must be an owner of the organization to delete a dataset.",
"metadata": {
"openapi": "delete /api/dataset/{dataset_id}",
"title": "Delete Dataset"
},
"tracking_id": "api-reference/dataset/delete-dataset-Delete-Dataset-Delete-Dataset-D",
"time_stamp": null,
"dataset_id": "fd92b3c5-079c-4bfb-b806-3c4f49b87b31",
"weight": 0,
"location": null,
"image_urls": null,
"tag_set": "page",
"num_value": null,
"group_tracking_ids": ["api-reference/dataset/delete-dataset"]
},
{
"id": "8e224948-f9b7-43a7-b387-c2a295e80628",
"link": "examples/job-board",
"qdrant_point_id": "1da04860-6721-45bb-a05f-f776088e88ff",
"created_at": "2024-06-21T05:04:59.363845",
"updated_at": "2024-06-21T05:04:59.409477",
"chunk_html": "Creating a data model to represent the data\nWhen we recieve the CSV data, we need to turn it into a data model to be able to effectively pull the data out of it. The data model for this CSV looks like:",
"metadata": { "title": "Creating a data model to represent the data" },
"tracking_id": "examples/job-board-Creating-a-data-model-to-represent-the-data",
"time_stamp": null,
"dataset_id": "fd92b3c5-079c-4bfb-b806-3c4f49b87b31",
"weight": 0,
"location": null,
"image_urls": null,
"tag_set": "",
"num_value": null,
"group_tracking_ids": ["examples/job-board"]
},
{
"id": "9ba72e8d-ea47-4853-ad32-4e05194f538e",
"link": "api-reference/dataset/get-datasets-from-organization",
"qdrant_point_id": "90b08db7-1e1c-4269-8f58-bae163d8718b",
"created_at": "2024-06-21T05:04:59.387905",
"updated_at": "2024-06-21T05:04:59.387906",
"chunk_html": "\n\nREST Endpoint GET /api/dataset/organization/{organization_id}\n\nSummary: Get Datasets from Organization \n\nDescription: Get Datasets from Organization\n\nGet all datasets for an organization. Auth'ed user or api key must have an admin or owner role for the specified dataset's organization.\n\nSecurity methods: \nheader: apiKey\n\nRequest params: \npath params:\norganization_id:\n\tstring\n\tDescription: id of the organization you want to retrieve datasets for\n\tExample: \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n\nquery params:\nlimit:\n\tinteger\n\tDescription: The number of records to return\n\tExample: 123\n\tnull\n\tDescription: The number of records to return\n\tExample: null\noffset:\n\tinteger\n\tDescription: The number of records to skip\n\tExample: 123\n\tnull\n\tDescription: The number of records to skip\n\tExample: null\n\nheader params:\nTR-Organization:\n\tstring\n\tDescription: The organization id to use for the request\n\tExample: \"<string>\"\n\n\nRequest body: N/A\n\n\nResponses: \n200: array\n\tDescription: N/A\n\tExample: [\"<any>\"]\n400: any\n\tDescription: N/A\n\tExample: \"<any>\"\n404: any\n\tDescription: N/A\n\tExample: \"<any>\"\n\n",
"metadata": {},
"tracking_id": "api-reference/dataset/get-datasets-from-organization-API-Metadata:-get-/api/dataset/organization/{organization_id}",
"time_stamp": null,
"dataset_id": "fd92b3c5-079c-4bfb-b806-3c4f49b87b31",
"weight": 0,
"location": null,
"image_urls": null,
"tag_set": "code",
"num_value": null,
"group_tracking_ids": [
"api-reference/dataset/get-datasets-from-organization"
]
},
{
"id": "0197c625-ed4a-4029-9e00-2f5e2602c397",
"link": "guides/recommending-with-trieve",
"qdrant_point_id": "ac11771e-27fb-4786-9422-15ffe4f682d6",
"created_at": "2024-06-21T05:05:00.242965",
"updated_at": "2024-06-21T05:05:00.242966",
"chunk_html": "Different Recommendation Types\nWe have two different recommendation types: Recommend Chunks : Recommends chunks that are similar to the provided examples. This is useful when your chunks are independent and do not need to be grouped together. Recommend Groups : Recommends groups that are similar to the provided examples. It returns the groups and the top chunks within each group that are most similar to your input, providing better search quality for datasets with highly related chunks within groups.",
"metadata": { "title": "Different Recommendation Types" },
"tracking_id": "guides/recommending-with-trieve-Different-Recommendation-Types",
"time_stamp": null,
"dataset_id": "fd92b3c5-079c-4bfb-b806-3c4f49b87b31",
"weight": 0,
"location": null,
"image_urls": null,
"tag_set": "",
"num_value": null,
"group_tracking_ids": ["guides/recommending-with-trieve"]
},
{
"id": "b192d5ce-bfc0-42c5-bbba-a0d551447630",
"link": "api-reference/message/edit-a-message",
"qdrant_point_id": "be4fff14-f0c9-4ba2-9163-565a987969e1",
"created_at": "2024-06-21T05:04:56.867084",
"updated_at": "2024-06-21T05:04:56.867085",
"chunk_html": "\n\nREST Endpoint PUT /api/message\n\nSummary: Edit message \n\nDescription: Edit message\n\nEdit message which exists within the topic's chat history. This will delete the message and replace it with a new message. The new message will be generated by the AI based on the new content provided in the request body. The response will include Chunks first on the stream if the topic is using RAG. The structure will look like `[chunks]||mesage`. See docs.trieve.ai for more information. Auth'ed user or api key must have an admin or owner role for the specified dataset's organization.\n\nSecurity methods: \nheader: apiKey\n\nRequest params: \nheader params:\nTR-Dataset:\n\tstring\n\tDescription: The dataset id to use for the request\n\tExample: \"<string>\"\n\n\nRequest body: any\n\tDescription: N/A\n\tExample: \"<any>\"\n\n\nResponses: \n200: N/A\n400: any\n\tDescription: N/A\n\tExample: \"<any>\"\n\n",
"metadata": {},
"tracking_id": "api-reference/message/edit-a-message-API-Metadata:-put-/api/message",
"time_stamp": null,
"dataset_id": "fd92b3c5-079c-4bfb-b806-3c4f49b87b31",
"weight": 0,
"location": null,
"image_urls": null,
"tag_set": "code",
"num_value": null,
"group_tracking_ids": ["api-reference/message/edit-a-message"]
},
{
"id": "48c25895-6d29-44f3-9dd6-ab73292edb73",
"link": "api-reference/message/get-all-messages-for-a-given-topic",
"qdrant_point_id": "5fa875a0-f18d-4c06-981a-c1936f6d2242",
"created_at": "2024-06-21T05:04:56.904576",
"updated_at": "2024-06-21T05:04:56.904576",
"chunk_html": "Get all messages for a given topic\nGet all messages for a given topic\n\nGet all messages for a given topic. If the topic is a RAG topic then the response will include Chunks first on each message. The structure will look like `[chunks]||mesage`. See docs.trieve.ai for more information.",
"metadata": {
"openapi": "get /api/messages/{messages_topic_id}",
"title": "Get all messages for a given topic"
},
"tracking_id": "api-reference/message/get-all-messages-for-a-given-topic-Get-all-messages-for-a-given-top",
"time_stamp": null,
"dataset_id": "fd92b3c5-079c-4bfb-b806-3c4f49b87b31",
"weight": 0,
"location": null,
"image_urls": null,
"tag_set": "page",
"num_value": null,
"group_tracking_ids": [
"api-reference/message/get-all-messages-for-a-given-topic"
]
},
{
"id": "91e138a3-b277-468b-a88f-b79530b28147",
"link": "api-reference/chunk/generate-suggested-queries",
"qdrant_point_id": "e8c120f2-d1b5-42b4-ba61-75fa600537b0",
"created_at": "2024-06-21T05:04:57.060456",
"updated_at": "2024-06-21T05:04:57.060457",
"chunk_html": "Generate suggested queries\nGenerate suggested queries\n\nThis endpoint will generate 3 suggested queries based off a hybrid search using RAG with the query provided in the request body and return them as a JSON object.",
"metadata": {
"openapi": "post /api/chunk/gen_suggestions",
"title": "Generate suggested queries"
},
"tracking_id": "api-reference/chunk/generate-suggested-queries-Generate-suggested-queries-Gener",
"time_stamp": null,
"dataset_id": "fd92b3c5-079c-4bfb-b806-3c4f49b87b31",
"weight": 0,
"location": null,
"image_urls": null,
"tag_set": "page",
"num_value": null,
"group_tracking_ids": ["api-reference/chunk/generate-suggested-queries"]
},
{
"id": "cc6ae537-7c61-41fe-899f-12b9e65d2272",
"link": "api-reference/organization/get-organization-usage",
"qdrant_point_id": "5e6abda4-2ddd-4029-a58a-8550e14b77fb",
"created_at": "2024-06-21T05:04:57.221810",
"updated_at": "2024-06-21T05:04:57.221810",
"chunk_html": "Get Organization Usage\nGet Organization Usage\n\nFetch the current usage specification of an organization by its id. Auth'ed user or api key must have an admin or owner role for the specified dataset's organization.",
"metadata": {
"openapi": "get /api/organization/usage/{organization_id}",
"title": "Get Organization Usage"
},
"tracking_id": "api-reference/organization/get-organization-usage-Get-Organization-Usage-Get-Organ",
"time_stamp": null,
"dataset_id": "fd92b3c5-079c-4bfb-b806-3c4f49b87b31",
"weight": 0,
"location": null,
"image_urls": null,
"tag_set": "page",
"num_value": null,
"group_tracking_ids": ["api-reference/organization/get-organization-usage"]
},
{
"id": "d9a2aa67-601d-4f31-8791-ac28892ae625",
"link": "api-reference/organization/get-organization-usage",
"qdrant_point_id": "f69804ea-3651-4f7d-86e3-62c3bdaf14da",
"created_at": "2024-06-21T05:04:57.253236",
"updated_at": "2024-06-21T05:04:57.253236",
"chunk_html": "\n\nREST Endpoint GET /api/organization/usage/{organization_id}\n\nSummary: Get Organization Usage \n\nDescription: Get Organization Usage\n\nFetch the current usage specification of an organization by its id. Auth'ed user or api key must have an admin or owner role for the specified dataset's organization.\n\nSecurity methods: \nheader: apiKey\n\nRequest params: \npath params:\norganization_id:\n\tstring\n\tDescription: The id of the organization you want to fetch the usage of.\n\tExample: \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n\nheader params:\nTR-Organization:\n\tstring\n\tDescription: The organization id to use for the request\n\tExample: \"<string>\"\n\n\nRequest body: N/A\n\n\nResponses: \n200: any\n\tDescription: N/A\n\tExample: \"<any>\"\n400: any\n\tDescription: N/A\n\tExample: \"<any>\"\n\n",
"metadata": {},
"tracking_id": "api-reference/organization/get-organization-usage-API-Metadata:-get-/api/organization/usage/{organization_id}",
"time_stamp": null,
"dataset_id": "fd92b3c5-079c-4bfb-b806-3c4f49b87b31",
"weight": 0,
"location": null,
"image_urls": null,
"tag_set": "code",
"num_value": null,
"group_tracking_ids": ["api-reference/organization/get-organization-usage"]
},
{
"id": "bd1c6a8a-dd85-4c98-bb95-f65d3d56a1d8",
"link": "api-reference/stripe/checkout",
"qdrant_point_id": "72344d0c-4d59-4adc-963b-f7dc3e4dadfd",
"created_at": "2024-06-21T05:04:57.585663",
"updated_at": "2024-06-21T05:04:57.585663",
"chunk_html": "\n\nREST Endpoint GET /api/stripe/payment_link/{plan_id}/{organization_id}\n\nSummary: Checkout \n\nDescription: Checkout\n\nGet a direct link to the stripe checkout page for the plan and organization\n\nSecurity methods: \n\nRequest params: \npath params:\nplan_id:\n\tstring\n\tDescription: id of the plan you want to subscribe to\n\tExample: \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\norganization_id:\n\tstring\n\tDescription: id of the organization you want to subscribe to the plan\n\tExample: \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n\n\nRequest body: N/A\n\n\nResponses: \n303: N/A\n400: any\n\tDescription: N/A\n\tExample: \"<any>\"\n\n",
"metadata": {},
"tracking_id": "api-reference/stripe/checkout-API-Metadata:-get-/api/stripe/payment_link/{plan_id}/{organization_id}",
"time_stamp": null,
"dataset_id": "fd92b3c5-079c-4bfb-b806-3c4f49b87b31",
"weight": 0,
"location": null,
"image_urls": null,
"tag_set": "code",
"num_value": null,
"group_tracking_ids": ["api-reference/stripe/checkout"]
},
{
"id": "9afafc93-354d-4c73-97f5-ddf617376519",
"link": "api-reference/topic/delete-topic",
"qdrant_point_id": "250728f4-5b06-447d-a6dd-3fd5f2a7e65c",
"created_at": "2024-06-21T05:04:57.840542",
"updated_at": "2024-06-21T05:04:57.840542",
"chunk_html": "Delete Topic\nDelete Topic\n\nDelete an existing chat topic. When a topic is deleted, all associated chat messages are also deleted. Auth'ed user or api key must have an admin or owner role for the specified dataset's organization.",
"metadata": {
"openapi": "delete /api/topic/{topic_id}",
"title": "Delete Topic"
},
"tracking_id": "api-reference/topic/delete-topic-Delete-Topic-Delete-Topic-Delet",
"time_stamp": null,
"dataset_id": "fd92b3c5-079c-4bfb-b806-3c4f49b87b31",
"weight": 0,
"location": null,
"image_urls": null,
"tag_set": "page",
"num_value": null,
"group_tracking_ids": ["api-reference/topic/delete-topic"]
},
{
"id": "4f442322-4121-43e9-b5a2-64f27606d4ba",
"link": "api-reference/chunk_group/create-chunk-group",
"qdrant_point_id": "aa535d12-4ae8-4ac6-8f58-96acfb5baed2",
"created_at": "2024-06-21T05:04:57.944175",
"updated_at": "2024-06-21T05:04:57.944175",
"chunk_html": "\n\nREST Endpoint POST /api/chunk_group\n\nSummary: Create Chunk Group \n\nDescription: Create Chunk Group\n\nCreate a new chunk_group. This is a way to group chunks together. If you try to create a chunk_group with the same tracking_id as an existing chunk_group, this operation will fail. Auth'ed user or api key must have an admin or owner role for the specified dataset's organization.\n\nSecurity methods: \nheader: apiKey\n\nRequest params: \nheader params:\nTR-Dataset:\n\tstring\n\tDescription: The dataset id to use for the request\n\tExample: \"<string>\"\n\n\nRequest body: any\n\tDescription: N/A\n\tExample: \"<any>\"\n\n\nResponses: \n200: any\n\tDescription: N/A\n\tExample: \"<any>\"\n400: any\n\tDescription: N/A\n\tExample: \"<any>\"\n\n",
"metadata": {},
"tracking_id": "api-reference/chunk_group/create-chunk-group-API-Metadata:-post-/api/chunk_group",
"time_stamp": null,
"dataset_id": "fd92b3c5-079c-4bfb-b806-3c4f49b87b31",
"weight": 0,
"location": null,
"image_urls": null,
"tag_set": "code",
"num_value": null,
"group_tracking_ids": ["api-reference/chunk_group/create-chunk-group"]
},
{
"id": "374d8028-9594-4dd8-93e6-9cceeb22b60d",
"link": "api-reference/chunk_group/get-groups-for-chunks",
"qdrant_point_id": "1401bd74-1149-4c40-b804-4d994047a776",
"created_at": "2024-06-21T05:04:58.445987",
"updated_at": "2024-06-21T05:04:58.445988",
"chunk_html": "\n\nREST Endpoint POST /api/chunk_group/chunks\n\nSummary: Get Groups for Chunks \n\nDescription: Get Groups for Chunks\n\nRoute to get the groups that a chunk is in.\n\nSecurity methods: \nheader: apiKey\n\nRequest params: \nheader params:\nTR-Dataset:\n\tstring\n\tDescription: The dataset id to use for the request\n\tExample: \"<string>\"\n\n\nRequest body: any\n\tDescription: N/A\n\tExample: \"<any>\"\n\n\nResponses: \n200: array\n\tDescription: N/A\n\tExample: [\"<any>\"]\n400: any\n\tDescription: N/A\n\tExample: \"<any>\"\n\n",
"metadata": {},
"tracking_id": "api-reference/chunk_group/get-groups-for-chunks-API-Metadata:-post-/api/chunk_group/chunks",
"time_stamp": null,
"dataset_id": "fd92b3c5-079c-4bfb-b806-3c4f49b87b31",
"weight": 0,
"location": null,
"image_urls": null,
"tag_set": "code",
"num_value": null,
"group_tracking_ids": ["api-reference/chunk_group/get-groups-for-chunks"]
},
{
"id": "ce0c3a8b-ec40-448b-afdc-a7ab9a40c425",
"link": "examples/ecommerce",
"qdrant_point_id": "1a0af6d2-fed7-499d-a268-011e1db5ac47",
"created_at": "2024-06-21T05:04:58.979629",
"updated_at": "2024-06-21T05:04:59.038228",
"chunk_html": "Iterating and sending chunks to Trieve\nThe last step is we iterate through all the json files, process each line into a CreateChunkData object. We use chukApi.createChunk to create chunks, in this case we are sending chunks in a batch size of 120 which is the max for this route.",
"metadata": { "title": "Iterating and sending chunks to Trieve" },
"tracking_id": "examples/ecommerce-Iterating-and-sending-chunks-to-Trieve",
"time_stamp": null,
"dataset_id": "fd92b3c5-079c-4bfb-b806-3c4f49b87b31",
"weight": 0,
"location": null,
"image_urls": null,
"tag_set": "",
"num_value": null,
"group_tracking_ids": ["examples/ecommerce"]
},
{
"id": "a7f0a793-a2a1-49f4-ae60-6c4af9eb28b7",
"link": "api-reference/dataset/get-client-configuration",
"qdrant_point_id": "c2ab0bdd-713e-4362-ad6f-e7444853c995",
"created_at": "2024-06-21T05:04:59.262184",
"updated_at": "2024-06-21T05:04:59.262184",
"chunk_html": "\n\nREST Endpoint GET /api/dataset/envs\n\nSummary: Get Client Configuration \n\nDescription: Get Client Configuration\n\nGet the client configuration for a dataset. Will use the TR-D\n\nSecurity methods: \nheader: apiKey\n\nRequest params: \nheader params:\nTR-Dataset:\n\tstring\n\tDescription: The dataset id to use for the request\n\tExample: \"<string>\"\n\n\nRequest body: N/A\n\n\nResponses: \n200: any\n\tDescription: N/A\n\tExample: \"<any>\"\n400: any\n\tDescription: N/A\n\tExample: \"<any>\"\n\n",
"metadata": {},
"tracking_id": "api-reference/dataset/get-client-configuration-API-Metadata:-get-/api/dataset/envs",
"time_stamp": null,
"dataset_id": "fd92b3c5-079c-4bfb-b806-3c4f49b87b31",
"weight": 0,
"location": null,
"image_urls": null,
"tag_set": "code",
"num_value": null,
"group_tracking_ids": ["api-reference/dataset/get-client-configuration"]
},
{
"id": "b4d1e5e5-e96c-4c62-9103-5029cdb6cb40",
"link": "api-reference/dataset/get-dataset",
"qdrant_point_id": "837b1de6-2bd0-47c4-bf13-60941c5b03e2",
"created_at": "2024-06-21T05:04:59.324566",
"updated_at": "2024-06-21T05:04:59.324567",
"chunk_html": "\n\nREST Endpoint GET /api/dataset/{dataset_id}\n\nSummary: Get Dataset \n\nDescription: Get Dataset\n\nGet a dataset by id. Auth'ed user or api key must have an admin or owner role for the specified dataset's organization.\n\nSecurity methods: \nheader: apiKey\n\nRequest params: \npath params:\ndataset_id:\n\tstring\n\tDescription: The id of the dataset you want to retrieve.\n\tExample: \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n\nheader params:\nTR-Dataset:\n\tstring\n\tDescription: The dataset id to use for the request\n\tExample: \"<string>\"\n\n\nRequest body: N/A\n\n\nResponses: \n200: any\n\tDescription: N/A\n\tExample: \"<any>\"\n400: any\n\tDescription: N/A\n\tExample: \"<any>\"\n404: any\n\tDescription: N/A\n\tExample: \"<any>\"\n\n",
"metadata": {},
"tracking_id": "api-reference/dataset/get-dataset-API-Metadata:-get-/api/dataset/{dataset_id}",
"time_stamp": null,
"dataset_id": "fd92b3c5-079c-4bfb-b806-3c4f49b87b31",
"weight": 0,
"location": null,
"image_urls": null,
"tag_set": "code",
"num_value": null,
"group_tracking_ids": ["api-reference/dataset/get-dataset"]
},
{
"id": "94f0d06c-7e65-4da8-87f5-6e1ac75e989e",
"link": "api-reference/dataset/update-dataset",
"qdrant_point_id": "75590101-2338-4839-aa2d-2ac549fde22d",
"created_at": "2024-06-21T05:04:59.429274",
"updated_at": "2024-06-21T05:04:59.429275",
"chunk_html": "Update Dataset\nUpdate Dataset\n\nUpdate a dataset. The auth'ed user must be an owner of the organization to update a dataset.",
"metadata": { "openapi": "put /api/dataset", "title": "Update Dataset" },
"tracking_id": "api-reference/dataset/update-dataset-Update-Dataset-Update-Dataset-U",
"time_stamp": null,
"dataset_id": "fd92b3c5-079c-4bfb-b806-3c4f49b87b31",
"weight": 0,
"location": null,
"image_urls": null,
"tag_set": "page",
"num_value": null,
"group_tracking_ids": ["api-reference/dataset/update-dataset"]
},
{
"id": "0a1ade9b-4e87-43f5-971f-d536571b5093",
"link": "quickstart",
"qdrant_point_id": "238f55ac-7980-4957-87fb-45429a9caa6d",
"created_at": "2024-06-21T05:05:01.088175",
"updated_at": "2024-06-21T05:05:01.405571",
"chunk_html": "Using Trieve API\nSee the API reference for the recommend endpoint to see all of the available options for getting recommendations for a specific chunk or chunks.",
"metadata": { "title": "Using Trieve API" },
"tracking_id": "quickstart-Using-Trieve-API",
"time_stamp": null,
"dataset_id": "fd92b3c5-079c-4bfb-b806-3c4f49b87b31",
"weight": 0,
"location": null,
"image_urls": null,
"tag_set": "",
"num_value": null,
"group_tracking_ids": ["quickstart"]
},
{
"id": "03c80dce-a7c2-4c6e-b98b-d9a850947b7b",
"link": "api-reference/auth/get-me",
"qdrant_point_id": "39cf75e3-6035-41b4-b72b-13818135b40d",
"created_at": "2024-06-21T05:04:56.473068",
"updated_at": "2024-06-21T05:04:56.473069",
"chunk_html": "\n\nREST Endpoint GET /api/auth/me\n\nSummary: Get Me \n\nDescription: Get Me\n\nGet the user corresponding to your current auth credentials.\n\nSecurity methods: \nheader: apiKey\n\nRequest params: \n\nRequest body: N/A\n\n\nResponses: \n200: any\n\tDescription: N/A\n\tExample: \"<any>\"\n400: any\n\tDescription: N/A\n\tExample: \"<any>\"\n\n",
"metadata": {},
"tracking_id": "api-reference/auth/get-me-API-Metadata:-get-/api/auth/me",
"time_stamp": null,
"dataset_id": "fd92b3c5-079c-4bfb-b806-3c4f49b87b31",
"weight": 0,
"location": null,
"image_urls": null,
"tag_set": "code",
"num_value": null,
"group_tracking_ids": ["api-reference/auth/get-me"]
},
{
"id": "9fed2ff2-137b-43c9-8d4c-8d3cc76a2025",
"link": "api-reference/chunk_group/get-chunks-in-group-by-tracking-id",
"qdrant_point_id": "d7176295-6ac5-4fa8-b0b4-1cdebba36ff1",
"created_at": "2024-06-21T05:04:58.122005",
"updated_at": "2024-06-21T05:04:58.122005",
"chunk_html": "Get Chunks in Group by Tracking ID\nGet Chunks in Group by Tracking ID\n\nRoute to get all chunks for a group. The response is paginated, with each page containing 10 chunks. Support for custom page size is coming soon. Page is 1-indexed.",
"metadata": {
"openapi": "get /api/chunk_group/tracking_id/{group_tracking_id}/{page}",
"title": "Get Chunks in Group by Tracking ID"
},
"tracking_id": "api-reference/chunk_group/get-chunks-in-group-by-tracking-id-Get-Chunks-in-Group-by-Tracking-",
"time_stamp": null,
"dataset_id": "fd92b3c5-079c-4bfb-b806-3c4f49b87b31",
"weight": 0,
"location": null,
"image_urls": null,
"tag_set": "page",
"num_value": null,
"group_tracking_ids": [
"api-reference/chunk_group/get-chunks-in-group-by-tracking-id"
]
},
{
"id": "aacd33d5-e6b7-4ac6-bc6e-5be27eb6ed55",
"link": "api-reference/user/update-user",
"qdrant_point_id": "adbcb88a-7b04-4414-b2e8-120ee13c5f79",
"created_at": "2024-06-21T05:04:58.240085",
"updated_at": "2024-06-21T05:04:58.240086",
"chunk_html": "\n\nREST Endpoint PUT /api/user\n\nSummary: Update User \n\nDescription: Update User\n\nUpdate a user's information. If the user_id is not provided, the auth'ed user will be updated. If the user_id is provided, the role of the auth'ed user or api key must be an admin (1) or owner (2) of the organization.\n\nSecurity methods: \nheader: apiKey\n\nRequest params: \n\nRequest body: any\n\tDescription: N/A\n\tExample: \"<any>\"\n\n\nResponses: \n204: N/A\n400: any\n\tDescription: N/A\n\tExample: \"<any>\"\n\n",
"metadata": {},
"tracking_id": "api-reference/user/update-user-API-Metadata:-put-/api/user",
"time_stamp": null,
"dataset_id": "fd92b3c5-079c-4bfb-b806-3c4f49b87b31",
"weight": 0,
"location": null,
"image_urls": null,
"tag_set": "code",
"num_value": null,
"group_tracking_ids": ["api-reference/user/update-user"]
},
{
"id": "d18236d8-7c99-4936-97c7-c62eb60a0021",
"link": "api-reference/message/regenerate-message",
"qdrant_point_id": "5f8fa0ed-dd30-4379-8003-e69d8c74cb8b",
"created_at": "2024-06-21T05:04:56.986178",
"updated_at": "2024-06-21T05:04:56.986178",
"chunk_html": "Regenerate message\nRegenerate message\n\nRegenerate the assistant response to the last user message of a topic. This will delete the last message and replace it with a new message. The response will include Chunks first on the stream if the topic is using RAG. The structure will look like `[chunks]||mesage`. See docs.trieve.ai for more information. Auth'ed user or api key must have an admin or owner role for the specified dataset's organization.",
"metadata": {
"openapi": "delete /api/message",
"title": "Regenerate message"
},
"tracking_id": "api-reference/message/regenerate-message-Regenerate-message-Regenerate-me",
"time_stamp": null,
"dataset_id": "fd92b3c5-079c-4bfb-b806-3c4f49b87b31",
"weight": 0,
"location": null,
"image_urls": null,
"tag_set": "page",
"num_value": null,
"group_tracking_ids": ["api-reference/message/regenerate-message"]
},
{
"id": "f7cd82a4-b1b6-49f2-8427-baad55e920f5",
"link": "guides/RAG-with-trieve",
"qdrant_point_id": "9e7e8df5-c239-4812-bd58-81693eb11a9f",
"created_at": "2024-06-21T05:04:59.708703",
"updated_at": "2024-06-21T05:04:59.708703",
"chunk_html": "RAG on specified chunks\nThis strategy allows you to specify the chunks that you want to chat with. This is useful when you want to control which exact chunks are used in the conversation. API Reference",
"metadata": { "title": "RAG on specified chunks" },
"tracking_id": "guides/RAG-with-trieve-RAG-on-specified-chunks",
"time_stamp": null,
"dataset_id": "fd92b3c5-079c-4bfb-b806-3c4f49b87b31",
"weight": 0,
"location": null,
"image_urls": null,
"tag_set": "",
"num_value": null,
"group_tracking_ids": ["guides/RAG-with-trieve"]
},
{
"id": "a6d1905d-4d95-45e9-b1be-633a154b2da9",
"link": "api-reference/user/update-user",
"qdrant_point_id": "a57a4153-8e44-4d87-acdc-3cb46997d1ce",
"created_at": "2024-06-21T05:04:58.192670",
"updated_at": "2024-06-21T05:04:58.192670",
"chunk_html": "Update User\nUpdate User\n\nUpdate a user's information. If the user_id is not provided, the auth'ed user will be updated. If the user_id is provided, the role of the auth'ed user or api key must be an admin (1) or owner (2) of the organization.",
"metadata": { "openapi": "put /api/user", "title": "Update User" },
"tracking_id": "api-reference/user/update-user-Update-User-Update-User-Update-",
"time_stamp": null,
"dataset_id": "fd92b3c5-079c-4bfb-b806-3c4f49b87b31",
"weight": 0,
"location": null,
"image_urls": null,
"tag_set": "page",
"num_value": null,
"group_tracking_ids": ["api-reference/user/update-user"]
},
{
"id": "164c6795-a588-48b6-a45a-072aa318470e",
"link": "guides/uploading-files",
"qdrant_point_id": "ac533640-6243-43e9-9477-2ec48a7b468e",
"created_at": "2024-06-21T05:05:00.380530",
"updated_at": "2024-06-21T05:05:00.380530",
"chunk_html": "Overview\nWe provide the ability for users to upload their files to Trieve and use our automatic chunking. When uploading a file to Trieve, we automatically group the chunks together to link them. This is done through our upload file route. The default chunker that we provide is basic, simply splitting on word limits. For more advanced chunking, we recommend that you chunk your data yourself and then use our create chunk route to upload them.",
"metadata": { "title": "Overview" },
"tracking_id": "guides/uploading-files-Overview",
"time_stamp": null,
"dataset_id": "fd92b3c5-079c-4bfb-b806-3c4f49b87b31",
"weight": 0,
"location": null,
"image_urls": null,
"tag_set": "",
"num_value": null,
"group_tracking_ids": ["guides/uploading-files"]
},
{
"id": "fff2c467-0631-412e-92d7-9b2b932b04e1",
"link": "api-reference/auth/get-me",
"qdrant_point_id": "4d99a5ba-007d-4676-ae69-feb6a4b72248",
"created_at": "2024-06-21T05:04:56.426237",
"updated_at": "2024-06-21T05:04:56.426238",
"chunk_html": "Get Me\nGet Me\n\nGet the user corresponding to your current auth credentials.",
"metadata": { "openapi": "get /api/auth/me", "title": "Get Me" },
"tracking_id": "api-reference/auth/get-me-Get-Me-Get-Me-Get-the-user-corr",
"time_stamp": null,
"dataset_id": "fd92b3c5-079c-4bfb-b806-3c4f49b87b31",
"weight": 0,
"location": null,
"image_urls": null,
"tag_set": "page",
"num_value": null,
"group_tracking_ids": ["api-reference/auth/get-me"]
},
{
"id": "e889431f-4962-42eb-9ea4-7e805cfea41a",
"link": "api-reference/dataset/delete-dataset-by-tracking-id",
"qdrant_point_id": "437ce9db-7202-4d17-a71c-b8722f81848e",
"created_at": "2024-06-21T05:04:59.126768",
"updated_at": "2024-06-21T05:04:59.126768",
"chunk_html": "\n\nREST Endpoint DELETE /api/dataset/tracking_id/{tracking_id}\n\nSummary: Delete Dataset by Tracking ID \n\nDescription: Delete Dataset by Tracking ID\n\nDelete a dataset by its tracking id. The auth'ed user must be an owner of the organization to delete a dataset.\n\nSecurity methods: \nheader: apiKey\n\nRequest params: \npath params:\ntracking_id:\n\tstring\n\tDescription: The tracking id of the dataset you want to delete.\n\tExample: \"<string>\"\n\nheader params:\nTR-Dataset:\n\tstring\n\tDescription: The dataset id to use for the request\n\tExample: \"<string>\"\n\n\nRequest body: N/A\n\n\nResponses: \n204: N/A\n400: any\n\tDescription: N/A\n\tExample: \"<any>\"\n404: any\n\tDescription: N/A\n\tExample: \"<any>\"\n\n",
"metadata": {},
"tracking_id": "api-reference/dataset/delete-dataset-by-tracking-id-API-Metadata:-delete-/api/dataset/tracking_id/{tracking_id}",
"time_stamp": null,
"dataset_id": "fd92b3c5-079c-4bfb-b806-3c4f49b87b31",
"weight": 0,
"location": null,
"image_urls": null,
"tag_set": "code",
"num_value": null,
"group_tracking_ids": [
"api-reference/dataset/delete-dataset-by-tracking-id"
]
},
{
"id": "2593ffae-257a-4d65-9dd1-b1c5e8b357e5",
"link": "api-reference/auth/login",
"qdrant_point_id": "0d117e90-6372-4a6e-861d-899852762716",
"created_at": "2024-06-21T05:04:56.552976",
"updated_at": "2024-06-21T05:04:56.552977",
"chunk_html": "\n\nREST Endpoint GET /api/auth\n\nSummary: Login \n\nDescription: Login\n\nThis will redirect you to the OAuth provider for authentication with email/pass, SSO, Google, Github, etc.\n\nSecurity methods: \n\nRequest params: \nquery params:\norganization_id:\n\tstring\n\tDescription: ID of organization to authenticate into\n\tExample: \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n\tnull\n\tDescription: ID of organization to authenticate into\n\tExample: null\nredirect_uri:\n\tstring\n\tDescription: URL to redirect to after successful login\n\tExample: \"<string>\"\n\tnull\n\tDescription: URL to redirect to after successful login\n\tExample: null\ninv_code:\n\tstring\n\tDescription: Code sent via email as a result of successful call to send_invitation\n\tExample: \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n\tnull\n\tDescription: Code sent via email as a result of successful call to send_invitation\n\tExample: null\n\n\nRequest body: N/A\n\n\nResponses: \n303: N/A\n400: any\n\tDescription: N/A\n\tExample: \"<any>\"\n\n",
"metadata": {},
"tracking_id": "api-reference/auth/login-API-Metadata:-get-/api/auth",
"time_stamp": null,
"dataset_id": "fd92b3c5-079c-4bfb-b806-3c4f49b87b31",
"weight": 0,
"location": null,
"image_urls": null,
"tag_set": "code",
"num_value": null,
"group_tracking_ids": ["api-reference/auth/login"]
},
{
"id": "39c52a59-d76b-4e0d-9a4f-f95ef9adb9b4",
"link": "examples/job-board",
"qdrant_point_id": "74eb17df-2caa-401f-b9b4-6377d4fcd775",
"created_at": "2024-06-21T05:04:59.563259",
"updated_at": "2024-06-21T05:04:59.626410",
"chunk_html": "Creating a Chunk\nWhen possible, use our bulk upload API to upload data in chunks of up to 120 to take advantage of the speed of the API. To efficiently upload data, we divide it into chunks. Here’s the code snippet for creating a chunk with the data: Checkout the api reference for the upload API to view all of the parameters that can be passed in with the chunk. By following this guide, you should be able to set up and run the demo successfully. If you encounter any issues, refer back to the steps and ensure all configurations are correctly set up.",
"metadata": { "title": "Creating a Chunk" },
"tracking_id": "examples/job-board-Creating-a-Chunk",
"time_stamp": null,
"dataset_id": "fd92b3c5-079c-4bfb-b806-3c4f49b87b31",
"weight": 0,
"location": null,
"image_urls": null,
"tag_set": "",
"num_value": null,
"group_tracking_ids": ["examples/job-board"]
},
{
"id": "a869aa50-9261-43a6-9c62-07442604b6e6",
"link": "api-reference/file/get-file",
"qdrant_point_id": "c4854bb9-8de2-4160-8e47-7c9c422dc044",
"created_at": "2024-06-21T05:04:59.644899",
"updated_at": "2024-06-21T05:04:59.644899",
"chunk_html": "Get File\nGet File\n\nDownload a file based on its id.",
"metadata": { "openapi": "get /api/file/{file_id}", "title": "Get File" },
"tracking_id": "api-reference/file/get-file-Get-File-Get-File-Download-a-fi",
"time_stamp": null,
"dataset_id": "fd92b3c5-079c-4bfb-b806-3c4f49b87b31",
"weight": 0,
"location": null,
"image_urls": null,
"tag_set": "page",
"num_value": null,
"group_tracking_ids": ["api-reference/file/get-file"]
},
{
"id": "2b3cae45-dd75-4f4b-99bd-e570c545eeea",
"link": "api-reference/chunk/get-chunks-by-trackingids",
"qdrant_point_id": "0c73234a-d793-472b-b8e3-0525232b1544",
"created_at": "2024-06-21T05:04:57.345244",
"updated_at": "2024-06-21T05:04:57.345244",
"chunk_html": "Get Chunks By TrackingIds\nGet Chunks By TrackingIds\n\nGet multiple chunks by ids.",
"metadata": {
"openapi": "post /api/chunks/tracking",
"title": "Get Chunks By TrackingIds"
},
"tracking_id": "api-reference/chunk/get-chunks-by-trackingids-Get-Chunks-By-TrackingIds-Get-Ch",
"time_stamp": null,
"dataset_id": "fd92b3c5-079c-4bfb-b806-3c4f49b87b31",
"weight": 0,
"location": null,
"image_urls": null,
"tag_set": "page",
"num_value": null,
"group_tracking_ids": ["api-reference/chunk/get-chunks-by-trackingids"]
},
{
"id": "feddb78a-24b7-4c1f-8e60-679f628c07a3",
"link": "api-reference/file/get-files-for-dataset",
"qdrant_point_id": "0ac6904d-4ca5-4067-befe-9fb4f2d274ca",
"created_at": "2024-06-21T05:04:59.751909",
"updated_at": "2024-06-21T05:04:59.751909",
"chunk_html": "\n\nREST Endpoint GET /api/dataset/files/{dataset_id}/{page}\n\nSummary: Get Files for Dataset \n\nDescription: Get Files for Dataset\n\nGet all files which belong to a given dataset specified by the dataset_id parameter. 10 files are returned per page.\n\nSecurity methods: \nheader: apiKey\n\nRequest params: \npath params:\ndataset_id:\n\tstring\n\tDescription: The id of the dataset to fetch files for.\n\tExample: \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\npage:\n\tinteger\n\tDescription: The page number of files you wish to fetch. Each page contains at most 10 files.\n\tExample: 1\n\nheader params:\nTR-Dataset:\n\tstring\n\tDescription: The dataset id to use for the request\n\tExample: \"<string>\"\n\n\nRequest body: N/A\n\n\nResponses: \n200: array\n\tDescription: N/A\n\tExample: [\"<any>\"]\n400: any\n\tDescription: N/A\n\tExample: \"<any>\"\n\n",
"metadata": {},
"tracking_id": "api-reference/file/get-files-for-dataset-API-Metadata:-get-/api/dataset/files/{dataset_id}/{page}",
"time_stamp": null,
"dataset_id": "fd92b3c5-079c-4bfb-b806-3c4f49b87b31",
"weight": 0,
"location": null,
"image_urls": null,
"tag_set": "code",
"num_value": null,
"group_tracking_ids": ["api-reference/file/get-files-for-dataset"]
},
{
"id": "b67451e2-a413-4341-936b-a574583c0b4c",
"link": "guides/recommending-with-trieve",
"qdrant_point_id": "81d6a787-beec-4cab-910f-845ce3af500d",
"created_at": "2024-06-21T05:05:00.168512",
"updated_at": "2024-06-21T05:05:00.168513",
"chunk_html": "Recommending with Trieve\nLearn how to recommend content with Trieve",
"metadata": { "title": "Recommending with Trieve" },
"tracking_id": "guides/recommending-with-trieve-Recommending-with-Trieve-Learn-h",
"time_stamp": null,
"dataset_id": "fd92b3c5-079c-4bfb-b806-3c4f49b87b31",
"weight": 0,
"location": null,
"image_urls": null,
"tag_set": "page",
"num_value": null,
"group_tracking_ids": ["guides/recommending-with-trieve"]
},
{
"id": "7edbd26f-f0ea-4f2e-aa36-24b92aba2862",
"link": "guides/recommending-with-trieve",
"qdrant_point_id": "bbc7fc2c-985b-41c1-9897-02f40f23abcc",
"created_at": "2024-06-21T05:05:00.198401",
"updated_at": "2024-06-21T05:05:00.198401",
"chunk_html": "Overview\nWe provide the ability to get recommended chunks similar to your data through the get recommended chunks route or through the get recommended groups route.",
"metadata": { "title": "Overview" },
"tracking_id": "guides/recommending-with-trieve-Overview",
"time_stamp": null,
"dataset_id": "fd92b3c5-079c-4bfb-b806-3c4f49b87b31",
"weight": 0,
"location": null,
"image_urls": null,
"tag_set": "",
"num_value": null,
"group_tracking_ids": ["guides/recommending-with-trieve"]
},
{
"id": "f846116b-a597-49a7-804a-604e689aba10",
"link": "api-reference/organization/get-organization-users",
"qdrant_point_id": "1bae0919-38b5-46b9-ad65-06e86efbd609",
"created_at": "2024-06-21T05:04:57.327521",
"updated_at": "2024-06-21T05:04:57.327521",
"chunk_html": "\n\nREST Endpoint GET /api/organization/users/{organization_id}\n\nSummary: Get Organization Users \n\nDescription: Get Organization Users\n\nFetch the users of an organization by its id. Auth'ed user or api key must have an admin or owner role for the specified dataset's organization.\n\nSecurity methods: \nheader: apiKey\n\nRequest params: \npath params:\norganization_id:\n\tstring\n\tDescription: The id of the organization you want to fetch the users of.\n\tExample: \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n\nheader params:\nTR-Organization:\n\tstring\n\tDescription: The organization id to use for the request\n\tExample: \"<string>\"\n\n\nRequest body: N/A\n\n\nResponses: \n200: array\n\tDescription: N/A\n\tExample: [\"<any>\"]\n400: any\n\tDescription: N/A\n\tExample: \"<any>\"\n\n",
"metadata": {},
"tracking_id": "api-reference/organization/get-organization-users-API-Metadata:-get-/api/organization/users/{organization_id}",
"time_stamp": null,
"dataset_id": "fd92b3c5-079c-4bfb-b806-3c4f49b87b31",
"weight": 0,
"location": null,
"image_urls": null,
"tag_set": "code",
"num_value": null,
"group_tracking_ids": ["api-reference/organization/get-organization-users"]
},
{
"id": "b192d5ce-bfc0-42c5-bbba-a0d551447630",
"link": "api-reference/message/edit-a-message",
"qdrant_point_id": "be4fff14-f0c9-4ba2-9163-565a987969e1",
"created_at": "2024-06-21T05:04:56.867084",
"updated_at": "2024-06-21T05:04:56.867085",
"chunk_html": "\n\nREST Endpoint PUT /api/message\n\nSummary: Edit message \n\nDescription: Edit message\n\nEdit message which exists within the topic's chat history. This will delete the message and replace it with a new message. The new message will be generated by the AI based on the new content provided in the request body. The response will include Chunks first on the stream if the topic is using RAG. The structure will look like `[chunks]||mesage`. See docs.trieve.ai for more information. Auth'ed user or api key must have an admin or owner role for the specified dataset's organization.\n\nSecurity methods: \nheader: apiKey\n\nRequest params: \nheader params:\nTR-Dataset:\n\tstring\n\tDescription: The dataset id to use for the request\n\tExample: \"<string>\"\n\n\nRequest body: any\n\tDescription: N/A\n\tExample: \"<any>\"\n\n\nResponses: \n200: N/A\n400: any\n\tDescription: N/A\n\tExample: \"<any>\"\n\n",
"metadata": {},
"tracking_id": "api-reference/message/edit-a-message-API-Metadata:-put-/api/message",
"time_stamp": null,
"dataset_id": "fd92b3c5-079c-4bfb-b806-3c4f49b87b31",
"weight": 0,
"location": null,
"image_urls": null,
"tag_set": "code",
"num_value": null
},
{
"id": "8343b54b-6d19-407b-b809-26598b8113bd",
"link": "api-reference/chunk/get-chunk-by-tracking-id",
"qdrant_point_id": "51b53e89-8fbf-41d8-b6c5-30e0ec7b8088",
"created_at": "2024-06-21T05:04:57.201033",
"updated_at": "2024-06-21T05:04:57.201033",
"chunk_html": "Get Chunk By Tracking Id\nGet Chunk By Tracking Id\n\nGet a singular chunk by tracking_id. This is useful for when you are coordinating with an external system and want to use your own id as the primary reference for a chunk.",
"metadata": {
"openapi": "get /api/chunk/tracking_id/{tracking_id}",
"title": "Get Chunk By Tracking Id"
},
"tracking_id": "api-reference/chunk/get-chunk-by-tracking-id-Get-Chunk-By-Tracking-Id-Get-Chu",
"time_stamp": null,
"dataset_id": "fd92b3c5-079c-4bfb-b806-3c4f49b87b31",
"weight": 0,
"location": null,
"image_urls": null,
"tag_set": "page",
"num_value": null,
"group_tracking_ids": ["api-reference/chunk/get-chunk-by-tracking-id"]
},
{
"id": "46a2bace-cebf-4337-8ab9-e11d294ee3ae",
"link": "api-reference/chunk_group/remove-chunk-from-group",
"qdrant_point_id": "68a509a1-7e11-4d96-a46f-9fbc9c42eac3",
"created_at": "2024-06-21T05:04:58.669034",
"updated_at": "2024-06-21T05:04:58.669035",
"chunk_html": "\n\nREST Endpoint DELETE /api/chunk_group/chunk/{group_id}\n\nSummary: Remove Chunk from Group \n\nDescription: Remove Chunk from Group\n\nRoute to remove a chunk from a group. Auth'ed user or api key must be an admin or owner of the dataset's organization to remove a chunk from a group.\n\nSecurity methods: \nheader: apiKey\n\nRequest params: \npath params:\ngroup_id:\n\tstring\n\tDescription: Id of the group you want to remove the chunk from.\n\tExample: \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n\nheader params:\nTR-Dataset:\n\tstring\n\tDescription: The dataset id to use for the request\n\tExample: \"<string>\"\n\n\nRequest body: any\n\tDescription: N/A\n\tExample: \"<any>\"\n\n\nResponses: \n204: N/A\n400: any\n\tDescription: N/A\n\tExample: \"<any>\"\n\n",
"metadata": {},
"tracking_id": "api-reference/chunk_group/remove-chunk-from-group-API-Metadata:-delete-/api/chunk_group/chunk/{group_id}",
"time_stamp": null,
"dataset_id": "fd92b3c5-079c-4bfb-b806-3c4f49b87b31",
"weight": 0,
"location": null,
"image_urls": null,
"tag_set": "code",
"num_value": null,
"group_tracking_ids": ["api-reference/chunk_group/remove-chunk-from-group"]
},
{
"id": "75195a55-f575-424e-9537-c7f359f7e2bf",
"link": "api-reference/chunk/update-chunk",
"qdrant_point_id": "2f0fa99f-e72e-4d67-9c1b-8aa876c49321",
"created_at": "2024-06-21T05:04:57.687112",
"updated_at": "2024-06-21T05:04:57.687112",
"chunk_html": "Update Chunk\nUpdate Chunk\n\nUpdate a chunk. If you try to change the tracking_id of the chunk to have the same tracking_id as an existing chunk, the request will fail. Auth'ed user or api key must have an admin or owner role for the specified dataset's organization.",
"metadata": { "openapi": "put /api/chunk", "title": "Update Chunk" },
"tracking_id": "api-reference/chunk/update-chunk-Update-Chunk-Update-Chunk-Updat",
"time_stamp": null,
"dataset_id": "fd92b3c5-079c-4bfb-b806-3c4f49b87b31",
"weight": 0,
"location": null,
"image_urls": null,
"tag_set": "page",
"num_value": null,
"group_tracking_ids": ["api-reference/chunk/update-chunk"]
},
{
"id": "6da59b82-4072-4711-bc57-46207ee7042e",
"link": "examples/ecommerce",
"qdrant_point_id": "c05bab65-e7db-40ca-8f13-1d9db6af1b90",
"created_at": "2024-06-21T05:04:58.340744",
"updated_at": "2024-06-21T05:04:58.340744",
"chunk_html": "Cloning the example repository\ngit clone https://github.com/devflowinc/examples\ncd examples/amazon-berkeley-dataset",
"metadata": { "title": "Cloning the example repository" },
"tracking_id": "examples/ecommerce-Cloning-the-example-repository",
"time_stamp": null,
"dataset_id": "fd92b3c5-079c-4bfb-b806-3c4f49b87b31",
"weight": 0,
"location": null,
"image_urls": null,
"tag_set": "code",
"num_value": null,
"group_tracking_ids": ["examples/ecommerce"]
},
{
"id": "50017003-4913-40c7-b71d-e096523dce90",
"link": "api-reference/chunk_group/get-recommended-groups",
"qdrant_point_id": "641e4bda-a72f-4124-8ee2-93dc474b8710",
"created_at": "2024-06-21T05:04:58.575579",
"updated_at": "2024-06-21T05:04:58.575579",
"chunk_html": "\n\nREST Endpoint POST /api/chunk_group/recommend\n\nSummary: Get Recommended Groups \n\nDescription: Get Recommended Groups\n\nRoute to get recommended groups. This route will return groups which are similar to the groups in the request body. You must provide at least one positive group id or group tracking id.\n\nSecurity methods: \nheader: apiKey\n\nRequest params: \nheader params:\nTR-Dataset:\n\tstring\n\tDescription: The dataset id to use for the request\n\tExample: \"<string>\"\n\n\nRequest body: any\n\tDescription: N/A\n\tExample: \"<any>\"\n\n\nResponses: \n200: array\n\tDescription: N/A\n\tExample: [\"<any>\"]\n400: any\n\tDescription: N/A\n\tExample: \"<any>\"\n\n",
"metadata": {},
"tracking_id": "api-reference/chunk_group/get-recommended-groups-API-Metadata:-post-/api/chunk_group/recommend",
"time_stamp": null,
"dataset_id": "fd92b3c5-079c-4bfb-b806-3c4f49b87b31",
"weight": 0,
"location": null,
"image_urls": null,
"tag_set": "code",
"num_value": null,
"group_tracking_ids": ["api-reference/chunk_group/get-recommended-groups"]
},
{
"id": "cd25bd36-dd76-4813-b9ef-c03eac5cd44d",
"link": "api-reference/organization/delete-organization",
"qdrant_point_id": "937971e0-b97b-4473-a852-1df8f51d788c",
"created_at": "2024-06-21T05:04:57.152103",
"updated_at": "2024-06-21T05:04:57.152103",
"chunk_html": "Delete Organization\nDelete Organization\n\nDelete an organization by its id. The auth'ed user must be an owner of the organization to delete it.",
"metadata": {
"openapi": "delete /api/organization/{organization_id}",
"title": "Delete Organization"
},
"tracking_id": "api-reference/organization/delete-organization-Delete-Organization-Delete-Organ",
"time_stamp": null,
"dataset_id": "fd92b3c5-079c-4bfb-b806-3c4f49b87b31",
"weight": 0,
"location": null,
"image_urls": null,
"tag_set": "page",
"num_value": null,
"group_tracking_ids": ["api-reference/organization/delete-organization"]
},
{
"id": "8141a2a6-78f4-48ab-9fcc-e15265b6b0b9",
"link": "examples/ecommerce",
"qdrant_point_id": "478cd7d6-9afb-4344-a687-22e2caf81e4c",
"created_at": "2024-06-21T05:04:58.821931",
"updated_at": "2024-06-21T05:04:58.872975",
"chunk_html": "Processing a Singular Chunk\nFor each row of json we construct a CreateChunkData object, each of which can be pushed into Trieve separately or in bulk. We use the imageHashMap object constructed from before to get the image_url for each.",
"metadata": { "title": "Processing a Singular Chunk" },
"tracking_id": "examples/ecommerce-Processing-a-Singular-Chunk",
"time_stamp": null,
"dataset_id": "fd92b3c5-079c-4bfb-b806-3c4f49b87b31",
"weight": 0,
"location": null,
"image_urls": null,
"tag_set": "",
"num_value": null,
"group_tracking_ids": ["examples/ecommerce"]
},
{
"id": "dcf66077-cf1f-4827-8827-5d1734275079",
"link": "examples/job-board",
"qdrant_point_id": "5ac47061-9a9f-4414-a353-51a6e7030e3a",
"created_at": "2024-06-21T05:04:59.057400",
"updated_at": "2024-06-21T05:04:59.057400",
"chunk_html": "Build Search for a Job Board\nLearn how to build a job board with Trieve",
"metadata": { "title": "Build Search for a Job Board" },
"tracking_id": "examples/job-board-Build-Search-for-a-Job-Board-Lea",
"time_stamp": null,
"dataset_id": "fd92b3c5-079c-4bfb-b806-3c4f49b87b31",
"weight": 0,
"location": null,
"image_urls": null,
"tag_set": "page",
"num_value": null,
"group_tracking_ids": ["examples/job-board"]
},
{
"id": "5b2aa3be-87b0-4106-a97d-a3864d162fa3",
"link": "guides/RAG-with-trieve",
"qdrant_point_id": "9aafd188-bf2d-4889-bf8b-04532b85c27f",
"created_at": "2024-06-21T05:04:59.781505",
"updated_at": "2024-06-21T05:04:59.781506",
"chunk_html": "RAG over all chunks\nThis strategy allows you to chat with all the chunks in your dataset. This is useful when you want to chat with all the chunks in your dataset, and have the model do the searching for you. To use the RAG route, you need to instantiate a topic with Trieve to store all of the messages in the conversation. This is done through the create topic route.",
"metadata": { "title": "RAG over all chunks" },
"tracking_id": "guides/RAG-with-trieve-RAG-over-all-chunks",
"time_stamp": null,
"dataset_id": "fd92b3c5-079c-4bfb-b806-3c4f49b87b31",
"weight": 0,
"location": null,
"image_urls": null,
"tag_set": "",
"num_value": null,
"group_tracking_ids": ["guides/RAG-with-trieve"]
},
{
"id": "a18a76f5-cbdf-406a-923d-8cef4b514009",
"link": "guides/create-chunk",
"qdrant_point_id": "f024a8b4-8e21-40c8-aced-2839b5b31029",
"created_at": "2024-06-21T05:04:59.955783",
"updated_at": "2024-06-21T05:04:59.955783",
"chunk_html": "Uploading Individual Chunks to Trieve\nThe main route that we expose to handle this functionality is our create chunk route.",
"metadata": { "title": "Uploading Individual Chunks to Trieve" },
"tracking_id": "guides/create-chunk-Uploading-Individual-Chunks-to-Trieve",
"time_stamp": null,
"dataset_id": "fd92b3c5-079c-4bfb-b806-3c4f49b87b31",
"weight": 0,
"location": null,
"image_urls": null,
"tag_set": "",
"num_value": null,
"group_tracking_ids": ["guides/create-chunk"]
},
{
"id": "908e7cc4-6e77-4645-b395-37303037deb6",
"link": "api-reference/chunk/create-or-upsert-chunk-or-chunks",
"qdrant_point_id": "b2670218-759f-4586-b82a-76b172a6c0a5",
"created_at": "2024-06-21T05:04:56.825553",
"updated_at": "2024-06-21T05:04:56.825554",
"chunk_html": "Create or Upsert Chunk or Chunks\nCreate or Upsert Chunk or Chunks\n\nCreate a new chunk. If the chunk has the same tracking_id as an existing chunk, the request will fail. Once a chunk is created, it can be searched for using the search endpoint.\nIf uploading in bulk, the maximum amount of chunks that can be uploaded at once is 120 chunks. Auth'ed user or api key must have an admin or owner role for the specified dataset's organization.",
"metadata": {
"openapi": "post /api/chunk",
"title": "Create or Upsert Chunk or Chunks"
},
"tracking_id": "api-reference/chunk/create-or-upsert-chunk-or-chunks-Create-or-Upsert-Chunk-or-Chunks",
"time_stamp": null,
"dataset_id": "fd92b3c5-079c-4bfb-b806-3c4f49b87b31",
"weight": 0,
"location": null,
"image_urls": null,
"tag_set": "page",
"num_value": null,
"group_tracking_ids": [
"api-reference/chunk/create-or-upsert-chunk-or-chunks"
]
},
{
"id": "48c25895-6d29-44f3-9dd6-ab73292edb73",
"link": "api-reference/message/get-all-messages-for-a-given-topic",
"qdrant_point_id": "5fa875a0-f18d-4c06-981a-c1936f6d2242",
"created_at": "2024-06-21T05:04:56.904576",
"updated_at": "2024-06-21T05:04:56.904576",
"chunk_html": "Get all messages for a given topic\nGet all messages for a given topic\n\nGet all messages for a given topic. If the topic is a RAG topic then the response will include Chunks first on each message. The structure will look like `[chunks]||mesage`. See docs.trieve.ai for more information.",
"metadata": {
"openapi": "get /api/messages/{messages_topic_id}",
"title": "Get all messages for a given topic"
},
"tracking_id": "api-reference/message/get-all-messages-for-a-given-topic-Get-all-messages-for-a-given-top",
"time_stamp": null,
"dataset_id": "fd92b3c5-079c-4bfb-b806-3c4f49b87b31",
"weight": 0,
"location": null,
"image_urls": null,
"tag_set": "page",
"num_value": null
},
{
"id": "91e138a3-b277-468b-a88f-b79530b28147",
"link": "api-reference/chunk/generate-suggested-queries",
"qdrant_point_id": "e8c120f2-d1b5-42b4-ba61-75fa600537b0",
"created_at": "2024-06-21T05:04:57.060456",
"updated_at": "2024-06-21T05:04:57.060457",
"chunk_html": "Generate suggested queries\nGenerate suggested queries\n\nThis endpoint will generate 3 suggested queries based off a hybrid search using RAG with the query provided in the request body and return them as a JSON object.",
"metadata": {
"openapi": "post /api/chunk/gen_suggestions",
"title": "Generate suggested queries"
},
"tracking_id": "api-reference/chunk/generate-suggested-queries-Generate-suggested-queries-Gener",
"time_stamp": null,
"dataset_id": "fd92b3c5-079c-4bfb-b806-3c4f49b87b31",
"weight": 0,
"location": null,
"image_urls": null,
"tag_set": "page",
"num_value": null
},
{
"id": "cc6ae537-7c61-41fe-899f-12b9e65d2272",
"link": "api-reference/organization/get-organization-usage",
"qdrant_point_id": "5e6abda4-2ddd-4029-a58a-8550e14b77fb",
"created_at": "2024-06-21T05:04:57.221810",
"updated_at": "2024-06-21T05:04:57.221810",
"chunk_html": "Get Organization Usage\nGet Organization Usage\n\nFetch the current usage specification of an organization by its id. Auth'ed user or api key must have an admin or owner role for the specified dataset's organization.",
"metadata": {
"openapi": "get /api/organization/usage/{organization_id}",
"title": "Get Organization Usage"
},
"tracking_id": "api-reference/organization/get-organization-usage-Get-Organization-Usage-Get-Organ",
"time_stamp": null,
"dataset_id": "fd92b3c5-079c-4bfb-b806-3c4f49b87b31",
"weight": 0,
"location": null,
"image_urls": null,
"tag_set": "page",
"num_value": null
},
{
"id": "d9a2aa67-601d-4f31-8791-ac28892ae625",
"link": "api-reference/organization/get-organization-usage",
"qdrant_point_id": "f69804ea-3651-4f7d-86e3-62c3bdaf14da",
"created_at": "2024-06-21T05:04:57.253236",
"updated_at": "2024-06-21T05:04:57.253236",
"chunk_html": "\n\nREST Endpoint GET /api/organization/usage/{organization_id}\n\nSummary: Get Organization Usage \n\nDescription: Get Organization Usage\n\nFetch the current usage specification of an organization by its id. Auth'ed user or api key must have an admin or owner role for the specified dataset's organization.\n\nSecurity methods: \nheader: apiKey\n\nRequest params: \npath params:\norganization_id:\n\tstring\n\tDescription: The id of the organization you want to fetch the usage of.\n\tExample: \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n\nheader params:\nTR-Organization:\n\tstring\n\tDescription: The organization id to use for the request\n\tExample: \"<string>\"\n\n\nRequest body: N/A\n\n\nResponses: \n200: any\n\tDescription: N/A\n\tExample: \"<any>\"\n400: any\n\tDescription: N/A\n\tExample: \"<any>\"\n\n",
"metadata": {},
"tracking_id": "api-reference/organization/get-organization-usage-API-Metadata:-get-/api/organization/usage/{organization_id}",
"time_stamp": null,
"dataset_id": "fd92b3c5-079c-4bfb-b806-3c4f49b87b31",
"weight": 0,
"location": null,
"image_urls": null,
"tag_set": "code",
"num_value": null
},
{
"id": "bd1c6a8a-dd85-4c98-bb95-f65d3d56a1d8",
"link": "api-reference/stripe/checkout",
"qdrant_point_id": "72344d0c-4d59-4adc-963b-f7dc3e4dadfd",
"created_at": "2024-06-21T05:04:57.585663",
"updated_at": "2024-06-21T05:04:57.585663",
"chunk_html": "\n\nREST Endpoint GET /api/stripe/payment_link/{plan_id}/{organization_id}\n\nSummary: Checkout \n\nDescription: Checkout\n\nGet a direct link to the stripe checkout page for the plan and organization\n\nSecurity methods: \n\nRequest params: \npath params:\nplan_id:\n\tstring\n\tDescription: id of the plan you want to subscribe to\n\tExample: \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\norganization_id:\n\tstring\n\tDescription: id of the organization you want to subscribe to the plan\n\tExample: \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n\n\nRequest body: N/A\n\n\nResponses: \n303: N/A\n400: any\n\tDescription: N/A\n\tExample: \"<any>\"\n\n",
"metadata": {},
"tracking_id": "api-reference/stripe/checkout-API-Metadata:-get-/api/stripe/payment_link/{plan_id}/{organization_id}",
"time_stamp": null,
"dataset_id": "fd92b3c5-079c-4bfb-b806-3c4f49b87b31",
"weight": 0,
"location": null,
"image_urls": null,
"tag_set": "code",
"num_value": null
},
{
"id": "9afafc93-354d-4c73-97f5-ddf617376519",
"link": "api-reference/topic/delete-topic",
"qdrant_point_id": "250728f4-5b06-447d-a6dd-3fd5f2a7e65c",
"created_at": "2024-06-21T05:04:57.840542",
"updated_at": "2024-06-21T05:04:57.840542",
"chunk_html": "Delete Topic\nDelete Topic\n\nDelete an existing chat topic. When a topic is deleted, all associated chat messages are also deleted. Auth'ed user or api key must have an admin or owner role for the specified dataset's organization.",
"metadata": {
"openapi": "delete /api/topic/{topic_id}",
"title": "Delete Topic"
},
"tracking_id": "api-reference/topic/delete-topic-Delete-Topic-Delete-Topic-Delet",
"time_stamp": null,
"dataset_id": "fd92b3c5-079c-4bfb-b806-3c4f49b87b31",
"weight": 0,
"location": null,
"image_urls": null,
"tag_set": "page",
"num_value": null
},
{
"id": "4f442322-4121-43e9-b5a2-64f27606d4ba",
"link": "api-reference/chunk_group/create-chunk-group",
"qdrant_point_id": "aa535d12-4ae8-4ac6-8f58-96acfb5baed2",
"created_at": "2024-06-21T05:04:57.944175",
"updated_at": "2024-06-21T05:04:57.944175",
"chunk_html": "\n\nREST Endpoint POST /api/chunk_group\n\nSummary: Create Chunk Group \n\nDescription: Create Chunk Group\n\nCreate a new chunk_group. This is a way to group chunks together. If you try to create a chunk_group with the same tracking_id as an existing chunk_group, this operation will fail. Auth'ed user or api key must have an admin or owner role for the specified dataset's organization.\n\nSecurity methods: \nheader: apiKey\n\nRequest params: \nheader params:\nTR-Dataset:\n\tstring\n\tDescription: The dataset id to use for the request\n\tExample: \"<string>\"\n\n\nRequest body: any\n\tDescription: N/A\n\tExample: \"<any>\"\n\n\nResponses: \n200: any\n\tDescription: N/A\n\tExample: \"<any>\"\n400: any\n\tDescription: N/A\n\tExample: \"<any>\"\n\n",
"metadata": {},
"tracking_id": "api-reference/chunk_group/create-chunk-group-API-Metadata:-post-/api/chunk_group",
"time_stamp": null,
"dataset_id": "fd92b3c5-079c-4bfb-b806-3c4f49b87b31",
"weight": 0,
"location": null,
"image_urls": null,
"tag_set": "code",
"num_value": null
},
{
"id": "374d8028-9594-4dd8-93e6-9cceeb22b60d",
"link": "api-reference/chunk_group/get-groups-for-chunks",
"qdrant_point_id": "1401bd74-1149-4c40-b804-4d994047a776",
"created_at": "2024-06-21T05:04:58.445987",
"updated_at": "2024-06-21T05:04:58.445988",
"chunk_html": "\n\nREST Endpoint POST /api/chunk_group/chunks\n\nSummary: Get Groups for Chunks \n\nDescription: Get Groups for Chunks\n\nRoute to get the groups that a chunk is in.\n\nSecurity methods: \nheader: apiKey\n\nRequest params: \nheader params:\nTR-Dataset:\n\tstring\n\tDescription: The dataset id to use for the request\n\tExample: \"<string>\"\n\n\nRequest body: any\n\tDescription: N/A\n\tExample: \"<any>\"\n\n\nResponses: \n200: array\n\tDescription: N/A\n\tExample: [\"<any>\"]\n400: any\n\tDescription: N/A\n\tExample: \"<any>\"\n\n",
"metadata": {},
"tracking_id": "api-reference/chunk_group/get-groups-for-chunks-API-Metadata:-post-/api/chunk_group/chunks",
"time_stamp": null,
"dataset_id": "fd92b3c5-079c-4bfb-b806-3c4f49b87b31",
"weight": 0,
"location": null,
"image_urls": null,
"tag_set": "code",
"num_value": null
},
{
"id": "ce0c3a8b-ec40-448b-afdc-a7ab9a40c425",
"link": "examples/ecommerce",
"qdrant_point_id": "1a0af6d2-fed7-499d-a268-011e1db5ac47",
"created_at": "2024-06-21T05:04:58.979629",
"updated_at": "2024-06-21T05:04:59.038228",
"chunk_html": "Iterating and sending chunks to Trieve\nThe last step is we iterate through all the json files, process each line into a CreateChunkData object. We use chukApi.createChunk to create chunks, in this case we are sending chunks in a batch size of 120 which is the max for this route.",
"metadata": { "title": "Iterating and sending chunks to Trieve" },
"tracking_id": "examples/ecommerce-Iterating-and-sending-chunks-to-Trieve",
"time_stamp": null,
"dataset_id": "fd92b3c5-079c-4bfb-b806-3c4f49b87b31",
"weight": 0,
"location": null,
"image_urls": null,
"tag_set": "",
"num_value": null
},
{
"id": "a7f0a793-a2a1-49f4-ae60-6c4af9eb28b7",
"link": "api-reference/dataset/get-client-configuration",
"qdrant_point_id": "c2ab0bdd-713e-4362-ad6f-e7444853c995",
"created_at": "2024-06-21T05:04:59.262184",
"updated_at": "2024-06-21T05:04:59.262184",
"chunk_html": "\n\nREST Endpoint GET /api/dataset/envs\n\nSummary: Get Client Configuration \n\nDescription: Get Client Configuration\n\nGet the client configuration for a dataset. Will use the TR-D\n\nSecurity methods: \nheader: apiKey\n\nRequest params: \nheader params:\nTR-Dataset:\n\tstring\n\tDescription: The dataset id to use for the request\n\tExample: \"<string>\"\n\n\nRequest body: N/A\n\n\nResponses: \n200: any\n\tDescription: N/A\n\tExample: \"<any>\"\n400: any\n\tDescription: N/A\n\tExample: \"<any>\"\n\n",
"metadata": {},
"tracking_id": "api-reference/dataset/get-client-configuration-API-Metadata:-get-/api/dataset/envs",
"time_stamp": null,
"dataset_id": "fd92b3c5-079c-4bfb-b806-3c4f49b87b31",
"weight": 0,
"location": null,
"image_urls": null,
"tag_set": "code",
"num_value": null
},
{
"id": "b4d1e5e5-e96c-4c62-9103-5029cdb6cb40",
"link": "api-reference/dataset/get-dataset",
"qdrant_point_id": "837b1de6-2bd0-47c4-bf13-60941c5b03e2",
"created_at": "2024-06-21T05:04:59.324566",
"updated_at": "2024-06-21T05:04:59.324567",
"chunk_html": "\n\nREST Endpoint GET /api/dataset/{dataset_id}\n\nSummary: Get Dataset \n\nDescription: Get Dataset\n\nGet a dataset by id. Auth'ed user or api key must have an admin or owner role for the specified dataset's organization.\n\nSecurity methods: \nheader: apiKey\n\nRequest params: \npath params:\ndataset_id:\n\tstring\n\tDescription: The id of the dataset you want to retrieve.\n\tExample: \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n\nheader params:\nTR-Dataset:\n\tstring\n\tDescription: The dataset id to use for the request\n\tExample: \"<string>\"\n\n\nRequest body: N/A\n\n\nResponses: \n200: any\n\tDescription: N/A\n\tExample: \"<any>\"\n400: any\n\tDescription: N/A\n\tExample: \"<any>\"\n404: any\n\tDescription: N/A\n\tExample: \"<any>\"\n\n",
"metadata": {},
"tracking_id": "api-reference/dataset/get-dataset-API-Metadata:-get-/api/dataset/{dataset_id}",
"time_stamp": null,
"dataset_id": "fd92b3c5-079c-4bfb-b806-3c4f49b87b31",
"weight": 0,
"location": null,
"image_urls": null,
"tag_set": "code",
"num_value": null
},
{
"id": "94f0d06c-7e65-4da8-87f5-6e1ac75e989e",
"link": "api-reference/dataset/update-dataset",
"qdrant_point_id": "75590101-2338-4839-aa2d-2ac549fde22d",
"created_at": "2024-06-21T05:04:59.429274",
"updated_at": "2024-06-21T05:04:59.429275",
"chunk_html": "Update Dataset\nUpdate Dataset\n\nUpdate a dataset. The auth'ed user must be an owner of the organization to update a dataset.",
"metadata": { "openapi": "put /api/dataset", "title": "Update Dataset" },
"tracking_id": "api-reference/dataset/update-dataset-Update-Dataset-Update-Dataset-U",
"time_stamp": null,
"dataset_id": "fd92b3c5-079c-4bfb-b806-3c4f49b87b31",
"weight": 0,
"location": null,
"image_urls": null,
"tag_set": "page",
"num_value": null
},
{
"id": "0a1ade9b-4e87-43f5-971f-d536571b5093",
"link": "quickstart",
"qdrant_point_id": "238f55ac-7980-4957-87fb-45429a9caa6d",
"created_at": "2024-06-21T05:05:01.088175",
"updated_at": "2024-06-21T05:05:01.405571",
"chunk_html": "Using Trieve API\nSee the API reference for the recommend endpoint to see all of the available options for getting recommendations for a specific chunk or chunks.",
"metadata": { "title": "Using Trieve API" },
"tracking_id": "quickstart-Using-Trieve-API",
"time_stamp": null,
"dataset_id": "fd92b3c5-079c-4bfb-b806-3c4f49b87b31",
"weight": 0,
"location": null,
"image_urls": null,
"tag_set": "",
"num_value": null
},
{
"id": "03c80dce-a7c2-4c6e-b98b-d9a850947b7b",
"link": "api-reference/auth/get-me",
"qdrant_point_id": "39cf75e3-6035-41b4-b72b-13818135b40d",
"created_at": "2024-06-21T05:04:56.473068",
"updated_at": "2024-06-21T05:04:56.473069",
"chunk_html": "\n\nREST Endpoint GET /api/auth/me\n\nSummary: Get Me \n\nDescription: Get Me\n\nGet the user corresponding to your current auth credentials.\n\nSecurity methods: \nheader: apiKey\n\nRequest params: \n\nRequest body: N/A\n\n\nResponses: \n200: any\n\tDescription: N/A\n\tExample: \"<any>\"\n400: any\n\tDescription: N/A\n\tExample: \"<any>\"\n\n",
"metadata": {},
"tracking_id": "api-reference/auth/get-me-API-Metadata:-get-/api/auth/me",
"time_stamp": null,
"dataset_id": "fd92b3c5-079c-4bfb-b806-3c4f49b87b31",
"weight": 0,
"location": null,
"image_urls": null,
"tag_set": "code",
"num_value": null
},
{
"id": "b76a1d89-d570-45b8-aea0-7a92b5b00644",
"link": "api-reference/chunk/get-chunk-by-id",
"qdrant_point_id": "5797bd87-16da-4be2-a067-e37a3ea398c2",
"created_at": "2024-06-21T05:04:57.167784",
"updated_at": "2024-06-21T05:04:57.167784",
"chunk_html": "\n\nREST Endpoint GET /api/chunk/{chunk_id}\n\nSummary: Get Chunk By Id \n\nDescription: Get Chunk By Id\n\nGet a singular chunk by id.\n\nSecurity methods: \nheader: apiKey\n\nRequest params: \npath params:\nchunk_id:\n\tstring\n\tDescription: Id of the chunk you want to fetch.\n\tExample: \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n\nheader params:\nTR-Dataset:\n\tstring\n\tDescription: The dataset id to use for the request\n\tExample: \"<string>\"\n\n\nRequest body: N/A\n\n\nResponses: \n200: any\n\tDescription: N/A\n\tExample: \"<any>\"\n400: any\n\tDescription: N/A\n\tExample: \"<any>\"\n404: any\n\tDescription: N/A\n\tExample: \"<any>\"\n\n",
"metadata": {},
"tracking_id": "api-reference/chunk/get-chunk-by-id-API-Metadata:-get-/api/chunk/{chunk_id}",
"time_stamp": null,
"dataset_id": "fd92b3c5-079c-4bfb-b806-3c4f49b87b31",
"weight": 0,
"location": null,
"image_urls": null,
"tag_set": "code",
"num_value": null,
"group_tracking_ids": ["api-reference/chunk/get-chunk-by-id"]
},
{
"id": "3bf0818b-4ba2-4110-8be2-9e56ed2f4c17",
"link": "api-reference/organization/get-organization",
"qdrant_point_id": "47ab75ae-5011-4228-8a82-43be4d48d54d",
"created_at": "2024-06-21T05:04:57.359460",
"updated_at": "2024-06-21T05:04:57.359460",
"chunk_html": "Get Organization\nGet Organization\n\nFetch the details of an organization by its id. Auth'ed user or api key must have an admin or owner role for the specified dataset's organization.",
"metadata": {
"openapi": "get /api/organization/{organization_id}",
"title": "Get Organization"
},
"tracking_id": "api-reference/organization/get-organization-Get-Organization-Get-Organizatio",
"time_stamp": null,
"dataset_id": "fd92b3c5-079c-4bfb-b806-3c4f49b87b31",
"weight": 0,
"location": null,
"image_urls": null,
"tag_set": "page",
"num_value": null,
"group_tracking_ids": ["api-reference/organization/get-organization"]
},
{
"id": "e1216262-f049-4b14-bad3-ca54f25b3956",
"link": "api-reference/chunk/get-chunks-by-trackingids",
"qdrant_point_id": "3c6cbd5e-46b8-4aa8-bdff-d0b686acfbbc",
"created_at": "2024-06-21T05:04:57.374947",
"updated_at": "2024-06-21T05:04:57.374948",
"chunk_html": "\n\nREST Endpoint POST /api/chunks/tracking\n\nSummary: Get Chunks By TrackingIds \n\nDescription: Get Chunks By TrackingIds\n\nGet multiple chunks by ids.\n\nSecurity methods: \nheader: apiKey\n\nRequest params: \nheader params:\nTR-Dataset:\n\tstring\n\tDescription: The dataset id to use for the request\n\tExample: \"<string>\"\n\n\nRequest body: any\n\tDescription: N/A\n\tExample: \"<any>\"\n\n\nResponses: \n200: array\n\tDescription: N/A\n\tExample: [\"<any>\"]\n400: any\n\tDescription: N/A\n\tExample: \"<any>\"\n\n",
"metadata": {},
"tracking_id": "api-reference/chunk/get-chunks-by-trackingids-API-Metadata:-post-/api/chunks/tracking",
"time_stamp": null,
"dataset_id": "fd92b3c5-079c-4bfb-b806-3c4f49b87b31",
"weight": 0,
"location": null,
"image_urls": null,
"tag_set": "code",
"num_value": null,
"group_tracking_ids": ["api-reference/chunk/get-chunks-by-trackingids"]
},
{
"id": "efbacce4-a92a-4b5e-909a-7f7aef7d43ff",
"link": "api-reference/chunk_group/delete-group-by-tracking-id",
"qdrant_point_id": "61c79553-b56c-467a-8668-3fb019c0bf5f",
"created_at": "2024-06-21T05:04:58.008195",
"updated_at": "2024-06-21T05:04:58.008195",
"chunk_html": "\n\nREST Endpoint DELETE /api/chunk_group/tracking_id/{tracking_id}\n\nSummary: Delete Group by Tracking ID \n\nDescription: Delete Group by Tracking ID\n\nDelete a chunk_group with the given tracking id. Auth'ed user or api key must have an admin or owner role for the specified dataset's organization.\n\nSecurity methods: \nheader: apiKey\n\nRequest params: \npath params:\ntracking_id:\n\tstring\n\tDescription: Tracking id of the chunk_group to delete\n\tExample: \"<string>\"\n\nquery params:\ndelete_chunks:\n\tboolean\n\tDescription: Delete the chunks within the group\n\tExample: true\n\nheader params:\nTR-Dataset:\n\tstring\n\tDescription: The dataset id to use for the request\n\tExample: \"<string>\"\n\n\nRequest body: N/A\n\n\nResponses: \n204: N/A\n400: any\n\tDescription: N/A\n\tExample: \"<any>\"\n\n",
"metadata": {},
"tracking_id": "api-reference/chunk_group/delete-group-by-tracking-id-API-Metadata:-delete-/api/chunk_group/tracking_id/{tracking_id}",
"time_stamp": null,
"dataset_id": "fd92b3c5-079c-4bfb-b806-3c4f49b87b31",
"weight": 0,
"location": null,
"image_urls": null,
"tag_set": "code",
"num_value": null,
"group_tracking_ids": [
"api-reference/chunk_group/delete-group-by-tracking-id"
]
},
{
"id": "31607aed-7b2c-4f71-a855-0e06b4833b32",
"link": "api-reference/chunk_group/delete-group",
"qdrant_point_id": "cabcd2ac-b09c-471f-8ac3-7817066c0d54",
"created_at": "2024-06-21T05:04:58.050653",
"updated_at": "2024-06-21T05:04:58.050653",
"chunk_html": "Delete Group\nDelete Group\n\nThis will delete a chunk_group. If you set delete_chunks to true, it will also delete the chunks within the group. Auth'ed user or api key must have an admin or owner role for the specified dataset's organization.",
"metadata": {
"openapi": "delete /api/chunk_group/{group_id}",
"title": "Delete Group"
},
"tracking_id": "api-reference/chunk_group/delete-group-Delete-Group-Delete-Group-This-",
"time_stamp": null,
"dataset_id": "fd92b3c5-079c-4bfb-b806-3c4f49b87b31",
"weight": 0,
"location": null,
"image_urls": null,
"tag_set": "page",
"num_value": null,
"group_tracking_ids": ["api-reference/chunk_group/delete-group"]
},
{
"id": "7bd09831-94d3-401c-b777-b77ff3d0c8bb",
"link": "api-reference/chunk_group/remove-chunk-from-group",
"qdrant_point_id": "f3baefcb-15f6-46cd-a530-653f67b35135",
"created_at": "2024-06-21T05:04:58.621926",
"updated_at": "2024-06-21T05:04:58.621927",
"chunk_html": "Remove Chunk from Group\nRemove Chunk from Group\n\nRoute to remove a chunk from a group. Auth'ed user or api key must be an admin or owner of the dataset's organization to remove a chunk from a group.",
"metadata": {
"openapi": "delete /api/chunk_group/chunk/{group_id}",
"title": "Remove Chunk from Group"
},
"tracking_id": "api-reference/chunk_group/remove-chunk-from-group-Remove-Chunk-from-Group-Remove-C",
"time_stamp": null,
"dataset_id": "fd92b3c5-079c-4bfb-b806-3c4f49b87b31",
"weight": 0,
"location": null,
"image_urls": null,
"tag_set": "page",
"num_value": null,
"group_tracking_ids": ["api-reference/chunk_group/remove-chunk-from-group"]
},
{
"id": "c6334dee-11b8-4b5f-89b1-4e22ba1cca35",
"link": "api-reference/chunk_group/update-group",
"qdrant_point_id": "194d592a-1407-48e3-9cda-a606a5d23fc6",
"created_at": "2024-06-21T05:04:58.948244",
"updated_at": "2024-06-21T05:04:58.948244",
"chunk_html": "Update Group\nUpdate Group\n\nUpdate a chunk_group. If you try to change the tracking_id to one that already exists, this operation will fail. Auth'ed user or api key must have an admin or owner role for the specified dataset's organization.",
"metadata": { "openapi": "put /api/chunk_group", "title": "Update Group" },
"tracking_id": "api-reference/chunk_group/update-group-Update-Group-Update-Group-Updat",
"time_stamp": null,
"dataset_id": "fd92b3c5-079c-4bfb-b806-3c4f49b87b31",
"weight": 0,
"location": null,
"image_urls": null,
"tag_set": "page",
"num_value": null,
"group_tracking_ids": ["api-reference/chunk_group/update-group"]
},
{
"id": "0fbd666e-33a8-48e3-b847-411dad6f2c2d",
"link": "api-reference/events/get-events-for-the-dataset",
"qdrant_point_id": "a26426bc-1f8c-400d-b583-1f052c658b51",
"created_at": "2024-06-21T05:04:59.495524",
"updated_at": "2024-06-21T05:04:59.495524",
"chunk_html": "Get events for the dataset\nGet events for the dataset\n\nGet events for the dataset specified by the TR-Dataset header.",
"metadata": {
"openapi": "post /api/events",
"title": "Get events for the dataset"
},
"tracking_id": "api-reference/events/get-events-for-the-dataset-Get-events-for-the-dataset-Get-e",
"time_stamp": null,
"dataset_id": "fd92b3c5-079c-4bfb-b806-3c4f49b87b31",
"weight": 0,
"location": null,
"image_urls": null,
"tag_set": "page",
"num_value": null,
"group_tracking_ids": ["api-reference/events/get-events-for-the-dataset"]
},
{
"id": "24296bd4-4f64-4c3e-ba73-9a7550c3a918",
"link": "api-reference/message/create-a-message",
"qdrant_point_id": "7b499973-f9d2-4c57-aca5-1675e750481f",
"created_at": "2024-06-21T05:04:59.988819",
"updated_at": "2024-06-21T05:04:59.988819",
"chunk_html": "Create message\nCreate message\n\nCreate message. Messages are attached to topics in order to coordinate memory of gen-AI chat sessions. We are considering refactoring this resource of the API soon. Currently, you can only send user messages. If the topic is a RAG topic then the response will include Chunks first on the stream. The structure will look like `[chunks]||mesage`. See docs.trieve.ai for more information. Auth'ed user or api key must have an admin or owner role for the specified dataset's organization.",
"metadata": { "openapi": "post /api/message", "title": "Create message" },
"tracking_id": "api-reference/message/create-a-message-Create-message-Create-message-C",
"time_stamp": null,
"dataset_id": "fd92b3c5-079c-4bfb-b806-3c4f49b87b31",
"weight": 0,
"location": null,
"image_urls": null,
"tag_set": "page",
"num_value": null,
"group_tracking_ids": ["api-reference/message/create-a-message"]
},
{
"id": "9771a47b-51ee-4180-9aff-bc0b36629c27",
"link": "guides/create-chunk",
"qdrant_point_id": "d5898d02-6ce1-4599-bd71-801fe87b1df1",
"created_at": "2024-06-21T05:05:00.025145",
"updated_at": "2024-06-21T05:05:00.068475",
"chunk_html": "Formatting chunk_html\nCreating a good chunk_html is crucial for the quality of your search results. Here are some tips to help you create a good chunk_html: Include all relevant information : Make sure to include all the information that you want to be searchable in the chunk_html. Use newlines : Put semantically distinct information on separate lines to help the model understand the structure of the text and search quality for each field better Label each field : If you have multiple fields in your chunk_html , label each field with a header to help the model better embed the text and improve search quality. Example of a good chunk_html:",
"metadata": { "title": "Formatting chunk_html" },
"tracking_id": "guides/create-chunk-Formatting-chunk_html",
"time_stamp": null,
"dataset_id": "fd92b3c5-079c-4bfb-b806-3c4f49b87b31",
"weight": 0,
"location": null,
"image_urls": null,
"tag_set": "",
"num_value": null,
"group_tracking_ids": ["guides/create-chunk"]
},
{
"id": "d272eb1c-8737-4b85-a496-15efc695257e",
"link": "guides/searching-with-trieve",
"qdrant_point_id": "2a6a0432-647e-4d83-ae11-c4375472b600",
"created_at": "2024-06-21T05:05:00.345752",
"updated_at": "2024-06-21T05:05:00.345752",
"chunk_html": "Searching with Trieve\nLearn how to search over your data with Trieve",
"metadata": { "title": "Searching with Trieve" },
"tracking_id": "guides/searching-with-trieve-Searching-with-Trieve-Learn-how-",
"time_stamp": null,
"dataset_id": "fd92b3c5-079c-4bfb-b806-3c4f49b87b31",
"weight": 0,
"location": null,
"image_urls": null,
"tag_set": "page",
"num_value": null,
"group_tracking_ids": ["guides/searching-with-trieve"]
},
{
"id": "a62bb29f-b5b6-4e62-82b7-46f55e4c75e9",
"link": "guides/uploading-files",
"qdrant_point_id": "e486a559-d26b-418d-b8a4-d3957669d2fb",
"created_at": "2024-06-21T05:05:00.421976",
"updated_at": "2024-06-21T05:05:00.421977",
"chunk_html": "Uploading a File to Trieve\nOur service supports various file types (e.g., HTML, DOCX, PDF). We use Apache Tika to convert these files to HTML to preserve formatting and then chunk them.",
"metadata": { "title": "Uploading a File to Trieve" },
"tracking_id": "guides/uploading-files-Uploading-a-File-to-Trieve",
"time_stamp": null,
"dataset_id": "fd92b3c5-079c-4bfb-b806-3c4f49b87b31",
"weight": 0,
"location": null,
"image_urls": null,
"tag_set": "",
"num_value": null,
"group_tracking_ids": ["guides/uploading-files"]
},
{
"id": "f0b3769a-a3e3-417a-bb31-93cb15bbaa55",
"link": "guides/uploading-files",
"qdrant_point_id": "00f46638-5ba9-42a7-8e0c-61c69597d944",
"created_at": "2024-06-21T05:05:00.451855",
"updated_at": "2024-06-21T05:05:00.451855",
"chunk_html": "Important Parameters\nbase64_file : To allow users to pass metadata with their file uploads, we require files to be base64 URL encoded. Convert + to - , / to _ , and remove the ending = if present. file_name : The name of the file being uploaded, including the extension. This will become the name of the resulting group. group_tracking_id : This field allows you to assign an arbitrary ID to the group, aiding in coordination with your database system. You can search for this group using this ID. link , tag_set , and time_stamp : These fields are indexed to enable fast filtering of groups based on these attributes. metadata : This field allows you to include any arbitrary metadata in the form of a JSON object with the group. For the best filtering performance, we recommend using the link , tag_set , and time_stamp fields, as there are dedicated indexes for these. The metadata field has an index built for match queries but is not optimized for range queries.",
"metadata": { "title": "Important Parameters" },
"tracking_id": "guides/uploading-files-Important-Parameters",
"time_stamp": null,
"dataset_id": "fd92b3c5-079c-4bfb-b806-3c4f49b87b31",
"weight": 0,
"location": null,
"image_urls": null,
"tag_set": "",
"num_value": null,
"group_tracking_ids": ["guides/uploading-files"]
},
{
"id": "a40524bf-7008-478f-9ace-01a231bd3e61",
"link": "quickstart",
"qdrant_point_id": "1e9f3ae8-4978-4fc9-9821-3f152106df6e",
"created_at": "2024-06-21T05:05:01.121809",
"updated_at": "2024-06-21T05:05:01.121809",
"chunk_html": "1. Copy a dataset_id\nGet an id from the output of the trieve dataset list command or create a new dataset with the trieve dataset create command and copy the id from the output.",
"metadata": { "title": "1. Copy a dataset_id" },
"tracking_id": "quickstart-1.-Copy-a-dataset_id",
"time_stamp": null,
"dataset_id": "fd92b3c5-079c-4bfb-b806-3c4f49b87b31",
"weight": 0,
"location": null,
"image_urls": null,
"tag_set": "",
"num_value": null,
"group_tracking_ids": ["quickstart"]
},
{
"id": "0677423e-61fe-48f0-927c-c003bd225757",
"link": "api-reference/chunk/delete-chunk",
"qdrant_point_id": "e26c1ddb-ac5d-42ce-ac09-1e9e05d291c0",
"created_at": "2024-06-21T05:04:56.986309",
"updated_at": "2024-06-21T05:04:56.986309",
"chunk_html": "Delete Chunk\nDelete Chunk\n\nDelete a chunk by its id. If deleting a root chunk which has a collision, the most recently created collision will become a new root chunk. Auth'ed user or api key must have an admin or owner role for the specified dataset's organization.",
"metadata": {
"openapi": "delete /api/chunk/{chunk_id}",
"title": "Delete Chunk"
},
"tracking_id": "api-reference/chunk/delete-chunk-Delete-Chunk-Delete-Chunk-Delet",
"time_stamp": null,
"dataset_id": "fd92b3c5-079c-4bfb-b806-3c4f49b87b31",
"weight": 0,
"location": null,
"image_urls": null,
"tag_set": "page",
"num_value": null,
"group_tracking_ids": ["api-reference/chunk/delete-chunk"]
},
{
"id": "114c47f9-a7ad-4c0d-9492-4b30685929c9",
"link": "api-reference/chunk_group/get-group",
"qdrant_point_id": "23d5bbdf-ff52-4fe9-a7e7-c8b42fa90b99",
"created_at": "2024-06-21T05:04:58.340399",
"updated_at": "2024-06-21T05:04:58.340400",
"chunk_html": "Get Group\nGet Group\n\nFetch the group with the given id.\nget_group",
"metadata": {
"openapi": "get /api/chunk_group/{group_id}",
"title": "Get Group"
},
"tracking_id": "api-reference/chunk_group/get-group-Get-Group-Get-Group-Fetch-the-g",
"time_stamp": null,
"dataset_id": "fd92b3c5-079c-4bfb-b806-3c4f49b87b31",
"weight": 0,
"location": null,
"image_urls": null,
"tag_set": "page",
"num_value": null,
"group_tracking_ids": ["api-reference/chunk_group/get-group"]
},
{
"id": "17c4e59b-4358-408c-8c55-802a62b03b59",
"link": "api-reference/stripe/update-subscription-plan",
"qdrant_point_id": "44cf95b4-571a-47a7-b4e0-0cb59b19e0b2",
"created_at": "2024-06-21T05:04:57.733013",
"updated_at": "2024-06-21T05:04:57.733013",
"chunk_html": "\n\nREST Endpoint PATCH /api/stripe/subscription_plan/{subscription_id}/{plan_id}\n\nSummary: Update Subscription Plan \n\nDescription: Update Subscription Plan\n\nUpdate a subscription to a new plan\n\nSecurity methods: \nheader: apiKey\n\nRequest params: \npath params:\nsubscription_id:\n\tstring\n\tDescription: id of the subscription you want to update\n\tExample: \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\nplan_id:\n\tstring\n\tDescription: id of the plan you want to subscribe to\n\tExample: \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n\nheader params:\nTR-Organization:\n\tstring\n\tDescription: The organization id to use for the request\n\tExample: \"<string>\"\n\n\nRequest body: N/A\n\n\nResponses: \n200: N/A\n400: any\n\tDescription: N/A\n\tExample: \"<any>\"\n\n",
"metadata": {},
"tracking_id": "api-reference/stripe/update-subscription-plan-API-Metadata:-patch-/api/stripe/subscription_plan/{subscription_id}/{plan_id}",
"time_stamp": null,
"dataset_id": "fd92b3c5-079c-4bfb-b806-3c4f49b87b31",
"weight": 0,
"location": null,
"image_urls": null,
"tag_set": "code",
"num_value": null,
"group_tracking_ids": ["api-reference/stripe/update-subscription-plan"]
},
{
"id": "7cb8d104-515d-4fd5-98d5-d9445a894c97",
"link": "api-reference/chunk/search",
"qdrant_point_id": "c095d496-4203-4e5f-9cc3-a3d5248c89d5",
"created_at": "2024-06-21T05:04:57.587069",
"updated_at": "2024-06-21T05:04:57.587069",
"chunk_html": "\n\nREST Endpoint POST /api/chunk/search\n\nSummary: Search \n\nDescription: Search\n\nThis route provides the primary search functionality for the API. It can be used to search for chunks by semantic similarity, full-text similarity, or a combination of both. Results' `chunk_html` values will be modified with `<b><mark>` tags for sub-sentence highlighting.\n\nSecurity methods: \nheader: apiKey\n\nRequest params: \nheader params:\nTR-Dataset:\n\tstring\n\tDescription: The dataset id to use for the request\n\tExample: \"<string>\"\n\n\nRequest body: any\n\tDescription: N/A\n\tExample: \"<any>\"\n\n\nResponses: \n200: any\n\tDescription: N/A\n\tExample: \"<any>\"\n400: any\n\tDescription: N/A\n\tExample: \"<any>\"\n\n",
"metadata": {},
"tracking_id": "api-reference/chunk/search-API-Metadata:-post-/api/chunk/search",
"time_stamp": null,
"dataset_id": "fd92b3c5-079c-4bfb-b806-3c4f49b87b31",
"weight": 0,
"location": null,
"image_urls": null,
"tag_set": "code",
"num_value": null,
"group_tracking_ids": ["api-reference/chunk/search"]
},
{
"id": "01726d8f-e7d5-49b7-a1cd-ad1cf1d91da3",
"link": "guides/searching-with-trieve",
"qdrant_point_id": "1b04f7b5-929f-48ed-b9df-a6566b9a9cf0",
"created_at": "2024-06-21T05:05:00.143725",
"updated_at": "2024-06-21T05:05:00.332907",
"chunk_html": "Filtering\nWe provide a system to allow users to filter the chunks that are returned. The filters are structured around three clauses: must : All filters within this clause must be matched to return the chunks. Get chunks with both \"CO\" and \"321\" in their tag_set: Get chunks with either \"CO\" OR \"321\" in their tag_set: must_not : All filters in this clause must not be matched to return the chunks. Get chunks with neither \"CO\" nor \"321\" in their tag_set: Get chunks that either don't have \"CO\" in their tag_set or don't have \"321\" in their tag_set: should : Any of these conditions can be matched to return a chunk. Get chunks that either have \"CO\" in their tag_set or \" http://example.com \" in their link:",
"metadata": { "title": "Filtering" },
"tracking_id": "guides/searching-with-trieve-Filtering",
"time_stamp": null,
"dataset_id": "fd92b3c5-079c-4bfb-b806-3c4f49b87b31",
"weight": 0,
"location": null,
"image_urls": null,
"tag_set": "",
"num_value": null,
"group_tracking_ids": ["guides/searching-with-trieve"]
},
{
"id": "a3aa6e0d-d5e3-455e-bb07-41265c8fb5c7",
"link": "api-reference/topic/update-topic",
"qdrant_point_id": "7c560794-732c-458b-96d9-203384bae1b2",
"created_at": "2024-06-21T05:04:58.007952",
"updated_at": "2024-06-21T05:04:58.007952",
"chunk_html": "\n\nREST Endpoint PUT /api/topic\n\nSummary: Update Topic \n\nDescription: Update Topic\n\nUpdate an existing chat topic. Currently, only the name of the topic can be updated. Auth'ed user or api key must have an admin or owner role for the specified dataset's organization.\n\nSecurity methods: \nheader: apiKey\n\nRequest params: \nheader params:\nTR-Dataset:\n\tstring\n\tDescription: The dataset id to use for the request\n\tExample: \"<string>\"\n\n\nRequest body: any\n\tDescription: N/A\n\tExample: \"<any>\"\n\n\nResponses: \n204: N/A\n400: any\n\tDescription: N/A\n\tExample: \"<any>\"\n\n",
"metadata": {},
"tracking_id": "api-reference/topic/update-topic-API-Metadata:-put-/api/topic",
"time_stamp": null,
"dataset_id": "fd92b3c5-079c-4bfb-b806-3c4f49b87b31",
"weight": 0,
"location": null,
"image_urls": null,
"tag_set": "code",
"num_value": null,
"group_tracking_ids": ["api-reference/topic/update-topic"]
},
{
"id": "c57a9587-c990-451d-8f57-f281fbe326fa",
"link": "api-reference/dataset/get-client-configuration",
"qdrant_point_id": "b643f905-ec36-427e-b569-672811e1032f",
"created_at": "2024-06-21T05:04:59.231824",
"updated_at": "2024-06-21T05:04:59.231824",
"chunk_html": "Get Client Configuration\nGet Client Configuration\n\nGet the client configuration for a dataset. Will use the TR-D",
"metadata": {
"openapi": "get /api/dataset/envs",
"title": "Get Client Configuration"
},
"tracking_id": "api-reference/dataset/get-client-configuration-Get-Client-Configuration-Get-Cli",
"time_stamp": null,
"dataset_id": "fd92b3c5-079c-4bfb-b806-3c4f49b87b31",
"weight": 0,
"location": null,
"image_urls": null,
"tag_set": "page",
"num_value": null,
"group_tracking_ids": ["api-reference/dataset/get-client-configuration"]
},
{
"id": "58500d2a-6fd1-42f7-ae69-5f4361f5b722",
"link": "api-reference/dataset/get-dataset",
"qdrant_point_id": "c384ef6a-650e-4612-8292-2b1c15c7f0b1",
"created_at": "2024-06-21T05:04:59.293331",
"updated_at": "2024-06-21T05:04:59.293332",
"chunk_html": "Get Dataset\nGet Dataset\n\nGet a dataset by id. Auth'ed user or api key must have an admin or owner role for the specified dataset's organization.",
"metadata": {
"openapi": "get /api/dataset/{dataset_id}",
"title": "Get Dataset"
},
"tracking_id": "api-reference/dataset/get-dataset-Get-Dataset-Get-Dataset-Get-a-d",
"time_stamp": null,
"dataset_id": "fd92b3c5-079c-4bfb-b806-3c4f49b87b31",
"weight": 0,
"location": null,
"image_urls": null,
"tag_set": "page",
"num_value": null,
"group_tracking_ids": ["api-reference/dataset/get-dataset"]
},
{
"id": "b1806295-25c4-4579-a9db-0966000aae44",
"link": "examples/job-board",
"qdrant_point_id": "3ce9dd77-99fe-4e16-8065-ce95459fa60e",
"created_at": "2024-06-21T05:04:59.495319",
"updated_at": "2024-06-21T05:04:59.544621",
"chunk_html": "Creating the Searchable Chunk HTML\nThe Chunk HTML should contain the data that we want to be searchable. In this case, we include the job title, description and other text fields that provide more context to the embedding model so that it can generate a better embedding to represent the job. It is typically best practice to put a \\n\\n between each field to separate them so that the model can differentiate between them. The following function transforms job data into the searchable chunk HTML:",
"metadata": { "title": "Creating the Searchable Chunk HTML" },
"tracking_id": "examples/job-board-Creating-the-Searchable-Chunk-HTML",
"time_stamp": null,
"dataset_id": "fd92b3c5-079c-4bfb-b806-3c4f49b87b31",
"weight": 0,
"location": null,
"image_urls": null,
"tag_set": "",
"num_value": null,
"group_tracking_ids": ["examples/job-board"]
},
{
"id": "72904485-8786-421f-a832-4c655d15985b",
"link": "api-reference/chunk_group/delete-group-by-tracking-id",
"qdrant_point_id": "7dabb910-3111-40a0-98e3-7edd03846fc4",
"created_at": "2024-06-21T05:04:57.976680",
"updated_at": "2024-06-21T05:04:57.976681",
"chunk_html": "Delete Group by Tracking ID\nDelete Group by Tracking ID\n\nDelete a chunk_group with the given tracking id. Auth'ed user or api key must have an admin or owner role for the specified dataset's organization.",
"metadata": {
"openapi": "delete /api/chunk_group/tracking_id/{tracking_id}",
"title": "Delete Group by Tracking ID"
},
"tracking_id": "api-reference/chunk_group/delete-group-by-tracking-id-Delete-Group-by-Tracking-ID-Dele",
"time_stamp": null,
"dataset_id": "fd92b3c5-079c-4bfb-b806-3c4f49b87b31",
"weight": 0,
"location": null,
"image_urls": null,
"tag_set": "page",
"num_value": null,
"group_tracking_ids": [
"api-reference/chunk_group/delete-group-by-tracking-id"
]
},
{
"id": "72583c3e-e20e-4d54-b3bd-81c9bdad6a92",
"link": "quickstart",
"qdrant_point_id": "f0a55f92-f657-4ed1-bc31-9a9a69ad3ebd",
"created_at": "2024-06-21T05:05:00.968182",
"updated_at": "2024-06-21T05:05:00.968182",
"chunk_html": "Using dashboard.trieve.ai\nAlternatively, you can also create a dataset at dashboard.trieve.ai by clicking on the \"Create Dataset\" button:",
"metadata": { "title": "Using dashboard.trieve.ai" },
"tracking_id": "quickstart-Using-dashboard.trieve.ai",
"time_stamp": null,
"dataset_id": "fd92b3c5-079c-4bfb-b806-3c4f49b87b31",
"weight": 0,
"location": null,
"image_urls": null,
"tag_set": "",
"num_value": null,
"group_tracking_ids": ["quickstart"]
},
{
"id": "9282f794-f5ec-4558-b517-1a3f6c6eb101",
"link": "quickstart",
"qdrant_point_id": "fc9a30e0-00e4-4404-89db-d64d000beb52",
"created_at": "2024-06-21T05:05:01.148468",
"updated_at": "2024-06-21T05:05:01.148469",
"chunk_html": "2. Copy an api-key\nGet an api-key from the result of the trieve api-key generate command making sure that it has both read and write permissions.",
"metadata": { "title": "2. Copy an api-key" },
"tracking_id": "quickstart-2.-Copy-an-api-key",
"time_stamp": null,
"dataset_id": "fd92b3c5-079c-4bfb-b806-3c4f49b87b31",
"weight": 0,
"location": null,
"image_urls": null,
"tag_set": "",
"num_value": null,
"group_tracking_ids": ["quickstart"]
},
{
"id": "ac3ccf6c-4f12-446c-8730-5fa8864fa0c0",
"link": "quickstart",
"qdrant_point_id": "c663dcc4-2175-44a6-bd1c-46667745deae",
"created_at": "2024-06-21T05:05:01.247725",
"updated_at": "2024-06-21T05:05:01.375711",
"chunk_html": "On search.trieve.ai\nOpen a chunk by itself by clicking on the external link icon on the right side of the chunk. Click on the \"Get Related Chunks\" button below the chunk. The recommended chunks will be displayed below the button.",
"metadata": { "title": "On search.trieve.ai" },
"tracking_id": "quickstart-On-search.trieve.ai",
"time_stamp": null,
"dataset_id": "fd92b3c5-079c-4bfb-b806-3c4f49b87b31",
"weight": 0,
"location": null,
"image_urls": null,
"tag_set": "",
"num_value": null,
"group_tracking_ids": ["quickstart"]
},
{
"id": "e7feaf88-d3da-447b-8e5d-66976f81bf01",
"link": "api-reference/auth/login",
"qdrant_point_id": "d7a40b14-8dab-4b60-8cdb-7f47f92aa848",
"created_at": "2024-06-21T05:04:56.513129",
"updated_at": "2024-06-21T05:04:56.513129",
"chunk_html": "Login\nLogin\n\nThis will redirect you to the OAuth provider for authentication with email/pass, SSO, Google, Github, etc.",
"metadata": { "openapi": "get /api/auth", "title": "Login" },
"tracking_id": "api-reference/auth/login-Login-Login-This-will-redirect-",
"time_stamp": null,
"dataset_id": "fd92b3c5-079c-4bfb-b806-3c4f49b87b31",
"weight": 0,
"location": null,
"image_urls": null,
"tag_set": "page",
"num_value": null,
"group_tracking_ids": ["api-reference/auth/login"]
},
{
"id": "9fed2ff2-137b-43c9-8d4c-8d3cc76a2025",
"link": "api-reference/chunk_group/get-chunks-in-group-by-tracking-id",
"qdrant_point_id": "d7176295-6ac5-4fa8-b0b4-1cdebba36ff1",
"created_at": "2024-06-21T05:04:58.122005",
"updated_at": "2024-06-21T05:04:58.122005",
"chunk_html": "Get Chunks in Group by Tracking ID\nGet Chunks in Group by Tracking ID\n\nRoute to get all chunks for a group. The response is paginated, with each page containing 10 chunks. Support for custom page size is coming soon. Page is 1-indexed.",
"metadata": {
"openapi": "get /api/chunk_group/tracking_id/{group_tracking_id}/{page}",
"title": "Get Chunks in Group by Tracking ID"
},
"tracking_id": "api-reference/chunk_group/get-chunks-in-group-by-tracking-id-Get-Chunks-in-Group-by-Tracking-",
"time_stamp": null,
"dataset_id": "fd92b3c5-079c-4bfb-b806-3c4f49b87b31",
"weight": 0,
"location": null,
"image_urls": null,
"tag_set": "page",
"num_value": null
},
{
"id": "aacd33d5-e6b7-4ac6-bc6e-5be27eb6ed55",
"link": "api-reference/user/update-user",
"qdrant_point_id": "adbcb88a-7b04-4414-b2e8-120ee13c5f79",
"created_at": "2024-06-21T05:04:58.240085",
"updated_at": "2024-06-21T05:04:58.240086",
"chunk_html": "\n\nREST Endpoint PUT /api/user\n\nSummary: Update User \n\nDescription: Update User\n\nUpdate a user's information. If the user_id is not provided, the auth'ed user will be updated. If the user_id is provided, the role of the auth'ed user or api key must be an admin (1) or owner (2) of the organization.\n\nSecurity methods: \nheader: apiKey\n\nRequest params: \n\nRequest body: any\n\tDescription: N/A\n\tExample: \"<any>\"\n\n\nResponses: \n204: N/A\n400: any\n\tDescription: N/A\n\tExample: \"<any>\"\n\n",
"metadata": {},
"tracking_id": "api-reference/user/update-user-API-Metadata:-put-/api/user",
"time_stamp": null,
"dataset_id": "fd92b3c5-079c-4bfb-b806-3c4f49b87b31",
"weight": 0,
"location": null,
"image_urls": null,
"tag_set": "code",
"num_value": null
},
{
"id": "d18236d8-7c99-4936-97c7-c62eb60a0021",
"link": "api-reference/message/regenerate-message",
"qdrant_point_id": "5f8fa0ed-dd30-4379-8003-e69d8c74cb8b",
"created_at": "2024-06-21T05:04:56.986178",
"updated_at": "2024-06-21T05:04:56.986178",
"chunk_html": "Regenerate message\nRegenerate message\n\nRegenerate the assistant response to the last user message of a topic. This will delete the last message and replace it with a new message. The response will include Chunks first on the stream if the topic is using RAG. The structure will look like `[chunks]||mesage`. See docs.trieve.ai for more information. Auth'ed user or api key must have an admin or owner role for the specified dataset's organization.",
"metadata": {
"openapi": "delete /api/message",
"title": "Regenerate message"
},
"tracking_id": "api-reference/message/regenerate-message-Regenerate-message-Regenerate-me",
"time_stamp": null,
"dataset_id": "fd92b3c5-079c-4bfb-b806-3c4f49b87b31",
"weight": 0,
"location": null,
"image_urls": null,
"tag_set": "page",
"num_value": null
},
{
"id": "f7cd82a4-b1b6-49f2-8427-baad55e920f5",
"link": "guides/RAG-with-trieve",
"qdrant_point_id": "9e7e8df5-c239-4812-bd58-81693eb11a9f",
"created_at": "2024-06-21T05:04:59.708703",
"updated_at": "2024-06-21T05:04:59.708703",
"chunk_html": "RAG on specified chunks\nThis strategy allows you to specify the chunks that you want to chat with. This is useful when you want to control which exact chunks are used in the conversation. API Reference",
"metadata": { "title": "RAG on specified chunks" },
"tracking_id": "guides/RAG-with-trieve-RAG-on-specified-chunks",
"time_stamp": null,
"dataset_id": "fd92b3c5-079c-4bfb-b806-3c4f49b87b31",
"weight": 0,
"location": null,
"image_urls": null,
"tag_set": "",
"num_value": null
},
{
"id": "a6d1905d-4d95-45e9-b1be-633a154b2da9",
"link": "api-reference/user/update-user",
"qdrant_point_id": "a57a4153-8e44-4d87-acdc-3cb46997d1ce",
"created_at": "2024-06-21T05:04:58.192670",
"updated_at": "2024-06-21T05:04:58.192670",
"chunk_html": "Update User\nUpdate User\n\nUpdate a user's information. If the user_id is not provided, the auth'ed user will be updated. If the user_id is provided, the role of the auth'ed user or api key must be an admin (1) or owner (2) of the organization.",
"metadata": { "openapi": "put /api/user", "title": "Update User" },
"tracking_id": "api-reference/user/update-user-Update-User-Update-User-Update-",
"time_stamp": null,
"dataset_id": "fd92b3c5-079c-4bfb-b806-3c4f49b87b31",
"weight": 0,
"location": null,
"image_urls": null,
"tag_set": "page",
"num_value": null
},
{
"id": "164c6795-a588-48b6-a45a-072aa318470e",
"link": "guides/uploading-files",
"qdrant_point_id": "ac533640-6243-43e9-9477-2ec48a7b468e",
"created_at": "2024-06-21T05:05:00.380530",
"updated_at": "2024-06-21T05:05:00.380530",
"chunk_html": "Overview\nWe provide the ability for users to upload their files to Trieve and use our automatic chunking. When uploading a file to Trieve, we automatically group the chunks together to link them. This is done through our upload file route. The default chunker that we provide is basic, simply splitting on word limits. For more advanced chunking, we recommend that you chunk your data yourself and then use our create chunk route to upload them.",
"metadata": { "title": "Overview" },
"tracking_id": "guides/uploading-files-Overview",
"time_stamp": null,
"dataset_id": "fd92b3c5-079c-4bfb-b806-3c4f49b87b31",
"weight": 0,
"location": null,
"image_urls": null,
"tag_set": "",
"num_value": null
},
{
"id": "fff2c467-0631-412e-92d7-9b2b932b04e1",
"link": "api-reference/auth/get-me",
"qdrant_point_id": "4d99a5ba-007d-4676-ae69-feb6a4b72248",
"created_at": "2024-06-21T05:04:56.426237",
"updated_at": "2024-06-21T05:04:56.426238",
"chunk_html": "Get Me\nGet Me\n\nGet the user corresponding to your current auth credentials.",
"metadata": { "openapi": "get /api/auth/me", "title": "Get Me" },
"tracking_id": "api-reference/auth/get-me-Get-Me-Get-Me-Get-the-user-corr",
"time_stamp": null,
"dataset_id": "fd92b3c5-079c-4bfb-b806-3c4f49b87b31",
"weight": 0,
"location": null,
"image_urls": null,
"tag_set": "page",
"num_value": null
},
{
"id": "e889431f-4962-42eb-9ea4-7e805cfea41a",
"link": "api-reference/dataset/delete-dataset-by-tracking-id",
"qdrant_point_id": "437ce9db-7202-4d17-a71c-b8722f81848e",
"created_at": "2024-06-21T05:04:59.126768",
"updated_at": "2024-06-21T05:04:59.126768",
"chunk_html": "\n\nREST Endpoint DELETE /api/dataset/tracking_id/{tracking_id}\n\nSummary: Delete Dataset by Tracking ID \n\nDescription: Delete Dataset by Tracking ID\n\nDelete a dataset by its tracking id. The auth'ed user must be an owner of the organization to delete a dataset.\n\nSecurity methods: \nheader: apiKey\n\nRequest params: \npath params:\ntracking_id:\n\tstring\n\tDescription: The tracking id of the dataset you want to delete.\n\tExample: \"<string>\"\n\nheader params:\nTR-Dataset:\n\tstring\n\tDescription: The dataset id to use for the request\n\tExample: \"<string>\"\n\n\nRequest body: N/A\n\n\nResponses: \n204: N/A\n400: any\n\tDescription: N/A\n\tExample: \"<any>\"\n404: any\n\tDescription: N/A\n\tExample: \"<any>\"\n\n",
"metadata": {},
"tracking_id": "api-reference/dataset/delete-dataset-by-tracking-id-API-Metadata:-delete-/api/dataset/tracking_id/{tracking_id}",
"time_stamp": null,
"dataset_id": "fd92b3c5-079c-4bfb-b806-3c4f49b87b31",
"weight": 0,
"location": null,
"image_urls": null,
"tag_set": "code",
"num_value": null
},
{
"id": "2593ffae-257a-4d65-9dd1-b1c5e8b357e5",
"link": "api-reference/auth/login",
"qdrant_point_id": "0d117e90-6372-4a6e-861d-899852762716",
"created_at": "2024-06-21T05:04:56.552976",
"updated_at": "2024-06-21T05:04:56.552977",
"chunk_html": "\n\nREST Endpoint GET /api/auth\n\nSummary: Login \n\nDescription: Login\n\nThis will redirect you to the OAuth provider for authentication with email/pass, SSO, Google, Github, etc.\n\nSecurity methods: \n\nRequest params: \nquery params:\norganization_id:\n\tstring\n\tDescription: ID of organization to authenticate into\n\tExample: \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n\tnull\n\tDescription: ID of organization to authenticate into\n\tExample: null\nredirect_uri:\n\tstring\n\tDescription: URL to redirect to after successful login\n\tExample: \"<string>\"\n\tnull\n\tDescription: URL to redirect to after successful login\n\tExample: null\ninv_code:\n\tstring\n\tDescription: Code sent via email as a result of successful call to send_invitation\n\tExample: \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n\tnull\n\tDescription: Code sent via email as a result of successful call to send_invitation\n\tExample: null\n\n\nRequest body: N/A\n\n\nResponses: \n303: N/A\n400: any\n\tDescription: N/A\n\tExample: \"<any>\"\n\n",
"metadata": {},
"tracking_id": "api-reference/auth/login-API-Metadata:-get-/api/auth",
"time_stamp": null,
"dataset_id": "fd92b3c5-079c-4bfb-b806-3c4f49b87b31",
"weight": 0,
"location": null,
"image_urls": null,
"tag_set": "code",
"num_value": null
},
{
"id": "39c52a59-d76b-4e0d-9a4f-f95ef9adb9b4",
"link": "examples/job-board",
"qdrant_point_id": "74eb17df-2caa-401f-b9b4-6377d4fcd775",
"created_at": "2024-06-21T05:04:59.563259",
"updated_at": "2024-06-21T05:04:59.626410",
"chunk_html": "Creating a Chunk\nWhen possible, use our bulk upload API to upload data in chunks of up to 120 to take advantage of the speed of the API. To efficiently upload data, we divide it into chunks. Here’s the code snippet for creating a chunk with the data: Checkout the api reference for the upload API to view all of the parameters that can be passed in with the chunk. By following this guide, you should be able to set up and run the demo successfully. If you encounter any issues, refer back to the steps and ensure all configurations are correctly set up.",
"metadata": { "title": "Creating a Chunk" },
"tracking_id": "examples/job-board-Creating-a-Chunk",
"time_stamp": null,
"dataset_id": "fd92b3c5-079c-4bfb-b806-3c4f49b87b31",
"weight": 0,
"location": null,
"image_urls": null,
"tag_set": "",
"num_value": null
},
{
"id": "a869aa50-9261-43a6-9c62-07442604b6e6",
"link": "api-reference/file/get-file",
"qdrant_point_id": "c4854bb9-8de2-4160-8e47-7c9c422dc044",
"created_at": "2024-06-21T05:04:59.644899",
"updated_at": "2024-06-21T05:04:59.644899",
"chunk_html": "Get File\nGet File\n\nDownload a file based on its id.",
"metadata": { "openapi": "get /api/file/{file_id}", "title": "Get File" },
"tracking_id": "api-reference/file/get-file-Get-File-Get-File-Download-a-fi",
"time_stamp": null,
"dataset_id": "fd92b3c5-079c-4bfb-b806-3c4f49b87b31",
"weight": 0,
"location": null,
"image_urls": null,
"tag_set": "page",
"num_value": null
},
{
"id": "2b3cae45-dd75-4f4b-99bd-e570c545eeea",
"link": "api-reference/chunk/get-chunks-by-trackingids",
"qdrant_point_id": "0c73234a-d793-472b-b8e3-0525232b1544",
"created_at": "2024-06-21T05:04:57.345244",
"updated_at": "2024-06-21T05:04:57.345244",
"chunk_html": "Get Chunks By TrackingIds\nGet Chunks By TrackingIds\n\nGet multiple chunks by ids.",
"metadata": {
"openapi": "post /api/chunks/tracking",
"title": "Get Chunks By TrackingIds"
},
"tracking_id": "api-reference/chunk/get-chunks-by-trackingids-Get-Chunks-By-TrackingIds-Get-Ch",
"time_stamp": null,
"dataset_id": "fd92b3c5-079c-4bfb-b806-3c4f49b87b31",
"weight": 0,
"location": null,
"image_urls": null,
"tag_set": "page",
"num_value": null
},
{
"id": "feddb78a-24b7-4c1f-8e60-679f628c07a3",
"link": "api-reference/file/get-files-for-dataset",
"qdrant_point_id": "0ac6904d-4ca5-4067-befe-9fb4f2d274ca",
"created_at": "2024-06-21T05:04:59.751909",
"updated_at": "2024-06-21T05:04:59.751909",
"chunk_html": "\n\nREST Endpoint GET /api/dataset/files/{dataset_id}/{page}\n\nSummary: Get Files for Dataset \n\nDescription: Get Files for Dataset\n\nGet all files which belong to a given dataset specified by the dataset_id parameter. 10 files are returned per page.\n\nSecurity methods: \nheader: apiKey\n\nRequest params: \npath params:\ndataset_id:\n\tstring\n\tDescription: The id of the dataset to fetch files for.\n\tExample: \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\npage:\n\tinteger\n\tDescription: The page number of files you wish to fetch. Each page contains at most 10 files.\n\tExample: 1\n\nheader params:\nTR-Dataset:\n\tstring\n\tDescription: The dataset id to use for the request\n\tExample: \"<string>\"\n\n\nRequest body: N/A\n\n\nResponses: \n200: array\n\tDescription: N/A\n\tExample: [\"<any>\"]\n400: any\n\tDescription: N/A\n\tExample: \"<any>\"\n\n",
"metadata": {},
"tracking_id": "api-reference/file/get-files-for-dataset-API-Metadata:-get-/api/dataset/files/{dataset_id}/{page}",
"time_stamp": null,
"dataset_id": "fd92b3c5-079c-4bfb-b806-3c4f49b87b31",
"weight": 0,
"location": null,
"image_urls": null,
"tag_set": "code",
"num_value": null
},
{
"id": "b67451e2-a413-4341-936b-a574583c0b4c",
"link": "guides/recommending-with-trieve",
"qdrant_point_id": "81d6a787-beec-4cab-910f-845ce3af500d",
"created_at": "2024-06-21T05:05:00.168512",
"updated_at": "2024-06-21T05:05:00.168513",
"chunk_html": "Recommending with Trieve\nLearn how to recommend content with Trieve",
"metadata": { "title": "Recommending with Trieve" },
"tracking_id": "guides/recommending-with-trieve-Recommending-with-Trieve-Learn-h",
"time_stamp": null,
"dataset_id": "fd92b3c5-079c-4bfb-b806-3c4f49b87b31",
"weight": 0,
"location": null,
"image_urls": null,
"tag_set": "page",
"num_value": null
},
{
"id": "7edbd26f-f0ea-4f2e-aa36-24b92aba2862",
"link": "guides/recommending-with-trieve",
"qdrant_point_id": "bbc7fc2c-985b-41c1-9897-02f40f23abcc",
"created_at": "2024-06-21T05:05:00.198401",
"updated_at": "2024-06-21T05:05:00.198401",
"chunk_html": "Overview\nWe provide the ability to get recommended chunks similar to your data through the get recommended chunks route or through the get recommended groups route.",
"metadata": { "title": "Overview" },
"tracking_id": "guides/recommending-with-trieve-Overview",
"time_stamp": null,
"dataset_id": "fd92b3c5-079c-4bfb-b806-3c4f49b87b31",
"weight": 0,
"location": null,
"image_urls": null,
"tag_set": "",
"num_value": null
},
{
"id": "f846116b-a597-49a7-804a-604e689aba10",
"link": "api-reference/organization/get-organization-users",
"qdrant_point_id": "1bae0919-38b5-46b9-ad65-06e86efbd609",
"created_at": "2024-06-21T05:04:57.327521",
"updated_at": "2024-06-21T05:04:57.327521",
"chunk_html": "\n\nREST Endpoint GET /api/organization/users/{organization_id}\n\nSummary: Get Organization Users \n\nDescription: Get Organization Users\n\nFetch the users of an organization by its id. Auth'ed user or api key must have an admin or owner role for the specified dataset's organization.\n\nSecurity methods: \nheader: apiKey\n\nRequest params: \npath params:\norganization_id:\n\tstring\n\tDescription: The id of the organization you want to fetch the users of.\n\tExample: \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n\nheader params:\nTR-Organization:\n\tstring\n\tDescription: The organization id to use for the request\n\tExample: \"<string>\"\n\n\nRequest body: N/A\n\n\nResponses: \n200: array\n\tDescription: N/A\n\tExample: [\"<any>\"]\n400: any\n\tDescription: N/A\n\tExample: \"<any>\"\n\n",
"metadata": {},
"tracking_id": "api-reference/organization/get-organization-users-API-Metadata:-get-/api/organization/users/{organization_id}",
"time_stamp": null,
"dataset_id": "fd92b3c5-079c-4bfb-b806-3c4f49b87b31",
"weight": 0,
"location": null,
"image_urls": null,
"tag_set": "code",
"num_value": null
},
{
"id": "b19be22e-b851-4e8f-ac11-c4eb224365c0",
"link": "api-reference/auth/openid-connect-callback",
"qdrant_point_id": "4da9a4e7-bf69-46e1-8de5-69d95cd19c61",
"created_at": "2024-06-21T05:04:56.721754",
"updated_at": "2024-06-21T05:04:56.721755",
"chunk_html": "\n\nREST Endpoint GET /api/auth/callback\n\nSummary: OpenID Connect callback \n\nDescription: OpenID Connect callback\n\nThis is the callback route for the OAuth provider, it should not be called directly. Redirects to browser with set-cookie header.\n\nSecurity methods: \n\nRequest params: \n\nRequest body: N/A\n\n\nResponses: \n200: any\n\tDescription: N/A\n\tExample: \"<any>\"\n400: any\n\tDescription: N/A\n\tExample: \"<any>\"\n\n",
"metadata": {},
"tracking_id": "api-reference/auth/openid-connect-callback-API-Metadata:-get-/api/auth/callback",
"time_stamp": null,
"dataset_id": "fd92b3c5-079c-4bfb-b806-3c4f49b87b31",
"weight": 0,
"location": null,
"image_urls": null,
"tag_set": "code",
"num_value": null,
"group_tracking_ids": ["api-reference/auth/openid-connect-callback"]
},
{
"id": "6bfe2c99-1b14-4c3b-9749-2c56b29aa6cc",
"link": "examples/ecommerce",
"qdrant_point_id": "89744404-2b65-427e-a9a0-76e3a52f2328",
"created_at": "2024-06-21T05:04:58.268892",
"updated_at": "2024-06-21T05:04:58.268892",
"chunk_html": "Build Search for Ecommerce\nLearn how to build a job board with Trieve",
"metadata": { "title": "Build Search for Ecommerce" },
"tracking_id": "examples/ecommerce-Build-Search-for-Ecommerce-Learn",
"time_stamp": null,
"dataset_id": "fd92b3c5-079c-4bfb-b806-3c4f49b87b31",
"weight": 0,
"location": null,
"image_urls": null,
"tag_set": "page",
"num_value": null,
"group_tracking_ids": ["examples/ecommerce"]
},
{
"id": "9cfba77e-a867-4bb5-8bbd-a71557a6ebb3",
"link": "api-reference/chunk_group/create-chunk-group",
"qdrant_point_id": "515a9a04-488b-42a0-ac8f-6d28b6a15fb1",
"created_at": "2024-06-21T05:04:57.902844",
"updated_at": "2024-06-21T05:04:57.902844",
"chunk_html": "Create Chunk Group\nCreate Chunk Group\n\nCreate a new chunk_group. This is a way to group chunks together. If you try to create a chunk_group with the same tracking_id as an existing chunk_group, this operation will fail. Auth'ed user or api key must have an admin or owner role for the specified dataset's organization.",
"metadata": {
"openapi": "post /api/chunk_group",
"title": "Create Chunk Group"
},
"tracking_id": "api-reference/chunk_group/create-chunk-group-Create-Chunk-Group-Create-Chunk-",
"time_stamp": null,
"dataset_id": "fd92b3c5-079c-4bfb-b806-3c4f49b87b31",
"weight": 0,
"location": null,
"image_urls": null,
"tag_set": "page",
"num_value": null,
"group_tracking_ids": ["api-reference/chunk_group/create-chunk-group"]
},
{
"id": "faa4b5cf-d606-4ac2-ab64-f318b96d5c40",
"link": "api-reference/topic/get-all-topics-for-owner-id",
"qdrant_point_id": "7478da33-91dc-4c0d-b59e-8163a075158b",
"created_at": "2024-06-21T05:04:57.903229",
"updated_at": "2024-06-21T05:04:57.903229",
"chunk_html": "Get All Topics for Owner ID\nGet All Topics for Owner ID\n\nGet all topics belonging to an arbitary owner_id. This is useful for managing message history and chat sessions. It is common to use a browser fingerprint or your user's id as the owner_id. Auth'ed user or api key must have an admin or owner role for the specified dataset's organization.",
"metadata": {
"openapi": "get /api/topic/owner/{owner_id}",
"title": "Get All Topics for Owner ID"
},
"tracking_id": "api-reference/topic/get-all-topics-for-owner-id-Get-All-Topics-for-Owner-ID-Get-",
"time_stamp": null,
"dataset_id": "fd92b3c5-079c-4bfb-b806-3c4f49b87b31",
"weight": 0,
"location": null,
"image_urls": null,
"tag_set": "page",
"num_value": null,
"group_tracking_ids": ["api-reference/topic/get-all-topics-for-owner-id"]
},
{
"id": "8ab4ac6a-792b-4124-b1ed-7e84d527956f",
"link": "api-reference/chunk/delete-chunk-by-tracking-id",
"qdrant_point_id": "d1b57a9b-97ef-4fea-aede-2d4cd23170fa",
"created_at": "2024-06-21T05:04:56.904385",
"updated_at": "2024-06-21T05:04:56.904386",
"chunk_html": "Delete Chunk By Tracking Id\nDelete Chunk By Tracking Id\n\nDelete a chunk by tracking_id. This is useful for when you are coordinating with an external system and want to use the tracking_id to identify the chunk. If deleting a root chunk which has a collision, the most recently created collision will become a new root chunk. Auth'ed user or api key must have an admin or owner role for the specified dataset's organization.",
"metadata": {
"openapi": "delete /api/chunk/tracking_id/{tracking_id}",
"title": "Delete Chunk By Tracking Id"
},
"tracking_id": "api-reference/chunk/delete-chunk-by-tracking-id-Delete-Chunk-By-Tracking-Id-Dele",
"time_stamp": null,
"dataset_id": "fd92b3c5-079c-4bfb-b806-3c4f49b87b31",
"weight": 0,
"location": null,
"image_urls": null,
"tag_set": "page",
"num_value": null,
"group_tracking_ids": ["api-reference/chunk/delete-chunk-by-tracking-id"]
},
{
"id": "9959b27e-64e3-4eab-8e9b-553045fd267d",
"link": "api-reference/user/set-user-api-key",
"qdrant_point_id": "c467048d-f369-4588-8f46-59b2a058b88e",
"created_at": "2024-06-21T05:04:58.125469",
"updated_at": "2024-06-21T05:04:58.125469",
"chunk_html": "Set User Api Key\nSet User Api Key\n\nCreate a new api key for the auth'ed user. Successful response will contain the newly created api key. If a write role is assigned the api key will have permission level of the auth'ed user who calls this endpoint.",
"metadata": {
"openapi": "post /api/user/api_key",
"title": "Set User Api Key"
},
"tracking_id": "api-reference/user/set-user-api-key-Set-User-Api-Key-Set-User-Api-Ke",
"time_stamp": null,
"dataset_id": "fd92b3c5-079c-4bfb-b806-3c4f49b87b31",
"weight": 0,
"location": null,
"image_urls": null,
"tag_set": "page",
"num_value": null,
"group_tracking_ids": ["api-reference/user/set-user-api-key"]
},
{
"id": "6260d519-a676-4cbd-a532-3e9626dd3b8a",
"link": "api-reference/dataset/update-dataset",
"qdrant_point_id": "e97991c0-a494-45fa-aa94-53d522ad2568",
"created_at": "2024-06-21T05:04:59.462411",
"updated_at": "2024-06-21T05:04:59.462412",
"chunk_html": "\n\nREST Endpoint PUT /api/dataset\n\nSummary: Update Dataset \n\nDescription: Update Dataset\n\nUpdate a dataset. The auth'ed user must be an owner of the organization to update a dataset.\n\nSecurity methods: \nheader: apiKey\n\nRequest params: \nheader params:\nTR-Organization:\n\tstring\n\tDescription: The organization id to use for the request\n\tExample: \"<string>\"\n\n\nRequest body: any\n\tDescription: N/A\n\tExample: \"<any>\"\n\n\nResponses: \n200: any\n\tDescription: N/A\n\tExample: \"<any>\"\n400: any\n\tDescription: N/A\n\tExample: \"<any>\"\n404: any\n\tDescription: N/A\n\tExample: \"<any>\"\n\n",
"metadata": {},
"tracking_id": "api-reference/dataset/update-dataset-API-Metadata:-put-/api/dataset",
"time_stamp": null,
"dataset_id": "fd92b3c5-079c-4bfb-b806-3c4f49b87b31",
"weight": 0,
"location": null,
"image_urls": null,
"tag_set": "code",
"num_value": null,
"group_tracking_ids": ["api-reference/dataset/update-dataset"]
},
{
"id": "5fc0e4c1-609a-44d8-b302-8a796248f8ad",
"link": "api-reference/file/delete-file",
"qdrant_point_id": "8cea1c34-997c-4ab5-a8b9-618eb2db4684",
"created_at": "2024-06-21T05:04:59.563822",
"updated_at": "2024-06-21T05:04:59.563822",
"chunk_html": "Delete File\nDelete File\n\nDelete a file from S3 attached to the server based on its id. This will disassociate chunks from the file, but only delete them all together if you specify delete_chunks to be true. Auth'ed user or api key must have an admin or owner role for the specified dataset's organization.",
"metadata": {
"openapi": "delete /api/file/{file_id}",
"title": "Delete File"
},
"tracking_id": "api-reference/file/delete-file-Delete-File-Delete-File-Delete-",
"time_stamp": null,
"dataset_id": "fd92b3c5-079c-4bfb-b806-3c4f49b87b31",
"weight": 0,
"location": null,
"image_urls": null,
"tag_set": "page",
"num_value": null,
"group_tracking_ids": ["api-reference/file/delete-file"]
},
{
"id": "ce9fac63-4356-40d6-b6a6-be100ac57f13",
"link": "examples/ecommerce",
"qdrant_point_id": "d657f4b9-7afb-42c6-8ce1-bda308797da6",
"created_at": "2024-06-21T05:04:58.562956",
"updated_at": "2024-06-21T05:04:58.649948",
"chunk_html": "Running the ingest script\nTo run the ingest script you first need to add or modify a .env file with Then run the ingest script A breakdown of the script is below",
"metadata": { "title": "Running the ingest script" },
"tracking_id": "examples/ecommerce-Running-the-ingest-script",
"time_stamp": null,
"dataset_id": "fd92b3c5-079c-4bfb-b806-3c4f49b87b31",
"weight": 0,
"location": null,
"image_urls": null,
"tag_set": "",
"num_value": null,
"group_tracking_ids": ["examples/ecommerce"]
},
{
"id": "1fbd3d57-4fa2-4a0a-8213-0ffda952a728",
"link": "guides/create-chunk",
"qdrant_point_id": "f9c20dde-e9e9-4077-8f49-951eef223bf0",
"created_at": "2024-06-21T05:04:59.885019",
"updated_at": "2024-06-21T05:04:59.885019",
"chunk_html": "Uploading Chunks to Trieve\nLearn how to upload your chunks to Trieve",
"metadata": { "title": "Uploading Chunks to Trieve" },
"tracking_id": "guides/create-chunk-Uploading-Chunks-to-Trieve-Learn",
"time_stamp": null,
"dataset_id": "fd92b3c5-079c-4bfb-b806-3c4f49b87b31",
"weight": 0,
"location": null,
"image_urls": null,
"tag_set": "page",
"num_value": null,
"group_tracking_ids": ["guides/create-chunk"]
},
{
"id": "dcdab5e4-96bd-48cc-bc5b-17527a99067f",
"link": "api-reference/chunk/create-or-upsert-chunk-or-chunks",
"qdrant_point_id": "cb140a44-bd5a-489a-80c8-6f0e6ca953db",
"created_at": "2024-06-21T05:04:56.862863",
"updated_at": "2024-06-21T05:04:56.862863",
"chunk_html": "\n\nREST Endpoint POST /api/chunk\n\nSummary: Create or Upsert Chunk or Chunks \n\nDescription: Create or Upsert Chunk or Chunks\n\nCreate a new chunk. If the chunk has the same tracking_id as an existing chunk, the request will fail. Once a chunk is created, it can be searched for using the search endpoint.\nIf uploading in bulk, the maximum amount of chunks that can be uploaded at once is 120 chunks. Auth'ed user or api key must have an admin or owner role for the specified dataset's organization.\n\nSecurity methods: \nheader: apiKey\n\nRequest params: \nheader params:\nTR-Dataset:\n\tstring\n\tDescription: The dataset id to use for the request\n\tExample: \"<string>\"\n\n\nRequest body: any\n\tDescription: N/A\n\tExample: \"<any>\"\n\n\nResponses: \n200: any\n\tDescription: N/A\n\tExample: \"<any>\"\n400: any\n\tDescription: N/A\n\tExample: \"<any>\"\n426: any\n\tDescription: N/A\n\tExample: \"<any>\"\n\n",
"metadata": {},
"tracking_id": "api-reference/chunk/create-or-upsert-chunk-or-chunks-API-Metadata:-post-/api/chunk",
"time_stamp": null,
"dataset_id": "fd92b3c5-079c-4bfb-b806-3c4f49b87b31",
"weight": 0,
"location": null,
"image_urls": null,
"tag_set": "code",
"num_value": null,
"group_tracking_ids": [
"api-reference/chunk/create-or-upsert-chunk-or-chunks"
]
},
{
"id": "54a145f4-4cee-4c95-8b3d-7506ca42f62a",
"link": "api-reference/dataset/create-dataset",
"qdrant_point_id": "fc38eab6-c7ce-42fe-a4c0-2062cec1e501",
"created_at": "2024-06-21T05:04:59.025099",
"updated_at": "2024-06-21T05:04:59.025100",
"chunk_html": "Create dataset\nCreate dataset\n\nCreate a new dataset. The auth'ed user must be an owner of the organization to create a dataset.",
"metadata": { "openapi": "post /api/dataset", "title": "Create dataset" },
"tracking_id": "api-reference/dataset/create-dataset-Create-dataset-Create-dataset-C",
"time_stamp": null,
"dataset_id": "fd92b3c5-079c-4bfb-b806-3c4f49b87b31",
"weight": 0,
"location": null,
"image_urls": null,
"tag_set": "page",
"num_value": null
},
{
"id": "911ddc59-1658-41c8-ade9-7aa67005a4ac",
"link": "api-reference/chunk_group/add-chunk-to-group-by-tracking-id",
"qdrant_point_id": "bde36270-6faa-48b8-9b3e-8192983cf244",
"created_at": "2024-06-21T05:04:57.794858",
"updated_at": "2024-06-21T05:04:57.794858",
"chunk_html": "\n(deprecated) \nREST Endpoint POST /api/chunk_group/tracking_id/{tracking_id}\n\nSummary: Add Chunk to Group by Tracking ID \n\nDescription: Add Chunk to Group by Tracking ID\n\nRoute to add a chunk to a group by tracking id. Auth'ed user or api key must have an admin or owner role for the specified dataset's organization.\n\nSecurity methods: \nheader: apiKey\n\nRequest params: \npath params:\ntracking_id:\n\tstring\n\tDescription: Id of the group to add the chunk to as a bookmark\n\tExample: \"<string>\"\n\nheader params:\nTR-Dataset:\n\tstring\n\tDescription: The dataset id to use for the request\n\tExample: \"<string>\"\n\n\nRequest body: any\n\tDescription: N/A\n\tExample: \"<any>\"\n\n\nResponses: \n204: N/A\n400: any\n\tDescription: N/A\n\tExample: \"<any>\"\n\n",
"metadata": {},
"tracking_id": "api-reference/chunk_group/add-chunk-to-group-by-tracking-id-API-Metadata:-post-/api/chunk_group/tracking_id/{tracking_id}",
"time_stamp": null,
"dataset_id": "fd92b3c5-079c-4bfb-b806-3c4f49b87b31",
"weight": 0,
"location": null,
"image_urls": null,
"tag_set": "code",
"num_value": null
},
{
"id": "45d969d9-cd28-49af-86de-28f30684892d",
"link": "api-reference/topic/create-topic",
"qdrant_point_id": "2de9e224-7945-48c4-9d30-f0f50620a0ad",
"created_at": "2024-06-21T05:04:57.765068",
"updated_at": "2024-06-21T05:04:57.765068",
"chunk_html": "Create Topic\nCreate Topic\n\nCreate a new chat topic. Topics are attached to a owner_id's and act as a coordinator for conversation message history of gen-AI chat sessions. Auth'ed user or api key must have an admin or owner role for the specified dataset's organization.",
"metadata": { "openapi": "post /api/topic", "title": "Create Topic" },
"tracking_id": "api-reference/topic/create-topic-Create-Topic-Create-Topic-Creat",
"time_stamp": null,
"dataset_id": "fd92b3c5-079c-4bfb-b806-3c4f49b87b31",
"weight": 0,
"location": null,
"image_urls": null,
"tag_set": "page",
"num_value": null
},
{
"id": "89e3344f-81c8-4fd2-bddd-419bc024b75c",
"link": "api-reference/invitation/send-invitation",
"qdrant_point_id": "e6f12170-72c5-4bc9-b4ba-15a6cf625144",
"created_at": "2024-06-21T05:04:59.955541",
"updated_at": "2024-06-21T05:04:59.955542",
"chunk_html": "\n\nREST Endpoint POST /api/invitation\n\nSummary: Send Invitation \n\nDescription: Send Invitation\n\nInvitations act as a way to invite users to join an organization. After a user is invited, they will automatically be added to the organization with the role specified in the invitation once they set their. Auth'ed user or api key must have an admin or owner role for the specified dataset's organization.\n\nSecurity methods: \nheader: apiKey\n\nRequest params: \nheader params:\nTR-Organization:\n\tstring\n\tDescription: The organization id to use for the request\n\tExample: \"<string>\"\n\n\nRequest body: any\n\tDescription: N/A\n\tExample: \"<any>\"\n\n\nResponses: \n204: N/A\n400: any\n\tDescription: N/A\n\tExample: \"<any>\"\n\n",
"metadata": {},
"tracking_id": "api-reference/invitation/send-invitation-API-Metadata:-post-/api/invitation",
"time_stamp": null,
"dataset_id": "fd92b3c5-079c-4bfb-b806-3c4f49b87b31",
"weight": 0,
"location": null,
"image_urls": null,
"tag_set": "code",
"num_value": null
},
{
"id": "0b2efbe3-c9c7-4cd8-9a36-021988be8534",
"link": "api-reference/user/set-user-api-key",
"qdrant_point_id": "e2df856b-3e06-4bea-badd-a7d0296c9f87",
"created_at": "2024-06-21T05:04:58.155699",
"updated_at": "2024-06-21T05:04:58.155699",
"chunk_html": "\n\nREST Endpoint POST /api/user/api_key\n\nSummary: Set User Api Key \n\nDescription: Set User Api Key\n\nCreate a new api key for the auth'ed user. Successful response will contain the newly created api key. If a write role is assigned the api key will have permission level of the auth'ed user who calls this endpoint.\n\nSecurity methods: \nheader: apiKey\n\nRequest params: \n\nRequest body: any\n\tDescription: N/A\n\tExample: \"<any>\"\n\n\nResponses: \n200: any\n\tDescription: N/A\n\tExample: \"<any>\"\n400: any\n\tDescription: N/A\n\tExample: \"<any>\"\n\n",
"metadata": {},
"tracking_id": "api-reference/user/set-user-api-key-API-Metadata:-post-/api/user/api_key",
"time_stamp": null,
"dataset_id": "fd92b3c5-079c-4bfb-b806-3c4f49b87b31",
"weight": 0,
"location": null,
"image_urls": null,
"tag_set": "code",
"num_value": null
},
{
"id": "a8143435-d936-48cf-8a1c-01c3631dc29b",
"link": "examples/job-board",
"qdrant_point_id": "24d76457-1af7-483e-b938-a0cfe176743e",
"created_at": "2024-06-21T05:04:59.124673",
"updated_at": "2024-06-21T05:04:59.346114",
"chunk_html": "Steps to Set Up the Demo\nClone the repository: Install the required dependencies: This demo uses Bun as a runtime. Install Bun by running: Install the dependencies by running: Create an account on Trieve: Go to Trieve Dashboard and create an account. Create a new dataset and copy the dataset ID. You can either create a dataset on the Trieve Dashboard or use our CLI Create a new API key and copy the API key. Create an .env file in the root of the project and add the following environment variables: Download the dataset Run the demo: View the results Head over to https://search.trieve.ai and select your dataset. Try out a few sample queries like software engineer at google or show me some listings knowing I have experience as a mechanic",
"metadata": { "title": "Steps to Set Up the Demo" },
"tracking_id": "examples/job-board-Steps-to-Set-Up-the-Demo",
"time_stamp": null,
"dataset_id": "fd92b3c5-079c-4bfb-b806-3c4f49b87b31",
"weight": 0,
"location": null,
"image_urls": null,
"tag_set": "",
"num_value": null
},
{
"id": "28a841a4-bc66-490b-aad4-5dd5c1cf0ce4",
"link": "api-reference/events/get-events-for-the-dataset",
"qdrant_point_id": "3a13f25c-e77f-4664-9697-39b2a54fb115",
"created_at": "2024-06-21T05:04:59.532210",
"updated_at": "2024-06-21T05:04:59.532210",
"chunk_html": "\n\nREST Endpoint POST /api/events\n\nSummary: Get events for the dataset \n\nDescription: Get events for the dataset\n\nGet events for the dataset specified by the TR-Dataset header.\n\nSecurity methods: \nheader: apiKey\n\nRequest params: \nheader params:\nTR-Dataset:\n\tstring\n\tDescription: The dataset id to use for the request\n\tExample: \"<string>\"\n\n\nRequest body: any\n\tDescription: N/A\n\tExample: \"<any>\"\n\n\nResponses: \n200: any\n\tDescription: N/A\n\tExample: \"<any>\"\n400: any\n\tDescription: N/A\n\tExample: \"<any>\"\n\n",
"metadata": {},
"tracking_id": "api-reference/events/get-events-for-the-dataset-API-Metadata:-post-/api/events",
"time_stamp": null,
"dataset_id": "fd92b3c5-079c-4bfb-b806-3c4f49b87b31",
"weight": 0,
"location": null,
"image_urls": null,
"tag_set": "code",
"num_value": null
},
{
"id": "296e144a-389c-4371-a9ad-a7f661ff4d47",
"link": "api-reference/file/delete-file",
"qdrant_point_id": "f6d8d43c-2e97-4e49-9547-b0946c2ec685",
"created_at": "2024-06-21T05:04:59.596334",
"updated_at": "2024-06-21T05:04:59.596335",
"chunk_html": "\n\nREST Endpoint DELETE /api/file/{file_id}\n\nSummary: Delete File \n\nDescription: Delete File\n\nDelete a file from S3 attached to the server based on its id. This will disassociate chunks from the file, but only delete them all together if you specify delete_chunks to be true. Auth'ed user or api key must have an admin or owner role for the specified dataset's organization.\n\nSecurity methods: \nheader: apiKey\n\nRequest params: \npath params:\nfile_id:\n\tstring\n\tDescription: The id of the file to delete\n\tExample: \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n\nheader params:\nTR-Dataset:\n\tstring\n\tDescription: The dataset id to use for the request\n\tExample: \"<string>\"\n\n\nRequest body: N/A\n\n\nResponses: \n204: N/A\n400: any\n\tDescription: N/A\n\tExample: \"<any>\"\n\n",
"metadata": {},
"tracking_id": "api-reference/file/delete-file-API-Metadata:-delete-/api/file/{file_id}",
"time_stamp": null,
"dataset_id": "fd92b3c5-079c-4bfb-b806-3c4f49b87b31",
"weight": 0,
"location": null,
"image_urls": null,
"tag_set": "code",
"num_value": null
},
{
"id": "fa7da060-c6ae-4bdf-ab6c-c1e0ebfd244e",
"link": "api-reference/chunk_group/delete-group",
"qdrant_point_id": "8a2456ad-7fa1-446d-9eee-f1e4d585a1cb",
"created_at": "2024-06-21T05:04:58.081688",
"updated_at": "2024-06-21T05:04:58.081688",
"chunk_html": "\n\nREST Endpoint DELETE /api/chunk_group/{group_id}\n\nSummary: Delete Group \n\nDescription: Delete Group\n\nThis will delete a chunk_group. If you set delete_chunks to true, it will also delete the chunks within the group. Auth'ed user or api key must have an admin or owner role for the specified dataset's organization.\n\nSecurity methods: \nheader: apiKey\n\nRequest params: \npath params:\ngroup_id:\n\tstring\n\tDescription: Id of the group you want to fetch.\n\tExample: \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n\nquery params:\ndelete_chunks:\n\tboolean\n\tDescription: Delete the chunks within the group\n\tExample: true\n\nheader params:\nTR-Dataset:\n\tstring\n\tDescription: The dataset id to use for the request\n\tExample: \"<string>\"\n\n\nRequest body: N/A\n\n\nResponses: \n204: N/A\n400: any\n\tDescription: N/A\n\tExample: \"<any>\"\n\n",
"metadata": {},
"tracking_id": "api-reference/chunk_group/delete-group-API-Metadata:-delete-/api/chunk_group/{group_id}",
"time_stamp": null,
"dataset_id": "fd92b3c5-079c-4bfb-b806-3c4f49b87b31",
"weight": 0,
"location": null,
"image_urls": null,
"tag_set": "code",
"num_value": null
},
{
"id": "a23e9d5f-2845-46ab-961a-53efaef14a32",
"link": "api-reference/chunk/get-chunks-by-ids",
"qdrant_point_id": "920922be-2a28-436e-9337-40cb6103670c",
"created_at": "2024-06-21T05:04:57.272258",
"updated_at": "2024-06-21T05:04:57.272258",
"chunk_html": "Get Chunks By Ids\nGet Chunks By Ids\n\nGet multiple chunks by multiple ids.",
"metadata": { "openapi": "post /api/chunks", "title": "Get Chunks By Ids" },
"tracking_id": "api-reference/chunk/get-chunks-by-ids-Get-Chunks-By-Ids-Get-Chunks-By-",
"time_stamp": null,
"dataset_id": "fd92b3c5-079c-4bfb-b806-3c4f49b87b31",
"weight": 0,
"location": null,
"image_urls": null,
"tag_set": "page",
"num_value": null
},
{
"id": "df2facba-0b52-45b6-8c73-425be53dfa9b",
"link": "api-reference/user/delete-user-api-key",
"qdrant_point_id": "7bc5a624-ecce-46eb-9206-53bcebd23e05",
"created_at": "2024-06-21T05:04:58.084769",
"updated_at": "2024-06-21T05:04:58.084770",
"chunk_html": "\n\nREST Endpoint DELETE /api/user/api_key/{api_key_id}\n\nSummary: Delete User Api Key \n\nDescription: Delete User Api Key\n\nDelete an api key for the auth'ed user.\n\nSecurity methods: \nheader: apiKey\n\nRequest params: \npath params:\napi_key_id:\n\tstring\n\tDescription: The id of the api key to delete\n\tExample: \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n\n\nRequest body: N/A\n\n\nResponses: \n204: N/A\n400: any\n\tDescription: N/A\n\tExample: \"<any>\"\n\n",
"metadata": {},
"tracking_id": "api-reference/user/delete-user-api-key-API-Metadata:-delete-/api/user/api_key/{api_key_id}",
"time_stamp": null,
"dataset_id": "fd92b3c5-079c-4bfb-b806-3c4f49b87b31",
"weight": 0,
"location": null,
"image_urls": null,
"tag_set": "code",
"num_value": null,
"group_tracking_ids": ["api-reference/user/delete-user-api-key"]
},
{
"id": "f7fb2d7a-3336-4a3d-a797-73be199a79ce",
"link": "api-reference/chunk_group/get-groups-for-dataset",
"qdrant_point_id": "d3040726-7171-413b-a6c7-d3f80dc0091c",
"created_at": "2024-06-21T05:04:58.477644",
"updated_at": "2024-06-21T05:04:58.477645",
"chunk_html": "Get Groups for Dataset\nGet Groups for Dataset\n\nFetch the groups which belong to a dataset specified by its id.",
"metadata": {
"openapi": "get /api/dataset/groups/{dataset_id}/{page}",
"title": "Get Groups for Dataset"
},
"tracking_id": "api-reference/chunk_group/get-groups-for-dataset-Get-Groups-for-Dataset-Get-Group",
"time_stamp": null,
"dataset_id": "fd92b3c5-079c-4bfb-b806-3c4f49b87b31",
"weight": 0,
"location": null,
"image_urls": null,
"tag_set": "page",
"num_value": null,
"group_tracking_ids": ["api-reference/chunk_group/get-groups-for-dataset"]
},
{
"id": "c40422aa-d6d6-4387-bba4-ae1ccd059a0b",
"link": "guides/searching-with-trieve",
"qdrant_point_id": "3fadf739-3a79-4508-9e0d-6e903f04b974",
"created_at": "2024-06-21T05:05:00.375747",
"updated_at": "2024-06-21T05:05:00.375747",
"chunk_html": "Overview\nWe provide the ability for you to search your data in a fast and performant manner. We have multiple search paradigms, which are exposed through the search over chunks route , the search within groups route , and the search over groups route.",
"metadata": { "title": "Overview" },
"tracking_id": "guides/searching-with-trieve-Overview",
"time_stamp": null,
"dataset_id": "fd92b3c5-079c-4bfb-b806-3c4f49b87b31",
"weight": 0,
"location": null,
"image_urls": null,
"tag_set": "",
"num_value": null,
"group_tracking_ids": ["guides/searching-with-trieve"]
},
{
"id": "35e9c8a3-c6fd-47c3-bdfc-e7b180d4c4d4",
"link": "api-reference/stripe/cancel-subscription",
"qdrant_point_id": "932d47f5-fbb0-4078-bcbf-5db468b91073",
"created_at": "2024-06-21T05:04:57.521734",
"updated_at": "2024-06-21T05:04:57.521734",
"chunk_html": "\n\nREST Endpoint DELETE /api/stripe/subscription/{subscription_id}\n\nSummary: Cancel Subscription \n\nDescription: Cancel Subscription\n\nCancel a subscription by its id\n\nSecurity methods: \nheader: apiKey\n\nRequest params: \npath params:\nsubscription_id:\n\tstring\n\tDescription: id of the subscription you want to cancel\n\tExample: \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n\nheader params:\nTR-Organization:\n\tstring\n\tDescription: The organization id to use for the request\n\tExample: \"<string>\"\n\n\nRequest body: N/A\n\n\nResponses: \n200: N/A\n400: any\n\tDescription: N/A\n\tExample: \"<any>\"\n\n",
"metadata": {},
"tracking_id": "api-reference/stripe/cancel-subscription-API-Metadata:-delete-/api/stripe/subscription/{subscription_id}",
"time_stamp": null,
"dataset_id": "fd92b3c5-079c-4bfb-b806-3c4f49b87b31",
"weight": 0,
"location": null,
"image_urls": null,
"tag_set": "code",
"num_value": null,
"group_tracking_ids": ["api-reference/stripe/cancel-subscription"]
},
{
"id": "7f4261a5-5647-463c-8ad1-ab743e5e129d",
"link": "api-reference/chunk_group/update-group-by-tracking-id",
"qdrant_point_id": "7384d669-e0de-4236-95c3-a566e6523e39",
"created_at": "2024-06-21T05:04:58.863218",
"updated_at": "2024-06-21T05:04:58.863219",
"chunk_html": "Update Group by Tracking ID\nUpdate Group by Tracking ID\n\nUpdate a chunk_group with the given tracking id. Auth'ed user or api key must have an admin or owner role for the specified dataset's organization.",
"metadata": {
"openapi": "put /api/chunk_group/tracking_id/{tracking_id}",
"title": "Update Group by Tracking ID"
},
"tracking_id": "api-reference/chunk_group/update-group-by-tracking-id-Update-Group-by-Tracking-ID-Upda",
"time_stamp": null,
"dataset_id": "fd92b3c5-079c-4bfb-b806-3c4f49b87b31",
"weight": 0,
"location": null,
"image_urls": null,
"tag_set": "page",
"num_value": null,
"group_tracking_ids": [
"api-reference/chunk_group/update-group-by-tracking-id"
]
},
{
"id": "8eea1abf-5701-4afd-953e-3f4e9118ffb5",
"link": "api-reference/chunk_group/search-over-groups",
"qdrant_point_id": "ab6bc36f-4609-42f1-95e2-85343638964e",
"created_at": "2024-06-21T05:04:58.704259",
"updated_at": "2024-06-21T05:04:58.704260",
"chunk_html": "Search Over Groups\nSearch Over Groups\n\nThis route allows you to get groups as results instead of chunks. Each group returned will have the matching chunks sorted by similarity within the group. This is useful for when you want to get groups of chunks which are similar to the search query. If choosing hybrid search, the results will be re-ranked using BAAI/bge-reranker-large. Compatible with semantic, fulltext, or hybrid search modes.",
"metadata": {
"openapi": "post /api/chunk_group/group_oriented_search",
"title": "Search Over Groups"
},
"tracking_id": "api-reference/chunk_group/search-over-groups-Search-Over-Groups-Search-Over-G",
"time_stamp": null,
"dataset_id": "fd92b3c5-079c-4bfb-b806-3c4f49b87b31",
"weight": 0,
"location": null,
"image_urls": null,
"tag_set": "page",
"num_value": null,
"group_tracking_ids": ["api-reference/chunk_group/search-over-groups"]
},
{
"id": "d0e6b116-d7b0-4062-892a-ec7b8182f308",
"link": "api-reference/dataset/delete-dataset",
"qdrant_point_id": "73e0641f-7129-48fa-a76e-786fc73dbd8b",
"created_at": "2024-06-21T05:04:59.188402",
"updated_at": "2024-06-21T05:04:59.188402",
"chunk_html": "\n\nREST Endpoint DELETE /api/dataset/{dataset_id}\n\nSummary: Delete Dataset \n\nDescription: Delete Dataset\n\nDelete a dataset. The auth'ed user must be an owner of the organization to delete a dataset.\n\nSecurity methods: \nheader: apiKey\n\nRequest params: \npath params:\ndataset_id:\n\tstring\n\tDescription: The id of the dataset you want to delete.\n\tExample: \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n\nheader params:\nTR-Dataset:\n\tstring\n\tDescription: The dataset id to use for the request\n\tExample: \"<string>\"\n\n\nRequest body: N/A\n\n\nResponses: \n204: N/A\n400: any\n\tDescription: N/A\n\tExample: \"<any>\"\n404: any\n\tDescription: N/A\n\tExample: \"<any>\"\n\n",
"metadata": {},
"tracking_id": "api-reference/dataset/delete-dataset-API-Metadata:-delete-/api/dataset/{dataset_id}",
"time_stamp": null,
"dataset_id": "fd92b3c5-079c-4bfb-b806-3c4f49b87b31",
"weight": 0,
"location": null,
"image_urls": null,
"tag_set": "code",
"num_value": null,
"group_tracking_ids": ["api-reference/dataset/delete-dataset"]
},
{
"id": "82d80694-11aa-4c72-b449-0a0e5b92c3bb",
"link": "api-reference/chunk_group/update-group",
"qdrant_point_id": "fd69907b-0db0-4dd6-a769-1f6f1d6ae928",
"created_at": "2024-06-21T05:04:58.979303",
"updated_at": "2024-06-21T05:04:58.979304",
"chunk_html": "\n\nREST Endpoint PUT /api/chunk_group\n\nSummary: Update Group \n\nDescription: Update Group\n\nUpdate a chunk_group. If you try to change the tracking_id to one that already exists, this operation will fail. Auth'ed user or api key must have an admin or owner role for the specified dataset's organization.\n\nSecurity methods: \nheader: apiKey\n\nRequest params: \nheader params:\nTR-Dataset:\n\tstring\n\tDescription: The dataset id to use for the request\n\tExample: \"<string>\"\n\n\nRequest body: any\n\tDescription: N/A\n\tExample: \"<any>\"\n\n\nResponses: \n204: N/A\n400: any\n\tDescription: N/A\n\tExample: \"<any>\"\n\n",
"metadata": {},
"tracking_id": "api-reference/chunk_group/update-group-API-Metadata:-put-/api/chunk_group",
"time_stamp": null,
"dataset_id": "fd92b3c5-079c-4bfb-b806-3c4f49b87b31",
"weight": 0,
"location": null,
"image_urls": null,
"tag_set": "code",
"num_value": null,
"group_tracking_ids": ["api-reference/chunk_group/update-group"]
},
{
"id": "1b3e30b8-dc4b-467b-a2b4-ad5d249beabc",
"link": "guides/create-chunk",
"qdrant_point_id": "e98df142-d222-4156-94ea-7371bb192c67",
"created_at": "2024-06-21T05:04:59.983973",
"updated_at": "2024-06-21T05:04:59.983973",
"chunk_html": "Important Parameters\nchunk_html : This is the content that will be embedded and made searchable. You can pass HTML here, and our service will automatically clean it for the embeddings. chunk_vector : This allows you to provide your own pre-calculated embeddings. Use this if you have already calculated embeddings for your dataset and want to migrate them to Trieve. group_ids and group_tracking_ids : These fields let you specify a group to associate the chunks with, useful for linking multiple chunks from one document. link , location , tag_set , and time_stamp : These fields are indexed to enable fast filtering of chunks based on these attributes. metadata : This field allows you to include any arbitrary metadata in the form of a JSON object with the chunk. For the best filtering performance, we recommend using the link , location , tag_set , and time_stamp rather than the metadata field as there are dedicated indexes for these. The metadata has an index built on it, but it is only optimized for match queries tracking_id : This field allows you to assign an arbitrary ID to the chunk, aiding in coordination with your database system. You can search for chunks using this ID. weight : This field allows you to assign a weight to the chunks, which can influence the chunk's ranking within search results. This is similar to merchandising features on other platforms.",
"metadata": { "title": "Important Parameters" },
"tracking_id": "guides/create-chunk-Important-Parameters",
"time_stamp": null,
"dataset_id": "fd92b3c5-079c-4bfb-b806-3c4f49b87b31",
"weight": 0,
"location": null,
"image_urls": null,
"tag_set": "",
"num_value": null,
"group_tracking_ids": ["guides/create-chunk"]
},
{
"id": "830ba3bd-d447-4665-8a2d-96071ae15b37",
"link": "api-reference/chunk/delete-chunk",
"qdrant_point_id": "c9fcee6c-1901-44df-a643-eff658ab6001",
"created_at": "2024-06-21T05:04:57.025057",
"updated_at": "2024-06-21T05:04:57.025057",
"chunk_html": "\n\nREST Endpoint DELETE /api/chunk/{chunk_id}\n\nSummary: Delete Chunk \n\nDescription: Delete Chunk\n\nDelete a chunk by its id. If deleting a root chunk which has a collision, the most recently created collision will become a new root chunk. Auth'ed user or api key must have an admin or owner role for the specified dataset's organization.\n\nSecurity methods: \nheader: apiKey\n\nRequest params: \npath params:\nchunk_id:\n\tstring\n\tDescription: Id of the chunk you want to fetch.\n\tExample: \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n\nheader params:\nTR-Dataset:\n\tstring\n\tDescription: The dataset id to use for the request\n\tExample: \"<string>\"\n\n\nRequest body: N/A\n\n\nResponses: \n204: N/A\n400: any\n\tDescription: N/A\n\tExample: \"<any>\"\n\n",
"metadata": {},
"tracking_id": "api-reference/chunk/delete-chunk-API-Metadata:-delete-/api/chunk/{chunk_id}",
"time_stamp": null,
"dataset_id": "fd92b3c5-079c-4bfb-b806-3c4f49b87b31",
"weight": 0,
"location": null,
"image_urls": null,
"tag_set": "code",
"num_value": null,
"group_tracking_ids": ["api-reference/chunk/delete-chunk"]
},
{
"id": "ce3e4af2-58b5-45a8-9f93-e044aff55cb7",
"link": "introduction",
"qdrant_point_id": "319443e8-d8ad-4c62-be59-9691b6cfd27d",
"created_at": "2024-06-21T05:05:00.597034",
"updated_at": "2024-06-21T05:05:00.597035",
"chunk_html": "Things still unclear? Check out our live demos or REST OpenAPI docs\nWe have deployed Trieve for production datasets of YCombinator companies. YCombinator companies search",
"metadata": {
"title": "Things still unclear? Check out our live demos or REST OpenAPI docs"
},
"tracking_id": "introduction-Things-still-unclear?-Check-out-our-live-demos-or-REST-OpenAPI-docs",
"time_stamp": null,
"dataset_id": "fd92b3c5-079c-4bfb-b806-3c4f49b87b31",
"weight": 0,
"location": null,
"image_urls": null,
"tag_set": "",
"num_value": null,
"group_tracking_ids": ["introduction"]
},
{
"id": "ee580d7b-437f-47f7-8d5d-6a1b88e2d177",
"link": "api-reference/message/edit-a-message",
"qdrant_point_id": "fd690f2f-2636-44c4-a5e0-42b21a4b4898",
"created_at": "2024-06-21T05:04:56.830315",
"updated_at": "2024-06-21T05:04:56.830315",
"chunk_html": "Edit message\nEdit message\n\nEdit message which exists within the topic's chat history. This will delete the message and replace it with a new message. The new message will be generated by the AI based on the new content provided in the request body. The response will include Chunks first on the stream if the topic is using RAG. The structure will look like `[chunks]||mesage`. See docs.trieve.ai for more information. Auth'ed user or api key must have an admin or owner role for the specified dataset's organization.",
"metadata": { "openapi": "put /api/message", "title": "Edit message" },
"tracking_id": "api-reference/message/edit-a-message-Edit-message-Edit-message-Edit-",
"time_stamp": null,
"dataset_id": "fd92b3c5-079c-4bfb-b806-3c4f49b87b31",
"weight": 0,
"location": null,
"image_urls": null,
"tag_set": "page",
"num_value": null,
"group_tracking_ids": ["api-reference/message/edit-a-message"]
},
{
"id": "bd7623f8-e3ed-42d7-a231-cbbc5e35b430",
"link": "api-reference/chunk/autocomplete",
"qdrant_point_id": "fb72d064-3b43-4c68-9d22-01ce3a6d5151",
"created_at": "2024-06-21T05:04:56.755759",
"updated_at": "2024-06-21T05:04:56.755759",
"chunk_html": "Autocomplete\nAutocomplete\n\nThis route provides the primary autocomplete functionality for the API. This prioritize prefix matching with semantic or full-text search.",
"metadata": {
"openapi": "post /api/chunk/autocomplete",
"title": "Autocomplete"
},
"tracking_id": "api-reference/chunk/autocomplete-Autocomplete-Autocomplete-This-",
"time_stamp": null,
"dataset_id": "fd92b3c5-079c-4bfb-b806-3c4f49b87b31",
"weight": 0,
"location": null,
"image_urls": null,
"tag_set": "page",
"num_value": null,
"group_tracking_ids": ["api-reference/chunk/autocomplete"]
}
]
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment