Documentation Index

Fetch the complete documentation index at: https://api.ncloud-docs.com/llms.txt

Use this file to discover all available pages before exploring further.

SearchScope

Prev Next

Available in Classic

These are limited search settings.

Syntax

The syntax is as follows.

private String scope_target;
private Object option;

Field

The following describes the fields.

Field Type Required Description
scope_target String Required Specify limited search target
option Object Optional Object as a map to set up a limited search
  • key: Select a limited search method
  • value: Set values based on the limited search method
  • key option types
    • exist, nexist: Limit search results to document attributes where the specified value exists
    • range, nrange: Limit search results to document attributes where values in a specified range exist (gte:lte)
    • gte, gt, lte, lt: Limit search results to document attributes where values in a specified range exist
      • gte: greater than or equal to
      • gt: greater than
      • lte: less than or equal to
      • lt: less than
    • bit, nbit: Limit search results to documents that are true or false by computing the value of specified bits and document attributes
    • bitmask: Limit search results to documents where the value of a specified bit and a document attribute are true by performing a bitmask operation

Examples

The following is a sample search request.

{
  "search": {
    "price": {
      "main": {
        "query": "keyboard"
      }
    }
  },
  "scope": {
  "dp_price": {
    "range": ["1000","5000"]
  },
  "dp_color": {
    "exist": "black"
    }
  }
}