CreateDocumentCollectionRequest (gpdb20160503 3.0.0 API)

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

public class CreateDocumentCollectionRequest
extends com.aliyun.tea.TeaModel

字段概要

字段
限定符和类型	字段和说明
`String`	`collection` This parameter is required.
`String`	`DBInstanceId` This parameter is required.
`String`	`embeddingModel` The vectorization algorithm.
`Integer`	`externalStorage` Specifies whether to use the memory mapping technology to create HNSW indexes.
`String`	`fullTextRetrievalFields` example: title,page
`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` example: mynamespace
`Long`	`ownerId`
`String`	`parser` example: zh_cn
`Integer`	`pqEnable` Specifies whether to enable the product quantization (PQ) feature for index acceleration.
`String`	`regionId` This parameter is required.

构造器概要

构造器
构造器和说明

CreateDocumentCollectionRequest()

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

方法概要

所有方法静态方法实例方法具体方法
限定符和类型	方法和说明
`static CreateDocumentCollectionRequest`	`build(Map<String,?> map)`
`String`	`getCollection()`
`String`	`getDBInstanceId()`
`String`	`getEmbeddingModel()`
`Integer`	`getExternalStorage()`
`String`	`getFullTextRetrievalFields()`
`Integer`	`getHnswM()`
`String`	`getManagerAccount()`
`String`	`getManagerAccountPassword()`
`String`	`getMetadata()`
`String`	`getMetrics()`
`String`	`getNamespace()`
`Long`	`getOwnerId()`
`String`	`getParser()`
`Integer`	`getPqEnable()`
`String`	`getRegionId()`
`CreateDocumentCollectionRequest`	`setCollection(String collection)`
`CreateDocumentCollectionRequest`	`setDBInstanceId(String DBInstanceId)`
`CreateDocumentCollectionRequest`	`setEmbeddingModel(String embeddingModel)`
`CreateDocumentCollectionRequest`	`setExternalStorage(Integer externalStorage)`
`CreateDocumentCollectionRequest`	`setFullTextRetrievalFields(String fullTextRetrievalFields)`
`CreateDocumentCollectionRequest`	`setHnswM(Integer hnswM)`
`CreateDocumentCollectionRequest`	`setManagerAccount(String managerAccount)`
`CreateDocumentCollectionRequest`	`setManagerAccountPassword(String managerAccountPassword)`
`CreateDocumentCollectionRequest`	`setMetadata(String metadata)`
`CreateDocumentCollectionRequest`	`setMetrics(String metrics)`
`CreateDocumentCollectionRequest`	`setNamespace(String namespace)`
`CreateDocumentCollectionRequest`	`setOwnerId(Long ownerId)`
`CreateDocumentCollectionRequest`	`setParser(String parser)`
`CreateDocumentCollectionRequest`	`setPqEnable(Integer pqEnable)`
`CreateDocumentCollectionRequest`	`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
  - embeddingModel
```
@NameInMap(value="EmbeddingModel")
public String embeddingModel
```
    The vectorization algorithm.
    
    Valid values:
    - text-embedding-v1: the algorithm that produces 1536-dimensional vectors.
    - text-embedding-v2: the algorithm that produces 1536-dimensional vectors.
    - text2vec: the algorithm that produces 1024-dimensional vectors.
    - m3e-base: the algorithm that produces 768-dimensional vectors.
    - m3e-small: the algorithm that produces 512-dimensional vectors.
    - multimodal-embedding-one-peace-v1: the image vectorization algorithm that produces 1536-dimensional vectors.
    - clip-vit-b-32: the image vectorization algorithm that uses the Contrastive Language-Image Pre-Training (CLIP) ViT-B/32 model and produces 512-dimensional vectors.
    - clip-vit-b-16: the image vectorization algorithm that uses the CLIP ViT-B/16 model and produces 512-dimensional vectors.
    - clip-vit-l-14: the image vectorization algorithm that uses the CLIP ViT-L/14 model and produces 768-dimensional vectors.
    - clip-vit-l-14-336px: the image vectorization algorithm that uses the CLIP ViT-L/14@336px model and produces 768-dimensional vectors.
    - clip-rn50: the image vectorization algorithm that uses the CLIP RN50 model and produces 1024-dimensional vectors.
    - clip-rn101: the image vectorization algorithm that uses the CLIP RN101 model and produces 512-dimensional vectors.
    - clip-rn50x4: the image vectorization algorithm that uses the CLIP RN50x4 model and produces 640-dimensional vectors.
    - clip-rn50x16: the image vectorization algorithm that uses the CLIP RN50x16 model and produces 768-dimensional vectors.
    - clip-rn50x64: the image vectorization algorithm that uses the CLIP RN50x64 model and produces 1024-dimensional vectors.
    example:
    text-embedding-v1
  - 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,page
  - 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, doc_name, content, loader_metadata, source, and to_tsvector cannot be used.
    
    example:
    {"title":"text","page":"int"}
  - metrics
```
@NameInMap(value="Metrics")
public String metrics
```
    example:
    cosine
  - namespace
```
@NameInMap(value="Namespace")
public String namespace
```
    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
```
    This parameter is required.
    example:
    cn-hangzhou
