CreateCollectionRequest (gpdb20160503 3.0.0 API)

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

public class CreateCollectionRequest
extends com.aliyun.tea.TeaModel

字段概要

字段
限定符和类型	字段和说明
`String`	`collection` The name of the collection that you want to create.
`String`	`DBInstanceId` The instance ID.
`Long`	`dimension` The number of vector dimensions.
`Integer`	`externalStorage` Specifies whether to use the memory mapping technology to create HNSW indexes.
`String`	`fullTextRetrievalFields` example: title,content
`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`	`metadata` The metadata of the vector data, which is a JSON string in the MAP format.
`String`	`metrics` example: cosine
`String`	`namespace` The name of the namespace.
`Long`	`ownerId`
`String`	`parser` example: zh_cn
`Integer`	`pqEnable` Specifies whether to enable the product quantization (PQ) feature for index acceleration.
`String`	`regionId` The region ID of the instance.
`String`	`workspaceId` The ID of the workspace that consists of multiple AnalyticDB for PostgreSQL instances.

构造器概要

构造器
构造器和说明

CreateCollectionRequest()

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

方法概要

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

从类继承的方法 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
```
    The name of the collection that you want to create.
    
    The name must comply with the naming conventions of PostgreSQL objects.
    
    This parameter is required.
    example:
    document
  - DBInstanceId
```
@NameInMap(value="DBInstanceId")
public String DBInstanceId
```
    The instance ID.
    
    You can call the DescribeDBInstances operation to query the IDs of all AnalyticDB for PostgreSQL instances in a specific region.
    
    example:
    gp-xxxxxxxxx
  - dimension
```
@NameInMap(value="Dimension")
public Long dimension
```
    The number of vector dimensions.
    
    If you specify this parameter, an index is created. When you call the UpsertCollectionData operation, make sure that the length of the Rows.Vector parameter is the same as the value of this parameter. If you do not specify this parameter, you can call the CreateVectorIndex operation to create an index.
    
    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
  - fullTextRetrievalFields
```
@NameInMap(value="FullTextRetrievalFields")
public String fullTextRetrievalFields
```
    example:
    title,content
  - 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
  - metadata
```
@NameInMap(value="Metadata")
public String metadata
```
    The metadata of the vector data, which is a JSON string in the MAP format. The key specifies the field name, and the value specifies the data type.
    - For information about the supported data types, see Data types.
    - The money data type is not supported.
    **
    
    Warning Reserved fields such as id, vector, to_tsvector, and source cannot be used.
    
    This parameter is required.
    example:
    {"title":"text","content":"text","response":"int"}
  - metrics
```
@NameInMap(value="Metrics")
public String metrics
```
    example:
    cosine
  - namespace
```
@NameInMap(value="Namespace")
public String namespace
```
    The name of the namespace.
    
    You can call the CreateNamespace operation to create a namespace and call the ListNamespaces operation to query a list of namespaces.
    
    example:
    mynamespace
  - ownerId
```
@NameInMap(value="OwnerId")
public Long ownerId
```
  - parser
```
@NameInMap(value="Parser")
public String parser
```
    example:
    zh_cn
  - 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:
    0
  - regionId
```
@NameInMap(value="RegionId")
public String regionId
```
    The region ID of the instance.
    
    This parameter is required.
    example:
    cn-hangzhou
  - workspaceId
```
@NameInMap(value="WorkspaceId")
public String workspaceId
```
    The ID of the workspace that consists of multiple AnalyticDB for PostgreSQL instances. You must specify one of the WorkspaceId and DBInstanceId parameters. If you specify both parameters, the WorkspaceId parameter takes effect.
    example:
    gp-ws-*****
- 构造器详细资料
  - CreateCollectionRequest
```
public CreateCollectionRequest()
```
- 方法详细资料
  - build
```
public static CreateCollectionRequest build(Map<String,?> map)
                                     throws Exception
```
    抛出:
    
    Exception
  - setCollection
```
public CreateCollectionRequest setCollection(String collection)
```
  - getCollection
```
public String getCollection()
```
  - setDBInstanceId
```
public CreateCollectionRequest setDBInstanceId(String DBInstanceId)
```
  - getDBInstanceId
```
public String getDBInstanceId()
```
  - setDimension
```
public CreateCollectionRequest setDimension(Long dimension)
```
  - getDimension
```
public Long getDimension()
```
  - setExternalStorage
```
public CreateCollectionRequest setExternalStorage(Integer externalStorage)
```
  - getExternalStorage
```
public Integer getExternalStorage()
```
  - setFullTextRetrievalFields
```
public CreateCollectionRequest setFullTextRetrievalFields(String fullTextRetrievalFields)
```
  - getFullTextRetrievalFields
```
public String getFullTextRetrievalFields()
```
  - setHnswM
```
public CreateCollectionRequest setHnswM(Integer hnswM)
```
  - getHnswM
```
public Integer getHnswM()
```
  - setManagerAccount
```
public CreateCollectionRequest setManagerAccount(String managerAccount)
```
  - getManagerAccount
```
public String getManagerAccount()
```
  - setManagerAccountPassword
```
public CreateCollectionRequest setManagerAccountPassword(String managerAccountPassword)
```
  - getManagerAccountPassword
```
public String getManagerAccountPassword()
```
  - setMetadata
```
public CreateCollectionRequest setMetadata(String metadata)
```
  - getMetadata
```
public String getMetadata()
```
  - setMetrics
```
public CreateCollectionRequest setMetrics(String metrics)
```
  - getMetrics
```
public String getMetrics()
```
  - setNamespace
```
public CreateCollectionRequest setNamespace(String namespace)
```
  - getNamespace
```
public String getNamespace()
```
  - setOwnerId
```
public CreateCollectionRequest setOwnerId(Long ownerId)
```
  - getOwnerId
```
public Long getOwnerId()
```
  - setParser
```
public CreateCollectionRequest setParser(String parser)
```
  - getParser
```
public String getParser()
```
  - setPqEnable
```
public CreateCollectionRequest setPqEnable(Integer pqEnable)
```
  - getPqEnable
```
public Integer getPqEnable()
```
  - setRegionId
```
public CreateCollectionRequest setRegionId(String regionId)
```
  - getRegionId
```
public String getRegionId()
```
  - setWorkspaceId
```
public CreateCollectionRequest setWorkspaceId(String workspaceId)
```
  - getWorkspaceId
```
public String getWorkspaceId()
```

类 CreateCollectionRequest

字段概要

构造器概要

方法概要

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

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

字段详细资料

collection

DBInstanceId

dimension

externalStorage

fullTextRetrievalFields

hnswM

managerAccount

managerAccountPassword

metadata

metrics

namespace

ownerId

parser

pqEnable

regionId

workspaceId

构造器详细资料

CreateCollectionRequest

方法详细资料

build

setCollection

getCollection

setDBInstanceId

getDBInstanceId

setDimension

getDimension

setExternalStorage

getExternalStorage

setFullTextRetrievalFields

getFullTextRetrievalFields

setHnswM

getHnswM

setManagerAccount

getManagerAccount

setManagerAccountPassword

getManagerAccountPassword

setMetadata

getMetadata

setMetrics

getMetrics

setNamespace

getNamespace

setOwnerId

getOwnerId

setParser

getParser

setPqEnable

getPqEnable

setRegionId

getRegionId

setWorkspaceId

getWorkspaceId