Skip to content

Commit

Permalink
link resolution: fixing broken links
Browse files Browse the repository at this point in the history
  • Loading branch information
jakerachleff committed Oct 23, 2024
1 parent cac33a6 commit 4c1f4c9
Show file tree
Hide file tree
Showing 22 changed files with 55 additions and 55 deletions.
4 changes: 2 additions & 2 deletions docs/administration/concepts/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ There are a few important differences between your personal organization and sha

| Feature | Personal | Shared |
| ------------------- | ------------------- | ------------------------------------------------------------ |
| Maximum workspaces | 1 | Variable, depending on plan (see [pricing page](../pricing)) |
| Maximum workspaces | 1 | Variable, depending on plan (see [pricing page](./pricing)) |
| Collaboration | Cannot invite users | Can invite users |
| Billing: paid plans | Developer plan only | All other plans available |

Expand All @@ -24,7 +24,7 @@ Workspaces were formerly called Tenants. Some code and APIs may still reference
:::

A workspace is a logical grouping of users and resources within an organization. A workspace separates trust boundaries for resources and access control.
Users may have permissions in a workspace that grant them access to the resources in that workspace, including tracing projects, datasets, annotation queues, and prompts. For more details, see the [setup guide](../how_to_guides/organization_management/set_up_workspace.mdx).
Users may have permissions in a workspace that grant them access to the resources in that workspace, including tracing projects, datasets, annotation queues, and prompts. For more details, see the [setup guide](./how_to_guides/organization_management/set_up_workspace).

