Reference documentation and code samples for the Google Cloud Discovery Engine V1 Client class ModelConfigInfo.
The resolved, server-side view of model selector configuration for the
end-user. The backend computes this per-request by applying, in order:
Mendel flag evaluation, regional availability rules based on the
engine's location, and admin-panel overrides from model_configs.
The backend is the single source of truth for this configuration;
clients should render resolved_models directly in the model selector
dropdown, in the order provided, without applying their own filtering,
ordering, or localization.
Generated from protobuf message google.cloud.discoveryengine.v1.WidgetConfig.UiSettings.ModelConfigInfo
Namespace
Google \ Cloud \ DiscoveryEngine \ V1 \ WidgetConfig \ UiSettingsMethods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ resolved_models |
array<ModelConfigInfo\ResolvedModel>
Output only. The list of models that are available to the end-user in the model selector, in the order in which they should be displayed. |
↳ default_model_id |
string
Output only. The |
↳ auto_model_id |
string
Output only. The |
getResolvedModels
Output only. The list of models that are available to the end-user in the model selector, in the order in which they should be displayed.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\RepeatedField<ModelConfigInfo\ResolvedModel> |
|
setResolvedModels
Output only. The list of models that are available to the end-user in the model selector, in the order in which they should be displayed.
| Parameter | |
|---|---|
| Name | Description |
var |
array<ModelConfigInfo\ResolvedModel>
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getDefaultModelId
Output only. The model_id of the model that should be selected by
default in the model selector when the end-user has not made an
explicit choice. The value is always one of the model_ids present in
resolved_models.
| Returns | |
|---|---|
| Type | Description |
string |
|
setDefaultModelId
Output only. The model_id of the model that should be selected by
default in the model selector when the end-user has not made an
explicit choice. The value is always one of the model_ids present in
resolved_models.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getAutoModelId
Output only. The model_id a client must send when the end-user picks
the "Auto" entry (the empty model_id).
Populated only for surfaces known to have no true "Auto" mode, where
leaving the model unset would fall back to a platform default rather
than a backend-chosen model. Empty on every other surface, where
"Auto" is resolved server-side, and when none of the surface's ranked
models is available. When set, it is always one of the non-empty
model_ids present in resolved_models.
| Returns | |
|---|---|
| Type | Description |
string |
|
setAutoModelId
Output only. The model_id a client must send when the end-user picks
the "Auto" entry (the empty model_id).
Populated only for surfaces known to have no true "Auto" mode, where
leaving the model unset would fall back to a platform default rather
than a backend-chosen model. Empty on every other surface, where
"Auto" is resolved server-side, and when none of the surface's ranked
models is available. When set, it is always one of the non-empty
model_ids present in resolved_models.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|