Resource: PublisherModel
A Model Garden Publisher Model.
name
string
Output only. The resource name of the PublisherModel.
versionId
string
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.
Required. Indicates the open source category of the publisher model.
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.
Optional. Supported call-to-action options.
frameworks[]
string
Optional. Additional information about the model's Frameworks.
Optional. Indicates the launch stage of the model.
Optional. Indicates the state of the model version.
publisherModelTemplate
string
Optional. Output only. Immutable. Used to indicate this model has a publisher model and provide the template of the publisher model resource name.
Optional. The schemata that describes formats of the PublisherModel's predictions and explanations as given and returned via PredictionService.Predict
.
JSON representation |
---|
{ "name": string, "versionId": string, "openSourceCategory": enum ( |
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. |
Parent
The information about the parent of a model.
displayName
string
Required. The display name of the parent. E.g., LaMDA, T5, Vision API, Natural Language API.
Optional. The Google Cloud resource name or the URI reference.
JSON representation |
---|
{
"displayName": string,
"reference": {
object ( |
ResourceReference
Reference to a resource.
reference
Union type
reference
can be only one of the following:uri
string
The URI of the resource.
resourceName
string
The resource name of the Google Cloud resource.
useCase
(deprecated)
string
Use case (CUJ) of the resource.
description
(deprecated)
string
description of the resource.
JSON representation |
---|
{ // reference "uri": string, "resourceName": string, "useCase": string, "description": string // Union type } |
CallToAction
Actions could take on this Publisher Model.
Optional. To view Rest API docs.
Optional. Open notebook of the PublisherModel.
Optional. Create application using the PublisherModel.
Optional. Open fine-tuning pipeline of the PublisherModel.
Optional. Open prompt-tuning pipeline of the PublisherModel.
Optional. Open Genie / Playground.
Optional. Deploy the PublisherModel to Vertex Endpoint.
Optional. Deploy PublisherModel to Google Kubernetes Engine.
Optional. Open in Generation AI Studio.
Optional. Request for access.
Optional. Open evaluation pipeline of the PublisherModel.
Optional. Open notebooks of the PublisherModel.
Optional. Open fine-tuning pipelines of the PublisherModel.
JSON representation |
---|
{ "viewRestApi": { object ( |
ViewRestApi
Rest API docs.
Required.
title
string
Required. The title of the view rest API.
JSON representation |
---|
{
"documentations": [
{
object ( |
Documentation
A named piece of documentation.
title
string
Required. E.g., OVERVIEW, USE CASES, DOCUMENTATION, SDK & SAMPLES, JAVA, NODE.JS, etc..
content
string
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..
Required.
title
string
Required.
resourceTitle
string
Optional. title of the resource.
resourceUseCase
string
Optional. Use case (CUJ) of the resource.
resourceDescription
string
Optional. description of the resource.
JSON representation |
---|
{
"references": {
string: {
object ( |
OpenNotebooks
Open notebooks.
Required. Regional resource references to notebooks.
JSON representation |
---|
{
"notebooks": [
{
object ( |
OpenFineTuningPipelines
Open fine tuning pipelines.
Required. Regional resource references to fine tuning pipelines.
JSON representation |
---|
{
"fineTuningPipelines": [
{
object ( |
Deploy
Model metadata that is needed for UploadModel or DeployModel/CreateEndpoint requests.
modelDisplayName
string
Optional. Default model display name.
Optional. Large model reference. When this is set, modelArtifactSpec is not needed.
Optional. The specification of the container that is to be used when deploying this Model in Vertex AI. Not present for Large Models.
artifactUri
string
Optional. The path to the directory containing the Model artifact and any of its supporting files.
title
string
Required. The title of the regional resource reference.
publicArtifactUri
string
Optional. The signed URI for ephemeral Cloud Storage access to model artifact.
prediction_resources
Union type
prediction_resources
can be only one of the following:A description of resources that are dedicated to the DeployedModel, and that need a higher degree of manual configuration.
A description of resources that to large degree are decided by Vertex AI, and require only a modest additional configuration.
deployTaskName
string
Optional. The name of the deploy task (e.g., "text to image generation").
Optional. metadata information about this deployment config.
JSON representation |
---|
{ "modelDisplayName": string, "largeModelReference": { object ( |
LargeModelReference
Contains information about the Large Model.
name
string
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.
labels
map (key: string, value: string)
Optional. Labels for the deployment config. For managing deployment config like verifying, source of deployment config, etc.
sampleRequest
string
Optional. Sample request for deployed endpoint.
JSON representation |
---|
{ "labels": { string: string, ... }, "sampleRequest": string } |
DeployGke
Configurations for PublisherModel GKE deployment
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_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. |
|
Lists publisher models in Model Garden. |