Skip to content

Enabling content references

Content references are a way to incorporate outside documentation sources into your outgoing messages to users. They rely on our integration with OpenAI, and our privacy policy lists how we interact with them. By default, OpenAI does not have access to any of your or your customers' data.

Enabling the content references feature provides support an additional switch action: summarize

To enable content references:

  1. Go to your organization settings page at https://web.yetto.app/orgs/[organization name]/settings.
  2. Click on Content references in the left sidebar.
  3. Click Enable AI features.

The summarize action

If your switch uses: "summarize", Yetto will summarize the first message in a conversation. You can also choose to summarize the entire public thread, by passing {"scope": "public_thread"}, to the switch action object.

Summarizing with content references

In addition to scope, your switch can also pass in an array of content references. Currently, we support external websites whose documentation is available as HTML—you know, the good stuff.

Defining a content reference

To define a content reference:

  1. Go to your organization settings page at https://web.yetto.app/orgs/[organization name]/settings.
  2. Click on Content references in the left sidebar.
  3. Click Add website.
  4. Enter the URL of your documentation site.
  5. Click Add website.

Yetto will crawl your documentation and build up a collection of references from your own content. You can see the status of the processing job on this page. On average, you can estimate about six hours for an average site, at a rate of three seconds per HTML page consumed.

When the processing is finished, you can refer to the content reference ID (it starts with uew_) in your switches.

Example

In this example, the switch will summarize the first public message in a conversation, and refer to the documentation site referenced as uew_01J3RFD4QMATG6VTWT48K8N0QA to provide associated links, based on the message and your own available documentation.

{
  "version": "2023-03-06",
  "events": {
  "message.created": {
    "conditions": {
    "if": "{% data.yetto.message.visibility == \"internal\" and data.yetto.message.text_content contains \"!summarize-with-docs\" %}"
    },
    "actions": [
    {
      "uses": "summarize",
      "with": {
      "content_references": [
        "uew_01J3RFD4QMATG6VTWT48K8N0QA"
      ],
      "scope": "first_message"
      }
    }
    ]
  }
}