QueryContentRequest (gpdb20160503 3.0.0 API)

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

public class QueryContentRequest
extends com.aliyun.tea.TeaModel

字段概要

字段
限定符和类型	字段和说明
`String`	`collection` This parameter is required.
`String`	`content`
`String`	`DBInstanceId` This parameter is required.
`String`	`fileName` example: test.jpg
`String`	`fileUrl` example: https://xx/myImage.jpg
`String`	`filter` The filter condition that is used to query data.
`String`	`hybridSearch` The two-way retrieval algorithm.
`Map<String,Map<String,?>>`	`hybridSearchArgs` The parameters of the two-way retrieval algorithm.
`Boolean`	`includeFileUrl` Specifies whether to return the URL of the document.
`String`	`includeMetadataFields` The metadata fields to be returned.
`Boolean`	`includeVector` example: true
`String`	`metrics` example: cosine
`String`	`namespace` The name of the namespace.
`String`	`namespacePassword` This parameter is required.
`Long`	`ownerId`
`List<Integer>`	`recallWindow` The recall window.
`String`	`regionId` This parameter is required.
`Double`	`rerankFactor` example: 2
`Integer`	`topK` example: 10
`Boolean`	`useFullTextRetrieval` Specifies whether to use full-text search to implement two-way retrieval.

构造器概要

构造器
构造器和说明

QueryContentRequest()

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

方法概要

所有方法静态方法实例方法具体方法
限定符和类型	方法和说明
`static QueryContentRequest`	`build(Map<String,?> map)`
`String`	`getCollection()`
`String`	`getContent()`
`String`	`getDBInstanceId()`
`String`	`getFileName()`
`String`	`getFileUrl()`
`String`	`getFilter()`
`String`	`getHybridSearch()`
`Map<String,Map<String,?>>`	`getHybridSearchArgs()`
`Boolean`	`getIncludeFileUrl()`
`String`	`getIncludeMetadataFields()`
`Boolean`	`getIncludeVector()`
`String`	`getMetrics()`
`String`	`getNamespace()`
`String`	`getNamespacePassword()`
`Long`	`getOwnerId()`
`List<Integer>`	`getRecallWindow()`
`String`	`getRegionId()`
`Double`	`getRerankFactor()`
`Integer`	`getTopK()`
`Boolean`	`getUseFullTextRetrieval()`
`QueryContentRequest`	`setCollection(String collection)`
`QueryContentRequest`	`setContent(String content)`
`QueryContentRequest`	`setDBInstanceId(String DBInstanceId)`
`QueryContentRequest`	`setFileName(String fileName)`
`QueryContentRequest`	`setFileUrl(String fileUrl)`
`QueryContentRequest`	`setFilter(String filter)`
`QueryContentRequest`	`setHybridSearch(String hybridSearch)`
`QueryContentRequest`	`setHybridSearchArgs(Map<String,Map<String,?>> hybridSearchArgs)`
`QueryContentRequest`	`setIncludeFileUrl(Boolean includeFileUrl)`
`QueryContentRequest`	`setIncludeMetadataFields(String includeMetadataFields)`
`QueryContentRequest`	`setIncludeVector(Boolean includeVector)`
`QueryContentRequest`	`setMetrics(String metrics)`
`QueryContentRequest`	`setNamespace(String namespace)`
`QueryContentRequest`	`setNamespacePassword(String namespacePassword)`
`QueryContentRequest`	`setOwnerId(Long ownerId)`
`QueryContentRequest`	`setRecallWindow(List<Integer> recallWindow)`
`QueryContentRequest`	`setRegionId(String regionId)`
`QueryContentRequest`	`setRerankFactor(Double rerankFactor)`
`QueryContentRequest`	`setTopK(Integer topK)`
`QueryContentRequest`	`setUseFullTextRetrieval(Boolean useFullTextRetrieval)`

从类继承的方法 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
  - content
```
@NameInMap(value="Content")
public String content
```
  - DBInstanceId
```
@NameInMap(value="DBInstanceId")
public String DBInstanceId
```
    This parameter is required.
    example:
    gp-xxxxxxxxx
  - fileName
```
@NameInMap(value="FileName")
public String fileName
```
    example:
    test.jpg
  - fileUrl
```
@NameInMap(value="FileUrl")
public String fileUrl
```
    example:
    https://xx/myImage.jpg
  - 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:
    title = \"test\"
  - 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
  - hybridSearchArgs
```
@NameInMap(value="HybridSearchArgs")
public Map<String,Map<String,?>> hybridSearchArgs
```
    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
    }
 }
 
