All Products
Search
Document Center

OpenSearch:SearchStrategy

Last Updated:Aug 31, 2023

Description

The information about a search policy of an OpenSearch application.

Example

{
	"name": "test",
 "description": "it's a test",
 "searchConfigs":[
		{
			"queryType":"vector",
 "firstRankName": "",
 "secondRankName": "",
 "mergeProportion": 30
 },
 {
			"queryType":"keyword",
 "firstRankName":"",
 "secondRankName":"",
 "mergeProportion": 70
 }
 ],
 "mergeConfig":{
 	"rankName": "",
 "docCount": 5000
	}
}

Structure

Parameter

Type

Description

name

String

The name of the search policy.

description

String

The description of the search policy.

searchConfigs[]

Object

The details of the search policy. For more information, see the searchConfig section of this topic.

mergeConfig

Object

The details of the merging policy. For more information, see the mergeConfig section of this topic.

isDefault

Boolean

Indicates whether the search policy is the default one.

searchConfig

Field

Type

Description

queryType

String

The type of the search. Valid values:

keyword: The keyword search.

vector: The vector search.

firstRankName

String

The name of the rough sort expression.

secondRankName

String

The name of the fine sort expression.

mergeProportion

Integer

The proportion of retrieval results.

mergeConfig

Field

Type

Description

rankName

String

The name of the merge sort expression.

docCount

Integer

The number of documents that are merged and sorted.