CreateTable - - Centre de documentation Alibaba Cloud

Crée une table d'index.

Description de l'opération

Méthode

POST

URI

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

Testez maintenant

Testez cette API dans OpenAPI Explorer, sans signature manuelle. Les appels réussis génèrent automatiquement du code SDK correspondant à vos paramètres. Téléchargez-le avec une sécurité intégrée des identifiants pour une utilisation locale. Testez cette API dans OpenAPI Explorer, sans signature manuelle. Les appels réussis génèrent automatiquement du code SDK correspondant à vos paramètres. Téléchargez-le avec une sécurité intégrée des identifiants pour une utilisation locale.

Test

Autorisation RAM

Le tableau ci-dessous décrit les autorisations nécessaires pour appeler cette API. Vous pouvez les définir dans une politique Resource Access Management (RAM). Les colonnes du tableau sont détaillées ci-dessous :

Action : les actions peuvent être utilisées dans l'élément Action des instructions de politique de permissions RAM pour accorder les autorisations nécessaires à l'exécution de l'opération.
API : l'API que vous pouvez appeler pour exécuter l'action.
Niveau d'accès : le niveau d'accès prédéfini accordé pour chaque API. Valeurs valides : create, list, get, update et delete.
Type de ressource : le type de ressource qui prend en charge l'autorisation pour exécuter l'action. Il indique si l'action prend en charge les permissions au niveau de la ressource. La ressource spécifiée doit être compatible avec l'action. Sinon, la politique sera inefficace.
- Pour les API avec permissions au niveau de la ressource, les types de ressource requis sont marqués d'un astérisque (*). Spécifiez l'Alibaba Cloud Resource Name (ARN) correspondant dans l'élément Resource de la politique.
- Pour les API sans permissions au niveau de la ressource, la valeur All Resources est affichée. Utilisez un astérisque (*) dans l'élément Resource de la politique.
Clé de condition : les clés de condition définies par le service. La clé permet un contrôle granulaire, applicable aux actions seules ou aux actions associées à des ressources spécifiques. En plus des clés de condition propres au service, Alibaba Cloud fournit un ensemble de clés de condition communes applicables à tous les services pris en charge par RAM.
Action dépendante : les actions dépendantes requises pour exécuter l'action. Pour mener à bien l'opération, l'utilisateur RAM ou le rôle RAM doit disposer des permissions pour toutes les actions dépendantes.

searchengine:CreateTable

create

*Instance

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

Aucune

Syntaxe de la requête

POST /openapi/ha3/instances/{instanceId}/tables HTTP/1.1

Paramètres de chemin

Paramètre	Type	Requis	Description	Exemple
instanceId	string	Oui	L'identifiant de l'instance.	ha-cn-pl32rf0****

Paramètres de requête

