Resource: PublisherModel
A Model Garden Publisher Model.
JSON representation |
---|
{ "name": string, "versionId": string, "openSourceCategory": enum ( |
Fields | |
---|---|
name |
Output only. The resource name of the PublisherModel. |
versionId |
Output only. Immutable. The version ID of the PublisherModel. A new version is committed when a new model version is uploaded under an existing model id. It is an auto-incrementing decimal number in string representation. |
openSourceCategory |
Required. Indicates the open source category of the publisher model. |
supportedActions |
Optional. Supported call-to-action options. |
frameworks[] |
Optional. Additional information about the model's Frameworks. |
launchStage |
Optional. Indicates the launch stage of the model. |
versionState |
Optional. Indicates the state of the model version. |
publisherModelTemplate |
Optional. Output only. Immutable. Used to indicate this model has a publisher model and provide the template of the publisher model resource name. |
predictSchemata |
Optional. The schemata that describes formats of the PublisherModel's predictions and explanations as given and returned via |
OpenSourceCategory
An enum representing the open source category of a PublisherModel.
Enums | |
---|---|
OPEN_SOURCE_CATEGORY_UNSPECIFIED |
The open source category is unspecified, which should not be used. |
PROPRIETARY |
Used to indicate the PublisherModel is not open sourced. |
GOOGLE_OWNED_OSS_WITH_GOOGLE_CHECKPOINT |
Used to indicate the PublisherModel is a Google-owned open source model w/ Google checkpoint. |
THIRD_PARTY_OWNED_OSS_WITH_GOOGLE_CHECKPOINT |
Used to indicate the PublisherModel is a 3p-owned open source model w/ Google checkpoint. |
GOOGLE_OWNED_OSS |
Used to indicate the PublisherModel is a Google-owned pure open source model. |
THIRD_PARTY_OWNED_OSS |
Used to indicate the PublisherModel is a 3p-owned pure open source model. |
CallToAction
Actions could take on this Publisher Model.
JSON representation |
---|
{ "viewRestApi": { object ( |
Fields | |
---|---|
viewRestApi |
Optional. To view Rest API docs. |
openNotebook |
Optional. Open notebook of the PublisherModel. |
createApplication |
Optional. Create application using the PublisherModel. |
openFineTuningPipeline |
Optional. Open fine-tuning pipeline of the PublisherModel. |
openPromptTuningPipeline |
Optional. Open prompt-tuning pipeline of the PublisherModel. |
openGenie |
Optional. Open Genie / Playground. |
deploy |
Optional. Deploy the PublisherModel to Vertex Endpoint. |
deployGke |
Optional. Deploy PublisherModel to Google Kubernetes Engine. |
openGenerationAiStudio |
Optional. Open in Generation AI Studio. |
requestAccess |
Optional. Request for access. |
openEvaluationPipeline |
Optional. Open evaluation pipeline of the PublisherModel. |
openNotebooks |
Optional. Open notebooks of the PublisherModel. |
openFineTuningPipelines |
Optional. Open fine-tuning pipelines of the PublisherModel. |
ViewRestApi
Rest API docs.
JSON representation |
---|
{
"documentations": [
{
object ( |
Fields | |
---|---|
documentations[] |
Required. |
title |
Required. The title of the view rest API. |
Documentation
A named piece of documentation.
JSON representation |
---|
{ "title": string, "content": string } |
Fields | |
---|---|
title |
Required. E.g., OVERVIEW, USE CASES, DOCUMENTATION, SDK & SAMPLES, JAVA, NODE.JS, etc.. |
content |
Required. Content of this piece of document (in Markdown format). |
RegionalResourceReferences
The regional resource name or the URI. Key is region, e.g., us-central1, europe-west2, global, etc..
JSON representation |
---|
{
"references": {
string: {
object ( |
Fields | |
---|---|
references |
Required. |
title |
Required. |
resourceTitle |
Optional. title of the resource. |
resourceUseCase |
Optional. Use case (CUJ) of the resource. |
resourceDescription |
Optional. description of the resource. |
ResourceReference
Reference to a resource.
JSON representation |
---|
{ // Union field |
Fields | |
---|---|
Union field
|
|
uri |
The URI of the resource. |
resourceName |
The resource name of the Google Cloud resource. |
useCase |
Use case (CUJ) of the resource. |
description |
description of the resource. |
OpenNotebooks
Open notebooks.
JSON representation |
---|
{
"notebooks": [
{
object ( |
Fields | |
---|---|
notebooks[] |
Required. Regional resource references to notebooks. |
OpenFineTuningPipelines
Open fine tuning pipelines.
JSON representation |
---|
{
"fineTuningPipelines": [
{
object ( |
Fields | |
---|---|
fineTuningPipelines[] |
Required. Regional resource references to fine tuning pipelines. |
Deploy
Model metadata that is needed for UploadModel or DeployModel/CreateEndpoint requests.
JSON representation |
---|
{ "modelDisplayName": string, "largeModelReference": { object ( |
Fields | |
---|---|
modelDisplayName |
Optional. Default model display name. |
largeModelReference |
Optional. Large model reference. When this is set, modelArtifactSpec is not needed. |
containerSpec |
Optional. The specification of the container that is to be used when deploying this Model in Vertex AI. Not present for Large Models. |
artifactUri |
Optional. The path to the directory containing the Model artifact and any of its supporting files. |
title |
Required. The title of the regional resource reference. |
publicArtifactUri |
Optional. The signed URI for ephemeral Cloud Storage access to model artifact. |
Union field prediction_resources . The prediction (for example, the machine) resources that the DeployedModel uses. prediction_resources can be only one of the following: |
|
dedicatedResources |
A description of resources that are dedicated to the DeployedModel, and that need a higher degree of manual configuration. |
automaticResources |
A description of resources that to large degree are decided by Vertex AI, and require only a modest additional configuration. |
sharedResources |
The resource name of the shared DeploymentResourcePool to deploy on. Format: |
deployTaskName |
Optional. The name of the deploy task (e.g., "text to image generation"). |
deployMetadata |
Optional. metadata information about this deployment config. |
LargeModelReference
Contains information about the Large Model.
JSON representation |
---|
{ "name": string } |
Fields | |
---|---|
name |
Required. The unique name of the large Foundation or pre-built model. Like "chat-bison", "text-bison". Or model name with version ID, like "chat-bison@001", "text-bison@005", etc. |
DeployMetadata
metadata information about the deployment for managing deployment config.
JSON representation |
---|
{ "labels": { string: string, ... } } |
Fields | |
---|---|
labels |
Optional. Labels for the deployment. For managing deployment config like verifying, source of deployment config, etc. |
DeployGke
Configurations for PublisherModel GKE deployment
JSON representation |
---|
{ "gkeYamlConfigs": [ string ] } |
Fields | |
---|---|
gkeYamlConfigs[] |
Optional. GKE deployment configuration in yaml format. |
LaunchStage
An enum representing the launch stage of a PublisherModel.
Enums | |
---|---|
LAUNCH_STAGE_UNSPECIFIED |
The model launch stage is unspecified. |
EXPERIMENTAL |
Used to indicate the PublisherModel is at Experimental launch stage, available to a small set of customers. |
PRIVATE_PREVIEW |
Used to indicate the PublisherModel is at Private Preview launch stage, only available to a small set of customers, although a larger set of customers than an Experimental launch. Previews are the first launch stage used to get feedback from customers. |
PUBLIC_PREVIEW |
Used to indicate the PublisherModel is at Public Preview launch stage, available to all customers, although not supported for production workloads. |
GA |
Used to indicate the PublisherModel is at GA launch stage, available to all customers and ready for production workload. |
VersionState
An enum representing the state of the PublicModelVersion.
Enums | |
---|---|
VERSION_STATE_UNSPECIFIED |
The version state is unspecified. |
VERSION_STATE_STABLE |
Used to indicate the version is stable. |
VERSION_STATE_UNSTABLE |
Used to indicate the version is unstable. |
Methods |
|
---|---|
|
Gets a Model Garden publisher model. |