Files
elasticsearch-js/docs/reference/api/MlGetCategoriesRequest.md
2025-05-28 10:02:30 -05:00

1.3 KiB

MlGetCategoriesRequest [interface-MlGetCategoriesRequest]

Name Type Description
body string ({ [key: string]: any; } & { job_id?: never; category_id?: never; from?: never; partition_field_value?: never; size?: never; page?: never; })
category_id CategoryId Identifier for the category, which is unique in the job. If you specify neither the category ID nor the partition_field_value, the API returns information about all categories. If you specify only the partition_field_value, it returns information about all categories for the specified partition.
from integer Skips the specified number of categories.
job_id Id Identifier for the anomaly detection job.
page MlPage Configures pagination. This parameter has the from and size properties.
partition_field_value string Only return categories for the specified partition.
querystring { [key: string]: any; } & { job_id?: never; category_id?: never; from?: never; partition_field_value?: never; size?: never; page?: never; } All values in querystring will be added to the request querystring.
size integer Specifies the maximum number of categories to obtain.