REST Resource: publishers.models

Resource: PublisherModel

A Model Garden Publisher Model.

Fields
namestring

Output only. The resource name of the PublisherModel.

versionIdstring

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.

openSourceCategoryenum (OpenSourceCategory)

Required. Indicates the open source category of the publisher model.

parentobject (Parent)

Optional. The parent that this model was customized from. E.g., Vision API, Natural Language API, LaMDA, T5, etc. Foundation models don't have parents.

supportedActionsobject (CallToAction)

Optional. Supported call-to-action options.

frameworks[]string

Optional. Additional information about the model's Frameworks.

launchStageenum (LaunchStage)

Optional. Indicates the launch stage of the model.

versionStateenum (VersionState)

Optional. Indicates the state of the model version.

publisherModelTemplatestring

Optional. Output only. Immutable. Used to indicate this model has a publisher model and provide the template of the publisher model resource name.

predictSchemataobject (PredictSchemata)

Optional. The schemata that describes formats of the PublisherModel's predictions and explanations as given and returned viaPredictionService.Predict.

JSON representation
{"name":string,"versionId":string,"openSourceCategory":enum (OpenSourceCategory),"parent":{object (Parent)},"supportedActions":{object (CallToAction)},"frameworks":[string],"launchStage":enum (LaunchStage),"versionState":enum (VersionState),"publisherModelTemplate":string,"predictSchemata":{object (PredictSchemata)}}

OpenSourceCategory

An enum representing the open source category of a PublisherModel.

Enums
OPEN_SOURCE_CATEGORY_UNSPECIFIEDThe open source category is unspecified, which should not be used.
PROPRIETARYUsed to indicate the PublisherModel is not open sourced.
GOOGLE_OWNED_OSS_WITH_GOOGLE_CHECKPOINTUsed to indicate the PublisherModel is a Google-owned open source model w/ Google checkpoint.
THIRD_PARTY_OWNED_OSS_WITH_GOOGLE_CHECKPOINTUsed to indicate the PublisherModel is a 3p-owned open source model w/ Google checkpoint.
GOOGLE_OWNED_OSSUsed to indicate the PublisherModel is a Google-owned pure open source model.
THIRD_PARTY_OWNED_OSSUsed to indicate the PublisherModel is a 3p-owned pure open source model.

Parent

The information about the parent of a model.

Fields
displayNamestring

Required. The display name of the parent. E.g., LaMDA, T5, Vision API, Natural Language API.

referenceobject (ResourceReference)

Optional. The Google Cloud resource name or the URI reference.

JSON representation
{"displayName":string,"reference":{object (ResourceReference)}}

ResourceReference

Reference to a resource.

Fields
referenceUnion type
reference can be only one of the following:
uristring

The URI of the resource.

resourceNamestring

The resource name of the Google Cloud resource.

