Pongo supports metadata in two formats- public and private.

Private metadata fields

Private metadata fields are not used in ranking. All values inside of each doc passed to pongo outside of the designated public metadata field and inference text field will be retained in the output objects, but not used by Pongo.

Public metadata fields

Public metadata fields will be included at the head of every chunk in the format of

  • “Key - value”.


Text: 'Apples are red, but can be green'
Public metadata: {'Title': 'Apple encyclopedia', 'Author': 'Jamari Morrison'}

Text pongo runs inference on: '
Title - Apple encyclopedia
Author - Jamari Morrison
Apples are red, but can be green'

The default metadata field for each doc passed into pongo is “metadata”, but that can be changed through the public_metadata_field parameter.