langsmith 0.5.19 → 0.6.0

package/dist/client.d.ts

@@ -1,6 +1,7 @@
 import type { OTELContext } from "./experimental/otel/types.js";
 import { AsyncCallerParams } from "./utils/async_caller.js";
-import { ComparativeExperiment, DataType, Dataset, DatasetDiffInfo, DatasetShareSchema, Example, ExampleCreate, ExampleUpdate, ExampleUpdateWithoutId, Feedback, FeedbackConfig, FeedbackIngestToken, KVMap, LangChainBaseMessage, LangSmithSettings, LikePromptResponse, Prompt, PromptCommit, PromptSortField, Run, RunCreate, RunUpdate, ScoreType, TimeDelta, TracerSession, TracerSessionResult, ValueType, AnnotationQueue, RunWithAnnotationQueueInfo, Attachments, UploadExamplesResponse, UpdateExamplesResponse, DatasetVersion, AnnotationQueueWithDetails, AnnotationQueueRubricItem, FeedbackConfigSchema } from "./schemas.js";
+import { ComparativeExperiment, DataType, Dataset, DatasetDiffInfo, DatasetShareSchema, Example, ExampleCreate, ExampleUpdate, ExampleUpdateWithoutId, Feedback, FeedbackConfig, FeedbackIngestToken, KVMap, LangChainBaseMessage, LangSmithSettings, LikePromptResponse, Prompt, PromptCommit, PromptSortField, Run, RunCreate, RunUpdate, ScoreType, TimeDelta, TracerSession, TracerSessionResult, ValueType, AnnotationQueue, RunWithAnnotationQueueInfo, Attachments, UploadExamplesResponse, UpdateExamplesResponse, DatasetVersion, AnnotationQueueWithDetails, AnnotationQueueRubricItem, FeedbackConfigSchema, AgentContext, SkillContext, Entry } from "./schemas.js";
+import { type TracingMode } from "./utils/env.js";
 import { EvaluationResult, EvaluationResults } from "./evaluation/evaluator.js";
 import { PromptCache } from "./utils/prompt_cache/index.js";
 export interface ClientConfig {
@@ -12,6 +13,7 @@ export interface ClientConfig {
     anonymizer?: (values: KVMap) => KVMap | Promise<KVMap>;
     hideInputs?: boolean | ((inputs: KVMap) => KVMap | Promise<KVMap>);
     hideOutputs?: boolean | ((outputs: KVMap) => KVMap | Promise<KVMap>);
+    hideMetadata?: boolean | ((metadata: KVMap) => KVMap | Promise<KVMap>);
     /**
      * Whether to omit runtime information from traced runs.
      * If true, runtime information (SDK version, platform, etc.) and
@@ -55,6 +57,17 @@ export interface ClientConfig {
      * By default, prompt caching is enabled globally.
      */
     disablePromptCache?: boolean;
+    /**
+     * Where to send traces.  One of:
+     *
+     * - `"langsmith"` (default) — LangSmith REST API only.
+     * - `"otel"` — OpenTelemetry export only.
+     *
+     * Falls back to the `LANGSMITH_TRACING_MODE` env var, then to the
+     * legacy `OTEL_ENABLED` / `LANGSMITH_OTEL_ENABLED` env vars, then to
+     * `"langsmith"`.
+     */
+    tracingMode?: TracingMode;
     /**
      * Additional HTTP headers to include in all requests.
      * These headers will be merged with the default headers (User-Agent,
@@ -396,6 +409,7 @@ export declare class Client implements LangSmithTracingClientInterface {
     private _tenantId;
     private hideInputs?;
     private hideOutputs?;
+    private hideMetadata?;
     private omitTracedRuntimeInfo?;
     private tracingSampleRate?;
     private filteredPostUuids;
@@ -412,11 +426,35 @@ export declare class Client implements LangSmithTracingClientInterface {
     private _serverInfo;
     private _getServerInfoPromise?;
     private manualFlushMode;
+    private _serializeWorker?;
+    /**
+     * Tracks in-flight drainAutoBatchQueue promises so awaitPendingTraceBatches
+     * can wait on them even if the flush involves async work (worker-thread
+     * serialize) that hasn't yet registered with batchIngestCaller.queue.
+     */
+    private _pendingDrains;
     private langSmithToOTELTranslator?;
+    private _tracingMode;
+    get tracingMode(): TracingMode;
     private fetchImplementation?;
     private cachedLSEnvVarsForMetadata?;
     private _promptCache?;
     private get _fetch();
+    /**
+     * Serialize a payload for tracing, optionally offloading the work to a
+     * Node worker thread when the runtime supports worker_threads.
+     *
+     * Falls back to synchronous serialization when:
+     *  - manualFlushMode is enabled (serverless: worker boot cost > benefit)
+     *  - worker_threads is unavailable (non-Node runtimes)
+     *  - the payload contains values that can't be structured-cloned across
+     *    threads (functions, non-cloneable class instances, streams, etc.)
+     *  - the worker throws for any other reason
+     *
+     * In all fallback cases the returned bytes are identical to the sync path.
+     */
+    private _trackDrain;
+    private _serializeBody;
     private multipartStreamingDisabled;
     private _multipartDisabled;
     private _runCompressionDisabled;
@@ -432,6 +470,7 @@ export declare class Client implements LangSmithTracingClientInterface {
         webUrl?: string;
         hideInputs?: boolean;
         hideOutputs?: boolean;
+        hideMetadata?: boolean;
     };
     getHostUrl(): string;
     private get _mergedHeaders();
@@ -445,6 +484,7 @@ export declare class Client implements LangSmithTracingClientInterface {
     private _getPlatformEndpointPath;
     private processInputs;
     private processOutputs;
+    private processMetadata;
     /**
      * Filter content from new_token events to prevent streaming LLM output
      * from being uploaded via events.
@@ -1280,18 +1320,57 @@ export declare class Client implements LangSmithTracingClientInterface {
      * Fetch a prompt commit directly from the API (bypassing cache).
      */
     private _fetchPromptFromApi;
+    /**
+     * Pull a prompt commit from the LangSmith API.
+     *
+     * Public prompts referenced by owner/name cross a trust boundary because the
+     * prompt manifest may contain serialized LangChain objects and configuration
+     * that affect runtime behavior. For example, a prompt can intentionally
+     * configure a model with a custom base URL, headers, model name, or other
+     * constructor arguments. These are supported features, but they also mean the
+     * prompt contents should be treated as executable configuration rather than
+     * plain text.
+     *
+     * Set `dangerouslyPullPublicPrompt: true` only after reviewing and trusting
+     * the prompt contents, not merely the publishing account. Prompts from your
+     * own or your organization's account can still be unsafe if that account or
+     * prompt was compromised.
+     */
     pullPromptCommit(promptIdentifier: string, options?: {
         includeModel?: boolean;
         skipCache?: boolean;
+        /**
+         * Set to `true` to allow pulling a public prompt by owner/name, for
+         * example `username/promptname`. Defaults to `false`.
+         */
+        dangerouslyPullPublicPrompt?: boolean;
     }): Promise<PromptCommit>;
     /**
      * This method should not be used directly, use `import { pull } from "langchain/hub"` instead.
      * Using this method directly returns the JSON string of the prompt rather than a LangChain object.
+     *
+     * Public prompts referenced by owner/name cross a trust boundary because the
+     * prompt manifest may contain serialized LangChain objects and configuration
+     * that affect runtime behavior. For example, a prompt can intentionally
+     * configure a model with a custom base URL, headers, model name, or other
+     * constructor arguments. These are supported features, but they also mean the
+     * prompt contents should be treated as executable configuration rather than
+     * plain text.
+     *
+     * Set `dangerouslyPullPublicPrompt: true` only after reviewing and trusting
+     * the prompt contents, not merely the publishing account. Prompts from your
+     * own or your organization's account can still be unsafe if that account or
+     * prompt was compromised.
      * @private
      */
     _pullPrompt(promptIdentifier: string, options?: {
         includeModel?: boolean;
         skipCache?: boolean;
+        /**
+         * Set to `true` to allow pulling a public prompt by owner/name, for
+         * example `username/promptname`. Defaults to `false`.
+         */
+        dangerouslyPullPublicPrompt?: boolean;
     }): Promise<any>;
     pushPrompt(promptIdentifier: string, options?: {
         object?: any;
@@ -1302,6 +1381,83 @@ export declare class Client implements LangSmithTracingClientInterface {
         tags?: string[];
         commitDescription?: string;
     }): Promise<string>;
+    /**
+     * Check if an agent repo exists.
+     */
+    agentExists(identifier: string): Promise<boolean>;
+    /**
+     * Check if a skill repo exists.
+     */
+    skillExists(identifier: string): Promise<boolean>;
+    /**
+     * Pull an agent directory from Hub.
+     * @param identifier The identifier (owner/name[:version]).
+     * @param options.version Commit hash or tag; overrides identifier's version.
+     */
+    pullAgent(identifier: string, options?: {
+        version?: string;
+    }): Promise<AgentContext>;
+    /**
+     * Pull a skill directory from Hub.
+     */
+    pullSkill(identifier: string, options?: {
+        version?: string;
+    }): Promise<SkillContext>;
+    /**
+     * Push an agent to Hub. Creates the repo if missing, patches metadata if
+     * provided, then commits the given files.
+     * @returns The URL of the resulting commit.
+     */
+    pushAgent(identifier: string, options: {
+        files: Record<string, Entry | null>;
+        parentCommit?: string;
+        description?: string;
+        readme?: string;
+        tags?: string[];
+        isPublic?: boolean;
+    }): Promise<string>;
+    /**
+     * Push a skill to Hub.
+     */
+    pushSkill(identifier: string, options: {
+        files: Record<string, Entry | null>;
+        parentCommit?: string;
+        description?: string;
+        readme?: string;
+        tags?: string[];
+        isPublic?: boolean;
+    }): Promise<string>;
+    /**
+     * Delete an agent and all its owned child file repos.
+     */
+    deleteAgent(identifier: string): Promise<void>;
+    /**
+     * Delete a skill and all its owned child file repos.
+     */
+    deleteSkill(identifier: string): Promise<void>;
+    /**
+     * List agent repos. Yields one at a time, auto-paginating.
+     */
+    listAgents(options?: {
+        isPublic?: boolean;
+        isArchived?: boolean;
+        query?: string;
+    }): AsyncIterableIterator<Prompt>;
+    /**
+     * List skill repos. Yields one at a time, auto-paginating.
+     */
+    listSkills(options?: {
+        isPublic?: boolean;
+        isArchived?: boolean;
+        query?: string;
+    }): AsyncIterableIterator<Prompt>;
+    private _listReposByType;
+    private _pullDirectory;
+    private _pushDirectory;
+    private _deleteDirectory;
+    private _repoExists;
+    private _createRepo;
+    private _updateRepoMetadata;
     /**
      * Clone a public dataset to your own langsmith tenant.
      * This operation is idempotent. If you already have a dataset with the given name,
@@ -1345,6 +1501,14 @@ export declare class Client implements LangSmithTracingClientInterface {
      * @returns A promise that resolves once all currently pending traces have sent.
      */
     awaitPendingTraceBatches(): Promise<void>;
+    /**
+     * Returns a string representation of the Client instance.
+     * This method is called when the object is converted to a string
+     * or logged, ensuring sensitive information like API keys is not exposed.
+     *
+     * @returns A string representation of the Client.
+     */
+    toString(): string;
 }
 export interface LangSmithTracingClientInterface {
     createRun: (run: CreateRunParams) => Promise<void>;