IBM Cloudant 検索の仕組み

検索インデックスの定義は、データベース内のすべての文書に対して実行される JavaScript 関数の形で_設計文書に_格納されます。 この関数は、どの属性が索引付けされ、どの属性が索引に格納されるが検索できないか、また、各テキスト属性が索引付けの前にどのように前処理されるか（選択された検索 "アナライザ "を使用）を定義する。

IBM Cloudant 検索は、データベース全体、またはパーティション化されたデータベースの場合、 がデザイン・ドキュメントで になっている単一のパーティションに対して行うことができます。 options.partitioned true

IBM Cloudant

IBM Cloudant 検索は理想的である：

• 言語を意識した全文検索、ワイルドカード検索、数値フィールドやテキストフィールドに対する単純な範囲検索が可能。
• インデックス付きフィールドのセットに対する柔軟なクエリ。
• 最近接検索やバウンディングボックス検索などの簡単な地理空間クエリ。
• ファセット」と呼ばれる、結果セット内の個々のフィールドに対するカウント集計。

IBM Cloudant 。

IBM Cloudant 検索を避ける

• 集約（ファセット以外）。 代わりにViewsを使ってください。

検索インデックスの構築

検索索引を作成するには、JavaScript 関数をデータベース内の設計文書に追加します。 索引は、1 つの検索要求が処理された後、またはサーバーで文書の更新が検出された後に作成されます。 index 関数では、以下のパラメーターを使用します。

1. フィールド名 - 索引を照会する際に使用するフィールドの名前。 このパラメーターを default に設定すると、照会構文にフィールドが指定されていない場合に、このフィールドが照会されます。
2. 索引付けするデータ (doc.address.country など)。
3. (オプション) 3 番目のパラメーターには、boost、facet、index および store の各フィールドが含まれます。 これらのフィールドについては、後で詳しく説明します。

デフォルトでは、検索索引応答により、25 行が返されます。 返される行数は、limit パラメーターを使用することで変更できます。 ただし、検索からの結果セットは 200 行に制限されます。 各応答には bookmark フィールドが含まれます。 後の照会で bookmark フィールドの値を組み込み、応答を調べることができます。

API を照会するには、URI、IBM Cloudant ダッシュボード、curl または ブラウザー・プラグイン (Postman や RESTClient など) の方法のいずれかを使用できます。

検索索引を定義する設計文書の例を以下に示します。

{
	"_id": "_design/search_example",
	"indexes": {
		"animals": {
			"index": "function(doc){ ... }"
		}
	}
}

検索索引パーティショニング・タイプ

検索索引は、以下のものからパーティション・タイプを継承します。 それを含む設計文書のoptions.partitionedフィールド。

index 関数

存在しないデータ・フィールドを使用して索引付けしようとすると、失敗します。 この問題を回避するには、適切なガード節を使用します。

索引付け関数は、環境で使用されるメモリーの一部に文書自体が含まれる、メモリーが制約された環境で作動します。 コードのスタックおよび文書は、このメモリー内に収まる必要があります。 文書の最大サイズは 64 MB に制限されています。

検索索引内では、同じフィールド名を複数のデータ・タイプに索引付けしないでください。 同じフィールド名が同じ検索索引関数内の異なるデータ・タイプに索引付けされている場合、エラーを受け取ることがあります。 このエラーは、 was indexed without position data というフィールドが指定されている検索インデックスに対してクエリを実行した際に発生します。 例えば、これら両方の行を同じ検索索引関数に含めないでください。 これらの行は、myfield フィールドを、ストリング "this is a string" と数値 123 の 2 つの異なるデータ・タイプとして索引付けします。

index("myfield", "this is a string");
index("myfield", 123);

索引フィールドに含まれる関数は、データベース内の文書ごとに呼び出される JavaScript 関数です。 この関数は、文書をパラメーターとして使用し、そこから一部のデータを抽出してから、 index フィールドに定義された関数を呼び出してそのデータを索引付けします。

index 関数では、3 つのパラメーターを使用します。このうち、3 番目のパラメーターはオプションです。

最初のパラメータは、インデックスをクエリする際に使用するフィールド名であり、 これは後続のクエリのLucene構文部分で指定されます。 照会の例を以下に示します。

query=color:red

Lucene フィールド名 color は、index 関数の最初のパラメーターです。

