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

# evaluations

> Scheduled and manual scope evaluations.

## Constructor

```typescript
evaluations(http: HttpClient, config: ModusConfig, scopeId: string | number): ScopeEvaluationsResource
```

### Parameters

<ResponseField name={"http"} type={"HttpClient"} required />

<ResponseField name={"config"} type={"ModusConfig"} required />

<ResponseField name={"scopeId"} type={"string | number"} required />

### Returns

`ScopeEvaluationsResource`

## Methods

### getConfig()

```typescript
getConfig(): Promise<object>
```

Get the evaluation configuration for this scope.

#### Returns

`Promise<object>`

### getRun()

```typescript
getRun(runId: string): Promise<object>
```

Retrieve one evaluation run with full results.

#### Parameters

<ResponseField name={"runId"} type={"string"} required>
  Evaluation run id.
</ResponseField>

#### Returns

`Promise<object>`

The run and its result details.

### listRuns()

```typescript
listRuns(options?: { pageSize: number; pageToken: string }): Promise<Page<object>>
```

List evaluation runs for this scope.

#### Parameters

<ResponseField name={"options"} type={"{ pageSize: number; pageToken: string }"} />

#### Returns

`Promise<Page<object>>`

A page of evaluation runs.

### triggerRun()

```typescript
triggerRun(): Promise<object>
```

Trigger a manual evaluation run for this scope.

#### Returns

`Promise<object>`

The triggered run id and status.

### updateConfig()

```typescript
updateConfig(update: object): Promise<object>
```

Update the evaluation configuration for this scope.

#### Parameters

<ResponseField name={"update"} type={"object"} required>
  Configuration fields to change.
</ResponseField>

#### Returns

`Promise<object>`

The updated evaluation configuration.