extends |
AbstractNamespace |
|---|
Class SearchRelevanceNamespace
NOTE: This file is autogenerated using util/GenerateEndpoints.php
| Methods | ||||
|---|---|---|---|---|
public
|
deleteExperiments(array $params = []): array
Deletes a specified experiment.
Deletes a specified experiment. $params['experiment_id'] = (string) The experiment id
$params['pretty'] = (boolean) Whether to pretty-format the returned JSON response. (Default = false)
$params['human'] = (boolean) Whether to return human-readable values for statistics. (Default = false)
$params['error_trace'] = (boolean) Whether to include the stack trace of returned errors. (Default = false)
$params['source'] = (string) The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests.
$params['filter_path'] = (any) A comma-separated list of filters used to filter the response. Use wildcards to match any field or part of a field's name. To exclude fields, use Parameters
|
# | ||
public
|
deleteJudgments(array $params = []): array
Deletes a specified judgment.
Deletes a specified judgment. $params['judgment_id'] = (string) The judgment id
$params['pretty'] = (boolean) Whether to pretty-format the returned JSON response. (Default = false)
$params['human'] = (boolean) Whether to return human-readable values for statistics. (Default = false)
$params['error_trace'] = (boolean) Whether to include the stack trace of returned errors. (Default = false)
$params['source'] = (string) The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests.
$params['filter_path'] = (any) A comma-separated list of filters used to filter the response. Use wildcards to match any field or part of a field's name. To exclude fields, use Parameters
|
# | ||
public
|
deleteQuerySets(array $params = []): array
Deletes a query set.
Deletes a query set. $params['query_set_id'] = (string) The query set id
$params['pretty'] = (boolean) Whether to pretty-format the returned JSON response. (Default = false)
$params['human'] = (boolean) Whether to return human-readable values for statistics. (Default = false)
$params['error_trace'] = (boolean) Whether to include the stack trace of returned errors. (Default = false)
$params['source'] = (string) The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests.
$params['filter_path'] = (any) A comma-separated list of filters used to filter the response. Use wildcards to match any field or part of a field's name. To exclude fields, use Parameters
|
# | ||
public
|
deleteSearchConfigurations(array $params = []): array
Deletes a specified search configuration.
Deletes a specified search configuration. $params['search_configuration_id'] = (string) The search configuration id
$params['pretty'] = (boolean) Whether to pretty-format the returned JSON response. (Default = false)
$params['human'] = (boolean) Whether to return human-readable values for statistics. (Default = false)
$params['error_trace'] = (boolean) Whether to include the stack trace of returned errors. (Default = false)
$params['source'] = (string) The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests.
$params['filter_path'] = (any) A comma-separated list of filters used to filter the response. Use wildcards to match any field or part of a field's name. To exclude fields, use Parameters
|
# | ||
public
|
getExperiments(array $params = []): array
Gets experiments.
Gets experiments. $params['experiment_id'] = (string) The experiment id
$params['pretty'] = (boolean) Whether to pretty-format the returned JSON response. (Default = false)
$params['human'] = (boolean) Whether to return human-readable values for statistics. (Default = false)
$params['error_trace'] = (boolean) Whether to include the stack trace of returned errors. (Default = false)
$params['source'] = (string) The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests.
$params['filter_path'] = (any) A comma-separated list of filters used to filter the response. Use wildcards to match any field or part of a field's name. To exclude fields, use Parameters
|
# | ||
public
|
getJudgments(array $params = []): array
Gets judgments.
Gets judgments. $params['judgment_id'] = (string) The judgment id
$params['pretty'] = (boolean) Whether to pretty-format the returned JSON response. (Default = false)
$params['human'] = (boolean) Whether to return human-readable values for statistics. (Default = false)
$params['error_trace'] = (boolean) Whether to include the stack trace of returned errors. (Default = false)
$params['source'] = (string) The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests.
$params['filter_path'] = (any) A comma-separated list of filters used to filter the response. Use wildcards to match any field or part of a field's name. To exclude fields, use Parameters
|
# | ||
public
|
getNodeStats(array $params = []): array
Gets stats by node.
Gets stats by node. $params['node_id'] = (string) The node id (Required)
$params['stat'] = (string) The statistic to return
$params['flat_stat_paths'] = (string) Requests flattened stat paths as keys
$params['include_all_nodes'] = (string) Whether to include all nodes
$params['include_individual_nodes'] = (string) Whether to include individual nodes
$params['include_info'] = (string) Whether to include info
$params['include_metadata'] = (string) Whether to include metadata
$params['pretty'] = (boolean) Whether to pretty-format the returned JSON response. (Default = false)
$params['human'] = (boolean) Whether to return human-readable values for statistics. (Default = false)
$params['error_trace'] = (boolean) Whether to include the stack trace of returned errors. (Default = false)
$params['source'] = (string) The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests.
$params['filter_path'] = (any) A comma-separated list of filters used to filter the response. Use wildcards to match any field or part of a field's name. To exclude fields, use Parameters
|
# | ||
public
|
getQuerySets(array $params = []): array
Lists the current query sets available.
Lists the current query sets available. $params['query_set_id'] = (string) The query set id
$params['pretty'] = (boolean) Whether to pretty-format the returned JSON response. (Default = false)
$params['human'] = (boolean) Whether to return human-readable values for statistics. (Default = false)
$params['error_trace'] = (boolean) Whether to include the stack trace of returned errors. (Default = false)
$params['source'] = (string) The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests.
$params['filter_path'] = (any) A comma-separated list of filters used to filter the response. Use wildcards to match any field or part of a field's name. To exclude fields, use Parameters
|
# | ||
public
|
getSearchConfigurations(array $params = []): array
Gets the search configurations.
Gets the search configurations. $params['search_configuration_id'] = (string) The search configuration id
$params['pretty'] = (boolean) Whether to pretty-format the returned JSON response. (Default = false)
$params['human'] = (boolean) Whether to return human-readable values for statistics. (Default = false)
$params['error_trace'] = (boolean) Whether to include the stack trace of returned errors. (Default = false)
$params['source'] = (string) The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests.
$params['filter_path'] = (any) A comma-separated list of filters used to filter the response. Use wildcards to match any field or part of a field's name. To exclude fields, use Parameters
|
# | ||
public
|
getStats(array $params = []): array
Gets stats.
Gets stats. $params['stat'] = (string) The statistic to return
$params['flat_stat_paths'] = (string) Requests flattened stat paths as keys
$params['include_all_nodes'] = (string) Whether to include all nodes
$params['include_individual_nodes'] = (string) Whether to include individual nodes
$params['include_info'] = (string) Whether to include info
$params['include_metadata'] = (string) Whether to include metadata
$params['pretty'] = (boolean) Whether to pretty-format the returned JSON response. (Default = false)
$params['human'] = (boolean) Whether to return human-readable values for statistics. (Default = false)
$params['error_trace'] = (boolean) Whether to include the stack trace of returned errors. (Default = false)
$params['source'] = (string) The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests.
$params['filter_path'] = (any) A comma-separated list of filters used to filter the response. Use wildcards to match any field or part of a field's name. To exclude fields, use Parameters
|
# | ||
public
|
postQuerySets(array $params = []): array
Creates a new query set by sampling queries from the user behavior data.
Creates a new query set by sampling queries from the user behavior data. $params['pretty'] = (boolean) Whether to pretty-format the returned JSON response. (Default = false)
$params['human'] = (boolean) Whether to return human-readable values for statistics. (Default = false)
$params['error_trace'] = (boolean) Whether to include the stack trace of returned errors. (Default = false)
$params['source'] = (string) The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests.
$params['filter_path'] = (any) A comma-separated list of filters used to filter the response. Use wildcards to match any field or part of a field's name. To exclude fields, use Parameters
|
# | ||
public
|
putExperiments(array $params = []): array
Creates an experiment.
Creates an experiment. $params['pretty'] = (boolean) Whether to pretty-format the returned JSON response. (Default = false)
$params['human'] = (boolean) Whether to return human-readable values for statistics. (Default = false)
$params['error_trace'] = (boolean) Whether to include the stack trace of returned errors. (Default = false)
$params['source'] = (string) The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests.
$params['filter_path'] = (any) A comma-separated list of filters used to filter the response. Use wildcards to match any field or part of a field's name. To exclude fields, use Parameters
|
# | ||
public
|
putJudgments(array $params = []): array
Creates a judgment.
Creates a judgment. $params['pretty'] = (boolean) Whether to pretty-format the returned JSON response. (Default = false)
$params['human'] = (boolean) Whether to return human-readable values for statistics. (Default = false)
$params['error_trace'] = (boolean) Whether to include the stack trace of returned errors. (Default = false)
$params['source'] = (string) The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests.
$params['filter_path'] = (any) A comma-separated list of filters used to filter the response. Use wildcards to match any field or part of a field's name. To exclude fields, use Parameters
|
# | ||
public
|
putQuerySets(array $params = []): array
Creates a new query set by uploading manually.
Creates a new query set by uploading manually. $params['pretty'] = (boolean) Whether to pretty-format the returned JSON response. (Default = false)
$params['human'] = (boolean) Whether to return human-readable values for statistics. (Default = false)
$params['error_trace'] = (boolean) Whether to include the stack trace of returned errors. (Default = false)
$params['source'] = (string) The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests.
$params['filter_path'] = (any) A comma-separated list of filters used to filter the response. Use wildcards to match any field or part of a field's name. To exclude fields, use Parameters
|
# | ||
public
|
putSearchConfigurations(array $params = []): array
Creates a search configuration.
Creates a search configuration. $params['pretty'] = (boolean) Whether to pretty-format the returned JSON response. (Default = false)
$params['human'] = (boolean) Whether to return human-readable values for statistics. (Default = false)
$params['error_trace'] = (boolean) Whether to include the stack trace of returned errors. (Default = false)
$params['source'] = (string) The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests.
$params['filter_path'] = (any) A comma-separated list of filters used to filter the response. Use wildcards to match any field or part of a field's name. To exclude fields, use Parameters
|
# | ||
| Methods inherited from OpenSearch\Namespaces\AbstractNamespace |
|---|
__construct(), extractArgument(), performRequest() |
| Properties inherited from OpenSearch\Namespaces\AbstractNamespace |
|---|
$transport, $httpTransport, $endpointFactory, $endpoints |