Reference documentation and code samples for the Google Cloud Discovery Engine V1 Client class ResolvedModel.
A single model that is resolved to be available to the end-user in the model selector, with all of its localized display metadata.
Generated from protobuf message google.cloud.discoveryengine.v1.WidgetConfig.UiSettings.ModelConfigInfo.ResolvedModel
Namespace
Google \ Cloud \ DiscoveryEngine \ V1 \ WidgetConfig \ UiSettings \ ModelConfigInfoMethods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ model_id |
string
Output only. Unique identifier of the model (e.g. |
↳ display_name |
string
Output only. Localized display name of the model (e.g. |
↳ icon |
string
Output only. GM3-compatible icon token associated with the model (e.g. |
↳ description |
string
Output only. Localized description text (e.g. |
↳ is_preview |
bool
Output only. Whether the model is currently in preview. Clients should surface this via a "Preview" badge in the selector UI. |
↳ label |
string
Output only. Short label shown in the compact selector bar chip (e.g. |
↳ admin_view |
ResolvedModel\AdminView
Output only. Admin-surface metadata; populated only for the Console admin Feature Control page (see |
↳ promoted |
bool
Output only. Whether this model should be promoted in the GE chat homepage banner. |
↳ icon_url |
string
Output only. Absolute URL of a brand mark to render instead of |
↳ family |
string
Output only. Groups models that render together in the selector. Models sharing a value form one group; empty means the model belongs to no group. Compared for equality only -- never parsed, and never shown to a user, so it is not localized. |
getModelId
Output only. Unique identifier of the model
(e.g. gemini-2.5-flash, gemini-3.1-pro-preview).
This is the same identifier that clients pass back to the assistant
service to select this model. Virtual / "pseudo" models (e.g.
gemini-fast) are also valid values here; they are resolved to the
underlying concrete model on the backend.
| Returns | |
|---|---|
| Type | Description |
string |
|
setModelId
Output only. Unique identifier of the model
(e.g. gemini-2.5-flash, gemini-3.1-pro-preview).
This is the same identifier that clients pass back to the assistant
service to select this model. Virtual / "pseudo" models (e.g.
gemini-fast) are also valid values here; they are resolved to the
underlying concrete model on the backend.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getDisplayName
Output only. Localized display name of the model (e.g. Gemini 3.1
Pro). Localized server-side based on the
LookupWidgetConfigRequest.language_code
and
LookupWidgetConfigRequest.region_code
of the request.
| Returns | |
|---|---|
| Type | Description |
string |
|
setDisplayName
Output only. Localized display name of the model (e.g. Gemini 3.1
Pro). Localized server-side based on the
LookupWidgetConfigRequest.language_code
and
LookupWidgetConfigRequest.region_code
of the request.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getIcon
Output only. GM3-compatible icon token associated with the model
(e.g. rocket_launch, bolt, graph_5).
| Returns | |
|---|---|
| Type | Description |
string |
|
setIcon
Output only. GM3-compatible icon token associated with the model
(e.g. rocket_launch, bolt, graph_5).
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getDescription
Output only. Localized description text (e.g. State-of-the-art
reasoning). Localized using the same locale as display_name.
| Returns | |
|---|---|
| Type | Description |
string |
|
setDescription
Output only. Localized description text (e.g. State-of-the-art
reasoning). Localized using the same locale as display_name.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getIsPreview
Output only. Whether the model is currently in preview. Clients should surface this via a "Preview" badge in the selector UI.
| Returns | |
|---|---|
| Type | Description |
bool |
|
setIsPreview
Output only. Whether the model is currently in preview. Clients should surface this via a "Preview" badge in the selector UI.
| Parameter | |
|---|---|
| Name | Description |
var |
bool
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getLabel
Output only. Short label shown in the compact selector bar chip (e.g.
3.x Flash) as opposed to the full display_name (Gemini 3.x
Flash). Falls back to display_name when the backend registry does
not specify a distinct short label.
| Returns | |
|---|---|
| Type | Description |
string |
|
setLabel
Output only. Short label shown in the compact selector bar chip (e.g.
3.x Flash) as opposed to the full display_name (Gemini 3.x
Flash). Falls back to display_name when the backend registry does
not specify a distinct short label.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getAdminView
Output only. Admin-surface metadata; populated only for the Console
admin Feature Control page (see AdminView). Unset for end-user
surfaces.
| Returns | |
|---|---|
| Type | Description |
ResolvedModel\AdminView|null |
|
hasAdminView
clearAdminView
setAdminView
Output only. Admin-surface metadata; populated only for the Console
admin Feature Control page (see AdminView). Unset for end-user
surfaces.
| Parameter | |
|---|---|
| Name | Description |
var |
ResolvedModel\AdminView
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getPromoted
Output only. Whether this model should be promoted in the GE chat homepage banner.
| Returns | |
|---|---|
| Type | Description |
bool |
|
setPromoted
Output only. Whether this model should be promoted in the GE chat homepage banner.
| Parameter | |
|---|---|
| Name | Description |
var |
bool
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getIconUrl
Output only. Absolute URL of a brand mark to render instead of
icon, for models whose vendor logo is not a GM3 glyph.
icon stays populated as the fallback, so a client that does not
render images, or that fails to fetch this one, shows the glyph
instead of nothing.
| Returns | |
|---|---|
| Type | Description |
string |
|
setIconUrl
Output only. Absolute URL of a brand mark to render instead of
icon, for models whose vendor logo is not a GM3 glyph.
icon stays populated as the fallback, so a client that does not
render images, or that fails to fetch this one, shows the glyph
instead of nothing.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getFamily
Output only. Groups models that render together in the selector.
Models sharing a value form one group; empty means the model belongs to no group. Compared for equality only -- never parsed, and never shown to a user, so it is not localized.
| Returns | |
|---|---|
| Type | Description |
string |
|
setFamily
Output only. Groups models that render together in the selector.
Models sharing a value form one group; empty means the model belongs to no group. Compared for equality only -- never parsed, and never shown to a user, so it is not localized.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|