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.

Sign up for GitHub

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

docs: add support for hiding LLM invocation parameters in masking span attributes #5739

Merged
merged 1 commit into from
Dec 15, 2024
Merged

docs: add support for hiding LLM invocation parameters in masking span attributes #5739

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
3 changes: 2 additions & 1 deletion docs/tracing/how-to-tracing/customize-spans/masking-span-attributes.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ The OpenInference Specification defines a set of environment variables you can c

The possible settings are:

<table data-full-width="false"><thead><tr><th width="298">Environment Variable Name</th><th width="281">Effect</th><th width="86">Type</th><th>Default</th></tr></thead><tbody><tr><td>OPENINFERENCE_HIDE_INPUTS</td><td>Hides input value, all input messages &#x26; embedding input text</td><td>bool</td><td>False</td></tr><tr><td>OPENINFERENCE_HIDE_OUTPUTS</td><td>Hides output value &#x26; all output messages</td><td>bool</td><td>False</td></tr><tr><td>OPENINFERENCE_HIDE_INPUT_MESSAGES</td><td>Hides all input messages &#x26; embedding input text</td><td>bool</td><td>False</td></tr><tr><td>OPENINFERENCE_HIDE_OUTPUT_MESSAGES</td><td>Hides all output messages</td><td>bool</td><td>False</td></tr><tr><td>PENINFERENCE_HIDE_INPUT_IMAGES</td><td>Hides images from input messages</td><td>bool</td><td>False</td></tr><tr><td>OPENINFERENCE_HIDE_INPUT_TEXT</td><td>Hides text from input messages &#x26; input embeddings</td><td>bool</td><td>False</td></tr><tr><td>OPENINFERENCE_HIDE_OUTPUT_TEXT</td><td>Hides text from output messages</td><td>bool</td><td>False</td></tr><tr><td>OPENINFERENCE_HIDE_EMBEDDING_VECTORS</td><td>Hides returned embedding vectors</td><td>bool</td><td>False</td></tr><tr><td>OPENINFERENCE_BASE64_IMAGE_MAX_LENGTH</td><td>Limits characters of a base64 encoding of an image</td><td>int</td><td>32,000</td></tr></tbody></table>
<table data-full-width="false"><thead><tr><th width="298">Environment Variable Name</th><th width="281">Effect</th><th width="86">Type</th><th>Default</th></tr></thead><tbody><tr><td>OPENINFERENCE_HIDE_INPUTS</td><td>Hides input value, all input messages &#x26; embedding input text</td><td>bool</td><td>False</td></tr><tr><td>OPENINFERENCE_HIDE_OUTPUTS</td><td>Hides output value &#x26; all output messages</td><td>bool</td><td>False</td></tr><tr><td>OPENINFERENCE_HIDE_INPUT_MESSAGES</td><td>Hides all input messages &#x26; embedding input text</td><td>bool</td><td>False</td></tr><tr><td>OPENINFERENCE_HIDE_OUTPUT_MESSAGES</td><td>Hides all output messages</td><td>bool</td><td>False</td></tr><tr><td>PENINFERENCE_HIDE_INPUT_IMAGES</td><td>Hides images from input messages</td><td>bool</td><td>False</td></tr><tr><td>OPENINFERENCE_HIDE_INPUT_TEXT</td><td>Hides text from input messages &#x26; input embeddings</td><td>bool</td><td>False</td></tr><tr><td>OPENINFERENCE_HIDE_OUTPUT_TEXT</td><td>Hides text from output messages</td><td>bool</td><td>False</td></tr><tr><td>OPENINFERENCE_HIDE_EMBEDDING_VECTORS</td><td>Hides returned embedding vectors</td><td>bool</td><td>False</td></tr><tr><td>OPENINFERENCE_HIDE_LLM_INVOCATION_PARAMETERS</td><td>Hides LLM invocation parameters</td><td>bool</td><td>False</td></tr><tr><td>OPENINFERENCE_BASE64_IMAGE_MAX_LENGTH</td><td>Limits characters of a base64 encoding of an image</td><td>int</td><td>32,000</td></tr></tbody></table>

To set up this configuration you can either:

Expand All @@ -33,6 +33,7 @@ config = TraceConfig(
hide_input_text=...,
hide_output_text=...,
hide_embedding_vectors=...,
hide_llm_invocation_parameters=...,
base64_image_max_length=...,
)

Expand Down
Loading