Skip to content

Commit bfe1229

Browse files
committed
changed docs to reflect init() change and requirement for manual trace management
1 parent b50b709 commit bfe1229

File tree

1 file changed

+5
-1
lines changed

1 file changed

+5
-1
lines changed

docs/v2/usage/sdk-reference.mdx

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ Initializes the AgentOps SDK and automatically starts tracking your application.
2525
- `default_tags` (List[str], optional): Default tags for the sessions that can be used for grouping or sorting later (e.g. ["GPT-4"]).
2626
- `tags` (List[str], optional): [Deprecated] Use `default_tags` instead.
2727
- `instrument_llm_calls` (bool, optional): Whether to instrument LLM calls automatically. Defaults to True.
28-
- `auto_start_session` (bool, optional): Whether to start a session automatically when the client is created. Defaults to True.
28+
- `auto_start_session` (bool, optional): Whether to start a session automatically when the client is created. Set to False if running in a Jupyter Notebook. Defaults to True.
2929
- `auto_init` (bool, optional): Whether to automatically initialize the client on import. Defaults to True.
3030
- `skip_auto_end_session` (bool, optional): Don't automatically end session based on your framework's decision-making. Defaults to False.
3131
- `env_data_opt_out` (bool, optional): Whether to opt out of collecting environment data. Defaults to False.
@@ -109,6 +109,8 @@ These functions help you manage the lifecycle of tracking traces.
109109

110110
Starts a new AgentOps trace manually. This is useful when you've disabled automatic session creation or need multiple separate traces.
111111

112+
Manually managing traces is required when running in a Jupyter Notebook as there is no end state.
113+
112114
**Parameters**:
113115

114116
- `trace_name` (str, optional): Name for the trace. If not provided, a default name will be used.
@@ -134,6 +136,8 @@ trace = agentops.start_trace("customer-service-workflow", tags=["customer-query"
134136

135137
Ends a specific trace or all active traces.
136138

139+
Manually managing traces is required when running in a Jupyter Notebook as there is no end state.
140+
137141
**Parameters**:
138142

139143
- `trace` (TraceContext, optional): The specific trace to end. If not provided, all active traces will be ended.

0 commit comments

Comments
 (0)