> ## 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

> TypeScript request type for the HoneyHive API

## Properties

### categories?

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

***

### ~~child\_metrics?~~

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

#### Deprecated

#### Description

Deprecated and ignored. Composite metrics are no longer supported.

***

### 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`

#### Deprecated

#### Description

Deprecated and ignored. Ground-truth use is inferred from the evaluator definition.

***

### 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"`


## Related topics

- [Metrics Methods](/v2/sdk-reference/typescript/ref/metrics/index.md)
- [Clients](/v2/changelog/clients.md)
- [CreateMetricVersionRequest](/v2/sdk-reference/typescript/ref/metric-versions/CreateMetricVersionRequest.md)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.