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

[Observability AI Assistant] Parse function responses when copying conversation #181216

Closed
dgieselaar opened this issue Apr 19, 2024 · 0 comments · Fixed by #195635
Closed

[Observability AI Assistant] Parse function responses when copying conversation #181216

dgieselaar opened this issue Apr 19, 2024 · 0 comments · Fixed by #195635
Assignees
Milestone

Comments

@dgieselaar
Copy link
Member

We have a "Copy conversation" feature which is useful for debugging purposes - it copies the JSON of the conversation to the clipboard. However, as function requests and responses are serialized separately, it can sometimes be cumbersome to get the data that we need. When copying conversations, we should first deserialize the function requests (function_call.arguments) and responses (content and data where name is set).

@emma-raffenne emma-raffenne added this to the 8.15 milestone Apr 23, 2024
@emma-raffenne emma-raffenne modified the milestones: 8.15, 8.16 Jul 11, 2024
viduni94 added a commit to viduni94/kibana that referenced this issue Oct 9, 2024
viduni94 added a commit to viduni94/kibana that referenced this issue Oct 9, 2024
viduni94 added a commit to viduni94/kibana that referenced this issue Oct 9, 2024
viduni94 added a commit to viduni94/kibana that referenced this issue Oct 9, 2024
viduni94 added a commit to viduni94/kibana that referenced this issue Oct 13, 2024
viduni94 added a commit to viduni94/kibana that referenced this issue Oct 13, 2024
viduni94 added a commit to viduni94/kibana that referenced this issue Oct 15, 2024
viduni94 added a commit to viduni94/kibana that referenced this issue Oct 15, 2024
viduni94 added a commit to viduni94/kibana that referenced this issue Oct 15, 2024
viduni94 added a commit to viduni94/kibana that referenced this issue Oct 15, 2024
viduni94 added a commit to viduni94/kibana that referenced this issue Oct 15, 2024
viduni94 added a commit to viduni94/kibana that referenced this issue Oct 15, 2024
viduni94 added a commit to viduni94/kibana that referenced this issue Oct 15, 2024
viduni94 added a commit to viduni94/kibana that referenced this issue Oct 15, 2024
viduni94 added a commit to viduni94/kibana that referenced this issue Oct 15, 2024
viduni94 added a commit to viduni94/kibana that referenced this issue Oct 15, 2024
viduni94 added a commit to viduni94/kibana that referenced this issue Oct 15, 2024
viduni94 added a commit to viduni94/kibana that referenced this issue Oct 15, 2024
kibanamachine pushed a commit to kibanamachine/kibana that referenced this issue Oct 16, 2024
…lastic#195635)

Closes elastic#181216

## Summary

### Problem
Function call arguments and responses are serialized separately.
Therefore, when a conversation is copied, arguments and responses
(`content` and `data`) appear as strings instead of JSON objects. This
makes it harder to debug.

### Solution
Deserialize the arguments and responses and include it in the copied
conversation object.

Example of original copied conversation:
<details>
  <summary>Click to expand JSON</summary>

