trieve-ts-sdk - npm Package Compare versions

Comparing version 0.0.11 to 0.0.12

dist/functions/analytics/index.d.ts

@@ -6,3 +6,3 @@ /**
  */
-import { ClusterAnalytics, CTRAnalytics, CTRDataRequestBody, RAGAnalytics, RecommendationAnalytics, SearchAnalytics } from "../../fetch-client";
+import { ClusterAnalytics, CTRAnalytics, CTRDataRequestBody, GetEventsRequestBody, GetTopDatasetsRequestBody, RAGAnalytics, RateQueryRequest, RecommendationAnalytics, SearchAnalytics } from "../../fetch-client";
 import { TrieveSDK } from "../../sdk";
@@ -142,2 +142,68 @@ /**
 this: TrieveSDK, data: ClusterAnalytics, signal?: AbortSignal): Promise<import("../../types.gen").ClusterAnalyticsResponse>;
+/**
+ * Function that allows you  to rate a RAG query.
+ *
+ * Example:
+ * ```js
+ *const data = await trieve.rateRagQuery({
+  query_id: 123,
+  rating: 1,
+});
+ * ```
+ */
+export declare function rateRagQuery(
+/** @hidden */
+this: TrieveSDK, data: RateQueryRequest, signal?: AbortSignal): Promise<void>;
+/**
+ * Function that allows you  to rate a search query.
+ *
+ * Example:
+ * ```js
+ *const data = await trieve.rateSearchQuery({
+  query_id: 123,
+  rating: 1,
+});
+ * ```
+ */
+export declare function rateSearchQuery(
+/** @hidden */
+this: TrieveSDK, data: RateQueryRequest, signal?: AbortSignal): Promise<void>;
+/**
+ * Function that allows you to fetch the top datasets for an organization
+ *
+ * Example:
+ * ```js
+ *const data = await trieve.getTopDatasets({
+  organizationId: 123,
+  type: "search"
+});
+ * ```
+ */
+export declare function getTopDatasets(
+/** @hidden */
+this: TrieveSDK, data: GetTopDatasetsRequestBody & {
+    organizationId: string;
+}, signal?: AbortSignal): Promise<import("../../types.gen").TopDatasetsResponse[]>;
+/**
+ * Function that allows you to view the CTR analytics for a dataset.
+ *
+ * Example:
+ * ```js
+ *const data = await trieve.getAllAnalyticsEvents({
+  filter: {
+    "date_range": {
+      "gt": "2021-08-10T00:00:00Z",
+      "lt": "2021-08-11T00:00:00Z"
+    },
+    "event_type": "view",
+    "is_conversion": true,
+    "metadata_filter": "path = \"value\"",
+    "user_id": "user1"
+  },
+});
+ * ```
+ */
+export declare function getAllAnalyticsEvents(
+/** @hidden */
+this: TrieveSDK, data: GetEventsRequestBody, signal?: AbortSignal): Promise<import("../../types.gen").GetEventsResponseBody>;
 //# sourceMappingURL=index.d.ts.map

dist/functions/index.d.ts