```
  - includeFileUrl
```
@NameInMap(value="IncludeFileUrl")
public Boolean includeFileUrl
```
    Specifies whether to return the URL of the document. Default value: false.
    example:
    false
  - 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,page
  - includeVector
```
@NameInMap(value="IncludeVector")
public Boolean includeVector
```
    example:
    true
  - metrics
```
@NameInMap(value="Metrics")
public String metrics
```
    example:
    cosine
  - namespace
```
@NameInMap(value="Namespace")
public String namespace
```
    The name of the namespace. Default value: public.
    
    You can call the CreateNamespace operation to create a namespace and 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
  - ownerId
```
@NameInMap(value="OwnerId")
public Long ownerId
```
  - recallWindow
```
@NameInMap(value="RecallWindow")
public List<Integer> recallWindow
```
    The recall window. If you specify this parameter, the context of the search result is returned. Format: List\<A, B>. Valid values: -10<=A<=0 and 0<=B<=10.
    - We recommend that you specify this parameter if the source document is segmented into large numbers of pieces and you may fail to obtain the context.
    - The context of the search result is retrieved based on the recall window after the search result is reranked.
  - regionId
```
@NameInMap(value="RegionId")
public String regionId
```
    This parameter is required.
    example:
    cn-hangzhou
  - rerankFactor
```
@NameInMap(value="RerankFactor")
public Double rerankFactor
```
    example:
    2
  - topK
```
@NameInMap(value="TopK")
public Integer topK
```
    example:
    10
  - useFullTextRetrieval
```
@NameInMap(value="UseFullTextRetrieval")
public Boolean useFullTextRetrieval
```
    Specifies whether to use full-text search to implement two-way retrieval. The default value is false, which specifies that only vector search is used.
    example:
    true
- 构造器详细资料
  - QueryContentRequest
```
public QueryContentRequest()
```
- 方法详细资料
  - build
```
public static QueryContentRequest build(Map<String,?> map)
                                 throws Exception
```
    抛出:
    
    Exception
  - setCollection
```
public QueryContentRequest setCollection(String collection)
```
  - getCollection
```
public String getCollection()
```
  - setContent
```
public QueryContentRequest setContent(String content)
```
  - getContent
```
public String getContent()
```
  - setDBInstanceId
```
public QueryContentRequest setDBInstanceId(String DBInstanceId)
```
  - getDBInstanceId
```
public String getDBInstanceId()
```
  - setFileName
```
public QueryContentRequest setFileName(String fileName)
```
  - getFileName
```
public String getFileName()
```
  - setFileUrl
```
public QueryContentRequest setFileUrl(String fileUrl)
```
  - getFileUrl
```
public String getFileUrl()
```
  - setFilter
```
public QueryContentRequest setFilter(String filter)
```
  - getFilter
```
public String getFilter()
```
  - setHybridSearch
```
public QueryContentRequest setHybridSearch(String hybridSearch)
```
  - getHybridSearch
```
public String getHybridSearch()
```
  - setHybridSearchArgs
```
public QueryContentRequest setHybridSearchArgs(Map<String,Map<String,?>> hybridSearchArgs)
```
  - getHybridSearchArgs
```
public Map<String,Map<String,?>> getHybridSearchArgs()
```
  - setIncludeFileUrl
```
public QueryContentRequest setIncludeFileUrl(Boolean includeFileUrl)
```
  - getIncludeFileUrl
```
public Boolean getIncludeFileUrl()
```
  - setIncludeMetadataFields
```
public QueryContentRequest setIncludeMetadataFields(String includeMetadataFields)
```
  - getIncludeMetadataFields
```
public String getIncludeMetadataFields()
```
  - setIncludeVector
```
public QueryContentRequest setIncludeVector(Boolean includeVector)
```
  - getIncludeVector
```
public Boolean getIncludeVector()
```
  - setMetrics
```
public QueryContentRequest setMetrics(String metrics)
```
  - getMetrics
```
public String getMetrics()
```
  - setNamespace
```
public QueryContentRequest setNamespace(String namespace)
```
  - getNamespace
```
public String getNamespace()
```
  - setNamespacePassword
```
public QueryContentRequest setNamespacePassword(String namespacePassword)
```
  - getNamespacePassword
```
public String getNamespacePassword()
```
  - setOwnerId
```
public QueryContentRequest setOwnerId(Long ownerId)
```
  - getOwnerId
```
public Long getOwnerId()
```
  - setRecallWindow
```
public QueryContentRequest setRecallWindow(List<Integer> recallWindow)
```
  - getRecallWindow
```
public List<Integer> getRecallWindow()
```
  - setRegionId
```
public QueryContentRequest setRegionId(String regionId)
```
  - getRegionId
```
public String getRegionId()
```
  - setRerankFactor
```
public QueryContentRequest setRerankFactor(Double rerankFactor)
```
  - getRerankFactor
```
public Double getRerankFactor()
```
  - setTopK
```
public QueryContentRequest setTopK(Integer topK)
```
  - getTopK
```
public Integer getTopK()
```
  - setUseFullTextRetrieval
```
public QueryContentRequest setUseFullTextRetrieval(Boolean useFullTextRetrieval)
```
  - getUseFullTextRetrieval
```
public Boolean getUseFullTextRetrieval()
```

类 QueryContentRequest

字段概要

构造器概要

方法概要

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

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

字段详细资料

collection

content

DBInstanceId

fileName

fileUrl

filter

hybridSearch

hybridSearchArgs

includeFileUrl

includeMetadataFields

includeVector

metrics

namespace

namespacePassword

ownerId

recallWindow

regionId

rerankFactor

topK

useFullTextRetrieval

构造器详细资料

QueryContentRequest

方法详细资料

build

setCollection

getCollection

setContent

getContent

setDBInstanceId

getDBInstanceId

setFileName

getFileName

setFileUrl

getFileUrl

setFilter

getFilter

setHybridSearch

getHybridSearch

setHybridSearchArgs

getHybridSearchArgs

setIncludeFileUrl

getIncludeFileUrl

setIncludeMetadataFields

getIncludeMetadataFields

setIncludeVector

getIncludeVector

setMetrics

getMetrics

setNamespace

getNamespace

setNamespacePassword

getNamespacePassword

setOwnerId

getOwnerId

setRecallWindow

getRecallWindow

setRegionId

getRegionId

setRerankFactor

getRerankFactor

setTopK

getTopK

setUseFullTextRetrieval

getUseFullTextRetrieval