Rovo Agent分析器

Rovo Agents 分析库,用于编译并发送已键入分析事件.

使用量

import { useRovoAgentActionAnalytics } from '@atlaskit/rovo-agent-analytics/actions';

const { trackAgentEvent } = useRovoAgentActionAnalytics({});

// Full control over event properties — all fields are type-checked
trackAgentEvent({
  action: 'view',
  actionSubject: 'rovoAgent',
  attributes: { 
    agentId: 'agent-123',
    touchPoint: 'browse-agent-list',
  },
});

可找到详细的文件和示例使用 这里。 。 。 .

实例

基本事件跟踪

用于明确类型的活动 action, (中文(简体) ), actionSubject,以及 attributes数字 :

import { useRovoAgentActionAnalytics } from '@atlaskit/rovo-agent-analytics/actions';

const { trackAgentEvent } = useRovoAgentActionAnalytics({
  agentId,
  touchPoint: 'browse-agent-list',
});

// Track a user interaction
trackAgentEvent({
  action: 'duplicate',
  actionSubject: 'rovoAgent',
  attributes: {},
});

带有自定义属性的事件跟踪

import { useRovoAgentActionAnalytics } from '@atlaskit/rovo-agent-analytics/actions';

const { trackAgentEvent } = useRovoAgentActionAnalytics({});

// Full control over event properties — all fields are type-checked
trackAgentEvent({
  action: 'created',
  actionSubject: 'batchEvaluationDataset',
  attributes: { 
    totalQuestions: 5 
  },
  objectType: 'batchEvaluationDataset',
  objectId: 'dataset-123',
});

有效载荷类型

每个组文件在 src/actions/groups/ 出口a 受歧视的联盟有效载荷类型 定义该组的所有有效事件形状.

合计 EventPayload 类型(从 types.ts)是所有这些有效载荷类型的联盟.

添加新动作

现有有效载荷类型

1. 打开组文件(例如. src/actions/groups/agent-interactions.ts(中文(简体) )
2. 在有效载荷联盟类型上添加有数据-门户登记链接的新变体:

export type AgentInteractionsEventPayload =
  | {
      // https://data-portal.internal.atlassian.com/analytics/registry/XXXXX
      actionSubject: 'rovoAgent';
      action: 'myNewAction';
      attributes: BaseAgentAnalyticsAttributes & {
        myCustomField: string;
      };
    }
  | // ... existing variants

就这样——TypeScript在调用时会执行正确的形状 trackAgentEvent()。 。 。 .

给新组合

如果您的行动不符合任何已有的组,请创建一个新的组:

1. 在 src/actions/groups/ 遵循现有模板
2. 出口受歧视的联盟有效载荷类型(例如:. MyFeatureEventPayload(中文(简体) )
3. 将新类型添加到 EventPayload 工会 src/common/types.ts数字 :

import type { MyFeatureEventPayload } from '../actions/groups/my-feature';

export type EventPayload =
  | EditingEventPayload
  | AgentInteractionsEventPayload
  // ... existing types
  | MyFeatureEventPayload;

定义自定义属性

有效载荷类型中的每个动作变体可以有自己的具体属性:

使用底物分析属性

需要采取的行动 touchPoint 财务报告和审定财务报表 agentId数字 :

{
  actionSubject: 'rovoAgent';
  action: 'view';
  attributes: BaseAgentAnalyticsAttributes;
}

使用自定义属性

对于需要额外属性的行动:

{
  actionSubject: 'rovoAgent';
  action: 'updated';
  attributes: BaseAgentAnalyticsAttributes & { 
    agentType: string; 
    field: string; 
  };
}

条目点

创建流程分析

这个 useRovoAgentCreateAnalytics 钩子用于跟踪代理创建漏斗:

import { useRovoAgentCreateAnalytics } from '@atlaskit/rovo-agent-analytics/create';

const [csid, { trackCreateSession, trackCreateSessionStart }] = useRovoAgentCreateAnalytics({
  touchPoint: 'agent-studio',
});

// Track funnel steps using string literal actions
trackCreateSession('createFlowStart');
trackCreateSession('createFlowActivate', { agentType: 'custom' });