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

add docs on resource tags #399

Merged
merged 3 commits into from
Aug 21, 2024
Merged
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: 18 additions & 2 deletions versioned_docs/version-2.0/concepts/admin/admin.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,10 @@ There are a few important differences between your personal organization and sha
Workspaces were formerly called Tenants. Some code and APIs may still reference the old name for a period of time during the transition.
:::

A workspace is a logical grouping of users and resources within an organization. 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/setup/set_up_workspace.mdx).
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/setup/set_up_workspace.mdx).

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.

The following image shows a sample workspace settings page:
![Sample Workspace](../static/sample_workspace.png)
Expand Down Expand Up @@ -51,8 +54,9 @@ See the table below for details on which features are available in which scope (
| Trace Projects | Workspace |
| Annotation Queues | Workspace |
| Deployments | Workspace |
| Datasets & Testing | Workspace |
| Datasets & Experiments | Workspace |
| Prompts | Workspace |
| Resource Tags | Workspace |
| API Keys | Workspace |
| Settings including Secrets, Feedback config, Models, Rules, and Shared URLs | Workspace |
| User management: Invite User to Workspace | Workspace |
Expand All @@ -68,6 +72,18 @@ See the table below for details on which features are available in which scope (
\*\* Self-hosted installations may enable workspace-level invites of users to the organization via a feature flag.
See the [self-hosted user management docs](../../self_hosting/configuration/user_management) for details.

## Resource tags

Resource tags allow you to organize resources within a workspaces. Each tag is a key-value pair that can be assigned to a resource.
Tags can be used to filter workspace-scoped resources in the UI and API: Projects, Datasets, Annotation Queues, Deployments, and Experiments.

Each new workspace comes with two default tag keys: `Application` and `Environment`; as the names suggest, these tags can be used to categorize resources based on the application and environment they belong to.
More tags can be added as needed.

LangSmith resource tags are very similar to tags in cloud services like [AWS](https://docs.aws.amazon.com/tag-editor/latest/userguide/tagging.html).

![Sample Resource Tags](../static/resource_tags.png)

## Users

A user is a person who has access to LangSmith. Users can be members of one or more organizations and workspaces within those organizations.
Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
5 changes: 5 additions & 0 deletions versioned_docs/version-2.0/how_to_guides/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,11 @@ See the following guides to set up your LangSmith account.
- [Set up access control (enterprise only)](./how_to_guides/setup/set_up_access_control)
- [Create a role](./how_to_guides/setup/set_up_access_control#create-a-role)
- [Assign a role to a user](./how_to_guides/setup/set_up_access_control#assign-a-role-to-a-user)
- [Set up resource tags](./how_to_guides/setup/set_up_resource_tags)
- [Create a tag](./how_to_guides/setup/set_up_resource_tags#create-a-tag)
- [Assign a tag to a resource](./how_to_guides/setup/set_up_resource_tags#assign-a-tag-to-a-resource)
- [Delete a tag](./how_to_guides/setup/set_up_resource_tags#delete-a-tag)
- [Filter resources by tags](./how_to_guides/setup/set_up_resource_tags#filter-resources-by-tags)

## Tracing

Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,59 @@
# Set up resource tags

:::tip Recommended Reading

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

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

:::

:::info Availability
Resource tags are available for Plus and Enterprise plans.
This feature will be rolling out week of August 19th.
:::

While workspaces help separate trust boundaries and access control, tags help you organize resources within a workspace. Tags are key-value pairs that you can attach to resources.

## Create a tag

To create a tag, head to the workspace settings and click on the "Resource Tags" tab.
Here, you'll be able to see the existing tag values, grouped by key. Two keys `Application` and `Environment` are created by default.

To create a new tag, click on the "New Tag" button. You'll be prompted to enter a key and a value for the tag. Note that you can use an existing key or create a new one.

![](../static/resource_tags/create_tag.png)

## Assign a tag to a resource

Within the same side panel for creating a new tag, you can also create assign resources to tags. Search for corresponding resources in the "Assign Resources" section and select the resources you want to tag.

:::note
You can only tag workspace-scoped resources with resource tags. This includes Tracing Projects, Annotation Queues, Deployments, Experiments, Datasets, and Prompts.
:::

You can also assign tags to resources from the resource's detail page. Click on the Resource tags button to open up the tag panel and assign tags.

![](../static/resource_tags/assign_tag.png)

To un-assign a tag from a resource, click on the Trash icon next to the tag, both in the tag panel and the resource tag panel.

## Delete a tag

You can delete either a key or a value of a tag from the [workspace settings page](https://smith.langchain.com/settings/workspaces/resource_tags). To delete a key, click on the Trash icon next to the key. To delete a value, click on the Trash icon next to the value.

Note that if you delete a key, all values associated with that key will also be deleted. When you delete a value, you will lose all associations between that value and resources.

![](../static/resource_tags/delete_tag.png)

## Filter resources by tags

You can use resource tags to organize your experience navigating resources in the workspace.

To filter resources by tags in your workspace, open up the left-hand side panel and click on the tags icon. Here, you can select the tags you want to filter by.

In the homepage, you can see updated counts for resources based on the tags you've selected.

As you navigate through the different product surfaces, you will _only_ see resources that match the tags you've selected. At any time, you can clear the tags to see all resources in the workspace or select different tags to filter by.

![](../static/resource_tags/filter_by_tags.png)
Original file line number Diff line number Diff line change
Expand Up @@ -6,10 +6,6 @@ import { RegionalUrl } from "@site/src/components/RegionalUrls";

# Set up a workspace

:::info
Workspaces will be incrementally rolled out being week of June 10, 2024.
:::

:::tip Recommended Reading

Before diving into this content, it might be helpful to read the following:
Expand All @@ -19,7 +15,9 @@ Before diving into this content, it might be helpful to read the following:
:::

When you log in for the first time, a default [workspace](../../concepts/admin/admin.mdx#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, business units, or deployment environments. Most LangSmith activity happens in the context of a workspace, each of which has its own settings.
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).

## Create a workspace

Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading