Class FederatedQueryNoticesOptions

All Implemented Interfaces:

public class FederatedQueryNoticesOptions
The federatedQueryNotices options.
  • Method Details

    • newBuilder

      New builder.
      a FederatedQueryNoticesOptions builder
    • environmentId

      public String environmentId()
      Gets the environmentId.

      The ID of the environment.

      the environmentId
    • collectionIds

      public List<String> collectionIds()
      Gets the collectionIds.

      A comma-separated list of collection IDs to be queried against.

      the collectionIds
    • filter

      public String filter()
      Gets the filter.

      A cacheable query that excludes documents that don't mention the query content. Filter searches are better for metadata-type searches and for assessing the concepts in the data set.

      the filter
    • query

      public String query()
      Gets the query.

      A query search returns all documents in your data set with full enrichments and full text, but with the most relevant documents listed first.

      the query
    • naturalLanguageQuery

      public String naturalLanguageQuery()
      Gets the naturalLanguageQuery.

      A natural language query that returns relevant documents by utilizing training data and natural language understanding.

      the naturalLanguageQuery
    • aggregation

      public String aggregation()
      Gets the aggregation.

      An aggregation search that returns an exact answer by combining query search with filters. Useful for applications to build lists, tables, and time series. For a full list of possible aggregations, see the Query reference.

      the aggregation
    • count

      public Long count()
      Gets the count.

      Number of results to return. The maximum for the **count** and **offset** values together in any one query is **10000**.

      the count
    • xReturn

      public List<String> xReturn()
      Gets the xReturn.

      A comma-separated list of the portion of the document hierarchy to return.

      the xReturn
    • offset

      public Long offset()
      Gets the 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**.

      the offset
    • sort

      public List<String> sort()
      Gets the sort.

      A comma-separated list of fields in the document to sort on. You can optionally specify a sort direction by prefixing the field with `-` for descending or `+` for ascending. Ascending is the default sort direction if no prefix is specified.

      the sort
    • highlight

      public Boolean highlight()
      Gets the highlight.

      When true, a highlight field is returned for each result which contains the fields which match the query with `<em></em>` tags around the matching query terms.

      the highlight
    • deduplicateField

      public String deduplicateField()
      Gets the deduplicateField.

      When specified, duplicate results based on the field specified are removed from the returned results. Duplicate comparison is limited to the current query only, **offset** is not considered. This parameter is currently Beta functionality.

      the deduplicateField
    • similar

      public Boolean similar()
      Gets the similar.

      When `true`, results are returned based on their similarity to the document IDs specified in the **similar.document_ids** parameter.

      the similar
    • similarDocumentIds

      public List<String> similarDocumentIds()
      Gets the similarDocumentIds.

      A comma-separated list of document IDs to find similar documents.

      **Tip:** Include the **natural_language_query** parameter to expand the scope of the document similarity search with the natural language query. Other query parameters, such as **filter** and **query**, are subsequently applied and reduce the scope.

      the similarDocumentIds
    • similarFields

      public List<String> similarFields()
      Gets the similarFields.

      A comma-separated list of field names that are used as a basis for comparison to identify similar documents. If not specified, the entire document is used for comparison.

      the similarFields