query パラメーターは q に省略できるため、次の例に、照会を記述する別の方法を示します。

q=color:red

名前を定義する際に特殊値 "default" を使用する場合は、照会時にフィールド名を指定する必要はありません。 その結果、照会を単純化できます。

query=red

2 番目のパラメーターは、索引付けするデータです。 データを索引付けする場合は、以下の情報に注意してください。

• このデータに指定できるのは、ストリング、数値またはブール値のみです。 その他のタイプは、index 関数呼び出しでエラーが返されます。
• この理由または他の理由で、関数の実行時にエラーが返された場合、文書はその検索索引に追加されません。

3 番目のパラメーター (オプション) は、以下のフィールドを含む JavaScript オブジェクトです。

store パラメーターを設定しない場合、文書の索引データ結果は、照会に対する応答で返されません。

検索索引関数の例を以下に示します。

function(doc) {
	index("default", doc._id);
	if (doc.min_length) {
		index("min_length", doc.min_length, {"store": true});
	}
	if (doc.diet) {
		index("diet", doc.diet, {"store": true});
	}
	if (doc.latin_name) {
		index("latin_name", doc.latin_name, {"store": true});
	}
	if (doc.class) {
		index("class", doc.class, {"store": true});
	}
}

if (doc.min_length) {
	index("min_length", doc.min_length, {"store": true});
}

if (typeof doc.min_length === 'number') {
    index("min_length", doc.min_length, {"store": true});
}

if (typeof doc.min_length) !== 'undefined') {
	// The field exists, and does have a type, so we can proceed to index using it.
	...
}

アナライザー

アナライザーは、テキスト内の用語を認識する方法を定義する設定です。 詳細は 検索アナライザー を参照。

アナライザーは、複数の言語を索引付けする必要がある場合に役立ちます。

以下の表は、IBM Cloudant検索でサポートされている汎用アナライザの一覧です：

アナライザー文書の例を以下に示します。

{
	"_id": "_design/analyzer_example",
	"indexes": {
		"INDEX_NAME": {
			"index": "function (doc) { ... }",
			"analyzer": "$ANALYZER_NAME"
		}
	}
}

{
	"_id": "_design/analyzer_example",
	"indexes": {
		"INDEX_NAME": {
			"analyzer": {
				"name": "perfield",
				"default": "english",
				"fields": {
					"spanish": "spanish",
					"german": "german"
				}
			},
			"index": "function (doc) { ... }"
		}
	}
}

 "a", "an", "and", "are", "as", "at", "be", "but", "by", "for", "if",
 "in", "into", "is", "it", "no", "not", "of", "on", "or", "such",
 "that", "the", "their", "then", "there", "these", "they", "this",
 "to", "was", "will", "with"

{
	"_id": "_design/stop_words_example",
	"indexes": {
		"INDEX_NAME": {
			"analyzer": {
				"name": "portuguese",
				"stopwords": [
					"foo",
					"bar",
					"baz"
				]
			},
			"index": "function (doc) { ... }"
		}
	}
}

Host: $ACCOUNT.cloudant.com
POST /_search_analyze HTTP/1.1
Content-Type: application/json
{"analyzer":"keyword", "text":"ablanks@renovations.com"}

curl "https://$ACCOUNT.cloudant.com/_search_analyze" \
	-H "Content-Type: application/json" \
	-d '{"analyzer":"keyword", "text":"ablanks@renovations.com"}'

import com.ibm.cloud.cloudant.v1.Cloudant;
import com.ibm.cloud.cloudant.v1.model.PostSearchAnalyzeOptions;
import com.ibm.cloud.cloudant.v1.model.SearchAnalyzeResult;
Cloudant service = Cloudant.newInstance();
PostSearchAnalyzeOptions searchAnalyzerOptions =
    new PostSearchAnalyzeOptions.Builder()
        .analyzer("keyword")
        .text("ablanks@renovations.com")
        .build();
SearchAnalyzeResult response =
    service.postSearchAnalyze(searchAnalyzerOptions).execute()
        .getResult();
System.out.println(response);

import { CloudantV1 } from '@ibm-cloud/cloudant';
const service = CloudantV1.newInstance({});
service.postSearchAnalyze({
	analyzer: 'keyword',
	text: 'ablanks@renovations.com',
}).then(response => {
	console.log(response.result);
});

