> ## Documentation Index
> Fetch the complete documentation index at: https://docs.honeyhive.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# CreateMetricRequest

> Use CreateMetricRequest to define evaluator metric creation payloads with the HoneyHive Metrics TypeScript client for typed calls and autocomplete.

## Properties

### categories?

> `optional` **categories?**: `object`\[] | `null`

***

### child\_metrics?

> `optional` **child\_metrics?**: `object`\[] | `null`

***

### criteria

> **criteria**: `string`

***

### description?

> `optional` **description?**: `string`

***

### enabled\_in\_prod?

> `optional` **enabled\_in\_prod?**: `boolean`

#### Default

```ts theme={null}
false
```

***

### filters?

> `optional` **filters?**: `object`

#### filterArray

> **filterArray**: `object`\[]

***

### model\_name?

> `optional` **model\_name?**: `string` | `null`

***

### model\_provider?

> `optional` **model\_provider?**: `string` | `null`

***

### name

> **name**: `string`

***

### needs\_ground\_truth?

> `optional` **needs\_ground\_truth?**: `boolean`

#### Default

```ts theme={null}
false
```

***

### return\_type?

> `optional` **return\_type?**: `"string"` | `"boolean"` | `"float"` | `"categorical"`

#### Default

```ts theme={null}
float
```

***

### sampling\_percentage?

> `optional` **sampling\_percentage?**: `number`

#### Default

```ts theme={null}
10
```

***

### scale?

> `optional` **scale?**: `number` | `null`

***

### threshold?

> `optional` **threshold?**: \{ `max?`: `number`; `min?`: `number`; `pass_when?`: `number` | `boolean`; `passing_categories?`: `string`\[]; } | `null`

***

### type

> **type**: `"LLM"` | `"COMPOSITE"` | `"PYTHON"` | `"HUMAN"`