lib/ibm_watson/discovery_v1.rb
def federated_query_notices(environment_id:, collection_ids:, filter: nil, query: nil, natural_language_query: nil, aggregation: nil, count: nil, return_fields: nil, offset: nil, sort: nil, highlight: nil, deduplicate_field: nil, similar: nil, similar_document_ids: nil, similar_fields: nil)
      raise ArgumentError.new("environment_id must be provided") if environment_id.nil?

      raise ArgumentError.new("collection_ids must be provided") if collection_ids.nil?

      headers = {
      }
      sdk_headers = Common.new.get_sdk_headers("discovery", "V1", "federated_query_notices")
      headers.merge!(sdk_headers)

      params = {
        "version" => @version,
        "collection_ids" => collection_ids.to_a,
        "filter" => filter,
        "query" => query,
        "natural_language_query" => natural_language_query,
        "aggregation" => aggregation,
        "count" => count,
        "return" => return_fields.to_a,
        "offset" => offset,
        "sort" => sort.to_a,
        "highlight" => highlight,
        "deduplicate.field" => deduplicate_field,
        "similar" => similar,
        "similar.document_ids" => similar_document_ids.to_a,
        "similar.fields" => similar_fields.to_a
      }

      method_url = "/v1/environments/%s/notices" % [ERB::Util.url_encode(environment_id)]

      response = request(
        method: "GET",
        url: method_url,
        headers: headers,
        params: params,
        accept_json: true
      )
      response
    end
def federated_query_notices(environment_id:, collection_ids:, filter: nil, query: nil, natural_language_query: nil, aggregation: nil, count: nil, return_fields: nil, offset: nil, sort: nil, highlight: nil, deduplicate_field: nil, similar: nil, similar_document_ids: nil, similar_fields: nil)
      raise ArgumentError.new("environment_id must be provided") if environment_id.nil?

      raise ArgumentError.new("collection_ids must be provided") if collection_ids.nil?

      headers = {
      }
      sdk_headers = Common.new.get_sdk_headers("discovery", "V1", "federated_query_notices")
      headers.merge!(sdk_headers)

      params = {
        "version" => @version,
        "collection_ids" => collection_ids.to_a,
        "filter" => filter,
        "query" => query,
        "natural_language_query" => natural_language_query,
        "aggregation" => aggregation,
        "count" => count,
        "return" => return_fields.to_a,
        "offset" => offset,
        "sort" => sort.to_a,
        "highlight" => highlight,
        "deduplicate.field" => deduplicate_field,
        "similar" => similar,
        "similar.document_ids" => similar_document_ids.to_a,
        "similar.fields" => similar_fields.to_a
      }

      method_url = "/v1/environments/%s/notices" % [ERB::Util.url_encode(environment_id)]

      response = request(
        method: "GET",
        url: method_url,
        headers: headers,
        params: params,
        accept_json: true
      )
      response
    end
@!method federated_query_notices(environment_id:, collection_ids:, filter: nil, query: nil, natural_language_query: nil, aggregation: nil, count: nil, return_fields: nil, offset: nil, sort: nil, highlight: nil, deduplicate_field: nil, similar: nil, similar_document_ids: nil, similar_fields: nil)
 Query multiple collection system notices.
 Queries for notices (errors or warnings) that might have been generated by the
   system. Notices are generated when ingesting documents and performing relevance
   training. See the [Discovery service
   documentation](https://cloud.ibm.com/docs/services/discovery?topic=discovery-query-concepts#query-concepts)
   for more details on the query language.
 @param environment_id [String] The ID of the environment.
 @param collection_ids [Array[String]] A comma-separated list of collection IDs to be queried against.
 @param filter [String] 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.
 @param query [String] A query search returns all documents in your data set with full enrichments and
   full text, but with the most relevant documents listed first. Use a query search
   when you want to find the most relevant search results. You cannot use
   **natural_language_query** and **query** at the same time.
 @param natural_language_query [String] A natural language query that returns relevant documents by utilizing training
   data and natural language understanding. You cannot use **natural_language_query**
   and **query** at the same time.
 @param aggregation [String] 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.
 @param count [Fixnum] Number of results to return. The maximum for the **count** and **offset** values
   together in any one query is **10000**.
 @param return_fields [Array[String]] A comma-separated list of the portion of the document hierarchy to return.
 @param offset [Fixnum] 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**.
 @param sort [Array[String]] 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.
 @param highlight [Boolean] 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.
 @param deduplicate_field [String] 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.
 @param similar [Boolean] When `true`, results are returned based on their similarity to the document IDs
   specified in the **similar.document_ids** parameter.
 @param similar_document_ids [Array[String]] 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.
 @param similar_fields [Array[String]] 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.
 @return [IBMCloudSdkCore::DetailedResponse] A `IBMCloudSdkCore::DetailedResponse` object representing the response.