from ibmcloudant.cloudant_v1 import CloudantV1
service = CloudantV1.new_instance()
response = service.post_search_analyze(
	analyzer='keyword',
	text='ablanks@renovations.com'
).get_result()
print(response)

postSearchAnalyzeOptions := service.NewPostSearchAnalyzeOptions(
	"keyword",
	"ablanks@renovations.com",
)
searchAnalyzeResult, _, err := service.PostSearchAnalyze(postSearchAnalyzeOptions)
if err != nil {
	panic(err)
}
b, _ := json.MarshalIndent(searchAnalyzeResult, "", "  ")
fmt.Println(string(b))

import (
   "encoding/json"
   "fmt"
   "github.com/IBM/cloudant-go-sdk/cloudantv1"
)

{
	"tokens": [
		"ablanks@renovations.com"
	]
}

Host: $ACCOUNT.cloudant.com
POST /_search_analyze HTTP/1.1
Content-Type: application/json
{"analyzer":"standard", "text":"ablanks@renovations.com"}

curl "https://$ACCOUNT.cloudant.com/_search_analyze" -H "Content-Type: application/json"
	-d '{"analyzer":"standard", "text":"ablanks@renovations.com"}'

{
	"tokens": [
		"ablanks",
		"renovations.com"
	]
}

照会

検索索引は、作成後に照会できます。

• 以下の要求を使用して、パーティション照会を実行します。

  GET /$DATABASE/_partition/$PARTITION_KEY/_design/$DDOC/_search/$INDEX_NAME
  

• 以下の要求を使用して、グローバル照会を実行します。

  GET /$DATABASE/_design/$DDOC/_search/$INDEX_NAME
  

query パラメーターを使用して、検索を指定します。

HTTP を使用してパーティション化された索引を照会する例を以下に示します。

GET /$DATABASE/_partition/$PARTITION_KEY/_design/$DDOC/_search/$INDEX_NAME?include_docs=true&query="*:*"&limit=1 HTTP/1.1
Content-Type: application/json
Host: $ACCOUNT.cloudant.com

コマンド・ラインを使用してパーティション化された索引を照会する例を以下に示します。

curl "https://$ACCOUNT.cloudant.com/$DATABASE/_partition/$PARTITION_KEY/_design/$DDOC/_search/$INDEX_NAME?include_docs=true&query=\"*:*\"&limit=1"

import com.ibm.cloud.cloudant.v1.Cloudant;
import com.ibm.cloud.cloudant.v1.model.PostPartitionSearchOptions;
import com.ibm.cloud.cloudant.v1.model.SearchResult;
Cloudant service = Cloudant.newInstance();
PostPartitionSearchOptions searchOptions =
    new PostPartitionSearchOptions.Builder()
		.db("<db-name>")
		.partitionKey("<partition-key>")
		.ddoc("<ddoc>")
		.index("<index-name>")
		.query("*:*")
		.includeDocs(true)
		.limit(1)
		.build();
SearchResult response =
    service.postPartitionSearch(searchOptions).execute()
        .getResult();
System.out.println(response);

import { CloudantV1 } from '@ibm-cloud/cloudant';
const service = CloudantV1.newInstance({});
service.postSearch({
	db: '<db-name>',
	partitionKey: '<partition-key>',
	ddoc: '<ddoc>',
	index: '<index-name>',
	query: '*:*',
	includeDocs: true,
	limit: 1
}).then(response => {
	console.log(response.result);
});

from ibmcloudant.cloudant_v1 import CloudantV1
service = CloudantV1.new_instance()
response = service.post_search(
	db='<db-name>',
	partition_key='<partition-key>',
	ddoc='<ddoc>',
	index='<index-name>',
	query='*:*',
	include_docs=True,
	limit=1
).get_result()
print(response)

postPartitionSearchOptions := service.NewPostPartitionSearchOptions(
	"<db-name>",
	"<partition-key>",
	"<ddoc>",
	"<index-name>",
	"*:*",
)
postPartitionSearchOptions.SetIncludeDocs(true)
postPartitionSearchOptions.SetLimit(1)
searchResult, _, err := service.PostPartitionSearch(postPartitionSearchOptions)
if err != nil {
	panic(err)
}
b, _ := json.MarshalIndent(searchResult, "", "  ")
fmt.Println(string(b))

