CreateVectorIndexRequest (gpdb20160503 3.0.0 API)

java.lang.Object
- com.aliyun.tea.TeaModel
- - com.aliyun.gpdb20160503.models.CreateVectorIndexRequest

public class CreateVectorIndexRequest
extends com.aliyun.tea.TeaModel

字段概要

字段
限定符和类型	字段和说明
`String`	`collection` This parameter is required.
`String`	`DBInstanceId` This parameter is required.
`Integer`	`dimension` This parameter is required.
`Integer`	`externalStorage` Specifies whether to use the memory mapping technology to create HNSW indexes.
`Integer`	`hnswM` The maximum number of neighbors for the Hierarchical Navigable Small World (HNSW) algorithm.
`String`	`managerAccount` This parameter is required.
`String`	`managerAccountPassword` This parameter is required.
`String`	`metrics` The method that is used to create vector indexes.Valid values: l2: Euclidean distance.
`String`	`namespace` example: mynamespace
`Long`	`ownerId`
`Integer`	`pqEnable` Specifies whether to enable the product quantization (PQ) feature for index acceleration.
`String`	`regionId` This parameter is required.

构造器概要

构造器
构造器和说明

CreateVectorIndexRequest()

构造器
构造器和说明
`CreateVectorIndexRequest()`

方法概要

所有方法静态方法实例方法具体方法
限定符和类型	方法和说明
`static CreateVectorIndexRequest`	`build(Map<String,?> map)`
`String`	`getCollection()`
`String`	`getDBInstanceId()`
`Integer`	`getDimension()`
`Integer`	`getExternalStorage()`
`Integer`	`getHnswM()`
`String`	`getManagerAccount()`
`String`	`getManagerAccountPassword()`
`String`	`getMetrics()`
`String`	`getNamespace()`
`Long`	`getOwnerId()`
`Integer`	`getPqEnable()`
`String`	`getRegionId()`
`CreateVectorIndexRequest`	`setCollection(String collection)`
`CreateVectorIndexRequest`	`setDBInstanceId(String DBInstanceId)`
`CreateVectorIndexRequest`	`setDimension(Integer dimension)`
`CreateVectorIndexRequest`	`setExternalStorage(Integer externalStorage)`
`CreateVectorIndexRequest`	`setHnswM(Integer hnswM)`
`CreateVectorIndexRequest`	`setManagerAccount(String managerAccount)`
`CreateVectorIndexRequest`	`setManagerAccountPassword(String managerAccountPassword)`
`CreateVectorIndexRequest`	`setMetrics(String metrics)`
`CreateVectorIndexRequest`	`setNamespace(String namespace)`
`CreateVectorIndexRequest`	`setOwnerId(Long ownerId)`
`CreateVectorIndexRequest`	`setPqEnable(Integer pqEnable)`
`CreateVectorIndexRequest`	`setRegionId(String regionId)`

从类继承的方法 com.aliyun.tea.TeaModel
build, buildMap, confirmType, confirmType, parseObject, toMap, toMap, toModel, validate, validateParams

从类继承的方法 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- 字段详细资料
  - collection
```
@NameInMap(value="Collection")
public String collection
```
    This parameter is required.
    example:
    document
  - DBInstanceId
```
@NameInMap(value="DBInstanceId")
public String DBInstanceId
```
    This parameter is required.
    example:
    gp-xxxxxxxxx
  - dimension
```
@NameInMap(value="Dimension")
public Integer dimension
```
    This parameter is required.
    example:
    1024
  - externalStorage
```
@NameInMap(value="ExternalStorage")
public Integer externalStorage
```
    Specifies whether to use the memory mapping technology to create HNSW indexes. Valid values: 0 and 1. Default value: 0. We recommend that you set the value to 1 in scenarios that require upload speed but not data deletion.
    - 0: uses segmented paging storage to create indexes. This method uses the shared buffer of PostgreSQL for caching and supports the delete and update operations.
    - 1: uses the memory mapping technology to create indexes. This method does not support the delete or update operation.
    example:
    0
  - hnswM
```
@NameInMap(value="HnswM")
public Integer hnswM
```
    The maximum number of neighbors for the Hierarchical Navigable Small World (HNSW) algorithm. Valid values: 1 to 1000. In most cases, this parameter is automatically configured based on the value of the Dimension parameter. You do not need to configure this parameter.
    
    We recommend that you configure this parameter based on the value of the Dimension parameter.
    - If you set Dimension to a value less than or equal to 384, set the value of HnswM to 16.
    - If you set Dimension to a value greater than 384 and less than or equal to 768, set the value of HnswM to 32.
    - If you set Dimension to a value greater than 768 and less than or equal to 1024, set the value of HnswM to 64.
    - If you set Dimension to a value greater than 1024, set the value of HnswM to 128.
    example:
    64
  - managerAccount
