public class QueryCollectionNoticesOptions
extends com.ibm.cloud.sdk.core.service.model.GenericModel
Modifier and Type | Class and Description |
---|---|
static class |
QueryCollectionNoticesOptions.Builder
Builder.
|
Modifier and Type | Method and Description |
---|---|
String |
collectionId()
Gets the collectionId.
|
Long |
count()
Gets the count.
|
String |
filter()
Gets the filter.
|
String |
naturalLanguageQuery()
Gets the naturalLanguageQuery.
|
QueryCollectionNoticesOptions.Builder |
newBuilder()
New builder.
|
Long |
offset()
Gets the offset.
|
String |
projectId()
Gets the projectId.
|
String |
query()
Gets the query.
|
public QueryCollectionNoticesOptions.Builder newBuilder()
public String projectId()
The ID of the project. This information can be found from the *Integrate and Deploy* page in Discovery.
public String collectionId()
The ID of the collection.
public String filter()
Searches for documents that match the Discovery Query Language criteria that is specified as input. Filter calls are cached and are faster than query calls because the results are not ordered by relevance. When used with the `aggregation`, `query`, or `natural_language_query` parameters, the `filter` parameter runs first. This parameter is useful for limiting results to those that contain specific metadata values.
public String query()
A query search that is written in the Discovery Query Language and returns all matching documents in your data set with full enrichments and full text, and with the most relevant documents listed first.
public String naturalLanguageQuery()
A natural language query that returns relevant documents by using training data and natural language understanding.
public Long count()
Number of results to return. The maximum for the **count** and **offset** values together in any one query is **10,000**.
public Long offset()
The number of query results to skip at the beginning. For example, if the total number of results that are returned is 10 and the offset is 8, it returns the last two results. The maximum for the **count** and **offset** values together in any one query is **10000**.
Copyright © 2023 IBM Cloud. All rights reserved.