ModifyTable API によるインデックステーブルの更新 - OpenSearch - Alibaba Cloud -

インデックステーブルを変更します。

操作説明

メソッド

PUT

URI

/openapi/ha3/instances/{instanceId}/tables/{tableName}
```。

今すぐお試しください

この API を OpenAPI Explorer でお試しください。手作業による署名は必要ありません。呼び出しに成功すると、入力したパラメーターに基づき、資格情報が組み込まれた SDK コードが自動的に生成されます。このコードをダウンロードしてローカルで使用できます。

テスト

RAM 認証

下表に、この API を呼び出すために必要な認証情報を示します。認証情報は、RAM (Resource Access Management) ポリシーを使用して定義できます。以下で各列名について説明します。

アクション：特定のリソースに対して実行可能な操作。ポリシー構文ではAction要素として指定します。
API：アクションを具体的に実行するための API。
アクセスレベル：各 API に対して事前定義されているアクセスの種類。有効な値：create、list、get、update、delete。
リソースタイプ：アクションが作用するリソースの種類。リソースレベルでの権限をサポートするかどうかを示すことができます。ポリシーの有効性を確保するため、アクションの対象として適切なリソースを指定してください。
- リソースレベルの権限を持つ API の場合、必要なリソースタイプはアスタリスク (*) でマークされます。ポリシーのResource要素で対応する ARN を指定してください。
- リソースレベルの権限を持たない API の場合、「すべてのリソース」と表示され、ポリシーのResource要素でアスタリスク (*) でマークされます。
条件キー：サービスによって定義された条件のキー。このキーにより、きめ細やかなアクセス制御が可能になります。この制御は、アクション単体に適用することも、特定のリソースに対するアクションに適用することもできます。Alibaba Cloud は、サービス固有の条件キーに加えて、すべての RAM 統合サービスに適用可能な一連の共通条件キーを提供しています。
依存アクション：ある特定のアクションを実行するために、前提として実行が必要となる他のアクション。依存アクションの権限も RAM ユーザーまたは RAM ロールに付与する必要があります。

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

searchengine:ModifyTable

update

*Instance

acs:searchengine:{#regionId}:{#accountId}:instance/{#InstanceId}

なし

リクエスト構文

PUT /openapi/ha3/instances/{instanceId}/tables/{tableName} HTTP/1.1

パスパラメーター

パラメーター	型	必須 / 任意	説明	例
instanceId	string	必須	インスタンス ID。	ha-cn-pl32rf0****
tableName	string	必須	インデックステーブルの名前。	index_hdfs

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
dryRun	boolean	任意	ドライランを実行するかどうかを指定します（データソースが有効かどうかのみを検証します）。有効な値: - true: ドライランを実行します。 - false: ドライランを実行しません。	true
body	object	任意	リクエストボディパラメーター。
partitionCount	integer	任意	データシャードの数。	1
dataSource	object	任意	データソースの構成。
dataTimeSec	integer	任意	増分データ追跡のタイムスタンプ。	1715160176
autoBuildIndex	boolean	任意	自動インデックス再構築が有効かどうかを示します。	true
config	object	任意	データソースの構成。
endpoint	string	任意	アクセスエンドポイント。	http://service.cn-hangzhou.maxcompute.aliyun-inc.com/api
accessKey	string	任意	ODPS データソースの AccessKey ID。	L***p
accessSecret	string	任意	ODPS データソースの AccessKey Secret。	5**9a6
project	string	任意	ODPS データソースのプロジェクト名。	test_project
partition	string	任意	パーティション情報。	ds=20231220
table	string	任意	ODPS または DLF データソースのテーブル名。	behavior
ossPath	string	任意	OSS ファイルパス。	/opensearch/test.txt
bucket	string	任意	OSS バケット。	test_bucket
catalog	string	任意	DLF データソースのカタログ名。	test_catalog
database	string	任意	DLF データソースのデータベース。	opensearch_db
tag	string	任意	DLF データソースのタグ。	test
tableFormat	string	任意	DLF データソースのテーブルフォーマット。	paimon lance object
path	string	任意	相対パス。	/test
format	string	任意	ファイル形式のタイプ。	ha3 json
rawSchema	string	任意	rawSchema が指定された場合、手動で組み立てることなく、HA3 スキーマ構造としてそのまま使用されます。	{}
primaryKey	string	任意	プライマリキーフィールド。	id
fieldSchema	object	任意	フィールドマップコレクション。
	string	任意	key: 字段名 value: 字段类型	{ "id": "INT64", "source_image": "STRING", "namespace": "INT64", "source_image_vector": "MULTI_FLOAT" }
vectorIndex	array<object>	任意	インデックス構造。
	array<object>	任意	インデックス構造の詳細。
indexName	string	任意	インデックス構造の名前。	test_index
vectorField	string	任意	ベクトルフィールド。	source_image_vector
sparseIndexField	string	任意	疎ベクトルインデックスフィールド。	sparse_indices
sparseValueField	string	任意	疎ベクトル値フィールド。	sparse_values
dimension	string	任意	ベクトル次元。	128
vectorIndexType	string	任意	ベクターインデックスアルゴリズム。	Qc
distanceType	string	任意	距離タイプ。	SquaredEuclidean
namespace	string	任意	名前空間フィールド。	namespace
advanceParams	object	任意	インデックス構造の構成。
buildIndexParams	string	任意	インデックス構築のパラメーター。	{}
searchIndexParams	string	任意	インデックス検索のパラメーター。	{}
minScanDocCnt	string	任意	再現率のための候補ドキュメントの最小値。	20000
linearBuildThreshold	string	任意	線形構築のしきい値。	5000
dataProcessConfig	array<object>	任意	フィールド処理の構成。
	array<object>	任意	フィールド処理構成の詳細。
operator	string	任意	フィールド処理メソッド。有効な値: copy（ソースフィールドを送信先フィールドにコピーします）および vectorize（モデルを使用してソースフィールドをベクトル化し、ベクターを送信先フィールドに格納します）。	vectorize
dstField	string	任意	送信先フィールド。	source_image_vector
srcField	string	任意	ソースフィールド。	source_image
params	object	任意	モデル構成情報。フォーマットはキーと値のペアです。
vectorModel	string	任意	ベクトル化モデル。	clip
vectorModal	string	任意	データの型。	image
srcFieldConfig	object	任意	ベクトル化情報のソース。
ossEndpoint	string	任意	OSS リージョンのエンドポイント。	oss-cn-hangzhou-internal.aliyuncs.com
ossBucket	string	任意	OSS バケット名。	test-bucket
uid	string	任意	Alibaba Cloud アカウント ID。	1062017779051424

リクエスト例

PUT /openapi/ha3/instances/{instanceId}/tables/{tableName}

重要この例では最もシンプルなパラメーターのみを示しています。その他のカスタムパラメーターについては、リクエストパラメーターを参照してください。

{
    "partitionCount": 1,
    "primaryKey": "id",
    "fieldSchema": {
        "id": "INT64",
        "source_image": "STRING",
        "namespace": "STRING",
        "source_image_vector": "MULTI_FLOAT"
    },
    "vectorIndex": [
        {
            "indexName": "test_index_1",
            "vectorField": "source_image_vector",
            "vectorIndexType": "HNSW",
            "dimension": "512",
            "distanceType": "InnerProduct"
        }
    ]
}

詳細については、レスポンス構造を参照してください。

レスポンスフィールド

フィールド	型	説明	例
	object
requestId	string	リクエスト ID。	FE03180A-0E29-5474-8A86-33F0683294A4
result	object	返された結果。	{}

例

成功レスポンス

JSONJSON

{
  "requestId": "FE03180A-0E29-5474-8A86-33F0683294A4",
  "result": {}
}

エラーコード

完全なリストについては、「エラーコード」をご参照ください。

変更履歴

完全なリストについては、「変更履歴」をご参照ください。