Paramètre	Type	Requis	Description	Exemple
dryRun	boolean	Non	Indique si un test à blanc doit être effectué (vérifie uniquement si la source de données est valide). Valeurs valides :\n- true : effectue un test à blanc.\n- false : n'effectue pas de test à blanc.	true
body	object	Non	Corps.
name	string	Non	Le nom de l'index.	api_index_1
dataProcessorCount	integer	Non	Le nombre de ressources de mise à jour des données.	1
partitionCount	integer	Non	Le nombre de fragments de données.	1
dataSource	object	Non	La configuration de la source de données.
type	string	Non	Le type de source de données. Seuls odps, swift et oss sont pris en charge. Valeurs valides : odps, swift, saro, oss et unKnow.	odps
dataTimeSec	integer	Non	L'horodatage pour le suivi des données incrémentielles.	1715160176
autoBuildIndex	boolean	Non	Indique si la reconstruction automatique de l'index est activée.	true
config	object	Non	La configuration de la source de données.
endpoint	string	Non	The access endpoint.	http://service.cn-hangzhou.maxcompute.aliyun-inc.com/api
accessKey	string	Non	The AccessKey ID of the ODPS data source.	L***p
accessSecret	string	Non	The AccessKey secret of the ODPS data source.	5**9a6
project	string	Non	The project name of the ODPS data source.	test_project
partition	string	Non	The partition. This parameter is required when the data source is ODPS.	ds=20220713
table	string	Non	The table name of the ODPS or DLF data source.	test56
path	string	Non	The relative path.	/test
ossPath	string	Non	The OSS data source path.	/opensearch/test.txt
bucket	string	Non	oss bucket	test-bucket
catalog	string	Non	The catalog name of the DLF data source.	test_catalog
database	string	Non	The database of the DLF data source.	opensearch_db
tag	string	Non	The tag of the DLF data source.	test
tableFormat	string	Non	The table format of the DLF data source.	paimon lance object
format	string	Non	The file format type.	ha3 json
rawSchema	string	Non	Le schéma brut. Si vous spécifiez ce paramètre, la valeur est utilisée directement comme structure de schéma HA3 sans assemblage manuel.	{}
primaryKey	string	Non	Le champ de clé primaire.	id
fieldSchema	object	Non	Le schéma de champ. La clé est le nom du champ.
	string	Non	Structure de mappage.	{
vectorIndex	array<object>	Non	La structure de l'index.
	array<object>	Non
indexName	string	Non	Le nom de la structure de l'index.	test_index
vectorField	string	Non	Le champ vectoriel.	source_image_vector
sparseIndexField	string	Non	Le champ d'index de vecteur creux.	sparse_indices
sparseValueField	string	Non	Le champ de valeur de vecteur creux.	sparse_values
dimension	string	Non	Les dimensions du vecteur.	128
vectorIndexType	string	Non	L'algorithme d'index vectoriel.	Qc
distanceType	string	Non	Le type de distance.	SquaredEuclidean
namespace	string	Non	Le champ d'espace de noms.	namespace
advanceParams	object	Non	La configuration de la structure de l'index.
buildIndexParams	string	Non	The index building parameters.	{}
searchIndexParams	string	Non	The index search parameters.	{}
minScanDocCnt	string	Non	The minimum number of candidate documents for recall.	20000
linearBuildThreshold	string	Non	The threshold for linear building.	5000
dataProcessConfig	array<object>	Non	La configuration du traitement des champs.
	array<object>	Non	Les détails de la configuration du traitement des champs.
operator	string	Non	La méthode de traitement des champs. Valeurs valides : copy : copie le champ source dans le champ de destination. vectorize : vectorise le champ source à l'aide d'un modèle et stocke le vecteur dans le champ de destination.	vectorize
dstField	string	Non	Le champ cible.	source_image_vector
srcField	string	Non	Le champ source.	source_image
params	object	Non	La configuration du modèle.
vectorModel	string	Non	The vectorization model.	clip
vectorModal	string	Non	The data type.	image
srcFieldConfig	object	Non	The vectorization information source.
ossEndpoint	string	Non	The OSS region endpoint.	oss-cn-hangzhou-internal.aliyuncs.com
ossBucket	string	Non	OSSBucket	test-bucket
uid	string	Non	The Alibaba Cloud account ID.	1062017779051424
scene	string	Non	Le type de modèle.	videoSearcher

Exemple de requête

POST /openapi/ha3/instances/{instanceId}/tables

Important Cet exemple répertorie uniquement les paramètres les plus simples. Pour d'autres paramètres personnalisés, reportez-vous aux paramètres de requête.

{
    "name": "api",
    "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"
        }
    ]
}

Pour plus d'informations, consultez Structure de la réponse

Éléments de réponse

Élément	Type	Description	Exemple
	object
requestId	string	L'identifiant de la requête.	2AE63638-5420-56DC-BF59-37D8174039A0
result	object	Le résultat renvoyé.	{}

Exemples

JSON format

{
  "requestId": "2AE63638-5420-56DC-BF59-37D8174039A0",
  "result": {}
}

Codes d'erreur

Consultez Codes d'erreur pour la liste complète.

Notes de version

Consultez Notes de version pour la liste complète.