extends |
AbstractNamespace |
|---|
Class LtrNamespace
NOTE: This file is autogenerated using util/GenerateEndpoints.php
| Methods | ||||
|---|---|---|---|---|
public
|
addFeaturesToSet(array $params = []): array
Add features to an existing feature set in the default feature store.
Add features to an existing feature set in the default feature store. $params['name'] = (string) The name of the feature set to add features to. (Required)
$params['store'] = (string) The name of the feature store.
$params['merge'] = (boolean) Whether to merge the feature list or append only. (Default = false)
$params['routing'] = (string) Specific routing value.
$params['version'] = (integer) Version check to ensure feature set is modified with expected version.
$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
|
addFeaturesToSetByQuery(array $params = []): array
Add features to an existing feature set in the default feature store.
Add features to an existing feature set in the default feature store. $params['name'] = (string) The name of the feature set to add features to. (Required)
$params['query'] = (string) Query string to filter existing features from the store by name. When provided, only features matching this query will be added to the feature set, and no request body should be included. (Required)
$params['store'] = (string) The name of the feature store.
$params['merge'] = (boolean) Whether to merge the feature list or append only. (Default = false)
$params['routing'] = (string) Specific routing value.
$params['version'] = (integer) Version check to ensure feature set is modified with expected version.
$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
|
cacheStats(array $params = []): array
Retrieves cache statistics for all feature stores.
Retrieves cache statistics for all feature stores. $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
|
clearCache(array $params = []): array
Clears the store caches.
Clears the store caches. $params['store'] = (string) The name of the feature store for which to clear the cache.
$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
|
createDefaultStore(array $params = []): array
Creates the default feature store.
Creates the default feature store. $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
|
createFeature(array $params = []): array
Create or update a feature in the default feature store.
Create or update a feature in the default feature store. $params['id'] = (string) The name of the feature. (Required)
$params['store'] = (string) The name of the feature store.
$params['routing'] = (string) Specific routing value.
$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
|
createFeatureset(array $params = []): array
Create or update a feature set in the default feature store.
Create or update a feature set in the default feature store. $params['id'] = (string) The name of the feature set. (Required)
$params['store'] = (string) The name of the feature store.
$params['routing'] = (string) Specific routing value.
$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
|
createModel(array $params = []): array
Create or update a model in the default feature store.
Create or update a model in the default feature store. $params['id'] = (string) The name of the model. (Required)
$params['store'] = (string) The name of the feature store.
$params['routing'] = (string) Specific routing value.
$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
|
createModelFromSet(array $params = []): array
Create a model from an existing feature set in the default feature store.
Create a model from an existing feature set in the default feature store. $params['name'] = (string) The name of the feature set to use for creating the model. (Required)
$params['store'] = (string) The name of the feature store.
$params['routing'] = (string) Specific routing value.
$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
|
createStore(array $params = []): array
Creates a new feature store with the specified name.
Creates a new feature store with the specified name. $params['store'] = (string) The name of the feature store.
$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
|
deleteDefaultStore(array $params = []): array
Deletes the default feature store.
Deletes the default feature store. $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
|
deleteFeature(array $params = []): array
Delete a feature from the default feature store.
Delete a feature from the default feature store. $params['id'] = (string) The name of the feature. (Required)
$params['store'] = (string) The name of the feature store.
$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
|
deleteFeatureset(array $params = []): array
Delete a feature set from the default feature store.
Delete a feature set from the default feature store. $params['id'] = (string) The name of the feature set. (Required)
$params['store'] = (string) The name of the feature store.
$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
|
deleteModel(array $params = []): array
Delete a model from the default feature store.
Delete a model from the default feature store. $params['id'] = (string) The name of the model. (Required)
$params['store'] = (string) The name of the feature store.
$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
|
deleteStore(array $params = []): array
Deletes a feature store with the specified name.
Deletes a feature store with the specified name. $params['store'] = (string) The name of the feature store.
$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
|
getFeature(array $params = []): array
Get a feature from the default feature store.
Get a feature from the default feature store. $params['id'] = (string) The name of the feature. (Required)
$params['store'] = (string) The name of the feature store.
$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
|
getFeatureset(array $params = []): array
Get a feature set from the default feature store.
Get a feature set from the default feature store. $params['id'] = (string) The name of the feature set. (Required)
$params['store'] = (string) The name of the feature store.
$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
|
getModel(array $params = []): array
Get a model from the default feature store.
Get a model from the default feature store. $params['id'] = (string) The name of the model. (Required)
$params['store'] = (string) The name of the feature store.
$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
|
getStore(array $params = []): array
Checks if a store exists.
Checks if a store exists. $params['store'] = (string) The name of the feature store.
$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
|
listStores(array $params = []): array
Lists all available feature stores.
Lists all available feature stores. $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
|
searchFeatures(array $params = []): array
Search for features in a feature store.
Search for features in a feature store. $params['store'] = (string) The name of the feature store.
$params['from'] = (integer) The offset from the first result (for pagination). (Default = 0)
$params['prefix'] = (string) A name prefix to filter features by.
$params['size'] = (integer) The number of features to return. (Default = 20)
$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
|
searchFeaturesets(array $params = []): array
Search for feature sets in a feature store.
Search for feature sets in a feature store. $params['store'] = (string) The name of the feature store.
$params['from'] = (integer) The offset from the first result (for pagination). (Default = 0)
$params['prefix'] = (string) A name prefix to filter feature sets by.
$params['size'] = (integer) The number of feature sets to return. (Default = 20)
$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
|
searchModels(array $params = []): array
Search for models in a feature store.
Search for models in a feature store. $params['store'] = (string) The name of the feature store.
$params['from'] = (integer) The offset from the first result (for pagination). (Default = 0)
$params['prefix'] = (string) A name prefix to filter models by.
$params['size'] = (integer) The number of models to return. (Default = 20)
$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
|
stats(array $params = []): array
Provides information about the current status of the LTR plugin.
Provides information about the current status of the LTR plugin. $params['node_id'] = (array) A comma-separated list of node IDs or names to limit the returned information; use Parameters
|
# | ||
public
|
updateFeature(array $params = []): array
Update a feature in the default feature store.
Update a feature in the default feature store. $params['id'] = (string) The name of the feature. (Required)
$params['store'] = (string) The name of the feature store.
$params['routing'] = (string) Specific routing value.
$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
|
updateFeatureset(array $params = []): array
Update a feature set in the default feature store.
Update a feature set in the default feature store. $params['id'] = (string) The name of the feature set. (Required)
$params['store'] = (string) The name of the feature store.
$params['routing'] = (string) Specific routing value.
$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 |