QueryCollectionDataShrinkRequest (gpdb20160503 3.0.0 API)

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

public class QueryCollectionDataShrinkRequest
extends com.aliyun.tea.TeaModel

字段概要

字段
限定符和类型	字段和说明
`String`	`collection` The name of the collection.
`String`	`content` The content that is used for full-text search.
`String`	`DBInstanceId` The instance ID.
`String`	`filter` The filter condition that is used to query data.
`String`	`hybridSearch` The two-way retrieval algorithm.
`String`	`hybridSearchArgsShrink` The parameters of the two-way retrieval algorithm.
`String`	`includeMetadataFields` The metadata fields to be returned.
`Boolean`	`includeValues` Specifies whether to return vector data.
`String`	`metrics` The similarity algorithm for search.
`String`	`namespace` The name of the namespace.
`String`	`namespacePassword` This parameter is required.
`Integer`	`offset` The starting point for paginated queries.
`String`	`orderBy` The fields by which to sort the results.
`Long`	`ownerId`
`String`	`regionId` The region ID of the instance.
`String`	`relationalTableFilterShrink`
`Long`	`topK` This parameter is required.
`String`	`vectorShrink` The vector data.
`String`	`workspaceId` example: gp-ws-*****

构造器概要

构造器
构造器和说明

QueryCollectionDataShrinkRequest()

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

方法概要

所有方法静态方法实例方法具体方法
限定符和类型	方法和说明
`static QueryCollectionDataShrinkRequest`	`build(Map<String,?> map)`
`String`	`getCollection()`
`String`	`getContent()`
`String`	`getDBInstanceId()`
`String`	`getFilter()`
`String`	`getHybridSearch()`
`String`	`getHybridSearchArgsShrink()`
`String`	`getIncludeMetadataFields()`
`Boolean`	`getIncludeValues()`
`String`	`getMetrics()`
`String`	`getNamespace()`
`String`	`getNamespacePassword()`
`Integer`	`getOffset()`
`String`	`getOrderBy()`
`Long`	`getOwnerId()`
`String`	`getRegionId()`
`String`	`getRelationalTableFilterShrink()`
`Long`	`getTopK()`
`String`	`getVectorShrink()`
`String`	`getWorkspaceId()`
`QueryCollectionDataShrinkRequest`	`setCollection(String collection)`
`QueryCollectionDataShrinkRequest`	`setContent(String content)`
`QueryCollectionDataShrinkRequest`	`setDBInstanceId(String DBInstanceId)`
`QueryCollectionDataShrinkRequest`	`setFilter(String filter)`
`QueryCollectionDataShrinkRequest`	`setHybridSearch(String hybridSearch)`
`QueryCollectionDataShrinkRequest`	`setHybridSearchArgsShrink(String hybridSearchArgsShrink)`
`QueryCollectionDataShrinkRequest`	`setIncludeMetadataFields(String includeMetadataFields)`
`QueryCollectionDataShrinkRequest`	`setIncludeValues(Boolean includeValues)`
`QueryCollectionDataShrinkRequest`	`setMetrics(String metrics)`
`QueryCollectionDataShrinkRequest`	`setNamespace(String namespace)`
`QueryCollectionDataShrinkRequest`	`setNamespacePassword(String namespacePassword)`
`QueryCollectionDataShrinkRequest`	`setOffset(Integer offset)`
`QueryCollectionDataShrinkRequest`	`setOrderBy(String orderBy)`
`QueryCollectionDataShrinkRequest`	`setOwnerId(Long ownerId)`
`QueryCollectionDataShrinkRequest`	`setRegionId(String regionId)`
`QueryCollectionDataShrinkRequest`	`setRelationalTableFilterShrink(String relationalTableFilterShrink)`
`QueryCollectionDataShrinkRequest`	`setTopK(Long topK)`
`QueryCollectionDataShrinkRequest`	`setVectorShrink(String vectorShrink)`
`QueryCollectionDataShrinkRequest`	`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.
    
    You can call the ListCollections operation to query a list of collections.
    
    This parameter is required.
    example:
    document
  - content
```
@NameInMap(value="Content")
public String content
```
    The content that is used for full-text search. If you leave this parameter empty, only vector search is used. If you do not leave this parameter empty, two-way retrieval based on vector search and full-text search is used.
    
    You must specify at least one of the Content and Vector parameters.
    
    example:
    hello_world
  - DBInstanceId
```
@NameInMap(value="DBInstanceId")
public String DBInstanceId
```
    The instance ID.
    
    You can call the DescribeDBInstances operation to query the information about all AnalyticDB for PostgreSQL instances within a region, including instance IDs.
    
    example:
    gp-xxxxxxxxx
  - filter
```
@NameInMap(value="Filter")
public String filter
```
    The filter condition that is used to query data. Specify the parameter in the WHERE clause format. The parameter is an expression that returns a Boolean value of TRUE or FALSE. The parameter can contain comparison operators, such as Equal To (=), Not Equal To (<> or !=), Greater Than (>), Less Than (<), Greater Than or Equal To (>=), and Less Than or Equal To (<=), logical operators, such as AND, OR, and NOT, and keywords, such as IN, BETWEEN, and LIKE.
    - For more information, see https://www.postgresqltutorial.com/postgresql-tutorial/postgresql-where/.
    example:
    response > 200
  - hybridSearch
```
@NameInMap(value="HybridSearch")
public String hybridSearch
```
    The two-way retrieval algorithm. This parameter is empty by default, which specifies that scores of vector search and full-text search are directly compared and sorted without additional weighting or adjustments.
    
    Valid values:
    - RRF: The reciprocal rank fusion (RRF) algorithm uses a constant k to control the fusion effect. For more information, see the description of the HybridSearchArgs parameter.
    - Weight: This algorithm uses the alpha parameter to specify the proportion of the vector search score and the full-text search score and then sorts by weight. For more information, see the description of the HybridSearchArgs parameter.
    - Cascaded: This algorithm performs first full-text search and then vector search.
    example:
    RRF
  - hybridSearchArgsShrink
```
@NameInMap(value="HybridSearchArgs")
public String hybridSearchArgsShrink
```
    The parameters of the two-way retrieval algorithm. The following parameters are supported:
    - When HybridSearch is set to RRF, the scores are calculated by using the 1/(k+rank_i) formula. The constant k is a positive integer that is greater than 1.
```
{ 
    "RRF": {
     "k": 60
    }
 }
 