前の Go の例では、以下のインポート・ブロックが必要です。

import (
   "encoding/json"
   "fmt"
   "github.com/IBM/cloudant-go-sdk/cloudantv1"
)

HTTP を使用してグローバル索引を照会する例を以下に示します。

GET /$DATABASE/_design/$DDOC/_search/$INDEX_NAME?include_docs=true&query="*:*"&limit=1 HTTP/1.1
Content-Type: application/json
Host: $ACCOUNT.cloudant.com

コマンド・ラインを使用してグローバル索引を照会する例を以下に示します。

curl "https://$ACCOUNT.cloudant.com/$DATABASE/_design/$DDOC/_search/$INDEX_NAME?include_docs=true&query=\"*:*\"&limit=1"

import com.ibm.cloud.cloudant.v1.Cloudant;
import com.ibm.cloud.cloudant.v1.model.PostSearchOptions;
import com.ibm.cloud.cloudant.v1.model.SearchResult;
Cloudant service = Cloudant.newInstance();
PostSearchOptions searchOptions = new PostSearchOptions.Builder()
    .db("<db-name>")
    .ddoc("<ddoc>")
    .index("<index-name>")
    .query("*:*")
	.includeDocs(true)
	.limit(1)
    .build();
SearchResult response =
    service.postSearch(searchOptions).execute()
        .getResult();
System.out.println(response);

import { CloudantV1 } from '@ibm-cloud/cloudant';
const service = CloudantV1.newInstance({});
service.postSearch({
	db: '<db-name>',
	ddoc: '<ddoc>',
	index: '<index-name>',
	query: '*:*',
	includeDocs: true,
	limit: 1
}).then(response => {
	console.log(response.result);
});

from ibmcloudant.cloudant_v1 import CloudantV1
service = CloudantV1.new_instance()
response = service.post_search(
	db='<db-name>',
	ddoc='<ddoc>',
	index='<index-name>',
	query='*:*',
	include_docs=True,
	limit=1
).get_result()
print(response)

postSearchOptions := service.NewPostSearchOptions(
	"<db-name>",
	"<ddoc>",
	"<index-name>",
	"*:*",
)
postSearchOptions.SetIncludeDocs(true)
postSearchOptions.SetLimit(1)
searchResult, _, err := service.PostSearch(postSearchOptions)
if err != nil {
	panic(err)
}
b, _ := json.MarshalIndent(searchResult, "", "  ")
fmt.Println(string(b))

前の Go の例では、以下のインポート・ブロックが必要です。

import (
   "encoding/json"
   "fmt"
   "github.com/IBM/cloudant-go-sdk/cloudantv1"
)

POST /db/_design/ddoc/_search/searchname HTTP/1.1
Content-Type: application/json
Host: $ACCOUNT.cloudant.com

curl "https://$ACCOUNT.cloudant.com/$DATABASE/_design/$DDOC/_search/$INDEX_NAME" -X POST -H "Content-Type: application/json" -d @search.json

{
    "q": "index:my query",
    "sort": "foo",
    "limit": 3
}

ページネーション

検索クエリに ブックマークのページネーションを 使用する。 具体的な詳細と例については、APIドキュメントのトピック Paging on search index queries を参照してください。

照会構文

IBM Cloudant の検索クエリ構文は、 Luceneの構文に基づいています。 検索照会は、名前を省略しない限り、 name:value の形式になります。名前を省略する場合は、次の例に示すようにデフォルト・フィールドが使用されます。

検索照会式の例を以下に示します。

// Birds
class:bird
// Animals that begin with the letter "l"
l*
// Carnivorous birds
class:bird AND diet:carnivore
// Herbivores that start with letter "l"
l* AND diet:herbivore
// Medium-sized herbivores
min_length:[1 TO 3] AND diet:herbivore
// Herbivores that are 2m long or less
diet:herbivore AND min_length:[-Infinity TO 2]
// Mammals that are at least 1.5m long
class:mammal AND min_length:[1.5 TO Infinity]
// Find "Meles meles"
latin_name:"Meles meles"
// Mammals who are herbivore or carnivore
diet:(herbivore OR omnivore) AND class:mammal
// Return all results
*:*

複数のフィールドに対するクエリーは論理的に結合でき、グループとフィールドはさらにグループ化できます。 使用可能な論理演算子は、大/小文字の区別があり、 AND、+、OR、NOT および - です。 範囲照会は、ストリングまたは数値に対して実行できます。

