Method: models.list

Full name: projects.locations.models.list

Lists Models in a Location.

Endpoint

get https://{service-endpoint}/v1beta1/{parent}/models

Where {service-endpoint} is one of the supported service endpoints.

Path parameters

parent string

Required. The resource name of the Location to list the Models from. Format: projects/{project}/locations/{location}

Query parameters

filter string

An expression for filtering the results of the request. For field names both snake_case and camelCase are supported.

  • model supports = and !=. model represents the Model id, i.e. the last segment of the Model's resource name .
  • displayName supports = and !=
  • labels supports general map functions that is:
    • labels.key=value - key:value equality
    • `labels.key:* or labels:key - key existence
    • A key including a space must be quoted. labels."a key".
  • base_model_name only supports =

Some examples:

  • model=1234
  • displayName="myDisplayName"
  • labels.myKey="myValue"
  • baseModelName="text-bison"
pageSize integer

The standard list page size.

pageToken string

The standard list page token. Typically obtained via ListModelsResponse.next_page_token of the previous ModelService.ListModels call.

readMask string (FieldMask format)

Mask specifying which fields to read.

This is a comma-separated list of fully qualified names of fields. Example: "user.displayName,photo".

Request body

The request body must be empty.

Response body

Response message for ModelService.ListModels

If successful, the response body contains data with the following structure:

Fields
models[] object (Model )

List of Models in the requested page.

nextPageToken string

A token to retrieve next page of results. Pass to ListModelsRequest.page_token to obtain that page.

JSON representation
{
 "models": [
 {
 object (Model )
 }
 ],
 "nextPageToken": string
}

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

Last updated 2025年06月27日 UTC.