Copilot Pre-built Skills¶
Insights Hub Copilot comes with a set of pre-built skills for data access and other basic capabilities. You can use these pre-built skills to create or enhance your own agents. If you require specific capabilities that are not provided by these pre-built skills, you can easily create your own. Please refer to Create custom agents and skills for further instructions.
This section provides information on the pre-built skills provided and their parameters.
GetAssetInfo¶
Description:
This skill provides information about the Insights Hub asset model.
- When the optional parameter
name
is provided and one or more matching assets are found, it returns a list of assets. - If the optional parameter
assetId
is provided, it gets details of the asset such as hierarchy path, asset id and name and child assets. The number of child asset can be controlled by using the pagination parameters (page
andsize
).
Parameters:
name
(string): The name of the asset as string. Name should be provided with full name, including the path to the asset.assetId
(string): The id of the asset as string.page
(number): The page belongs to pagination and is given as an integer number. Page number starts with 0.size
(number): The size belongs to pagination and is given as an integer number. It configures how many items (records) are wanted per page.
GetTimeInfo¶
Description:
This skill returns a time range or the current time.
- It parses the
timeDescription
and returnsstartTime
andendTime
in ISO format, or the current time. - The parameter
timeDescription
contains time information written in natural language. IftimeDescription
is not set, 'now' is used as the default.
Parameters:
timeDescription
(string): Contains time information written in natural language, in english.
GetTimeSeriesRaw¶
Description:
This skill gets raw time series data for the provided asset id, aspect name, and variables for the given duration or for the to and from date.
- If
from
andto
are not specified it returns data for the last 24 hours.
Parameters:
assetId
(string): Asset id.aspectName
(string): Aspect name.from
(string): Start time in ISO format.to
(string): End time in ISO format.variables
(string): Comma-separated list of variables.
GetTimeSeriesAggregates¶
Description:
This skill gets aggregated time series data for the provided asset id, aspect name, and variables for the given duration or for the to and from date.
- If
from
andto
are not specified it returns data for the last 24 hours.
Parameters:
assetId
(string): Asset id.aspectName
(string): Aspect name.from
(string): Start time in ISO format.to
(string): End time in ISO format.variables
(string): Comma-separated list of variables.
AnalyzeTimeSeries¶
Description:
This skill analyzes raw or aggregate timeseries data for one or more variables belonging to the aspect of an asset.
- Performs statistical features (min, max, median, mean, standard deviation, kurtosis, skewness, mode, variance, q25, q75)
- Calculates correlation matrix, detects outliers, analyzes trends, detects patterns (dominant period, period score).
- The time range
from
,to
defaults to 24 hour time range if not provided.
Parameters:
assetIdAspectNameVariables
(array): Array of strings in formatassetId/aspectName/variables
.from
(string): Time range start in ISO format.to
(string): Time range end in ISO format.timeseriesMode
(string): "Raw" or "Aggregate".shouldIncludeDetails
(boolean): Include details in analysis.
GetEvents¶
Description:
This skill retrieves events filtered by optional parameters.
Parameters:
id
(string): Unique identifier of an event.entityId
(string): Identifier of the asset.from
(string): Start date in ISO 8601 format.to
(string): End date in ISO 8601 format.severity
(number): Filters events by severity code.acknowledged
(boolean): Filters events based on acknowledgment.summarize
(boolean): Summarized view.summarizeLimit
(number): Threshold for summarization.size
(number): Items per page.page
(number): Page number for pagination.
GetCases¶
Description:
This skill gets a filtered list of cases in tabular format. Results are shown in tabular format with only title, description & created.
Parameters:
title
(string): Title of the case.description
(string): Description of the case.asset
(string): Asset name or ID.priority
(string): Priority (EMERGENCY, MEDIUM, HIGH, LOW).status
(string): Status (OPEN, INPROGRESS, ONHOLD, DONE, OVERDUE, CANCELLED, ARCHIVED).type
(string): Type (PLANNED, INCIDENT, ANNOTATION).duration
(string): Duration filter.createdDate
(string): Creation date.dueDate
(string): Due date.relatedTo
(string): Related entities.count
(string): Number of cases.sort
(string): Sorting mechanism.
DeleteCase¶
Description:
This skill permanently deletes an existing case from the system using the case handle as the unique identifier with eTag. If only the case title is known, the GetCases skill can be used to get the required handle. The skill returns a confirmation message or error details.
Parameters:
etag
(string): The eTag of the case.handle
(string): The unique identifier/handle of the case to be removed from the system e.g., AA-052, AB-198
FindInDocuments¶
Description:
This skill searches for a given question in documents and gets the answer (RAG approach). The search is performed in the uploaded and synched IDL documents.
Parameters:
question
(string): Question to search/find in documents.
GetDocumentsInfo¶
Description:
This skill gets document meta data like names and document URLs.
Parameters:
None