Adding span for invoke agent (#1900)
Signed-off-by: Guangya Liu <gyliu@ibm.com>
This commit is contained in:
Guangya Liu
GitHub
parent
9f3388e01f
commit
0f5b12f74f
|
|
@ -0,0 +1,22 @@
|
|||
# Use this changelog template to create an entry for release notes.
|
||||
#
|
||||
# If your change doesn't affect end users you should instead start
|
||||
# your pull request title with [chore] or use the "Skip Changelog" label.
|
||||
|
||||
# One of 'breaking', 'deprecation', 'new_component', 'enhancement', 'bug_fix'
|
||||
change_type: enhancement
|
||||
|
||||
# The name of the area of concern in the attributes-registry, (e.g. http, cloud, db)
|
||||
component: gen-ai
|
||||
|
||||
# A brief description of the change. Surround your text with quotes ("") if it needs to start with a backtick (`).
|
||||
note: Adding span for invoke agent
|
||||
|
||||
# Mandatory: One or more tracking issues related to the change. You can use the PR number here if no issue exists.
|
||||
# The values here must be integers.
|
||||
issues: [1842]
|
||||
|
||||
# (Optional) One or more lines of additional information to render under the primary note.
|
||||
# These lines will be padded with 2 spaces and then inserted directly into the document.
|
||||
# Use pipe (|) for multiline entries.
|
||||
subtext:
|
||||
|
|
@ -12,6 +12,7 @@ linkTitle: Agent spans
|
|||
|
||||
- [Spans](#spans)
|
||||
- [Create agent span](#create-agent-span)
|
||||
- [Invoke Agent Span](#invoke-agent-span)
|
||||
- [Agent execute tool span](#agent-execute-tool-span)
|
||||
|
||||
<!-- tocstop -->
|
||||
|
|
@ -138,6 +139,160 @@ Instrumentations SHOULD document the list of errors they report.
|
|||
<!-- END AUTOGENERATED TEXT -->
|
||||
<!-- endsemconv -->
|
||||
|
||||
### Invoke Agent Span
|
||||
|
||||
Describes GenAI agent invoke and is usually applicable when working with remote agent
|
||||
services.
|
||||
|
||||
The `gen_ai.operation.name` SHOULD be `invoke_agent`.
|
||||
|
||||
The **span name** SHOULD be `invoke_agent {gen_ai.agent.name}` if `gen_ai.agent.name` is readily available.
|
||||
When `gen_ai.agent.name` is not available, it SHOULD be `invoke_agent`.
|
||||
Semantic conventions for individual GenAI systems and frameworks MAY specify different span name format.
|
||||
|
||||
<!-- semconv span.gen_ai.invoke_agent.client -->
|
||||
<!-- NOTE: THIS TEXT IS AUTOGENERATED. DO NOT EDIT BY HAND. -->
|
||||
<!-- see templates/registry/markdown/snippet.md.j2 -->
|
||||
<!-- prettier-ignore-start -->
|
||||
<!-- markdownlint-capture -->
|
||||
<!-- markdownlint-disable -->
|
||||
|
||||
**Status:** 
|
||||
|
||||
Describes GenAI agent invocation and is usually applicable when working with remote agent services.
|
||||
|
||||
The `gen_ai.operation.name` SHOULD be `invoke_agent`.
|
||||
The **span name** SHOULD be `invoke_agent {gen_ai.agent.name}` if `gen_ai.agent.name` is readily available.
|
||||
When `gen_ai.agent.name` is not available, it SHOULD be `invoke_agent`.
|
||||
Semantic conventions for individual GenAI systems and frameworks MAY specify different span name format.
|
||||
|
||||
**Span kind** SHOULD be `CLIENT`.
|
||||
|
||||
**Span status** SHOULD follow the [Recording Errors](/docs/general/recording-errors.md) document.
|
||||
|
||||
| Attribute | Type | Description | Examples | [Requirement Level](https://opentelemetry.io/docs/specs/semconv/general/attribute-requirement-level/) | Stability |
|
||||
|---|---|---|---|---|---|
|
||||
| [`gen_ai.operation.name`](/docs/attributes-registry/gen-ai.md) | string | The name of the operation being performed. [1] | `chat`; `generate_content`; `text_completion` | `Required` |  |
|
||||
| [`gen_ai.system`](/docs/attributes-registry/gen-ai.md) | string | The Generative AI product as identified by the client or server instrumentation. [2] | `openai` | `Required` |  |
|
||||
| [`error.type`](/docs/attributes-registry/error.md) | string | Describes a class of error the operation ended with. [3] | `timeout`; `java.net.UnknownHostException`; `server_certificate_invalid`; `500` | `Conditionally Required` if the operation ended in an error |  |
|
||||
| [`gen_ai.agent.description`](/docs/attributes-registry/gen-ai.md) | string | Free-form description of the GenAI agent provided by the application. | `Helps with math problems`; `Generates fiction stories` | `Conditionally Required` when available |  |
|
||||
| [`gen_ai.agent.id`](/docs/attributes-registry/gen-ai.md) | string | The unique identifier of the GenAI agent. | `asst_5j66UpCpwteGg4YSxUnt7lPY` | `Conditionally Required` if applicable. |  |
|
||||
| [`gen_ai.agent.name`](/docs/attributes-registry/gen-ai.md) | string | Human-readable name of the GenAI agent provided by the application. | `Math Tutor`; `Fiction Writer` | `Conditionally Required` when available |  |
|
||||
| [`gen_ai.output.type`](/docs/attributes-registry/gen-ai.md) | string | Represents the content type requested by the client. [4] | `text`; `json`; `image` | `Conditionally Required` [5] |  |
|
||||
| [`gen_ai.request.choice.count`](/docs/attributes-registry/gen-ai.md) | int | The target number of candidate completions to return. | `3` | `Conditionally Required` if available, in the request, and !=1 |  |
|
||||
| [`gen_ai.request.model`](/docs/attributes-registry/gen-ai.md) | string | The name of the GenAI model a request is being made to. [6] | `gpt-4` | `Conditionally Required` If available. |  |
|
||||
| [`gen_ai.request.seed`](/docs/attributes-registry/gen-ai.md) | int | Requests with same seed value more likely to return same result. | `100` | `Conditionally Required` if applicable and if the request includes a seed |  |
|
||||
| [`server.port`](/docs/attributes-registry/server.md) | int | GenAI server port. [7] | `80`; `8080`; `443` | `Conditionally Required` If `server.address` is set. |  |
|
||||
| [`gen_ai.request.frequency_penalty`](/docs/attributes-registry/gen-ai.md) | double | The frequency penalty setting for the GenAI request. | `0.1` | `Recommended` |  |
|
||||
| [`gen_ai.request.max_tokens`](/docs/attributes-registry/gen-ai.md) | int | The maximum number of tokens the model generates for a request. | `100` | `Recommended` |  |
|
||||
| [`gen_ai.request.presence_penalty`](/docs/attributes-registry/gen-ai.md) | double | The presence penalty setting for the GenAI request. | `0.1` | `Recommended` |  |
|
||||
| [`gen_ai.request.stop_sequences`](/docs/attributes-registry/gen-ai.md) | string[] | List of sequences that the model will use to stop generating further tokens. | `["forest", "lived"]` | `Recommended` |  |
|
||||
| [`gen_ai.request.temperature`](/docs/attributes-registry/gen-ai.md) | double | The temperature setting for the GenAI request. | `0.0` | `Recommended` |  |
|
||||
| [`gen_ai.request.top_p`](/docs/attributes-registry/gen-ai.md) | double | The top_p sampling setting for the GenAI request. | `1.0` | `Recommended` |  |
|
||||
| [`gen_ai.response.finish_reasons`](/docs/attributes-registry/gen-ai.md) | string[] | Array of reasons the model stopped generating tokens, corresponding to each generation received. | `["stop"]`; `["stop", "length"]` | `Recommended` |  |
|
||||
| [`gen_ai.response.id`](/docs/attributes-registry/gen-ai.md) | string | The unique identifier for the completion. | `chatcmpl-123` | `Recommended` |  |
|
||||
| [`gen_ai.response.model`](/docs/attributes-registry/gen-ai.md) | string | The name of the model that generated the response. [8] | `gpt-4-0613` | `Recommended` |  |
|
||||
| [`gen_ai.usage.input_tokens`](/docs/attributes-registry/gen-ai.md) | int | The number of tokens used in the GenAI input (prompt). | `100` | `Recommended` |  |
|
||||
| [`gen_ai.usage.output_tokens`](/docs/attributes-registry/gen-ai.md) | int | The number of tokens used in the GenAI response (completion). | `180` | `Recommended` |  |
|
||||
| [`server.address`](/docs/attributes-registry/server.md) | string | GenAI server address. [9] | `example.com`; `10.1.2.80`; `/tmp/my.sock` | `Recommended` |  |
|
||||
|
||||
**[1] `gen_ai.operation.name`:** If one of the predefined values applies, but specific system uses a different name it's RECOMMENDED to document it in the semantic conventions for specific GenAI system and use system-specific name in the instrumentation. If a different name is not documented, instrumentation libraries SHOULD use applicable predefined value.
|
||||
|
||||
**[2] `gen_ai.system`:** The `gen_ai.system` describes a family of GenAI models with specific model identified
|
||||
by `gen_ai.request.model` and `gen_ai.response.model` attributes.
|
||||
|
||||
The actual GenAI product may differ from the one identified by the client.
|
||||
Multiple systems, including Azure OpenAI and Gemini, are accessible by OpenAI client
|
||||
libraries. In such cases, the `gen_ai.system` is set to `openai` based on the
|
||||
instrumentation's best knowledge, instead of the actual system. The `server.address`
|
||||
attribute may help identify the actual system in use for `openai`.
|
||||
|
||||
For custom model, a custom friendly name SHOULD be used.
|
||||
If none of these options apply, the `gen_ai.system` SHOULD be set to `_OTHER`.
|
||||
|
||||
**[3] `error.type`:** The `error.type` SHOULD match the error code returned by the Generative AI provider or the client library,
|
||||
the canonical name of exception that occurred, or another low-cardinality error identifier.
|
||||
Instrumentations SHOULD document the list of errors they report.
|
||||
|
||||
**[4] `gen_ai.output.type`:** This attribute SHOULD be used when the client requests output of a specific type. The model may return zero or more outputs of this type.
|
||||
This attribute specifies the output modality and not the actual output format. For example, if an image is requested, the actual output could be a URL pointing to an image file.
|
||||
Additional output format details may be recorded in the future in the `gen_ai.output.{type}.*` attributes.
|
||||
|
||||
**[5] `gen_ai.output.type`:** when applicable and if the request includes an output format.
|
||||
|
||||
**[6] `gen_ai.request.model`:** The name of the GenAI model a request is being made to. If the model is supplied by a vendor, then the value must be the exact name of the model requested. If the model is a fine-tuned custom model, the value should have a more specific name than the base model that's been fine-tuned.
|
||||
|
||||
**[7] `server.port`:** When observed from the client side, and when communicating through an intermediary, `server.port` SHOULD represent the server port behind any intermediaries, for example proxies, if it's available.
|
||||
|
||||
**[8] `gen_ai.response.model`:** If available. The name of the GenAI model that provided the response. If the model is supplied by a vendor, then the value must be the exact name of the model actually used. If the model is a fine-tuned custom model, the value should have a more specific name than the base model that's been fine-tuned.
|
||||
|
||||
**[9] `server.address`:** When observed from the client side, and when communicating through an intermediary, `server.address` SHOULD represent the server address behind any intermediaries, for example proxies, if it's available.
|
||||
|
||||
---
|
||||
|
||||
`error.type` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used.
|
||||
|
||||
| Value | Description | Stability |
|
||||
|---|---|---|
|
||||
| `_OTHER` | A fallback error value to be used when the instrumentation doesn't define a custom value. |  |
|
||||
|
||||
---
|
||||
|
||||
`gen_ai.operation.name` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used.
|
||||
|
||||
| Value | Description | Stability |
|
||||
|---|---|---|
|
||||
| `chat` | Chat completion operation such as [OpenAI Chat API](https://platform.openai.com/docs/api-reference/chat) |  |
|
||||
| `create_agent` | Create GenAI agent |  |
|
||||
| `embeddings` | Embeddings operation such as [OpenAI Create embeddings API](https://platform.openai.com/docs/api-reference/embeddings/create) |  |
|
||||
| `execute_tool` | Execute a tool |  |
|
||||
| `generate_content` | Multimodal content generation operation such as [Gemini Generate Content](https://ai.google.dev/api/generate-content) |  |
|
||||
| `text_completion` | Text completions operation such as [OpenAI Completions API (Legacy)](https://platform.openai.com/docs/api-reference/completions) |  |
|
||||
|
||||
---
|
||||
|
||||
`gen_ai.output.type` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used.
|
||||
|
||||
| Value | Description | Stability |
|
||||
|---|---|---|
|
||||
| `image` | Image |  |
|
||||
| `json` | JSON object with known or unknown schema |  |
|
||||
| `speech` | Speech |  |
|
||||
| `text` | Plain text |  |
|
||||
|
||||
---
|
||||
|
||||
`gen_ai.system` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used.
|
||||
|
||||
| Value | Description | Stability |
|
||||
|---|---|---|
|
||||
| `anthropic` | Anthropic |  |
|
||||
| `aws.bedrock` | AWS Bedrock |  |
|
||||
| `az.ai.inference` | Azure AI Inference |  |
|
||||
| `az.ai.openai` | Azure OpenAI |  |
|
||||
| `cohere` | Cohere |  |
|
||||
| `deepseek` | DeepSeek |  |
|
||||
| `gcp.gemini` | Gemini [10] |  |
|
||||
| `gcp.gen_ai` | Any Google generative AI endpoint [11] |  |
|
||||
| `gcp.vertex_ai` | Vertex AI [12] |  |
|
||||
| `groq` | Groq |  |
|
||||
| `ibm.watsonx.ai` | IBM Watsonx AI |  |
|
||||
| `mistral_ai` | Mistral AI |  |
|
||||
| `openai` | OpenAI |  |
|
||||
| `perplexity` | Perplexity |  |
|
||||
| `xai` | xAI |  |
|
||||
|
||||
**[10]:** This refers to the 'generativelanguage.googleapis.com' endpoint. Also known as the AI Studio API. May use common attributes prefixed with 'gcp.gen_ai.'.
|
||||
|
||||
**[11]:** May be used when specific backend is unknown. May use common attributes prefixed with 'gcp.gen_ai.'.
|
||||
|
||||
**[12]:** This refers to the 'aiplatform.googleapis.com' endpoint. May use common attributes prefixed with 'gcp.gen_ai.'.
|
||||
|
||||
<!-- markdownlint-restore -->
|
||||
<!-- prettier-ignore-end -->
|
||||
<!-- END AUTOGENERATED TEXT -->
|
||||
<!-- endsemconv -->
|
||||
|
||||
## Agent execute tool span
|
||||
|
||||
If you are using some tools in your agent, refer to [Execute Tool Span](./gen-ai-spans.md#execute-tool-span).
|
||||
|
|
|
|||
|
|
@ -219,6 +219,32 @@ groups:
|
|||
requirement_level:
|
||||
conditionally_required: If provided by the application.
|
||||
|
||||
- id: span.gen_ai.invoke_agent.client
|
||||
type: span
|
||||
stability: development
|
||||
span_kind: client
|
||||
brief: >
|
||||
Describes GenAI agent invocation and is usually applicable when working
|
||||
with remote agent services.
|
||||
note: |
|
||||
The `gen_ai.operation.name` SHOULD be `invoke_agent`.
|
||||
The **span name** SHOULD be `invoke_agent {gen_ai.agent.name}` if `gen_ai.agent.name` is readily available.
|
||||
When `gen_ai.agent.name` is not available, it SHOULD be `invoke_agent`.
|
||||
Semantic conventions for individual GenAI systems and frameworks MAY specify different span name format.
|
||||
extends: attributes.gen_ai.inference.client
|
||||
attributes:
|
||||
- ref: gen_ai.system
|
||||
requirement_level: required
|
||||
- ref: gen_ai.agent.id
|
||||
requirement_level:
|
||||
conditionally_required: if applicable.
|
||||
- ref: gen_ai.agent.name
|
||||
requirement_level:
|
||||
conditionally_required: when available
|
||||
- ref: gen_ai.agent.description
|
||||
requirement_level:
|
||||
conditionally_required: when available
|
||||
|
||||
- id: span.gen_ai.execute_tool.internal
|
||||
type: span
|
||||
stability: development
|
||||
|
|
|
|||
Loading…
Reference in New Issue