すべてのプロダクト
Search

このプロダクト

    OpenSearch:検索候補のデモ

    ドキュメントセンター

    OpenSearch:検索候補のデモ

    最終更新日:Apr 02, 2026

    このページでは、OpenSearch Industry Algorithm Edition SDK を使用して検索候補をクエリするための TypeScript サンプルコードを提供します。パッケージは npmjs.com からダウンロードしてください。

    前提条件

    開始する前に、次のものが揃っていることを確認してください：

    • 検索候補アルゴリズムが設定された OpenSearch アプリケーション

    • ご利用の OpenSearch エンドポイント (OpenSearch コンソールで確認可能)

    • AccessKey ID と AccessKey Secret。Resource Access Management (RAM) ベースの認証を使用する場合は、Security Token Service (STS) トークンも必要です。

    手順1：依存関係のインストール

    次のパッケージをプロジェクトに追加します：

    依存関係

    @alicloud/credentials
@alicloud/opensearch-util
@alicloud/tea-typescript
@alicloud/tea-util

    開発時の依存関係

    typescript
ts-node

    手順2：クライアントの設定

    Config インスタンスを作成し、接続パラメーターを設定します。

    すべてのタイムアウト値の単位はミリ秒です。

    import * as $Util from '@alicloud/tea-util';
import Client from "./Client";
import Config from "./Config";
import construct = Reflect.construct;

const config = new Config();
config.endpoint = "opensearch-cn-hangzhou.aliyuncs.com";
config.protocol = "HTTP";
config.type = "access_key";
config.securityToken = "";

const runtime = new $Util.RuntimeOptions({
  connectTimeout: 5000,
  readTimeout: 10000,
  autoretry: false,
  ignoreSSL: false,
  maxIdleConns: 50,
});

const client = new Client(config);
    パラメーター説明デフォルト値
    config.endpointOpenSearch API エンドポイント。OpenSearch コンソールから取得します。—
    config.protocolリクエストプロトコル。有効な値：HTTP、HTTPS。HTTP
    config.type認証メソッド。有効な値：access_key、sts。access_key
    config.securityTokenSTS 一時トークン。config.type が sts の場合にのみ必要です。Alibaba Cloud RAM の AssumeRole 操作を呼び出して STS トークンを取得します。""
    connectTimeout接続タイムアウト (ミリ秒)。5000
    readTimeout読み取りタイムアウト (ミリ秒)。10000
    autoretry失敗時にリトライするかどうか。false
    ignoreSSLSSL 検証をスキップするかどうか。false
    maxIdleConns最大アイドル接続数。50

    手順3：検索候補のクエリ

    アプリケーション名とアルゴリズム名を指定して、サジェスト検索エンドポイントを呼び出します。

    const appName = "YOUR_APP_NAME";
const algoName = "YOUR_ALGO_NAME";

const suggest_algoQuery = {
  "query": "q",
  "hit": 10,
  "user_id": "a7a0d37c824b659f36a5b9e3b819fcdd"
};

try {
  const pathname = `/v3/openapi/apps/${appName}/suggest/${algoName}/search`;
  const result = client._request("GET", pathname, suggest_algoQuery, null, null, runtime);
  result.then(function (result) {
    console.log(result);
  });
} catch (e) {
  console.log(e);
}
    パラメーター説明例
    queryユーザーが入力した検索語。"q"
    hit返される候補の最大数。10
    user_idパーソナライズされた候補のためのユーザー識別子。"a7a0d37c824b659f36a5b9e3b819fcdd"

    次のステップ

    クエリパラメーターとレスポンスフィールドの完全なリストについては、「検索候補のクエリ」をご参照ください。