```json
{
  "title": "",
  "messages": [
    {
      "@timestamp": "2024-10-09T13:58:41.723Z",
      "message": {
        "role": "system",
        "content": "You are a helpful assistant for Elastic Observability...."
      }
    },
    {
      "@timestamp": "2024-10-09T13:58:26.881Z",
      "message": { "role": "user", "content": "Give me examples of questions I can ask here." }
    },
    {
      "@timestamp": "2024-10-09T13:58:26.965Z",
      "message": { "role": "assistant", "function_call": { "name": "context", "trigger": "assistant" }, "content": "" }
    },
    {
      "@timestamp": "2024-10-09T13:58:27.063Z",
      "message": {
        "role": "user",
        "data": "{\"scores\":[],\"suggestions\":[]}",
        "name": "context",
        "content": "{\"screen_description\":\"The user is looking at http://localhost:5601/kyq/app/observability/overview?rangeFrom=now-15m&rangeTo=now. The current time range is 2024-10-09T13:40:00.288Z - 2024-10-09T13:55:00.288Z.\\n\\nThe user is viewing the Overview page which shows a summary of the following apps: {\\\"universal_profiling\\\":{\\\"hasData\\\":false,\\\"status\\\":\\\"success\\\"},\\\"uptime\\\":{\\\"hasData\\\":false,\\\"indices\\\":\\\"heartbeat-*\\\",\\\"status\\\":\\\"success\\\"},\\\"infra_metrics\\\":{\\\"hasData\\\":false,\\\"indices\\\":\\\"metrics-*,metricbeat-*\\\",\\\"status\\\":\\\"success\\\"},\\\"alert\\\":{\\\"hasData\\\":false,\\\"status\\\":\\\"success\\\"},\\\"apm\\\":{\\\"hasData\\\":false,\\\"indices\\\":{\\\"transaction\\\":\\\"traces-apm*,apm-*,traces-*.otel-*\\\",\\\"span\\\":\\\"traces-apm*,apm-*,traces-*.otel-*\\\",\\\"error\\\":\\\"logs-apm*,apm-*,logs-*.otel-*\\\",\\\"metric\\\":\\\"metrics-apm*,apm-*,metrics-*.otel-*\\\",\\\"onboarding\\\":\\\"apm-*\\\",\\\"sourcemap\\\":\\\"apm-*\\\"},\\\"status\\\":\\\"success\\\"},\\\"ux\\\":{\\\"hasData\\\":false,\\\"indices\\\":\\\"traces-apm*,apm-*,traces-*.otel-*,logs-apm*,apm-*,logs-*.otel-*,metrics-apm*,apm-*,metrics-*.otel-*\\\",\\\"status\\\":\\\"success\\\"},\\\"infra_logs\\\":{\\\"hasData\\\":false,\\\"indices\\\":\\\"logs-*-*,logs-*,filebeat-*,kibana_sample_data_logs*\\\",\\\"status\\\":\\\"success\\\"}}\",\"learnings\":[]}"
      }
    },
    {
      "@timestamp": "2024-10-09T13:58:35.140Z",
      "message": {
        "role": "assistant",
        "function_call": { "name": "", "arguments": "", "trigger": "assistant" },
        "content": "Sure, here are some examples of questions you can ask:\n\n1. \"What is the average response time for my services?\"\n2. \"Show me the error rate for my services.\"\n3. \"Are there any anomalies in my system?\"\n4. \"What are the top 5 services by transaction volume?\"\n5. \"Show me the logs for a specific service.\"\n6. \"Are there any alerts in my system?\"\n7. \"What is the CPU usage of my hosts?\"\n8. \"Show me the network traffic in my system.\"\n9. \"What is the disk usage of my hosts?\"\n10. \"Show me the memory usage of my containers.\"\n\nPlease note that the actual questions you can ask depend on the data you have in your system."
      }
    },
    {
      "@timestamp": "2024-10-09T13:58:41.651Z",
      "message": { "role": "user", "content": "What are the top 5 services by transaction volume" }
    },
    {
      "@timestamp": "2024-10-09T13:58:41.723Z",
      "message": { "role": "assistant", "function_call": { "name": "context", "trigger": "assistant" }, "content": "" }
    },
    {
      "@timestamp": "2024-10-09T13:58:41.784Z",
      "message": {
        "role": "user",
        "data": "{\"scores\":[],\"suggestions\":[]}",
        "name": "context",
        "content": "{\"screen_description\":\"The user is looking at http://localhost:5601/kyq/app/observability/overview?rangeFrom=now-15m&rangeTo=now. The current time range is 2024-10-09T13:40:00.288Z - 2024-10-09T13:55:00.288Z.\\n\\nThe user is viewing the Overview page which shows a summary of the following apps: {\\\"universal_profiling\\\":{\\\"hasData\\\":false,\\\"status\\\":\\\"success\\\"},\\\"uptime\\\":{\\\"hasData\\\":false,\\\"indices\\\":\\\"heartbeat-*\\\",\\\"status\\\":\\\"success\\\"},\\\"infra_metrics\\\":{\\\"hasData\\\":false,\\\"indices\\\":\\\"metrics-*,metricbeat-*\\\",\\\"status\\\":\\\"success\\\"},\\\"alert\\\":{\\\"hasData\\\":false,\\\"status\\\":\\\"success\\\"},\\\"apm\\\":{\\\"hasData\\\":false,\\\"indices\\\":{\\\"transaction\\\":\\\"traces-apm*,apm-*,traces-*.otel-*\\\",\\\"span\\\":\\\"traces-apm*,apm-*,traces-*.otel-*\\\",\\\"error\\\":\\\"logs-apm*,apm-*,logs-*.otel-*\\\",\\\"metric\\\":\\\"metrics-apm*,apm-*,metrics-*.otel-*\\\",\\\"onboarding\\\":\\\"apm-*\\\",\\\"sourcemap\\\":\\\"apm-*\\\"},\\\"status\\\":\\\"success\\\"},\\\"ux\\\":{\\\"hasData\\\":false,\\\"indices\\\":\\\"traces-apm*,apm-*,traces-*.otel-*,logs-apm*,apm-*,logs-*.otel-*,metrics-apm*,apm-*,metrics-*.otel-*\\\",\\\"status\\\":\\\"success\\\"},\\\"infra_logs\\\":{\\\"hasData\\\":false,\\\"indices\\\":\\\"logs-*-*,logs-*,filebeat-*,kibana_sample_data_logs*\\\",\\\"status\\\":\\\"success\\\"}}\",\"learnings\":[]}"
      }
    },
    {
      "@timestamp": "2024-10-09T13:58:43.370Z",
      "message": {
        "role": "assistant",
        "function_call": {
          "name": "get_dataset_info",
          "arguments": "{\n  \"index\": \"traces-apm*,apm-*,traces-*.otel-*\"\n}",
          "trigger": "assistant"
        },
        "content": ""
      }
    },
    {
      "@timestamp": "2024-10-09T13:58:43.379Z",
      "message": { "role": "user", "name": "get_dataset_info", "content": "{\"indices\":[],\"fields\":[]}" }
    },
    {
      "@timestamp": "2024-10-09T13:58:43.998Z",
      "message": {
        "role": "assistant",
        "function_call": { "name": "query", "arguments": "{}", "trigger": "assistant" },
        "content": ""
      }
    },
    {
      "@timestamp": "2024-10-09T13:58:47.572Z",
      "message": {
        "role": "user",
        "data": "{\"keywords\":[\"STATS\",\"SORT\",\"LIMIT\",\"COUNT\"],\"requestedDocumentation\":{\"STATS\":\"# STATS ... BY\\n\\nThe `STATS ... BY` command groups rows based on a common value and calculates one or more aggregated values over these grouped rows.\\n\\n## Syntax\\n\\n```esql\\nSTATS [column1 =] expression1[, ..., [columnN =] expressionN] [BY grouping_expression1[, ..., grouping_expressionN]]\\n```\\n\\n### Parameters\\n\\n#### columnX\\n\\nThe name for the aggregated value in the output. If not provided...."}}",
        "name": "query",
        "content": "{}"
      }
    },
    {
      "@timestamp": "2024-10-09T13:58:51.481Z",
      "message": {
        "role": "assistant",
        "function_call": {
          "name": "execute_query",
          "arguments": "{\"query\":\"FROM traces-apm*,apm-*,traces-*.otel-* | STATS COUNT(*) BY service.name | SORT COUNT(*) DESC | LIMIT 5\"}",
          "trigger": "assistant"
        },
        "content": ""
      }
    },
    {
      "@timestamp": "2024-10-09T13:58:51.619Z",
      "message": {
        "role": "user",
        "name": "execute_query",
        "content": "{\"message\":\"The query failed to execute\",\"error\":{\"name\":\"ResponseError\",\"message\":\"verification_exception\\n\\tRoot causes:\\n\\t\\tverification_exception: Found 1 problem\\nline 1:1: Unknown index [traces-apm*,apm-*,traces-*.otel-*]\"}}"
      }
    },
    {
      "@timestamp": "2024-10-09T13:58:56.600Z",
      "message": {
        "role": "assistant",
        "function_call": { "name": "", "arguments": "", "trigger": "assistant" },
        "content": "I'm sorry, but it seems like there are no indices matching the pattern \"traces-apm*,apm-*,traces-*.otel-*\" in your system. Therefore, I'm unable to retrieve the top 5 services by transaction volume. Please ensure that your APM data is being ingested correctly into Elasticsearch."
      }
    }
  ]
}
```
</details>
<br/>
Copied conversation after deserializing:
<details>
  <summary>Click to expand JSON</summary>