ファジー検索が必要な場合は、~ を指定して照会を実行し、検索語に似た用語を検索できます。 例えば、こうだ、 look~ book および という項が導き出される。 took

範囲照会の上限が両方とも数字のみを含むストリングである場合、境界はストリングではなく数値として処理されます。 例えば、照会 mod_date:["20170101" TO "20171231"] を使用して検索する場合、結果には、mod_date がストリング "20170101" と "20171231" の間ではなく、数値 20170101 と 20171231 の間にある文書が含まれます。

検索語の重要度を変更するには、^ と正数を追加します。 この変更により、ランキング調整値の指数に比例して、より関連性の高いまたは低い用語を含む一致が作成されます。 デフォルト値は 1 です。これは、一致の強度において増減がないことを意味します。 10 進値 0 から 1 を指定すると、重要度が低下し、一致の強度は弱くなります。 1 より大きい値を指定すると、重要度が増加し、一致の強度は強くなります。

ワイルドカード検索は、単一 (?) と複数 (*) の両方の文字検索でサポートされます。 以下に例を示します。 dat? date や に一致し、 は 、 、 、 および に一致します。data dat* date``data``database dates ワイルドカードは検索語の後に指定する必要があります。

すべての結果を返すには、*:* を使用します。

検索からの結果セットは 200 行に制限されており、デフォルトでは 25 行が返されます。 返される行の数は、 limit パラメーターを使用して変更できます。

検索照会で "group_field" 引数を指定しない場合、応答にはブックマークが含まれます。 このブックマークを後で URL パラメーターとして指定すると、応答では、結果の次のセットを素早く簡単に取得できるように、既に検出された行がスキップされます。

検索照会に "group_field" パラメーターが含まれている場合、応答にはブックマークが含まれません。

group_field、group_limit および group_sort の各オプションは、グローバル照会を行う場合にのみ使用できます。

以下の文字を検索する場合は、エスケープする必要があります。

+ - && || ! ( ) { } [ ] ^ " ~ * ? : \ /

これらの文字のいずれかをエスケープするには、前に円記号（\）を使用します。

検索照会に対する応答には、各結果の order フィールドが含まれます。 order フィールドは、最初の要素として sort パラメーターで指定された 1 つ以上のフィールドを含む配列です。 クエリに sort パラメータ が含まれていない場合、order フィールドには Luceneの関連性スコアが格納されます sort by distance地理的検索で説明されているように 機能を使用する場合、最初の要素はポイントからの距離です。 距離は、キロメートルまたはマイルのいずれかを使用して測定されます。

順序配列の 2 番目の要素は無視できます。 これは、トラブルシューティングの目的にのみ使用されます。

ファセット

IBM Cloudant 検索では、ファセット検索もサポートされており、一致に関する集約情報を素早く簡単に検出できます。 特殊な ?q=*:* 照会構文を使用してすべての文書を突き合わせ、返されたファセットを使用して照会を絞り込むことができます。 ファセット照会でフィールドに索引付けする必要があることを示すには、そのオプションで {"facet": true} を設定します。

ファセット検索を有効にすることを指定した検索照会の例を以下に示します。

function(doc) {
    index("type", doc.type, {"facet": true});
    index("price", doc.price, {"facet": true});
}

ファセットを使用するには、索引内のすべての文書に、ファセットが有効になっているすべてのフィールドが含まれている必要があります。 文書にすべてのフィールドが含まれていない場合は、「 bad_request が存在しない」という理由で、field_name エラーを受け取ります。 各文書にファセットのすべてのフィールドが含まれていない場合は、フィールドごとに個別の索引を作成します。 フィールドごとに個別の索引を作成しない場合は、すべてのフィールドを含む文書のみを含める必要があります。 単一の if ステートメントを使用して、各文書にフィールドが存在することを確認します。

各文書に必要なフィールドが存在することを確認する if ステートメントの例を以下に示します。

if (typeof doc.town == "string" && typeof doc.name == "string") {
        index("town", doc.town, {facet: true});
        index("name", doc.name, {facet: true});        
    }

?q=*:*&counts=["type"]

{
    "total_rows":100000,
    "bookmark":"g...",
    "rows":[...],
    "counts":{
        "type":{
            "sofa": 10,
            "chair": 100,
            "lamp": 97
        }
    }
}

