Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 21 additions & 0 deletions clients/ts-sdk/src/functions/crawl/crawl.test.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
import { beforeAll, describe, expectTypeOf } from "vitest";
import { TrieveSDK } from "../../sdk";
import { CrawlRequest } from "../../types.gen";
import { TRIEVE } from "../../__tests__/constants";
import { test } from "../../__tests__/utils";

describe("Crawl Tests", async () => {
let trieve: TrieveSDK;
beforeAll(() => {
trieve = TRIEVE;
});

test("getCrawlsForDataset", async () => {
const data = await trieve.getCrawlsForDataset({
page: 1,
limit: 10,
});

expectTypeOf(data).toEqualTypeOf<Array<CrawlRequest>>();
});
});
50 changes: 42 additions & 8 deletions clients/ts-sdk/src/functions/crawl/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -7,39 +7,73 @@
import { TrieveSDK } from "../../sdk";
import {
$OpenApiTs,
Dataset,
CreateCrawlReqPayload,
CrawlRequest,
GetCrawlRequestsForDatasetData,
} from "../../types.gen";

/**
* Function that provides the ability to create a dataset. This function is used to create a new dataset in the organization.
* Function that retrieves all crawl requests for the current dataset, with optional pagination.
*
* Example:
* ```js
* const dataset = await trieve.createDataset({
* dataset_name: "My Dataset",
* const crawls = await trieve.getCrawlsForDataset({
* page: 1,
* limit: 10,
* });
* ```
*/
export async function getCrawlsForDataset(
/** @hidden */
this: TrieveSDK,
props: GetCrawlRequestsForDatasetData,
props: Omit<GetCrawlRequestsForDatasetData, "trDataset"> = {},
signal?: AbortSignal,
): Promise<Dataset> {
): Promise<Array<CrawlRequest>> {
if (!this.datasetId) {
throw new Error("Dataset ID is required to create a crawl");
throw new Error("Dataset ID is required to get crawls");
}

return this.trieve.fetch<"eject">(
`/api/crawl?limit=${props.limit ?? 10}&page=${
props.page ?? 1
}` as keyof $OpenApiTs,
"get",
{
datasetId: this.datasetId,
},
signal,
) as Promise<Array<CrawlRequest>>;
}

/**
* Function that creates a new crawl request for the current dataset.
*
* Example:
* ```js
* const crawl = await trieve.createCrawl({
* crawl_options: {
* site_url: "https://example.com",
* },
* });
* ```
*/
export async function createCrawl(
/** @hidden */
this: TrieveSDK,
props: CreateCrawlReqPayload,
signal?: AbortSignal,
): Promise<CrawlRequest> {
if (!this.datasetId) {
throw new Error("Dataset ID is required to create a crawl");
}

return this.trieve.fetch(
"/api/crawl",
"post",
{
data: props,
datasetId: this.datasetId,
},
signal,
) as Promise<Dataset>;
) as Promise<CrawlRequest>;
}