```
@NameInMap(value="ManagerAccount")
public String managerAccount
```
    This parameter is required.
    example:
    testaccount
  - managerAccountPassword
```
@NameInMap(value="ManagerAccountPassword")
public String managerAccountPassword
```
    This parameter is required.
    example:
    testpassword
  - metrics
```
@NameInMap(value="Metrics")
public String metrics
```
    The method that is used to create vector indexes.Valid values:
    - l2: Euclidean distance.
    - ip: inner product distance.
    - cosine: cosine similarity.
    example:
    cosine
  - namespace
```
@NameInMap(value="Namespace")
public String namespace
```
    example:
    mynamespace
  - ownerId
```
@NameInMap(value="OwnerId")
public Long ownerId
```
  - pqEnable
```
@NameInMap(value="PqEnable")
public Integer pqEnable
```
    Specifies whether to enable the product quantization (PQ) feature for index acceleration. We recommend that you enable this feature for more than 500,000 rows of data. Valid values:
    - 0: no.
    - 1 (default): yes.
    example:
    1
  - regionId
```
@NameInMap(value="RegionId")
public String regionId
```
    This parameter is required.
    example:
    cn-hangzhou
- 构造器详细资料
  - CreateVectorIndexRequest
```
public CreateVectorIndexRequest()
```
- 方法详细资料
  - build
```
public static CreateVectorIndexRequest build(Map<String,?> map)
                                      throws Exception
```
    抛出:
    
    Exception
  - setCollection
```
public CreateVectorIndexRequest setCollection(String collection)
```
  - getCollection
```
public String getCollection()
```
  - setDBInstanceId
```
public CreateVectorIndexRequest setDBInstanceId(String DBInstanceId)
```
  - getDBInstanceId
```
public String getDBInstanceId()
```
  - setDimension
```
public CreateVectorIndexRequest setDimension(Integer dimension)
```
  - getDimension
```
public Integer getDimension()
```
  - setExternalStorage
```
public CreateVectorIndexRequest setExternalStorage(Integer externalStorage)
```
  - getExternalStorage
```
public Integer getExternalStorage()
```
  - setHnswM
```
public CreateVectorIndexRequest setHnswM(Integer hnswM)
```
  - getHnswM
```
public Integer getHnswM()
```
  - setManagerAccount
```
public CreateVectorIndexRequest setManagerAccount(String managerAccount)
```
  - getManagerAccount
```
public String getManagerAccount()
```
  - setManagerAccountPassword
```
public CreateVectorIndexRequest setManagerAccountPassword(String managerAccountPassword)
```
  - getManagerAccountPassword
```
public String getManagerAccountPassword()
```
  - setMetrics
```
public CreateVectorIndexRequest setMetrics(String metrics)
```
  - getMetrics
```
public String getMetrics()
```
  - setNamespace
```
public CreateVectorIndexRequest setNamespace(String namespace)
```
  - getNamespace
```
public String getNamespace()
```
  - setOwnerId
```
public CreateVectorIndexRequest setOwnerId(Long ownerId)
```
  - getOwnerId
```
public Long getOwnerId()
```
  - setPqEnable
```
public CreateVectorIndexRequest setPqEnable(Integer pqEnable)
```
  - getPqEnable
```
public Integer getPqEnable()
```
  - setRegionId
```
public CreateVectorIndexRequest setRegionId(String regionId)
```
  - getRegionId
```
public String getRegionId()
```

类 CreateVectorIndexRequest

字段概要

构造器概要

方法概要

从类继承的方法 com.aliyun.tea.TeaModel

从类继承的方法 java.lang.Object

字段详细资料

collection

DBInstanceId

dimension

externalStorage

hnswM

managerAccount

managerAccountPassword

metrics

namespace

ownerId

pqEnable

regionId

构造器详细资料

CreateVectorIndexRequest

方法详细资料

build

setCollection

getCollection

setDBInstanceId

getDBInstanceId

setDimension

getDimension

setExternalStorage

getExternalStorage

setHnswM

getHnswM

setManagerAccount

getManagerAccount

setManagerAccountPassword

getManagerAccountPassword

setMetrics

getMetrics

setNamespace

getNamespace

setOwnerId

getOwnerId

setPqEnable

getPqEnable

setRegionId

getRegionId