?q=*:*&ranges={"price":{"cheap":"[0 TO 100]","expensive":"{100 TO Infinity}"}}

{
    "total_rows":100000,
    "bookmark":"g...",
    "rows":[...],
    "ranges": {
        "price": {
            "expensive": 278682,
            "cheap": 257023
        }
    }
}

地理的検索

テキスト・フィールドの内容による検索に加えて、地理的座標からの距離で結果をソートすることもできます。

この方法で結果をソートするには、経度と緯度を表す 2 つの数値フィールドに索引付けする必要があります。

その後、特別な <distance...> ソート・フィールドを使用して照会を行うことができます。このソート・フィールドには、以下の 5 つのパラメーターがあります。

• 経度フィールド名 - 経度フィールドの名前 (例では mylon)。
• 緯度フィールド名 - 緯度フィールドの名前 (例では mylat)。
• 起点の経度 - 距離でソートする起点となる場所の経度。
• 起点の緯度 - 距離でソートする起点となる場所の緯度。
• 単位 - 使用する単位には、キロメートルの場合は km、またはマイルの場合は mi が含まれます。 距離は、順序フィールドで返されます。

距離による並べ替えは、他のあらゆる検索クエリと組み合わせることができます。 たとえば、緯度や経度による範囲検索や、 地理情報以外の情報を含むクエリなどです。

このようにして、境界ボックス内を検索し、追加の基準を使用して検索を絞り込むことができます。

地理的データの例を以下に示します。

{
    "name":"Aberdeen, Scotland",
    "lat":57.15,
    "lon":-2.15,
    "type":"city"
}

地理的データの検索索引を含む設計文書の例を以下に示します。

function(doc) {
    if (doc.type && doc.type == 'city') {
        index('city', doc.name, {'store': true});
        index('lat', doc.lat, {'store': true});
        index('lon', doc.lon, {'store': true});
    }
}

ニューヨークへの距離によって北半球の都市をソートする照会に HTTP を使用する例を以下に示します。

GET /examples/_design/cities-designdoc/_search/cities?q=lat:[0+TO+90]&sort="<distance,lon,lat,-74.0059,40.7127,km>" HTTP/1.1
Host: $ACCOUNT.cloudant.com

ニューヨークへの距離によって北半球の都市をソートする照会にコマンド・ラインを使用する例を以下に示します。

curl "https://$ACCOUNT.cloudant.com/examples/_design/cities-designdoc/_search/cities?q=lat:\[0+TO+90\]&sort=\"<distance,lon,lat,-74.0059,40.7127,km>\""

import com.ibm.cloud.cloudant.v1.Cloudant;
import com.ibm.cloud.cloudant.v1.model.PostSearchOptions;
import com.ibm.cloud.cloudant.v1.model.SearchResult;
import java.util.Arrays;
Cloudant service = Cloudant.newInstance();
PostSearchOptions searchOptions = new PostSearchOptions.Builder()
	.db("examples")
	.ddoc("cities-designdoc")
	.index("cities")
	.query("lat:\\[0+TO+90\\]")
	.sort(Arrays.asList("<distance,lon,lat,-74.0059,40.7127,km>"))
	.build();
SearchResult response =
    service.postSearch(searchOptions).execute()
        .getResult();
System.out.println(response);

import { CloudantV1 } from '@ibm-cloud/cloudant';
const service = CloudantV1.newInstance({});
service.postSearch({
	db: 'examples',
	ddoc: 'cities-designdoc',
	index: 'cities',
	query: 'lat:\\[0+TO+90\\]',
	sort: ['<distance,lon,lat,-74.0059,40.7127,km>']
}).then(response => {
	console.log(response.result);
});

from ibmcloudant.cloudant_v1 import CloudantV1
service = CloudantV1.new_instance()
response = service.post_search(
	db='examples',
	ddoc='cities-designdoc',
	index='cities',
	query='lat:\\[0+TO+90\\]',
	sort=['<distance,lon,lat,-74.0059,40.7127,km>']
).get_result()
print(response)