@@ -9,2 +9,6 @@ declare const _default: {
     createMessageReader(this: import("..").TrieveSDK, data: import("..").CreateMessageReqPayload, signal?: AbortSignal): Promise<ReadableStreamDefaultReader<Uint8Array>>;
+    createMessageReaderWithQueryId(this: import("..").TrieveSDK, data: import("..").CreateMessageReqPayload, signal?: AbortSignal): Promise<{
+        reader: ReadableStreamDefaultReader<Uint8Array>;
+        queryId: string | null;
+    }>;
     editMessage(this: import("..").TrieveSDK, data: import("..").EditMessageReqPayload, signal?: AbortSignal): Promise<unknown>;
@@ -25,2 +29,8 @@ editMessageReader(this: import("..").TrieveSDK, data: import("..").EditMessageReqPayload, signal?: AbortSignal): Promise<ReadableStreamDefaultReader<Uint8Array>>;
     getClusterAnalytics(this: import("..").TrieveSDK, data: import("..").ClusterAnalytics, signal?: AbortSignal): Promise<import("..").ClusterAnalyticsResponse>;
+    rateRagQuery(this: import("..").TrieveSDK, data: import("..").RateQueryRequest, signal?: AbortSignal): Promise<void>;
+    rateSearchQuery(this: import("..").TrieveSDK, data: import("..").RateQueryRequest, signal?: AbortSignal): Promise<void>;
+    getTopDatasets(this: import("..").TrieveSDK, data: import("..").GetTopDatasetsRequestBody & {
+        organizationId: string;
+    }, signal?: AbortSignal): Promise<import("..").TopDatasetsResponse[]>;
+    getAllAnalyticsEvents(this: import("..").TrieveSDK, data: import("..").GetEventsRequestBody, signal?: AbortSignal): Promise<import("..").GetEventsResponseBody>;
     createChunkGroup(this: import("..").TrieveSDK, data: Omit<import("..").CreateChunkGroupReqPayloadEnum, "datasetId">): Promise<import("..").CreateChunkGroupResponseEnum>;
@@ -27,0 +37,0 @@ searchOverGroups(this: import("..").TrieveSDK, data: import("..").SearchOverGroupsReqPayload, signal?: AbortSignal): Promise<import("..").SearchOverGroupsResponseTypes>;

dist/functions/message/index.d.ts

@@ -37,2 +37,19 @@ /**
 /**
+ * Create a message as a stream and returns a reader with the message id. Messages are attached to topics in order to coordinate memory of gen-AI chat sessions.Auth’ed user or api key must have an admin or owner role for the specified dataset’s organization.
+ *
+ * Example:
+ * ```js
+ *const reader = await trieve.createMessageReader({
+  topic_id: "3c90c3cc-1d76-27198-8888-8dd25736052a",
+  new_message_content: "a new message"
+});
+ * ```
+ */
+export declare function createMessageReaderWithQueryId(
+/** @hidden */
+this: TrieveSDK, data: CreateMessageReqPayload, signal?: AbortSignal): Promise<{
+    reader: ReadableStreamDefaultReader<Uint8Array>;
+    queryId: string | null;
+}>;
+/**
  * Edit 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.
@@ -39,0 +56,0 @@ *

dist/index.js

@@ -502,2 +502,3 @@ var __defProp = Object.defineProperty;
 __export(analytics_exports, {
+  getAllAnalyticsEvents: () => getAllAnalyticsEvents,
   getCTRAnalytics: () => getCTRAnalytics,
@@ -508,2 +509,5 @@ getClusterAnalytics: () => getClusterAnalytics,
   getSearchAnalytics: () => getSearchAnalytics,
+  getTopDatasets: () => getTopDatasets,
+  rateRagQuery: () => rateRagQuery,
+  rateSearchQuery: () => rateSearchQuery,
   sendCTRAnalytics: () => sendCTRAnalytics
@@ -577,2 +581,45 @@ });
 }
+async function rateRagQuery(data, signal) {
+  return this.trieve.fetch(
+    "/api/analytics/rag",
+    "put",
+    {
+      data,
+      datasetId: this.datasetId
+    },
+    signal
+  );
+}
+async function rateSearchQuery(data, signal) {
+  return this.trieve.fetch(
+    "/api/analytics/search",
+    "put",
+    {
+      data,
+      datasetId: this.datasetId
+    },
+    signal
+  );
+}
+async function getTopDatasets(data, signal) {
+  return this.trieve.fetch(
+    "/api/analytics/top",
+    "post",
+    {
+      data,
+      organizationId: data.organizationId
+    },
+    signal
+  );
+}
+async function getAllAnalyticsEvents(data, signal) {
+  return await this.trieve.fetch(
+    "/api/analytics/events",
+    "post",
+    {
+      data
+    },
+    signal
+  );
+}
 
@@ -637,2 +684,3 @@ // src/functions/topic/index.ts
   createMessageReader: () => createMessageReader,
+  createMessageReaderWithQueryId: () => createMessageReaderWithQueryId,
   editMessage: () => editMessage,
@@ -672,2 +720,23 @@ editMessageReader: () => editMessageReader,
 }
+async function createMessageReaderWithQueryId(data, signal) {
+  const response = await fetch(this.trieve.baseUrl + "/api/message", {
+    method: "post",
+    headers: {
+      "Content-Type": "application/json",
+      "TR-Dataset": this.datasetId,
+      Authorization: `Bearer ${this.trieve.apiKey}`
+    },
+    body: JSON.stringify(data),
+    signal
+  });
+  const reader = response.body?.getReader();
+  if (!reader) {
+    throw new Error("Failed to get reader from response body");
+  }
+  const queryId = response.headers.get("TR-QueryID");
+  return {
+    reader,
+    queryId
+  };
+}
 async function editMessage(data, signal) {
@@ -674,0 +743,0 @@ return await this.trieve.fetch(

package.json

@@ -9,3 +9,3 @@ {
   ],
-  "version": "0.0.11",
+  "version": "0.0.12",
   "license": "MIT",
@@ -12,0 +12,0 @@ "scripts": {

No alert changes

Improved metrics

Total package byte prevSize

412477

increased by2.48%

Lines of code

6839

increased by2.43%

Worsened metrics

Number of medium supply chain risk alerts

5

increased by25%

No dependency changes