- 构造器详细资料
  - CreateDocumentCollectionRequest
```
public CreateDocumentCollectionRequest()
```
- 方法详细资料
  - build
```
public static CreateDocumentCollectionRequest build(Map<String,?> map)
                                             throws Exception
```
    抛出:
    
    Exception
  - setCollection
```
public CreateDocumentCollectionRequest setCollection(String collection)
```
  - getCollection
```
public String getCollection()
```
  - setDBInstanceId
```
public CreateDocumentCollectionRequest setDBInstanceId(String DBInstanceId)
```
  - getDBInstanceId
```
public String getDBInstanceId()
```
  - setEmbeddingModel
```
public CreateDocumentCollectionRequest setEmbeddingModel(String embeddingModel)
```
  - getEmbeddingModel
```
public String getEmbeddingModel()
```
  - setExternalStorage
```
public CreateDocumentCollectionRequest setExternalStorage(Integer externalStorage)
```
  - getExternalStorage
```
public Integer getExternalStorage()
```
  - setFullTextRetrievalFields
```
public CreateDocumentCollectionRequest setFullTextRetrievalFields(String fullTextRetrievalFields)
```
  - getFullTextRetrievalFields
```
public String getFullTextRetrievalFields()
```
  - setHnswM
```
public CreateDocumentCollectionRequest setHnswM(Integer hnswM)
```
  - getHnswM
```
public Integer getHnswM()
```
  - setManagerAccount
```
public CreateDocumentCollectionRequest setManagerAccount(String managerAccount)
```
  - getManagerAccount
```
public String getManagerAccount()
```
  - setManagerAccountPassword
```
public CreateDocumentCollectionRequest setManagerAccountPassword(String managerAccountPassword)
```
  - getManagerAccountPassword
```
public String getManagerAccountPassword()
```
  - setMetadata
```
public CreateDocumentCollectionRequest setMetadata(String metadata)
```
  - getMetadata
```
public String getMetadata()
```
  - setMetrics
```
public CreateDocumentCollectionRequest setMetrics(String metrics)
```
  - getMetrics
```
public String getMetrics()
```
  - setNamespace
```
public CreateDocumentCollectionRequest setNamespace(String namespace)
```
  - getNamespace
```
public String getNamespace()
```
  - setOwnerId
```
public CreateDocumentCollectionRequest setOwnerId(Long ownerId)
```
  - getOwnerId
```
public Long getOwnerId()
```
  - setParser
```
public CreateDocumentCollectionRequest setParser(String parser)
```
  - getParser
```
public String getParser()
```
  - setPqEnable
```
public CreateDocumentCollectionRequest setPqEnable(Integer pqEnable)
```
  - getPqEnable
```
public Integer getPqEnable()
```
  - setRegionId
```
public CreateDocumentCollectionRequest setRegionId(String regionId)
```
  - getRegionId
```
public String getRegionId()
```

类 CreateDocumentCollectionRequest

字段概要

构造器概要

方法概要

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

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

字段详细资料

collection

DBInstanceId

embeddingModel

externalStorage

fullTextRetrievalFields

hnswM

managerAccount

managerAccountPassword

metadata

metrics

namespace

ownerId

parser

pqEnable

regionId

构造器详细资料

CreateDocumentCollectionRequest

方法详细资料

build

setCollection

getCollection

setDBInstanceId

getDBInstanceId

setEmbeddingModel

getEmbeddingModel

setExternalStorage

getExternalStorage

setFullTextRetrievalFields

getFullTextRetrievalFields

setHnswM

getHnswM

setManagerAccount

getManagerAccount

setManagerAccountPassword

getManagerAccountPassword

setMetadata

getMetadata

setMetrics

getMetrics

setNamespace

getNamespace

setOwnerId

getOwnerId

setParser

getParser

setPqEnable

getPqEnable

setRegionId

getRegionId