```
    - When HybridSearch is set to Weight, the scores are calculated by using the alpha * vector_score + (1-alpha) * text_score formula. The alpha parameter specifies the proportion of the vector search score and the full-text search score and ranges from 0 to 1. A value of 0 specifies full-text search and a value of 1 specifies vector search.
```
{ 
    "Weight": {
     "alpha": 0.5
    }
 }
 
```
  - includeMetadataFields
```
@NameInMap(value="IncludeMetadataFields")
public String includeMetadataFields
```
    The metadata fields to be returned. Separate multiple fields with commas (,). This parameter is empty by default.
    example:
    title,content
  - includeValues
```
@NameInMap(value="IncludeValues")
public Boolean includeValues
```
    Specifies whether to return vector data. Valid values:
    - true: returns vector data.
    - false: does not return vector data. In full-text search scenarios, set this parameter to false.
    example:
    true
  - metrics
```
@NameInMap(value="Metrics")
public String metrics
```
    The similarity algorithm for search. Valid values:
    - l2: Euclidean distance.
    - ip: inner product distance.
    - cosine: cosine similarity.
    If you leave this parameter empty, the l2, ip, or cosine algorithm that is specified when you create an index is used.
    
    example:
    cosine
  - namespace
```
@NameInMap(value="Namespace")
public String namespace
```
    The name of the namespace.
    
    You can call the ListNamespaces operation to query a list of namespaces.
    
    example:
    mynamespace
  - namespacePassword
```
@NameInMap(value="NamespacePassword")
public String namespacePassword
```
    This parameter is required.
    example:
    testpassword
  - offset
```
@NameInMap(value="Offset")
public Integer offset
```
    The starting point for paginated queries. This parameter is empty by default. This parameter does not support two-way retrieval scenarios.
    
    The value must be greater than or equal to 0. If you do not leave this parameter empty, the Total parameter is returned to indicate the total number of matched entries. You must specify this parameter and the TopK parameter in pairs. For example, to paginate 20 chunks at a time for a total of 45 chunks whose chunk_id values are 0 to 44, three requests are involved:
    - First request: Set the Offset value to 0 and the TopK value to 20. The chunks whose chunk_id values are 0 to 19 are returned.
    - Second request: Set the Offset value to 20 and the TopK value to 20. The chunks whose chunk_id values are 20 to 39 are returned.
    - Third request: Set the Offset value to 30 and the TopK value to 20. The chunks whose chunk_id values are 40 to 44 are returned.
    example:
    0
  - orderBy
```
@NameInMap(value="OrderBy")
public String orderBy
```
    The fields by which to sort the results. This parameter is empty by default. This parameter does not support two-way retrieval scenarios.
    
    You must specify the default fields in the metadata or the table, such as id. You can specify the following number of fields:
    - One field, such as chunk_id.
    - Multiple fields that are sorted in ascending order and separated by commas (,), such as block_id and chunk_id.
    - Multiple fields that are sorted in descending order and separated by commas (,), such as block_id DESC, chunk_id DESC.
    example:
    chunk_id
  - ownerId
```
@NameInMap(value="OwnerId")
public Long ownerId
```
  - regionId
```
@NameInMap(value="RegionId")
public String regionId
```
    The region ID of the instance.
    
    This parameter is required.
    example:
    cn-hangzhou
  - relationalTableFilterShrink
```
@NameInMap(value="RelationalTableFilter")
public String relationalTableFilterShrink
```
  - topK
```
@NameInMap(value="TopK")
public Long topK
```
    This parameter is required.
    example:
    10
  - vectorShrink
```
@NameInMap(value="Vector")
public String vectorShrink
```
    The vector data. The length of the value must be the same as that of the Dimension parameter in the CreateCollection operation.
    
    If you leave this parameter empty, only full-text search results are returned.
  - workspaceId
```
@NameInMap(value="WorkspaceId")
public String workspaceId
```
    example:
    gp-ws-*****
- 构造器详细资料
  - QueryCollectionDataShrinkRequest
```
public QueryCollectionDataShrinkRequest()
```
- 方法详细资料
  - build
```
public static QueryCollectionDataShrinkRequest build(Map<String,?> map)
                                              throws Exception
