What are citations?

Citations are used by the Moveworks Copilot to present users with verifiable information.

How do I return citations for my plugins?

To generate citations, the Compound Action for your plugin must contain either an object (stored under output_mapper.result) or a list of objects (stored under output_mapper.results)

• Each object MUST have an id (this is what’s used to distinguish the record).
• It can optionally have a friendly_id.

Examples

Returning a list of objects (specifying the id)

return:
  output_mapper:
    results:
      MAP():
        converter:
          MERGE():
            - item
            - id: item.system_id
              friendly_id: item.user_facing_name
        items: data.list_of_objects

Returning a single object

return:
  output_mapper:
    result:
      MERGE():
        - data.result
        - id: data.result.sys_id
          friendly_id: data.result.name