Puppet Task: searchindex_azure_documents_search_get
- Defined in:
-
tasks/searchindex_azure_documents_search_get.json,
tasks/searchindex_azure_documents_search_get.rb
Overview
Searches for documents in the Azure Search index.
Supports noop? false
Parameters
- odatanextlink (Optional[String[1]]) — Continuation URL returned when Azure Search can't return all the requested results in a single Search response. You can use this URL to formulate another GET or POST Search request to get the next part of the search response. Make sure to use the same verb (GET or POST) as the request that produced this response.
- odatacount (Optional[String[1]]) — The total count of results found by the search operation, or null if the count was not requested. If present, the count may be greater than the number of results in this response. This can happen if you use the $top or $skip parameters, or if Azure Search can't return all the requested documents in a single Search response.
- searchcoverage (Optional[String[1]]) — A value indicating the percentage of the index that was included in the query, or null if minimumCoverage was not specified in the request.
- searchfacets (Optional[String[1]]) — The facet query results for the search operation, organized as a collection of buckets for each faceted field; null if the query did not include any facet expressions.
- search_mode (Optional[String[1]]) — A value that specifies whether any or all of the search terms must be matched in order to count the document as a match.
- skip (Optional[String[1]]) — The number of search results to skip. This value cannot be greater than 100,000. If you need to scan documents in sequence, but cannot use $skip due to this limitation, consider using $orderby on a totally-ordered key and $filter with a range query instead.
- top (Optional[String[1]]) — The number of search results to retrieve. This can be used in conjunction with $skip to implement client-side paging of search results. If results are truncated due to server-side paging, the response will include a continuation token that can be used to issue another Search request for the next page of results.
- client_request_id (Optional[String[1]]) — The tracking ID sent with the request to help with debugging.
- scoring_parameter (Optional[String[1]]) — The list of parameter values to be used in scoring functions (for example, referencePointParameter) using the format name-values. For example, if the scoring profile defines a function with a parameter called 'mylocation' the parameter string would be 'mylocation--122.2,44.8' (without the quotes).
- highlight (Optional[String[1]]) — The list of field names to use for hit highlights. Only searchable fields can be used for hit highlighting.
- highlight_pre_tag (Optional[String[1]]) — A string tag that is prepended to hit highlights. Must be set with highlightPostTag. Default is <em>.
- orderby (Optional[String[1]]) — The list of OData $orderby expressions by which to sort the results. Each expression can be either a field name or a call to either the geo.distance() or the search.score() functions. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order. Ties will be broken by the match scores of documents. If no OrderBy is specified, the default sort order is descending by document match score. There can be at most 32 $orderby clauses.
- query_type (Optional[String[1]]) — A value that specifies the syntax of the search query. The default is 'simple'. Use 'full' if your query uses the Lucene query syntax.
- search (Optional[String[1]]) — A full-text search query expression; Use '*' or omit this parameter to match all documents.
- minimum_coverage (Optional[String[1]]) — A number between 0 and 100 indicating the percentage of the index that must be covered by a search query in order for the query to be reported as a success. This parameter can be useful for ensuring search availability even for services with only one replica. The default is 100.
- search_fields (Optional[String[1]]) — The list of field names to which to scope the full-text search. When using fielded search (fieldName:searchExpression) in a full Lucene query, the field names of each fielded search expression take precedence over any field names listed in this parameter.
- api_version (Optional[String[1]]) — Client Api Version.
- scoring_profile (Optional[String[1]]) — The name of a scoring profile to evaluate match scores for matching documents in order to sort the results.
- select (Optional[String[1]]) — The list of fields to retrieve. If unspecified, all fields marked as retrievable in the schema are included.
- searchnextpageparameters (Optional[String[1]]) — Continuation JSON payload returned when Azure Search can't return all the requested results in a single Search response. You can use this JSON along with @odata.nextLink to formulate another POST Search request to get the next part of the search response.
- value (Optional[String[1]]) — The sequence of results returned by the query.
- count (Optional[String[1]]) — A value that specifies whether to fetch the total count of results. Default is false. Setting this value to true may have a performance impact. Note that the count returned is an approximation.
- facet (Optional[String[1]]) — The list of facet expressions to apply to the search query. Each facet expression contains a field name, optionally followed by a comma-separated list of name:value pairs.
- filter (Optional[String[1]]) — The OData $filter expression to apply to the search query.
- highlight_post_tag (Optional[String[1]]) — A string tag that is appended to hit highlights. Must be set with highlightPreTag. Default is </em>.