Text feed is used to add additional content to the search or shopping assistant. It can be blog articles, web page content, or any arbitrary text-based content.

You can effectively build and maintain knowledge that is used by the Shopping Assistant and Search.

Currently, we support ingesting data by providing a publicly available JSON lines file. Each line of the file should be a valid JSON with the following content (note that the example is split into multiple lines for readability, but each record should get its own line):

{
  "id": "_product_withdrawal_information",
  "content_string": "Return option for certain children's hoodies\n\nDear customers, if you purchased these children's hoodies at one of our stores or at eshop.com, you have the option to return them.\nThe hoodies previously had drawstrings in the hood, which could be potentially dangerous for small children and do not meet safety standards. We apologize.\nThis notice is based on a safety test protocol. The mentioned products did not comply with the requirements of children's clothing safety standards related to cords and drawstrings.",
  "title": "Return options",
  "tags": [
    "assistant",
    "search"
  ],
  "advertised_url": "https://www.eshop.com/product-withdrawal-information/",
  "properties": {
    "custom_property": "custom_value"
  }
}

Field Descriptions

id (mandatory)

Unique identifier of the text entry. This field should contain only characters (any case), numbers, dashes, or underscores.

content_string (mandatory)

The actual text content that holds the key information value to be processed by our system.

title (optional, recommended)

Title of the text or article. This will be used for search purposes and also will be used in the autocomplete to show the text to the user.

Filling this field is strongly recommended. Without this field, the text will not be properly shown to the user.

tags (optional)

List of strings that allow for more granular control over which use-cases this text will be used for. By filling this field, the ingested text will be taken into account only for use-cases specified here and will be ignored by other use cases.

We currently support the following values:

• assistant which will enable the tags to be used by assistant use cases (assistant or similar)
• search which will enable the tags to be used for the search use-case (e.g. search autocomplete feature)

Leaving this empty will allow the text to be used by all use-cases without limitation.

advertised_url (mandatory)

URL that can be shown to the end user and that will allow them to visit the actual text source on the original web page. Depending on the nature of this text, it may lead to an FAQ web page, an article web page, a particular e-shop item category listing, or similar.

Our assistant may provide this URL to the user in case the conversation references some particular content (e.g., FAQ page). Similarly, this URL can be used as a clickable link for the user that will lead them to the blog article from the auto-complete search widget.

properties (optional)

Optional nested object with custom properties related to this text. These may be necessary to allow usage of special use-cases for particular business domains or providing additional information about the nature of the text that cannot be represented in the core fields.

Generally speaking, keep this empty, unless you are instructed to fill this by our integration team.

Note that we ingest properties in an incremental manner, i.e., in order to unset the field (set the value of an already ingested property to null) you are required to include the field in the update with a null value. Just omitting the field will NOT lead to its deletion in our systems.

Usage and examples

If the assistant's answer is not precise, you can define the question and answer format and enrich the knowledge base.

{
  "id": "_payment_invoice",
  "content_string": "QUESTION: Can I pay by invoice? ANSWER: Yes, it is possible if your company is registered.",
  "advertised_url": "https://www.eshop.com/payments-information/",
  "tags": [
    "assistant"
  ]
}