postSearchOptions := service.NewPostSearchOptions(
	"examples",
	"cities-designdoc",
	"cities",
	"lat:\\[0+TO+90\\]",
)
postSearchOptions.SetSort([]string{"<distance,lon,lat,-74.0059,40.7127,km>"})
searchResult, _, err := service.PostSearch(postSearchOptions)
if err != nil {
  panic(err)
}
b, _ := json.MarshalIndent(searchResult, "", "  ")
fmt.Println(string(b))

前の Go の例では、以下のインポート・ブロックが必要です。

import (
   "encoding/json"
   "fmt"
   "github.com/IBM/cloudant-go-sdk/cloudantv1"
)

ニューヨークへの距離によってソートされた北半球の都市のリストを含む (省略された) 応答の例を以下に示します。

{
    "total_rows": 205,
    "bookmark": "g1A...XIU",
    "rows": [
        {
            "id": "city180",
            "order": [
                8.530665755719783,
                18
            ],
            "fields": {
                "city": "New York, N.Y.",
                "lat": 40.78333333333333,
                "lon": -73.96666666666667
            }
        },
        {
            "id": "city177",
            "order": [
                13.756343205985946,
                17
            ],
            "fields": {
                "city": "Newark, N.J.",
                "lat": 40.733333333333334,
                "lon": -74.16666666666667
            }
        },
        {
            "id": "city178",
            "order": [
                113.53603438866077,
                26
            ],
            "fields": {
                "city": "New Haven, Conn.",
                "lat": 41.31666666666667,
                "lon": -72.91666666666667
            }
        }
    ]
}

検索語の強調表示

検索語が言及されたコンテキストを取得して、結果をより強調してユーザーに表示できるようにすると、役立つ場合があります。

結果をより強調するには、検索照会に highlight_fields パラメーターを追加します。 抜粋するフィールド名を指定して、検索語が強調教示された状態で返されるようにします。

デフォルトでは、検索語は強調表示するために <em> タグ内に配置されますが、強調表示は highlights_pre_tag パラメーターと highlights_post_tag パラメーターを使用してオーバーライドできます。

フラグメントの長さは、デフォルトで 100 文字です。 highlights_size パラメーターを使用して、異なる長さを要求できます。

highlights_number は返されるフラグメントの数を制御するパラメーターで、デフォルトは 1 です。

応答では、フィールド名ごとに 1 つのサブフィールドを含む、highlights フィールドが追加されます。

フィールドごとに、検索語が強調表示されたフラグメントの配列を受け取ります。

強調表示が機能するには、store: true オプションを使用して、フィールドを索引内に保管します。

HTTP を使用して強調表示が有効な検索を行う例を以下に示します。

GET /movies/_design/searches/_search/movies?q=movie_name:Azazel&highlight_fields=["movie_name"]&highlight_pre_tag=" "&highlight_post_tag=" "&highlights_size=30&highlights_number=2 HTTP/1.1
HOST: $ACCOUNT.cloudant.com
Authorization: ...

ハイライト表示を有効にして検索を行うコマンドラインの例を以下に示します

curl "https://$ACCOUNT.cloudant.com/movies/_design/searches/_search/movies?q=\"movie_name:Azazel\"&highlight_fields=\[\"movie_name\"\]&highlight_pre_tag=\" \"&highlight_post_tag=\" \"&highlights_size=30&highlights_number=2" \
	-X GET

import com.ibm.cloud.cloudant.v1.Cloudant;
import com.ibm.cloud.cloudant.v1.model.PostSearchOptions;
import com.ibm.cloud.cloudant.v1.model.SearchResult;
import java.util.Arrays;
Cloudant service = Cloudant.newInstance();
PostSearchOptions searchOptions = new PostSearchOptions.Builder()
    .db("movies")
    .ddoc("searches")
    .index("movies")
    .query("movie_name:Azazel")
    .highlightFields(Arrays.asList("[\"movie_name\"]"))
    .highlightPreTag("\" \"")
    .highlightPostTag("\" \"")
    .highlightSize(30)
    .highlightNumber(2)
    .build();
SearchResult response =
    service.postSearch(searchOptions).execute()
        .getResult();
System.out.println(response);

import { CloudantV1 } from '@ibm-cloud/cloudant';
const service = CloudantV1.newInstance({});
service.postSearch({
	db: 'movies',
	ddoc: 'searches',
	index: 'movies',
	query: 'movie_name:Azazel',
	highlightFields: ['["movie_name"]'],
	highlightPreTag: '" "',
	highlightPostTag: '" "',
	highlightSize: 30,
	highlightNumber: 2
}).then(response => {
	console.log(response.result);
});

