Skip to content

[Internal]: Update Observability AI Assistant available functions docs #1990

Open
@eleonoramicozzi

Description

@eleonoramicozzi

Description

The Observability AI Assistant documentation currently includes outdated information in the "Suggest functions" section. Specifically, several functions listed are no longer available in the codebase and should be removed. Additionally, there are multiple functions present in the codebase that are not currently documented and should be added.

Functions to remove (no longer available):

  • get_apm_error_document
  • get_apm_service_summary
  • get_apm_correlations

Functions to add (currently available but undocumented):

  • get_apm_dataset_info
  • execute_connector
  • get_data_on_screen
  • context
  • get_dataset_info
  • get_alerts_dataset_info
  • retrieve_elastic_doc
  • changes
  • execute_query
  • query

Resources

The 3 functions to be removed were removed in this PR. In the same PR, the get_apm_dataset_info, get_dataset_info and changes functions were also introduced.

Here's the location of the folder where most functions are defined: x-pack/platform/plugins/shared/observability_ai_assistant/server/functions as well as x-pack/solutions/observability/plugins/apm/server/assistant_functions for apm related functions.

Which documentation set does this change impact?

Elastic On-Prem and Cloud (all)

Feature differences

N/A

What release is this request related to?

N/A

Serverless release

This is already available

Collaboration model

The documentation team

Point of contact.

Main contact: @eleonoramicozzi

Stakeholders: @elastic/obs-ai-assistant

Metadata

Metadata

Assignees

Labels

Team:ExperienceIssues owned by the Experience Docs Team

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions