Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Generate JS library docs #1064

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from
Draft
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
20 changes: 20 additions & 0 deletions js/docs/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
**langsmith** • **Docs**

***

# langsmith

## Modules

- [anonymizer](anonymizer/README.md)
- [client](client/README.md)
- [evaluation](evaluation/README.md)
- [evaluation/langchain](evaluation/langchain/README.md)
- [langchain](langchain/README.md)
- [run\_trees](run_trees/README.md)
- [schemas](schemas/README.md)
- [singletons/traceable](singletons/traceable/README.md)
- [traceable](traceable/README.md)
- [wrappers](wrappers/README.md)
- [wrappers/openai](wrappers/openai/README.md)
- [wrappers/vercel](wrappers/vercel/README.md)
23 changes: 23 additions & 0 deletions js/docs/anonymizer/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
[**langsmith**](../README.md) • **Docs**

***

[langsmith](../README.md) / anonymizer

# anonymizer

## Index

### Interfaces

- [StringNode](interfaces/StringNode.md)
- [StringNodeProcessor](interfaces/StringNodeProcessor.md)
- [StringNodeRule](interfaces/StringNodeRule.md)

### Type Aliases

- [ReplacerType](type-aliases/ReplacerType.md)

### Functions

- [createAnonymizer](functions/createAnonymizer.md)
37 changes: 37 additions & 0 deletions js/docs/anonymizer/functions/createAnonymizer.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
[**langsmith**](../../README.md) • **Docs**

***

[langsmith](../../README.md) / [anonymizer](../README.md) / createAnonymizer

# Function: createAnonymizer()

> **createAnonymizer**(`replacer`, `options`?): \<`T`\>(`data`) => `T`

## Parameters

• **replacer**: [`ReplacerType`](../type-aliases/ReplacerType.md)

• **options?**

• **options.maxDepth?**: `number`

## Returns

`Function`

### Type Parameters

• **T**

### Parameters

• **data**: `T`

### Returns

`T`

## Defined in

[src/anonymizer/index.ts:57](https://github.com/langchain-ai/langsmith-sdk/blob/da3c1bb4f1396b48909bf0abac53fd717458c764/js/src/anonymizer/index.ts#L57)
27 changes: 27 additions & 0 deletions js/docs/anonymizer/interfaces/StringNode.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
[**langsmith**](../../README.md) • **Docs**

***

[langsmith](../../README.md) / [anonymizer](../README.md) / StringNode

# Interface: StringNode

## Properties

### path

> **path**: `string`

#### Defined in

[src/anonymizer/index.ts:5](https://github.com/langchain-ai/langsmith-sdk/blob/da3c1bb4f1396b48909bf0abac53fd717458c764/js/src/anonymizer/index.ts#L5)

***

### value

> **value**: `string`

#### Defined in

[src/anonymizer/index.ts:4](https://github.com/langchain-ai/langsmith-sdk/blob/da3c1bb4f1396b48909bf0abac53fd717458c764/js/src/anonymizer/index.ts#L4)
25 changes: 25 additions & 0 deletions js/docs/anonymizer/interfaces/StringNodeProcessor.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
[**langsmith**](../../README.md) • **Docs**

***

[langsmith](../../README.md) / [anonymizer](../README.md) / StringNodeProcessor

# Interface: StringNodeProcessor

## Properties

### maskNodes()

> **maskNodes**: (`nodes`) => [`StringNode`](StringNode.md)[]

#### Parameters

• **nodes**: [`StringNode`](StringNode.md)[]

#### Returns

[`StringNode`](StringNode.md)[]

#### Defined in

[src/anonymizer/index.ts:43](https://github.com/langchain-ai/langsmith-sdk/blob/da3c1bb4f1396b48909bf0abac53fd717458c764/js/src/anonymizer/index.ts#L43)
37 changes: 37 additions & 0 deletions js/docs/anonymizer/interfaces/StringNodeRule.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
[**langsmith**](../../README.md) • **Docs**

***

[langsmith](../../README.md) / [anonymizer](../README.md) / StringNodeRule

# Interface: StringNodeRule

## Properties

### pattern

> **pattern**: `string` \| `RegExp`

#### Defined in

[src/anonymizer/index.ts:48](https://github.com/langchain-ai/langsmith-sdk/blob/da3c1bb4f1396b48909bf0abac53fd717458c764/js/src/anonymizer/index.ts#L48)

***

### replace?

> `optional` **replace**: `string`

#### Defined in

[src/anonymizer/index.ts:49](https://github.com/langchain-ai/langsmith-sdk/blob/da3c1bb4f1396b48909bf0abac53fd717458c764/js/src/anonymizer/index.ts#L49)

***

### type?

> `optional` **type**: `"pattern"`

#### Defined in

[src/anonymizer/index.ts:47](https://github.com/langchain-ai/langsmith-sdk/blob/da3c1bb4f1396b48909bf0abac53fd717458c764/js/src/anonymizer/index.ts#L47)
13 changes: 13 additions & 0 deletions js/docs/anonymizer/type-aliases/ReplacerType.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
[**langsmith**](../../README.md) • **Docs**

***

[langsmith](../../README.md) / [anonymizer](../README.md) / ReplacerType

# Type Alias: ReplacerType

> **ReplacerType**: (`value`, `path`?) => `string` \| [`StringNodeRule`](../interfaces/StringNodeRule.md)[] \| [`StringNodeProcessor`](../interfaces/StringNodeProcessor.md)

## Defined in

[src/anonymizer/index.ts:52](https://github.com/langchain-ai/langsmith-sdk/blob/da3c1bb4f1396b48909bf0abac53fd717458c764/js/src/anonymizer/index.ts#L52)
27 changes: 27 additions & 0 deletions js/docs/client/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
[**langsmith**](../README.md) • **Docs**

***

[langsmith](../README.md) / client

# client

## Index

### Classes

- [Client](classes/Client.md)
- [Queue](classes/Queue.md)

### Interfaces

- [ClientConfig](interfaces/ClientConfig.md)

### Type Aliases

- [CreateExampleOptions](type-aliases/CreateExampleOptions.md)
- [FeedbackSourceType](type-aliases/FeedbackSourceType.md)

### Variables

- [DEFAULT\_BATCH\_SIZE\_LIMIT\_BYTES](variables/DEFAULT_BATCH_SIZE_LIMIT_BYTES.md)
Loading
Loading