from ibmcloudant.cloudant_v1 import CloudantV1
service = CloudantV1.new_instance()
response = service.post_search(
	db='movies',
	ddoc='searches',
	index='movies',
	query='movie_name:Azazel',
	highlight_fields=['["movie_name"]'],
	highlight_pre_tag='" "',
	highlight_post_tag='" "',
	highlight_size=30,
	highlight_number=2
).get_result()
print(response)

postSearchOptions := service.NewPostSearchOptions(
	"movies",
	"searches",
	"movies",
	"movie_name:Azazel",
)
postSearchOptions.SetHighlightFields([]string{"[\"movie_name\"]"})
postSearchOptions.SetHighlightPreTag("\" \"")
postSearchOptions.SetHighlightPostTag("\" \"")
postSearchOptions.SetHighlightSize(30)
postSearchOptions.SetHighlightNumber(2)
searchResult, _, err := service.PostSearch(postSearchOptions)
if err != nil {
	panic(err)
}
b, _ := json.MarshalIndent(searchResult, "", "  ")
fmt.Println(string(b))

前の Go の例では、以下のインポート・ブロックが必要です。

import (
   "encoding/json"
   "fmt"
   "github.com/IBM/cloudant-go-sdk/cloudantv1"
)

強調表示された検索結果の例を以下に示します。

{
    "highlights": {
        "movie_name": [
            " on the Azazel Orient Express",
            " Azazel manuals, you"
        ]
    }
}

検索索引メタデータ

検索索引に関する情報を取得するには、以下の例に示すように、GET 要求を _search_info エンドポイントに送信します。 DDOC は、索引を含む設計文書を参照し、INDEX_NAME は索引の名前です。

HTTP を使用して検索索引メタデータを要求する例を以下に示します。

GET /$DATABASE/_design/$DDOC/_search_info/$INDEX_NAME HTTP/1.1

コマンド・ラインを使用して検索索引メタデータを要求する例を以下に示します。

curl "https://$ACCOUNT.cloudant.com/$DATABASE/_design/$DDOC/_search_info/$INDEX_NAME" \
     -X GET

import com.ibm.cloud.cloudant.v1.Cloudant;
import com.ibm.cloud.cloudant.v1.model.GetSearchInfoOptions;
import com.ibm.cloud.cloudant.v1.model.SearchInfoResult;
Cloudant service = Cloudant.newInstance();
GetSearchInfoOptions infoOptions =
    new GetSearchInfoOptions.Builder()
        .db("<db-name>")
        .ddoc("<ddoc>")
        .index("<index-name>")
        .build();
SearchInfoResult response =
    service.getSearchInfo(infoOptions).execute()
        .getResult();
System.out.println(response);

import { CloudantV1 } from '@ibm-cloud/cloudant';
const service = CloudantV1.newInstance({});
service.getSearchInfo({
	db: '<db-name>',
	ddoc: '<ddoc>',
	index: '<index-name>'
}).then(response => {
	console.log(response.result);
});

from ibmcloudant.cloudant_v1 import CloudantV1
service = CloudantV1.new_instance()
response = service.get_search_info(
	db='<db-name>',
	ddoc='<ddoc>',
	index='<index-name>'
).get_result()
print(response)

getSearchInfoOptions := service.NewGetSearchInfoOptions(
	"<db-name>",
	"<ddoc>",
	"<index-name>",
)
searchInfoResult, _, err := service.GetSearchInfo(getSearchInfoOptions)
if err != nil {
  panic(err)
}
b, _ := json.MarshalIndent(searchInfoResult, "", "  ")
fmt.Println(string(b))

前の Go の例では、以下のインポート・ブロックが必要です。

import (
   "encoding/json"
   "fmt"
   "github.com/IBM/cloudant-go-sdk/cloudantv1"
)

応答には、索引内の文書数やディスク上の索引のサイズなど、索引に関する情報が含まれます。

検索索引メタデータを要求した後の応答の例を以下に示します。

{
    "name": "_design/DDOC/INDEX",
    "search_index": {
        "pending_seq": 7125496,
        "doc_del_count": 129180,
        "doc_count": 1066173,
        "disk_size": 728305827,
        "committed_seq": 7125496
    }
}