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

# GroundingModel

# Class: GroundingModel

Defined in: [index.d.ts:436](https://github.com/simular-ai/simulang-js-internal/blob/d2b85c3277cbb16ce50c0781e1db8ad2c8a5690e/index.d.ts#L436)

A visual-language grounding model that can locate concepts on images.

## Constructors

### Constructor

> **new GroundingModel**(): `GroundingModel`

#### Returns

`GroundingModel`

## Accessors

### name

#### Get Signature

> **get** **name**(): `string`

Defined in: [index.d.ts:466](https://github.com/simular-ai/simulang-js-internal/blob/d2b85c3277cbb16ce50c0781e1db8ad2c8a5690e/index.d.ts#L466)

The wire-level model identifier sent in the request body.

##### Returns

`string`

## Methods

### ground()

> **ground**(`target`, `concept`): \[`number`, `number`]

Defined in: [index.d.ts:480](https://github.com/simular-ai/simulang-js-internal/blob/d2b85c3277cbb16ce50c0781e1db8ad2c8a5690e/index.d.ts#L480)

Locate `concept` on `target` and return zero-based pixel coordinates
`[x, y]`:

* If `target` is an `Image`, coordinates are in **image-space**.
  Normalized model outputs are scaled linearly onto
  `[0, width - 1]` and `[0, height - 1]`.
* If `target` is a `Screenshot`, coordinates are in **global physical
  screen space** — suitable to feed directly into primitives that
  expect global screen coordinates (e.g. `moveTo`, `clickAt`).

Equivalent to `target.ground(model, concept)`.

#### Parameters

##### target

[`Image`](Image.mdx) | [`Screenshot`](Screenshot.mdx)

##### concept

`string`

#### Returns

\[`number`, `number`]

***

### availableAliases()

> `static` **availableAliases**(): `string`\[]

Defined in: [index.d.ts:464](https://github.com/simular-ai/simulang-js-internal/blob/d2b85c3277cbb16ce50c0781e1db8ad2c8a5690e/index.d.ts#L464)

Every VLM model alias accepted by `byAlias` on this machine, deduplicated
and sorted alphabetically. Use to discover what aliases the loaded config
(bundled defaults plus any user provider files advertises.

#### Returns

`string`\[]

***

### byAlias()

> `static` **byAlias**(`alias`): `GroundingModel`

Defined in: [index.d.ts:448](https://github.com/simular-ai/simulang-js-internal/blob/d2b85c3277cbb16ce50c0781e1db8ad2c8a5690e/index.d.ts#L448)

Resolve a model alias against the loaded config (e.g. `"ui_venus_30b"`,
`"ui_tars_7b"`, or any alias declared by a user provider). Throws if
the alias is unknown.

#### Parameters

##### alias

`string`

#### Returns

`GroundingModel`

***

### default()

> `static` **default**(): `GroundingModel`

Defined in: [index.d.ts:442](https://github.com/simular-ai/simulang-js-internal/blob/d2b85c3277cbb16ce50c0781e1db8ad2c8a5690e/index.d.ts#L442)

First VLM model advertised by the first VLM provider in the loaded
config. Throws if no provider in the loaded config advertises a VLM
service.

#### Returns

`GroundingModel`

***

### uiTars7B()

> `static` **uiTars7B**(): `GroundingModel`

Defined in: [index.d.ts:453](https://github.com/simular-ai/simulang-js-internal/blob/d2b85c3277cbb16ce50c0781e1db8ad2c8a5690e/index.d.ts#L453)

Convenience shim for the bundled `ui_tars_7b` alias. Throws if no
provider advertises that alias.

#### Returns

`GroundingModel`

***

### uiVenus30B()

> `static` **uiVenus30B**(): `GroundingModel`

Defined in: [index.d.ts:458](https://github.com/simular-ai/simulang-js-internal/blob/d2b85c3277cbb16ce50c0781e1db8ad2c8a5690e/index.d.ts#L458)

Convenience shim for the bundled `ui_venus_30b` alias. Throws if no
provider advertises that alias.

#### Returns

`GroundingModel`