langsmith 0.5.6 → 0.5.8

package/dist/client.d.ts

@@ -234,6 +234,24 @@ interface GroupRunsParams {
      */
     offset?: number;
 }
+export interface ReadThreadParams {
+    threadId: string;
+    projectId?: string;
+    projectName?: string;
+    isRoot?: boolean;
+    limit?: number;
+    filter?: string;
+    order?: "asc" | "desc";
+}
+export interface ListThreadsParams {
+    projectId?: string;
+    projectName?: string;
+    limit?: number;
+    offset?: number;
+    filter?: string;
+    startTime?: Date;
+    isRoot?: boolean;
+}
 interface UploadCSVParams {
     csvFile: Blob;
     fileName: string;
@@ -317,11 +335,15 @@ type Thread = {
     latency_p50: number;
     latency_p99: number;
     feedback_stats: any | null;
-    group_key: string;
+    thread_id: string;
     first_inputs: string;
     last_outputs: string;
     last_error: string | null;
 };
+/** Item returned by {@link Client.listThreads}. */
+export interface ListThreadsItem extends Thread {
+    runs: Run[];
+}
 export declare function mergeRuntimeEnvIntoRun<T extends RunCreate | RunUpdate>(run: T, cachedEnvVars?: Record<string, string>, omitTracedRuntimeInfo?: boolean): T;
 export declare const DEFAULT_UNCOMPRESSED_BATCH_SIZE_LIMIT_BYTES: number;
 /** Default maximum memory (1GB) for queue size limits. */
@@ -391,6 +413,9 @@ export declare class Client implements LangSmithTracingClientInterface {
     private multipartStreamingDisabled;
     private _multipartDisabled;
     private _runCompressionDisabled;
+    private failedTracesDir;
+    private failedTracesMaxBytes;
+    private static _fallbackDirsCreated;
     debug: boolean;
     constructor(config?: ClientConfig);
     static getDefaultClientConfig(): {
@@ -419,6 +444,19 @@ export declare class Client implements LangSmithTracingClientInterface {
     private _getBatchSizeLimit;
     private _getDatasetExamplesMultiPartSupport;
     private drainAutoBatchQueue;
+    /**
+     * Persist a failed trace payload to a local fallback directory.
+     *
+     * Saves a self-contained JSON file containing the endpoint path, the HTTP
+     * headers required for replay, and the base64-encoded request body.
+     * Can be replayed later with a simple POST:
+     *
+     *   POST /<endpoint>
+     *   Content-Type: <value from saved headers>
+     *   [Content-Encoding: <value from saved headers>]
+     *   <decoded body>
+     */
+    private static _writeTraceToFallbackDir;
     private _processBatch;
     private _sendBatchToOTELTranslator;
     private processRunOperation;
@@ -562,6 +600,8 @@ export declare class Client implements LangSmithTracingClientInterface {
      */
     listRuns(props: ListRunsParams): AsyncIterable<Run>;
     listGroupRuns(props: GroupRunsParams): AsyncIterable<Thread>;
+    readThread(props: ReadThreadParams): AsyncIterable<Run>;
+    listThreads(props: ListThreadsParams): Promise<ListThreadsItem[]>;
     getRunStats({ id, trace, parentRun, runType, projectNames, projectIds, referenceExampleIds, startTime, endTime, error, query, filter, traceFilter, treeFilter, isRoot, dataSourceType, }: {
         id?: string[];
         trace?: string;
@@ -1045,23 +1085,183 @@ export declare class Client implements LangSmithTracingClientInterface {
     protected _getLatestCommitHash(promptOwnerAndName: string): Promise<string | undefined>;
     protected _likeOrUnlikePrompt(promptIdentifier: string, like: boolean): Promise<LikePromptResponse>;
     protected _getPromptUrl(promptIdentifier: string): Promise<string>;
+    /**
+     * Check if a prompt exists.
+     * @param promptIdentifier - The identifier of the prompt. Can be in the format:
+     *   - "promptName" (for private prompts, owner defaults to "-")
+     *   - "owner/promptName" (for prompts with explicit owner)
+     * @returns A Promise that resolves to true if the prompt exists, false otherwise
+     * @example
+     * ```typescript
+     * // Check if a prompt exists before creating a commit
+     * if (await client.promptExists("my-prompt")) {
+     *   await client.createCommit("my-prompt", template);
+     * } else {
+     *   await client.createPrompt("my-prompt");
+     * }
+     * ```
+     */
     promptExists(promptIdentifier: string): Promise<boolean>;
+    /**
+     * Like a prompt.
+     * @param promptIdentifier - The identifier of the prompt. Can be in the format:
+     *   - "promptName" (for private prompts, owner defaults to "-")
+     *   - "owner/promptName" (for prompts with explicit owner)
+     * @returns A Promise that resolves to the like response containing the updated like count
+     * @example
+     * ```typescript
+     * // Like a prompt
+     * const response = await client.likePrompt("owner/useful-prompt");
+     * console.log(`Prompt now has ${response.likes} likes`);
+     * ```
+     */
     likePrompt(promptIdentifier: string): Promise<LikePromptResponse>;
+    /**
+     * Unlike a prompt (remove a previously added like).
+     * @param promptIdentifier - The identifier of the prompt. Can be in the format:
+     *   - "promptName" (for private prompts, owner defaults to "-")
+     *   - "owner/promptName" (for prompts with explicit owner)
+     * @returns A Promise that resolves to the like response containing the updated like count
+     * @example
+     * ```typescript
+     * // Unlike a prompt
+     * const response = await client.unlikePrompt("owner/useful-prompt");
+     * console.log(`Prompt now has ${response.likes} likes`);
+     * ```
+     */
     unlikePrompt(promptIdentifier: string): Promise<LikePromptResponse>;
-    listCommits(promptOwnerAndName: string): AsyncIterableIterator<PromptCommit>;
+    /**
+     * List all commits for a prompt.
+     * @param promptIdentifier - The identifier of the prompt. Can be in the format:
+     *   - "promptName" (for private prompts, owner defaults to "-")
+     *   - "owner/promptName" (for prompts with explicit owner)
+     *   - "promptName:commitHash" (commit hash is ignored, all commits are returned)
+     * @returns An async iterable iterator of PromptCommit objects
+     * @example
+     * ```typescript
+     * // List commits for a private prompt
+     * for await (const commit of client.listCommits("my-prompt")) {
+     *   console.log(commit);
+     * }
+     *
+     * // List commits for a prompt with explicit owner
+     * for await (const commit of client.listCommits("owner/my-prompt")) {
+     *   console.log(commit);
+     * }
+     * ```
+     */
+    listCommits(promptIdentifier: string): AsyncIterableIterator<PromptCommit>;
+    /**
+     * List prompts by filter.
+     * @param options - Optional filters for listing prompts
+     * @param options.isPublic - Filter by public/private prompts. If undefined, returns all prompts.
+     * @param options.isArchived - Filter by archived status. Defaults to false (non-archived prompts only).
+     * @param options.sortField - Field to sort by. Defaults to "updated_at".
+     * @param options.query - Search query to filter prompts by name or description.
+     * @returns An async iterable iterator of Prompt objects
+     * @example
+     * ```typescript
+     * // List all prompts
+     * for await (const prompt of client.listPrompts()) {
+     *   console.log(prompt);
+     * }
+     *
+     * // List only public prompts
+     * for await (const prompt of client.listPrompts({ isPublic: true })) {
+     *   console.log(prompt);
+     * }
+     *
+     * // Search for prompts
+     * for await (const prompt of client.listPrompts({ query: "translation" })) {
+     *   console.log(prompt);
+     * }
+     * ```
+     */
     listPrompts(options?: {
         isPublic?: boolean;
         isArchived?: boolean;
         sortField?: PromptSortField;
         query?: string;
     }): AsyncIterableIterator<Prompt>;
+    /**
+     * Get a prompt by its identifier.
+     * @param promptIdentifier - The identifier of the prompt. Can be in the format:
+     *   - "promptName" (for private prompts, owner defaults to "-")
+     *   - "owner/promptName" (for prompts with explicit owner)
+     *   - "promptName:commitHash" (commit hash is ignored, latest version is returned)
+     * @returns A Promise that resolves to the Prompt object, or null if not found
+     * @example
+     * ```typescript
+     * // Get a private prompt
+     * const prompt = await client.getPrompt("my-prompt");
+     *
+     * // Get a public prompt
+     * const publicPrompt = await client.getPrompt("owner/public-prompt");
+     * ```
+     */
     getPrompt(promptIdentifier: string): Promise<Prompt | null>;
+    /**
+     * Create a new prompt.
+     * @param promptIdentifier - The identifier for the new prompt. Can be in the format:
+     *   - "promptName" (creates a private prompt)
+     *   - "owner/promptName" (creates a prompt under a specific owner, must match your tenant)
+     * @param options - Optional configuration for the prompt
+     * @param options.description - A description of the prompt
+     * @param options.readme - Markdown content for the prompt's README
+     * @param options.tags - Array of tags to categorize the prompt
+     * @param options.isPublic - Whether the prompt should be public. Requires a LangChain Hub handle.
+     * @returns A Promise that resolves to the created Prompt object
+     * @throws {Error} If creating a public prompt without a LangChain Hub handle, or if owner doesn't match current tenant
+     * @example
+     * ```typescript
+     * // Create a private prompt
+     * const prompt = await client.createPrompt("my-new-prompt", {
+     *   description: "A prompt for translations",
+     *   tags: ["translation", "language"]
+     * });
+     *
+     * // Create a public prompt
+     * const publicPrompt = await client.createPrompt("my-public-prompt", {
+     *   description: "A public translation prompt",
+     *   isPublic: true
+     * });
+     * ```
+     */
     createPrompt(promptIdentifier: string, options?: {
         description?: string;
         readme?: string;
         tags?: string[];
         isPublic?: boolean;
     }): Promise<Prompt>;
+    /**
+     * Create a new commit for an existing prompt.
+     * @param promptIdentifier - The identifier of the prompt. Can be in the format:
+     *   - "promptName" (for private prompts, owner defaults to "-")
+     *   - "owner/promptName" (for prompts with explicit owner)
+     * @param object - The prompt object/manifest to commit (e.g., ChatPromptTemplate, messages array, etc.)
+     * @param options - Optional configuration for the commit
+     * @param options.parentCommitHash - The parent commit hash. Defaults to "latest" (the most recent commit).
+     * @returns A Promise that resolves to the URL of the newly created commit
+     * @throws {Error} If the prompt does not exist
+     * @example
+     * ```typescript
+     * import { ChatPromptTemplate } from "@langchain/core/prompts";
+     *
+     * // Create a commit with a new version of the prompt
+     * const template = ChatPromptTemplate.fromMessages([
+     *   ["system", "You are a helpful assistant."],
+     *   ["human", "{input}"]
+     * ]);
+     *
+     * const commitUrl = await client.createCommit("my-prompt", template);
+     * console.log(`Commit created: ${commitUrl}`);
+     *
+     * // Create a commit based on a specific parent commit
+     * const commitUrl2 = await client.createCommit("my-prompt", template, {
+     *   parentCommitHash: "abc123def456"
+     * });
+     * ```
+     */
     createCommit(promptIdentifier: string, object: any, options?: {
         parentCommitHash?: string;
     }): Promise<string>;