It is recommended to create a separate workspace for each team within your organization. To organize resources even further, you can use [Resource Tags](#resource-tags) to group resources within a workspace.

Expand Down
40 changes: 20 additions & 20 deletions docs/administration/how_to_guides/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,23 +6,23 @@ Step-by-step guides that cover key tasks and operations in LangSmith.

See the following guides to set up your LangSmith account.

- [Create an account and API key](./organization_management/create_account_api_key)
- [Set up an organization](./organization_management/set_up_organization)
- [Create an organization](./organization_management/set_up_organization#create-an-organization)
- [Manage and navigate workspaces](./organization_management/set_up_organization#manage-and-navigate-workspaces)
- [Manage users](./organization_management/set_up_organization#manage-users)
- [Manage your organization using the API](./organization_management/manage_organization_by_api)
- [Set up a workspace](./organization_management/set_up_workspace)
- [Create a workspace](./organization_management/set_up_workspace#create-a-workspace)
- [Manage users](./organization_management/set_up_workspace#manage-users)
- [Configure workspace settings](./organization_management/set_up_workspace#configure-workspace-settings)
- [Set up billing](./organization_management/set_up_billing)
- [Update invoice email, tax id and, business information](./organization_management/update_business_info)
- [Set up access control (enterprise only)](./organization_management/set_up_access_control)
- [Create a role](./organization_management/set_up_access_control#create-a-role)
- [Assign a role to a user](./organization_management/set_up_access_control#assign-a-role-to-a-user)
- [Set up resource tags](./organization_management/set_up_resource_tags)
- [Create a tag](./organization_management/set_up_resource_tags#create-a-tag)
- [Assign a tag to a resource](./organization_management/set_up_resource_tags#assign-a-tag-to-a-resource)
- [Delete a tag](./organization_management/set_up_resource_tags#delete-a-tag)
- [Filter resources by tags](./organization_management/set_up_resource_tags#filter-resources-by-tags)
- [Create an account and API key](./how_to_guides/organization_management/create_account_api_key)
- [Set up an organization](./how_to_guides/organization_management/set_up_organization)
- [Create an organization](./how_to_guides/organization_management/set_up_organization#create-an-organization)
- [Manage and navigate workspaces](./how_to_guides/organization_management/set_up_organization#manage-and-navigate-workspaces)
- [Manage users](./how_to_guides/organization_management/set_up_organization#manage-users)
- [Manage your organization using the API](./how_to_guides/organization_management/manage_organization_by_api)
- [Set up a workspace](./how_to_guides/organization_management/set_up_workspace)
- [Create a workspace](./how_to_guides/organization_management/set_up_workspace#create-a-workspace)
- [Manage users](./how_to_guides/organization_management/set_up_workspace#manage-users)
- [Configure workspace settings](./how_to_guides/organization_management/set_up_workspace#configure-workspace-settings)
- [Set up billing](./how_to_guides/organization_management/set_up_billing)
- [Update invoice email, tax id and, business information](./how_to_guides/organization_management/update_business_info)
- [Set up access control (enterprise only)](./how_to_guides/organization_management/set_up_access_control)
- [Create a role](./how_to_guides/organization_management/set_up_access_control#create-a-role)
- [Assign a role to a user](./how_to_guides/organization_management/set_up_access_control#assign-a-role-to-a-user)
- [Set up resource tags](./how_to_guides/organization_management/set_up_resource_tags)
- [Create a tag](./how_to_guides/organization_management/set_up_resource_tags#create-a-tag)
- [Assign a tag to a resource](./how_to_guides/organization_management/set_up_resource_tags#assign-a-tag-to-a-resource)
- [Delete a tag](./how_to_guides/organization_management/set_up_resource_tags#delete-a-tag)
- [Filter resources by tags](./how_to_guides/organization_management/set_up_resource_tags#filter-resources-by-tags)
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ We support logging in with Google, GitHub, Discord, and email.
LangSmith supports two types of API keys: Service Keys and Personal Access Tokens.
Both types of tokens can be used to authenticate requests to the LangSmith API, but they have different use cases.

Read more about the differences between Service Keys and Personal Access Tokens under [admin concepts](../../concepts/index)
Read more about the differences between Service Keys and Personal Access Tokens under [admin concepts](../../concepts)

## Create an API key

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ LangSmith's API supports programmatic access via API key to all of the actions a

Before diving into this content, it might be helpful to read the following:

- [Conceptual guide on organizations and workspaces](../../concepts/index)
- [Conceptual guide on organizations and workspaces](../../concepts)
- [Organization setup how-to guild](.//set_up_organization.mdx)

:::
Expand All @@ -17,7 +17,7 @@ Before diving into this content, it might be helpful to read the following:
There are a few limitations that will be lifted soon:

- The LangSmith SDKs do not support these organization management actions yet.
- [Service Keys](../../concepts/index#api-keys) don't have access to newly-added workspaces yet (we're adding support soon). We recommend using a PAT of an Organization Admin for now, which by default has the required permissions for these actions.
- [Service Keys](../../concepts#api-keys) don't have access to newly-added workspaces yet (we're adding support soon). We recommend using a PAT of an Organization Admin for now, which by default has the required permissions for these actions.

:::

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,14 +4,14 @@ import { RegionalUrl } from "@site/src/components/RegionalUrls";

:::note
RBAC (Role-Based Access Control) is a feature that is only available to Enterprise customers. If you are interested in this feature, please contact our sales team at sales@langchain.dev
Other plans default to using the Admin role for all users. Read more about roles under [admin concepts](../../concepts/index)
Other plans default to using the Admin role for all users. Read more about roles under [admin concepts](../../concepts)
:::

:::tip Recommended Reading

Before diving into this content, it might be helpful to read the following:

- [Conceptual guide on organizations and workspaces](../../concepts/index)
- [Conceptual guide on organizations and workspaces](../../concepts)

:::

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ import { RegionalUrl } from "@site/src/components/RegionalUrls";

Before diving into this content, it might be helpful to read the following:

- [Conceptual guide on organizations and workspaces](../../concepts/index)
- [Conceptual guide on organizations and workspaces](../../concepts)

:::

Expand Down Expand Up @@ -59,4 +59,4 @@ The `Organization User` role is only available in organizations on plans with mu
Custom organization-scoped roles are not available yet.
:::

See [this conceptual guide](../../concepts/index#organization-roles) for a full list of permissions associated with each role.
See [this conceptual guide](../../concepts#organization-roles) for a full list of permissions associated with each role.
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

Before diving into this content, it might be helpful to read the following:

- [Conceptual guide on organizations and workspaces](../../concepts/index)
- [Conceptual guide on organizations and workspaces](../../concepts)

:::

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ SSO services permit a user to use one set of credentials (for example, a name or

- Your organization must be on an Enterprise plan
- Your Identity Provider (IdP) must support the SAML 2.0 standard
- Only [Organization Admins](../../concepts/index#organization-roles) can configure SAML SSO
- Only [Organization Admins](../../concepts#organization-roles) can configure SAML SSO

### Initial configuration

Expand Down Expand Up @@ -69,7 +69,7 @@ JIT provisioning only runs for new users i.e. users who do not already have acce
Once you have completed your configuration of SAML SSO for your organization, users will be able to login via SAML SSO in addition to [other login methods](../../../reference/authentication_authorization/authentication_methods.mdx#cloud) such as username/password and Google Authentication.

- When logged in via SAML SSO, users can only access the corresponding organization with SAML SSO configured.
- Users with SAML SSO as their only login method do not have [personal organizations](../../concepts/index#organizations)
- Users with SAML SSO as their only login method do not have [personal organizations](../../concepts#organizations)
- When logged in via any other method, users can access the organization with SAML SSO configured along with any other organizations they are a part of

## Enforce SAML SSO only
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,11 +10,11 @@ import { RegionalUrl } from "@site/src/components/RegionalUrls";

Before diving into this content, it might be helpful to read the following:

- [Conceptual guide on organizations and workspaces](../../concepts/index)
- [Conceptual guide on organizations and workspaces](../../concepts)

:::

When you log in for the first time, a default [workspace](../../concepts/index#workspaces) will be created for you automatically in your [personal organization](./set_up_organization#personal-vs-shared-organizations).
When you log in for the first time, a default [workspace](../../concepts#workspaces) will be created for you automatically in your [personal organization](./set_up_organization#personal-vs-shared-organizations).
Workspaces are often used to separate resources between different teams or business units, ensuring clear trust boundaries between them. Within each workspace, Role-Based Access Control (RBAC) is implemented to manage permissions and access levels, ensuring that users only have access to the resources and settings necessary for their role. Most LangSmith activity happens in the context of a workspace, each of which has its own settings and access controls.

To organize resources _within_ a workspace, you can use [resource tags](./set_up_resource_tags).
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ sidebar_position: 1
:::tip Recommended Reading
Before diving into this content, it might be helpful to read the following:

- [Concepts guide on evaluation and datasets](../../evaluation/concepts/index#datasets-and-examples)
- [Concepts guide on evaluation and datasets](../../evaluation/concepts#datasets-and-examples)

:::

Expand All @@ -19,7 +19,7 @@ To get started, you can create a new datasets by heading to the "Datasets and Te

![](./static/new_dataset.png)

Then, enter the relevant dataset details, including a name, optional description, and dataset type. Please see the [concepts](../../evaluation/concepts/index#datasets-and-examples) for more information on dataset types. For most flexibility, the key-value dataset type is recommended.
Then, enter the relevant dataset details, including a name, optional description, and dataset type. Please see the [concepts](../../evaluation/concepts#datasets-and-examples) for more information on dataset types. For most flexibility, the key-value dataset type is recommended.

![](./static/enter_dataset_details.png)

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ import {
:::tip Recommended Reading
Before diving into this content, it might be helpful to read the following:

- [Conceptual guide on evaluation](../../evaluation/concepts/index)
- [Conceptual guide on evaluation](../../evaluation/concepts)
- [How-to guide on managing datasets](../datasets/manage_datasets_in_application)
- [How-to guide on managing datasets programmatically](../datasets/manage_datasets_programmatically)

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ import {
:::tip Recommended Reading
Before diving into this content, it might be helpful to read the following:

- [Conceptual guide on tracing and feedback](../../observability/concepts/index)
- [Conceptual guide on tracing and feedback](../../observability/concepts)
- [Reference guide on feedback data format](../../reference/data_formats/feedback_data_format)

:::
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ import { RegionalUrl } from "@site/src/components/RegionalUrls";
:::tip Recommended Reading
Before diving into this content, it might be helpful to read the following:

- [Conceptual guide on tracing and feedback](../../observability/concepts/index)
- [Conceptual guide on tracing and feedback](../../observability/concepts)
- [Reference guide on feedback data format](../../reference/data_formats/feedback_data_format)

:::
Expand Down
8 changes: 4 additions & 4 deletions docs/observability/concepts/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -50,10 +50,10 @@ Feedback can currently be continuous or discrete (categorical), and you can reus

Collecting feedback on runs can be done in a number of ways:

1. [Sent up along with a trace](../how_to_guides/human_feedback/attach_user_feedback) from the LLM application
2. Generated by a user in the app [inline](../how_to_guides/human_feedback/annotate_traces_inline) or in an [annotation queue](../how_to_guides/human_feedback/annotation_queues)
3. Generated by an automatic evaluator during [offline evaluation](../how_to_guides/evaluation/evaluate_llm_application)
4. Generated by an [online evaluator](../how_to_guides/monitoring/online_evaluations)
1. [Sent up along with a trace](/evaluation/how_to_guides/human_feedback/attach_user_feedback) from the LLM application
2. Generated by a user in the app [inline](/evaluation/how_to_guides/human_feedback/annotate_traces_inline) or in an [annotation queue](../how_to_guides/human_feedback/annotation_queues)
3. Generated by an automatic evaluator during [offline evaluation](/evaluation/how_to_guides/evaluation/evaluate_llm_application)
4. Generated by an [online evaluator](./how_to_guides/monitoring/online_evaluations)

To learn more about how feedback is stored in the application, see [this reference guide](../reference/data_formats/feedback_data_format).

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ sidebar_position: 1

Before diving into this content, it might be helpful to read the following to gain familiarity with the concepts mentioned here:

- [Conceptual guide on tracing](../../observability/concepts/index)
- [Conceptual guide on tracing](../../observability/concepts)

:::

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ LangSmith supports sending arbitrary metadata and tags along with traces.
Tags are strings that can be used to categorize or label a trace. Metadata is a dictionary of key-value pairs that can be used to store additional information about a trace.

Both are useful for associating additional information with a trace, such as the environment in which it was executed, the user who initiated it, or an internal correlation ID.
For more information on tags and metadata, see the [Concepts](/observability/concepts/index#tags) page. For information on how to query traces and runs by metadata and tags, see the [Filter traces in the application](/how_to_guides/monitoring/filter_traces_in_application) page.
For more information on tags and metadata, see the [Concepts](/observability/concepts#tags) page. For information on how to query traces and runs by metadata and tags, see the [Filter traces in the application](/how_to_guides/monitoring/filter_traces_in_application) page.

<CodeTabs
tabs={[
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ You can change the destination project of your traces both statically through en

## Set the destination project statically

As mentioned in the [Tracing Concepts](/observability/concepts/index#projects) section, LangSmith uses the concept of a `Project` to group traces. If left unspecified, the project is set to `default`. You can set the `LANGCHAIN_PROJECT` environment variable to configure a custom project name for an entire application run. This should be done before executing your application.
As mentioned in the [Tracing Concepts](/observability/concepts#projects) section, LangSmith uses the concept of a `Project` to group traces. If left unspecified, the project is set to `default`. You can set the `LANGCHAIN_PROJECT` environment variable to configure a custom project name for an entire application run. This should be done before executing your application.

```bash
export LANGCHAIN_PROJECT=my-custom-project
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -84,7 +84,7 @@ await chain.invoke(

### Statically

As mentioned in the [tracing conceptual guide](../../observability/concepts/index) LangSmith uses the concept of a Project to group traces. If left unspecified, the tracer project is set to default. You can set the `LANGCHAIN_PROJECT` environment variable to configure a custom project name for an entire application run. This should be done before executing your application.
As mentioned in the [tracing conceptual guide](../../observability/concepts) LangSmith uses the concept of a Project to group traces. If left unspecified, the tracer project is set to default. You can set the `LANGCHAIN_PROJECT` environment variable to configure a custom project name for an entire application run. This should be done before executing your application.

```shell
export LANGCHAIN_PROJECT=my-project
Expand Down
2 changes: 1 addition & 1 deletion docs/reference/data_formats/feedback_data_format.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ sidebar_position: 2
:::tip Recommended Reading
Before diving into this content, it might be helpful to read the following:

- [Conceptual guide on tracing and feedback](../../observability/concepts/index)
- [Conceptual guide on tracing and feedback](../../observability/concepts)

:::

Expand Down
2 changes: 1 addition & 1 deletion docs/reference/data_formats/run_data_format.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ sidebar_position: 1
:::tip Recommended Reading
Before diving into this content, it might be helpful to read the following:

- [Conceptual guide on tracing and runs](../../observability/concepts/index)
- [Conceptual guide on tracing and runs](../../observability/concepts)

:::

Expand Down
2 changes: 1 addition & 1 deletion docs/tutorials/Administrators/manage_spend.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -135,7 +135,7 @@ projects page, click `Rules -> Add Rule`, and configure the rule as follows:
![](./static/P2SampleTraces.png)

Run rules match on runs rather than traces. Runs are single units of work within an LLM application's API handling. Traces
are end to end API calls (learn more about [tracing concepts in LangSmith](../../observability/concepts/index)). This means a trace can
are end to end API calls (learn more about [tracing concepts in LangSmith](../../observability/concepts)). This means a trace can
be thought of as a tree of runs making up an API call. When a run rule matches any run within a trace, the trace's full run tree
upgrades to be retained for 400 days.

Expand Down
Loading

0 comments on commit 4c1f4c9

Please sign in to comment.