SearchPassage
    • PDF

    SearchPassage

    • PDF

    Article summary

    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.

    FieldTypeRequiredDescription
    section_nameStringRequiredSpecify the section to output as a result
    • Select from previously created sections
    passage_typeStringOptionalSpecify 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_optionStringOptionalSpecify passage extraction options (outside of CBT scope)
    max_lengthIntegerOptionalSpecify 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
        }
      }
    }
    

    Was this article helpful?

    What's Next
    Changing your password will log you out immediately. Use the new password to log back in.
    First name must have atleast 2 characters. Numbers and special characters are not allowed.
    Last name must have atleast 1 characters. Numbers and special characters are not allowed.
    Enter a valid email
    Enter a valid password
    Your profile has been successfully updated.