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

# StateSatisfiesModel

> A dedicated state-satisfaction model that evaluates whether observed screen state satisfies a natural-language condition.

This speaks Simular's `v1/perception/state_satisfies` endpoint. It is
separate from `AskModel`, which remains an OpenAI-compatible
chat-completions client.

## Constructor

```typescript
StateSatisfiesModel(): StateSatisfiesModel
```

### Returns

`StateSatisfiesModel`

## Properties

<ResponseField name={"name"} type={"string"} required>
  The provider-configured model identifier.
</ResponseField>

## Methods

### availableAliases()

```typescript
availableAliases(): string[]
```

Every state-satisfaction model alias accepted by `byAlias` on this
machine, deduplicated and sorted alphabetically.

#### Returns

`string[]`

### byAlias()

```typescript
byAlias(alias: string): StateSatisfiesModel
```

Resolve a model alias against the loaded config. Throws if the alias is
unknown.

#### Parameters

<ResponseField name={"alias"} type={"string"} required />

#### Returns

`StateSatisfiesModel`

### checkAuth()

```typescript
checkAuth(): void
```

Check that the provider credentials work. Throws if they do not.

### default()

```typescript
default(): StateSatisfiesModel
```

First state-satisfaction model advertised by the first capable provider
in the loaded configuration whose credentials are currently available.
Throws if no provider advertises the state-satisfies service.

#### Returns

`StateSatisfiesModel`

### simularStateSatisfies()

```typescript
simularStateSatisfies(): StateSatisfiesModel
```

Convenience shim for the bundled `simular_state_satisfies` alias.

#### Returns

`StateSatisfiesModel`

### stateSatisfies()

```typescript
stateSatisfies(condition: string, text: string, image: string): boolean
```

Evaluate `condition` against the supplied accessibility text and raw
screenshot base64.

#### Parameters

<ResponseField name={"condition"} type={"string"} required />

<ResponseField name={"text"} type={"string"} required />

<ResponseField name={"image"} type={"string"} required />

#### Returns

`boolean`
