From bb77c1b7db4cbe3c09d34e14345078bc1bc24a00 Mon Sep 17 00:00:00 2001 From: Shawn Qiu Date: Tue, 30 Jul 2024 16:36:26 -0700 Subject: [PATCH] docs --- docs/v1/concepts/tags.mdx | 13 ++++++++----- 1 file changed, 8 insertions(+), 5 deletions(-) diff --git a/docs/v1/concepts/tags.mdx b/docs/v1/concepts/tags.mdx index 751f7ec4..7d8f5ebf 100644 --- a/docs/v1/concepts/tags.mdx +++ b/docs/v1/concepts/tags.mdx @@ -8,21 +8,24 @@ Ex: `paid-user`, `v3`, `recruiter-agent`' # How to use Tags -Tags belong to [Sessions](/v1/concepts/tags), but can be assigned in multiple ways. +There are two types: `tags` and `default tags`. + +Tags belong to [Sessions](/v1/concepts/sessions) and are a fantastic way to organize your Sessions. When a session is created, `default_tags` +are automatically assigned to the session alongside any tags that are passed in. ## On `init()` -Passing tags into the `init` function will assign these tags to the `Session` +Passing `default_tags` into the `init` function will assign these tags to the all subsequent Sessions. ```python python -agentops.init(tags=['test tag']) +agentops.init(default_tags=['test tag']) ``` ## `set_tags([str])` -This will override any existing tags on the session and set them to the value passed into the function. +This will override any existing tags on the session and set them to the value passed into the function. Future sessions will not have these tags. ```python python @@ -32,7 +35,7 @@ agentops.set_tags(['test new tag']) ## `add_tags([str])` -This will append an array of tags to the Session's existing tags +This will append an array of tags to the session's existing tags. Future sessions will not have these tags. ```python python