```
    抛出:
    
    Exception
  - setCollection
```
public QueryCollectionDataShrinkRequest setCollection(String collection)
```
  - getCollection
```
public String getCollection()
```
  - setContent
```
public QueryCollectionDataShrinkRequest setContent(String content)
```
  - getContent
```
public String getContent()
```
  - setDBInstanceId
```
public QueryCollectionDataShrinkRequest setDBInstanceId(String DBInstanceId)
```
  - getDBInstanceId
```
public String getDBInstanceId()
```
  - setFilter
```
public QueryCollectionDataShrinkRequest setFilter(String filter)
```
  - getFilter
```
public String getFilter()
```
  - setHybridSearch
```
public QueryCollectionDataShrinkRequest setHybridSearch(String hybridSearch)
```
  - getHybridSearch
```
public String getHybridSearch()
```
  - setHybridSearchArgsShrink
```
public QueryCollectionDataShrinkRequest setHybridSearchArgsShrink(String hybridSearchArgsShrink)
```
  - getHybridSearchArgsShrink
```
public String getHybridSearchArgsShrink()
```
  - setIncludeMetadataFields
```
public QueryCollectionDataShrinkRequest setIncludeMetadataFields(String includeMetadataFields)
```
  - getIncludeMetadataFields
```
public String getIncludeMetadataFields()
```
  - setIncludeValues
```
public QueryCollectionDataShrinkRequest setIncludeValues(Boolean includeValues)
```
  - getIncludeValues
```
public Boolean getIncludeValues()
```
  - setMetrics
```
public QueryCollectionDataShrinkRequest setMetrics(String metrics)
```
  - getMetrics
```
public String getMetrics()
```
  - setNamespace
```
public QueryCollectionDataShrinkRequest setNamespace(String namespace)
```
  - getNamespace
```
public String getNamespace()
```
  - setNamespacePassword
```
public QueryCollectionDataShrinkRequest setNamespacePassword(String namespacePassword)
```
  - getNamespacePassword
```
public String getNamespacePassword()
```
  - setOffset
```
public QueryCollectionDataShrinkRequest setOffset(Integer offset)
```
  - getOffset
```
public Integer getOffset()
```
  - setOrderBy
```
public QueryCollectionDataShrinkRequest setOrderBy(String orderBy)
```
  - getOrderBy
```
public String getOrderBy()
```
  - setOwnerId
```
public QueryCollectionDataShrinkRequest setOwnerId(Long ownerId)
```
  - getOwnerId
```
public Long getOwnerId()
```
  - setRegionId
```
public QueryCollectionDataShrinkRequest setRegionId(String regionId)
```
  - getRegionId
```
public String getRegionId()
```
  - setRelationalTableFilterShrink
```
public QueryCollectionDataShrinkRequest setRelationalTableFilterShrink(String relationalTableFilterShrink)
```
  - getRelationalTableFilterShrink
```
public String getRelationalTableFilterShrink()
```
  - setTopK
```
public QueryCollectionDataShrinkRequest setTopK(Long topK)
```
  - getTopK
```
public Long getTopK()
```
  - setVectorShrink
```
public QueryCollectionDataShrinkRequest setVectorShrink(String vectorShrink)
```
  - getVectorShrink
```
public String getVectorShrink()
```
  - setWorkspaceId
```
public QueryCollectionDataShrinkRequest setWorkspaceId(String workspaceId)
```
  - getWorkspaceId
```
public String getWorkspaceId()
```

类 QueryCollectionDataShrinkRequest

字段概要

构造器概要

方法概要

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

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

字段详细资料

collection

content

DBInstanceId

filter

hybridSearch

hybridSearchArgsShrink

includeMetadataFields

includeValues

metrics

namespace

namespacePassword

offset

orderBy

ownerId

regionId

relationalTableFilterShrink

topK

vectorShrink

workspaceId

构造器详细资料

QueryCollectionDataShrinkRequest

方法详细资料

build

setCollection

getCollection

setContent

getContent

setDBInstanceId

getDBInstanceId

setFilter

getFilter

setHybridSearch

getHybridSearch

setHybridSearchArgsShrink

getHybridSearchArgsShrink

setIncludeMetadataFields

getIncludeMetadataFields

setIncludeValues

getIncludeValues

setMetrics

getMetrics

setNamespace

getNamespace

setNamespacePassword

getNamespacePassword

setOffset

getOffset

setOrderBy

getOrderBy

setOwnerId

getOwnerId

setRegionId

getRegionId

setRelationalTableFilterShrink

getRelationalTableFilterShrink

setTopK

getTopK

setVectorShrink

getVectorShrink

setWorkspaceId

getWorkspaceId