```json
{
  "title": "",
  "messages": [
    {
      "@timestamp": "2024-10-09T13:58:41.723Z",
      "message": {
        "role": "system",
        "content": "You are a helpful assistant for Elastic Observability. Your goal is to help the Elastic Observability users to quickly assess what is happening in their observed systems..."
      }
    },
    {
      "@timestamp": "2024-10-09T13:58:26.881Z",
      "message": { "role": "user", "content": "Give me examples of questions I can ask here." }
    },
    {
      "@timestamp": "2024-10-09T13:58:26.965Z",
      "message": { "role": "assistant", "function_call": { "name": "context", "trigger": "assistant" }, "content": "" }
    },
    {
      "@timestamp": "2024-10-09T13:58:27.063Z",
      "message": {
        "role": "user",
        "data": { "scores": [], "suggestions": [] },
        "name": "context",
        "content": {
          "screen_description": "The user is looking at http://localhost:5601/kyq/app/observability/overview?rangeFrom=now-15m&rangeTo=now. The current time range is 2024-10-09T13:40:00.288Z - 2024-10-09T13:55:00.288Z.\n\nThe user is viewing the Overview page which shows a summary of the following apps: {\"universal_profiling\":{\"hasData\":false,\"status\":\"success\"},\"uptime\":{\"hasData\":false,\"indices\":\"heartbeat-*\",\"status\":\"success\"},\"infra_metrics\":{\"hasData\":false,\"indices\":\"metrics-*,metricbeat-*\",\"status\":\"success\"},\"alert\":{\"hasData\":false,\"status\":\"success\"},\"apm\":{\"hasData\":false,\"indices\":{\"transaction\":\"traces-apm*,apm-*,traces-*.otel-*\",\"span\":\"traces-apm*,apm-*,traces-*.otel-*\",\"error\":\"logs-apm*,apm-*,logs-*.otel-*\",\"metric\":\"metrics-apm*,apm-*,metrics-*.otel-*\",\"onboarding\":\"apm-*\",\"sourcemap\":\"apm-*\"},\"status\":\"success\"},\"ux\":{\"hasData\":false,\"indices\":\"traces-apm*,apm-*,traces-*.otel-*,logs-apm*,apm-*,logs-*.otel-*,metrics-apm*,apm-*,metrics-*.otel-*\",\"status\":\"success\"},\"infra_logs\":{\"hasData\":false,\"indices\":\"logs-*-*,logs-*,filebeat-*,kibana_sample_data_logs*\",\"status\":\"success\"}}",
          "learnings": []
        }
      }
    },
    {
      "@timestamp": "2024-10-09T13:58:35.140Z",
      "message": {
        "role": "assistant",
        "function_call": { "name": "", "arguments": "", "trigger": "assistant" },
        "content": "Sure, here are some examples of questions..."
      }
    },
    {
      "@timestamp": "2024-10-09T13:58:41.651Z",
      "message": { "role": "user", "content": "What are the top 5 services by transaction volume" }
    },
    {
      "@timestamp": "2024-10-09T13:58:41.723Z",
      "message": { "role": "assistant", "function_call": { "name": "context", "trigger": "assistant" }, "content": "" }
    },
    {
      "@timestamp": "2024-10-09T13:58:41.784Z",
      "message": {
        "role": "user",
        "data": { "scores": [], "suggestions": [] },
        "name": "context",
        "content": {
          "screen_description": "The user is looking at http://localhost:5601/kyq/app/observability/overview?rangeFrom=now-15m&rangeTo=now. The current time range is 2024-10-09T13:40:00.288Z - 2024-10-09T13:55:00.288Z.\n\nThe user is viewing the Overview page which shows a summary of the following apps: {\"universal_profiling\":{\"hasData\":false,\"status\":\"success\"},\"uptime\":{\"hasData\":false,\"indices\":\"heartbeat-*\",\"status\":\"success\"},\"infra_metrics\":{\"hasData\":false,\"indices\":\"metrics-*,metricbeat-*\",\"status\":\"success\"},\"alert\":{\"hasData\":false,\"status\":\"success\"},\"apm\":{\"hasData\":false,\"indices\":{\"transaction\":\"traces-apm*,apm-*,traces-*.otel-*\",\"span\":\"traces-apm*,apm-*,traces-*.otel-*\",\"error\":\"logs-apm*,apm-*,logs-*.otel-*\",\"metric\":\"metrics-apm*,apm-*,metrics-*.otel-*\",\"onboarding\":\"apm-*\",\"sourcemap\":\"apm-*\"},\"status\":\"success\"},\"ux\":{\"hasData\":false,\"indices\":\"traces-apm*,apm-*,traces-*.otel-*,logs-apm*,apm-*,logs-*.otel-*,metrics-apm*,apm-*,metrics-*.otel-*\",\"status\":\"success\"},\"infra_logs\":{\"hasData\":false,\"indices\":\"logs-*-*,logs-*,filebeat-*,kibana_sample_data_logs*\",\"status\":\"success\"}}",
          "learnings": []
        }
      }
    },
    {
      "@timestamp": "2024-10-09T13:58:43.370Z",
      "message": {
        "role": "assistant",
        "function_call": {
          "name": "get_dataset_info",
          "arguments": { "index": "traces-apm*,apm-*,traces-*.otel-*" },
          "trigger": "assistant"
        },
        "content": ""
      }
    },
    {
      "@timestamp": "2024-10-09T13:58:43.379Z",
      "message": { "role": "user", "name": "get_dataset_info", "content": { "indices": [], "fields": [] } }
    },
    {
      "@timestamp": "2024-10-09T13:58:43.998Z",
      "message": {
        "role": "assistant",
        "function_call": { "name": "query", "arguments": {}, "trigger": "assistant" },
        "content": ""
      }
    },
    {
      "@timestamp": "2024-10-09T13:58:47.572Z",
      "message": {
        "role": "user",
        "data": {
          "keywords": ["STATS", "SORT", "LIMIT", "COUNT"],
          "requestedDocumentation": {
            "STATS": "# STATS ... BY\n\nThe `STATS ... BY`...",
            "SORT": "# SORT\n\nThe SORT command...",
            "LIMIT": "# LIMIT\n\nThe LIMIT command...",
            "COUNT": "# COUNT\n\n....",
            "SYNTAX": "# ES|QL Syntax Guide....",
            "OVERVIEW": "## ES|QL Overview\n\n### ES|QL....",
            "OPERATORS": "# ES|QL Operators\n\nThis document...."
          }
        },
        "name": "query",
        "content": {}
      }
    },
    {
      "@timestamp": "2024-10-09T13:58:51.481Z",
      "message": {
        "role": "assistant",
        "function_call": {
          "name": "execute_query",
          "arguments": {
            "query": "FROM traces-apm*,apm-*,traces-*.otel-* | STATS COUNT(*) BY service.name | SORT COUNT(*) DESC | LIMIT 5"
          },
          "trigger": "assistant"
        },
        "content": ""
      }
    },
    {
      "@timestamp": "2024-10-09T13:58:51.619Z",
      "message": {
        "role": "user",
        "name": "execute_query",
        "content": {
          "message": "The query failed to execute",
          "error": {
            "name": "ResponseError",
            "message": "verification_exception\n\tRoot causes:\n\t\tverification_exception: Found 1 problem\nline 1:1: Unknown index [traces-apm*,apm-*,traces-*.otel-*]"
          }
        }
      }
    },
    {
      "@timestamp": "2024-10-09T13:58:56.600Z",
      "message": {
        "role": "assistant",
        "function_call": { "name": "", "arguments": "", "trigger": "assistant" },
        "content": "I'm sorry, but it seems like there are no indices matching the pattern \"traces-apm*,apm-*,traces-*.otel-*\" in your system. Therefore, I'm unable to retrieve the top 5 services by transaction volume. Please ensure that your APM data is being ingested correctly into Elasticsearch."
      }
    }
  ]
}
```
</details>

(cherry picked from commit e34876a)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants