SearchPassage

Available in Classic

These are settings for how search results are extracted.

Syntax

The syntax is as follows.

private String section_name;
private String passage_type;
private String passage_option
private Integer max_length;

Field

The following describes the fields.

Field	Type	Required	Description
`section_name`	String	Required	Specify the section to output as a result Select from previously created sections
`passage_type`	String	Optional	Specify the passage extraction method `none` \| `classic` `none`: Read from the beginning of the section `classic`: Read around the query's index terms in the section
`passage_option`	String	Optional	Specify passage extraction options (outside of CBT scope)
`max_length`	Integer	Optional	Specify the passage extraction length

Examples

The following is a sample search request.

{
  "search": {
    "content": {
      "main": {
        "query": "Weather"
      }
    }
  },
  "passage": {
    "TITLE": {
       "passage_type": "classic",
       "passage_option": "mspcnt=1;rmtag=on;",
       "max_length": 400
    },
    "TITLE+BODY": {
       "passage_type": "classic",
       "passage_option": "mspcnt=1;rmtag=on;",
       "max_length": 500
    }
  }
}