JSON representation
{// reference"uri":string,"resourceName":string,"useCase":string,"description":string// Union type}

CallToAction

Actions could take on this Publisher Model.

Fields

Optional. To view Rest API docs.

openNotebookobject (RegionalResourceReferences)

Optional. Open notebook of the PublisherModel.

createApplicationobject (RegionalResourceReferences)

Optional. Create application using the PublisherModel.

openFineTuningPipelineobject (RegionalResourceReferences)

Optional. Open fine-tuning pipeline of the PublisherModel.

openPromptTuningPipelineobject (RegionalResourceReferences)

Optional. Open prompt-tuning pipeline of the PublisherModel.

openGenieobject (RegionalResourceReferences)

Optional. Open Genie / Playground.

deployobject (Deploy)

Optional. Deploy the PublisherModel to Vertex Endpoint.

multiDeployVertexobject (DeployVertex)

Optional. Multiple setups to deploy the PublisherModel to Vertex Endpoint.

deployGkeobject (DeployGke)

Optional. Deploy PublisherModel to Google Kubernetes Engine.

openGenerationAiStudioobject (RegionalResourceReferences)

Optional. Open in Generation AI Studio.

requestAccessobject (RegionalResourceReferences)

Optional. Request for access.

openEvaluationPipelineobject (RegionalResourceReferences)

Optional. Open evaluation pipeline of the PublisherModel.

openNotebooksobject (OpenNotebooks)

Optional. Open notebooks of the PublisherModel.

openFineTuningPipelinesobject (OpenFineTuningPipelines)

Optional. Open fine-tuning pipelines of the PublisherModel.

JSON representation
{"viewRestApi":{object (ViewRestApi)},"openNotebook":{object (RegionalResourceReferences)},"createApplication":{object (RegionalResourceReferences)},"openFineTuningPipeline":{object (RegionalResourceReferences)},"openPromptTuningPipeline":{object (RegionalResourceReferences)},"openGenie":{object (RegionalResourceReferences)},"deploy":{object (Deploy)},"multiDeployVertex":{object (DeployVertex)},"deployGke":{object (DeployGke)},"openGenerationAiStudio":{object (RegionalResourceReferences)},"requestAccess":{object (RegionalResourceReferences)},"openEvaluationPipeline":{object (RegionalResourceReferences)},"openNotebooks":{object (OpenNotebooks)},"openFineTuningPipelines":{object (OpenFineTuningPipelines)}}

ViewRestApi

Rest API docs.

Fields
documentations[]object (Documentation)

Required.

titlestring

Required. The title of the view rest API.

JSON representation
{"documentations":[{object (Documentation)}],"title":string}

Documentation

A named piece of documentation.

Fields
titlestring

Required. E.g., OVERVIEW, USE CASES, DOCUMENTATION, SDK & SAMPLES, JAVA, NODE.JS, etc..

contentstring

Required. Content of this piece of document (in Markdown format).

JSON representation
{"title":string,"content":string}

RegionalResourceReferences

The regional resource name or the URI. Key is region, e.g., us-central1, europe-west2, global, etc..

Fields
referencesmap (key: string, value: object (ResourceReference))

Required.

titlestring

Required.

resourceTitlestring

Optional. title of the resource.

resourceUseCasestring

Optional. Use case (CUJ) of the resource.

resourceDescriptionstring

Optional. description of the resource.

JSON representation
{"references":{string:{object (ResourceReference)},...},"title":string,"resourceTitle":string,"resourceUseCase":string,"resourceDescription":string}

OpenNotebooks

Open notebooks.

Fields
notebooks[]object (RegionalResourceReferences)

Required. Regional resource references to notebooks.

JSON representation
{"notebooks":[{object (RegionalResourceReferences)}]}

OpenFineTuningPipelines

Open fine tuning pipelines.

Fields
fineTuningPipelines[]object (RegionalResourceReferences)

Required. Regional resource references to fine tuning pipelines.

JSON representation
{"fineTuningPipelines":[{object (RegionalResourceReferences)}]}

Deploy

Model metadata that is needed for UploadModel or DeployModel/CreateEndpoint requests.

Fields
modelDisplayNamestring

Optional. Default model display name.

largeModelReferenceobject (LargeModelReference)

Optional. Large model reference. When this is set, modelArtifactSpec is not needed.

containerSpecobject (ModelContainerSpec)

Optional. The specification of the container that is to be used when deploying this Model in Vertex AI. Not present for Large Models.

artifactUristring

Optional. The path to the directory containing the Model artifact and any of its supporting files.

titlestring

Required. The title of the regional resource reference.

publicArtifactUristring

Optional. The signed URI for ephemeral Cloud Storage access to model artifact.

prediction_resourcesUnion type
The prediction (for example, the machine) resources that the DeployedModel uses.prediction_resources can be only one of the following:
dedicatedResourcesobject (DedicatedResources)

A description of resources that are dedicated to the DeployedModel, and that need a higher degree of manual configuration.

automaticResourcesobject (AutomaticResources)

A description of resources that to large degree are decided by Vertex AI, and require only a modest additional configuration.

sharedResourcesstring

The resource name of the shared DeploymentResourcePool to deploy on. Format:projects/{project}/locations/{location}/deploymentResourcePools/{deploymentResourcePool}

deployTaskNamestring

Optional. The name of the deploy task (e.g., "text to image generation").

deployMetadataobject (DeployMetadata)

Optional. metadata information about this deployment config.

JSON representation
{"modelDisplayName":string,"largeModelReference":{object (LargeModelReference)},"containerSpec":{object (ModelContainerSpec)},"artifactUri":string,"title":string,"publicArtifactUri":string,// prediction_resources"dedicatedResources":{object (DedicatedResources)},"automaticResources":{object (AutomaticResources)},"sharedResources":string// Union type"deployTaskName":string,"deployMetadata":{object (DeployMetadata)}}

LargeModelReference

Contains information about the Large Model.

Fields
namestring

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.

JSON representation
{"name":string}

DeployMetadata

metadata information about the deployment for managing deployment config.

Fields
labelsmap (key: string, value: string)

Optional. Labels for the deployment config. For managing deployment config like verifying, source of deployment config, etc.

sampleRequeststring

Optional. Sample request for deployed endpoint.

JSON representation
{"labels":{string:string,...},"sampleRequest":string}

DeployVertex

Multiple setups to deploy the PublisherModel.

Fields
multiDeployVertex[]object (Deploy)

Optional. One click deployment configurations.

JSON representation
{"multiDeployVertex":[{object (Deploy)}]}

DeployGke

Configurations for PublisherModel GKE deployment

Fields
gkeYamlConfigs[]string

Optional. GKE deployment configuration in yaml format.

JSON representation
{"gkeYamlConfigs":[string]}

LaunchStage

An enum representing the launch stage of a PublisherModel.

Enums
LAUNCH_STAGE_UNSPECIFIEDThe model launch stage is unspecified.
EXPERIMENTALUsed to indicate the PublisherModel is at Experimental launch stage, available to a small set of customers.
PRIVATE_PREVIEWUsed 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_PREVIEWUsed to indicate the PublisherModel is at Public Preview launch stage, available to all customers, although not supported for production workloads.
GAUsed 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_UNSPECIFIEDThe version state is unspecified.
VERSION_STATE_STABLEUsed to indicate the version is stable.
VERSION_STATE_UNSTABLEUsed to indicate the version is unstable.

Methods

get

 Gets a Model Garden publisher model.

list

 Lists publisher models in Model Garden.

Except as otherwise noted, the content of this page is licensed under theCreative Commons Attribution 4.0 License, and code samples are licensed under theApache 2.0 License. For details, see theGoogle Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated 2025-06-27 UTC.