2025-04-01
▼ ▲ aiplatform.projects.locations.featureOnlineStores.featureViews.directWrite
Path : v1beta1/{+featureView}:directWrite
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/featureViews/{featureViewsId}:directWrite
HTTP Method : POST
Parameters :
featureView
Description : FeatureView resource format `projects/{project}/locations/{location}/featureOnlineStores/{featureOnlineStore}/featureViews/{featureView}`
Pattern : ^projects/[^/]+/locations/[^/]+/featureOnlineStores/[^/]+/featureViews/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : featureView
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Bidirectional streaming RPC to directly write to feature values in a feature view. Requests may not have a one-to-one mapping to responses and responses may be returned out-of-order to reduce latency.
▼ ▲ aiplatform.projects.locations.publishers.models.export
Path : v1beta1/{+parent}/{+name}:export
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/publishers/{publishersId}/models/{modelsId}:export
HTTP Method : POST
Parameters :
parent
Description : Required. The Location to export the model weights from Format: `projects/{project}/locations/{location}`
Pattern : ^projects/[^/]+/locations/[^/]+$
Location : path
Required : Yes
Type : string
name
Description : Required. The name of the PublisherModel resource. Format: `publishers/{publisher}/models/{publisher_model}@{version_id}`, or `publishers/hf-{hugging-face-author}/models/{hugging-face-model-name}@001`
Pattern : ^publishers/[^/]+/models/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order :
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Exports a publisher model to a user provided Google Cloud Storage bucket.
▼ ▲ aiplatform.projects.locations.exampleStores.create
Path : v1beta1/{+parent}/exampleStores:create
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/exampleStores:create
HTTP Method : POST
Parameters :
parent
Description : Required. The resource name of the Location to create the ExampleStore in. Format: `projects/{project}/locations/{location}`
Pattern : ^projects/[^/]+/locations/[^/]+$
Location : path
Required : Yes
Type : string
exampleStore.name
Description : Identifier. The resource name of the ExampleStore. This is a unique identifier. Format: projects/{project}/locations/{location}/exampleStores/{example_store}
Location : query
Type : string
exampleStore.displayName
Description : Required. Display name of the ExampleStore.
Location : query
Type : string
exampleStore.description
Description : Optional. Description of the ExampleStore.
Location : query
Type : string
exampleStore.createTime
Description : Output only. Timestamp when this ExampleStore was created.
Location : query
Type : string
Format : google-datetime
exampleStore.updateTime
Description : Output only. Timestamp when this ExampleStore was most recently updated.
Location : query
Type : string
Format : google-datetime
exampleStore.exampleStoreConfig.vertexEmbeddingModel
Description : Required. The embedding model to be used for vector embedding. Immutable. Supported models: * "textembedding-gecko@003" * "text-embedding-004" * "text-embedding-005" * "text-multilingual-embedding-002"
Location : query
Type : string
Parameter Order : parent
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Create an ExampleStore.
▼ ▲ aiplatform.projects.locations.exampleStores.get
Path : v1beta1/{+name}
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/exampleStores/{exampleStoresId}
HTTP Method : GET
Parameters :
name
Description : Required. The resource name of the ExampleStore. Format: `projects/{project}/locations/{location}/exampleStores/{example_store}`
Pattern : ^projects/[^/]+/locations/[^/]+/exampleStores/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Get an ExampleStore.
▼ ▲ aiplatform.projects.locations.exampleStores.patch
Path : v1beta1/{+name}
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/exampleStores/{exampleStoresId}
HTTP Method : PATCH
Parameters :
name
Description : Identifier. The resource name of the ExampleStore. This is a unique identifier. Format: projects/{project}/locations/{location}/exampleStores/{example_store}
Pattern : ^projects/[^/]+/locations/[^/]+/exampleStores/[^/]+$
Location : path
Required : Yes
Type : string
updateMask
Description : Optional. Mask specifying which fields to update. Supported fields: * `display_name` * `description`
Location : query
Type : string
Format : google-fieldmask
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Update an ExampleStore.
▼ ▲ aiplatform.projects.locations.exampleStores.delete
Path : v1beta1/{+name}
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/exampleStores/{exampleStoresId}
HTTP Method : DELETE
Parameters :
name
Description : Required. The resource name of the ExampleStore to be deleted. Format: `projects/{project}/locations/{location}/exampleStores/{example_store}`
Pattern : ^projects/[^/]+/locations/[^/]+/exampleStores/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Delete an ExampleStore.
▼ ▲ aiplatform.projects.locations.exampleStores.list
Path : v1beta1/{+parent}/exampleStores
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/exampleStores
HTTP Method : GET
Parameters :
parent
Description : Required. The resource name of the Location to list the ExampleStores from. Format: `projects/{project}/locations/{location}`
Pattern : ^projects/[^/]+/locations/[^/]+$
Location : path
Required : Yes
Type : string
filter
Description : Optional. The standard list filter. More detail in [AIP-160](https://google.aip.dev/160).
Location : query
Type : string
pageSize
Description : Optional. The standard list page size.
Location : query
Type : integer
Format : int32
pageToken
Description : Optional. The standard list page token.
Location : query
Type : string
Parameter Order : parent
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : List ExampleStores in a Location.
▼ ▲ aiplatform.projects.locations.exampleStores.upsertExamples
Path : v1beta1/{+exampleStore}:upsertExamples
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/exampleStores/{exampleStoresId}:upsertExamples
HTTP Method : POST
Parameters :
exampleStore
Description : Required. The name of the ExampleStore resource that examples are added to or updated in. Format: `projects/{project}/locations/{location}/exampleStores/{example_store}`
Pattern : ^projects/[^/]+/locations/[^/]+/exampleStores/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : exampleStore
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Create or update Examples in the Example Store.
▼ ▲ aiplatform.projects.locations.exampleStores.removeExamples
Path : v1beta1/{+exampleStore}:removeExamples
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/exampleStores/{exampleStoresId}:removeExamples
HTTP Method : POST
Parameters :
exampleStore
Description : Required. The name of the ExampleStore resource that the examples should be removed from. Format: `projects/{project}/locations/{location}/exampleStores/{example_store}`
Pattern : ^projects/[^/]+/locations/[^/]+/exampleStores/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : exampleStore
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Remove Examples from the Example Store.
▼ ▲ aiplatform.projects.locations.exampleStores.searchExamples
Path : v1beta1/{+exampleStore}:searchExamples
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/exampleStores/{exampleStoresId}:searchExamples
HTTP Method : POST
Parameters :
exampleStore
Description : Required. The name of the ExampleStore resource that examples are retrieved from. Format: `projects/{project}/locations/{location}/exampleStores/{example_store}`
Pattern : ^projects/[^/]+/locations/[^/]+/exampleStores/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : exampleStore
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Search for similar Examples for given selection criteria.
▼ ▲ aiplatform.projects.locations.exampleStores.fetchExamples
Path : v1beta1/{+exampleStore}:fetchExamples
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/exampleStores/{exampleStoresId}:fetchExamples
HTTP Method : POST
Parameters :
exampleStore
Description : Required. The name of the ExampleStore resource that the examples should be fetched from. Format: `projects/{project}/locations/{location}/exampleStores/{example_store}`
Pattern : ^projects/[^/]+/locations/[^/]+/exampleStores/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : exampleStore
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Get Examples from the Example Store.
▼ ▲ aiplatform.projects.locations.reasoningEngines.sessions.create
Path : v1beta1/{+parent}/sessions
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/sessions
HTTP Method : POST
Parameters :
parent
Description : Required. The resource name of the location to create the session in. Format: `projects/{project}/locations/{location}` or `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`
Pattern : ^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : parent
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Creates a new Session in a given project and location.
▼ ▲ aiplatform.projects.locations.reasoningEngines.sessions.get
Path : v1beta1/{+name}
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/sessions/{sessionsId}
HTTP Method : GET
Parameters :
name
Description : Required. The resource name of the session. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sessions/{session}`
Pattern : ^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/sessions/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Gets details of the specific Session.
▼ ▲ aiplatform.projects.locations.reasoningEngines.sessions.list
Path : v1beta1/{+parent}/sessions
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/sessions
HTTP Method : GET
Parameters :
parent
Description : Required. The resource name of the location to list sessions from. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`
Pattern : ^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+$
Location : path
Required : Yes
Type : string
pageSize
Description : Optional. The maximum number of sessions to return. The service may return fewer than this value. If unspecified, at most 100 sessions will be returned.
Location : query
Type : integer
Format : int32
pageToken
Description : Optional. The next_page_token value returned from a previous list SessionService.ListSessions call.
Location : query
Type : string
filter
Description : Optional. The standard list filter. Supported fields: * `display_name` Example: `display_name=abc`.
Location : query
Type : string
orderBy
Description : Optional. A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported fields: * `create_time` * `update_time` Example: `create_time desc`.
Location : query
Type : string
Parameter Order : parent
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Lists Sessions in a given project and location.
▼ ▲ aiplatform.projects.locations.reasoningEngines.sessions.patch
Path : v1beta1/{+name}
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/sessions/{sessionsId}
HTTP Method : PATCH
Parameters :
name
Description : Required. Identifier. The resource name of the session. Format: 'projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sessions/{session}'.
Pattern : ^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/sessions/[^/]+$
Location : path
Required : Yes
Type : string
updateMask
Description : Optional. Field mask is used to control which fields get updated. If the mask is not present, all fields will be updated.
Location : query
Type : string
Format : google-fieldmask
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Updates the specific Session.
▼ ▲ aiplatform.projects.locations.reasoningEngines.sessions.delete
Path : v1beta1/{+name}
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/sessions/{sessionsId}
HTTP Method : DELETE
Parameters :
name
Description : Required. The resource name of the session. Format: `projects/{project}/locations/{location}/sessions/{session}` or `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sessions/{session}`
Pattern : ^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/sessions/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Deletes details of the specific Session.
▼ ▲ aiplatform.projects.locations.reasoningEngines.sessions.appendEvent
Path : v1beta1/{+name}:appendEvent
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/sessions/{sessionsId}:appendEvent
HTTP Method : POST
Parameters :
name
Description : Required. The resource name of the session to append event to. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sessions/{session}`
Pattern : ^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/sessions/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Appends an event to a given session.
▼ ▲ aiplatform.projects.locations.reasoningEngines.sessions.events.list
Path : v1beta1/{+parent}/events
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/sessions/{sessionsId}/events
HTTP Method : GET
Parameters :
parent
Description : Required. The resource name of the session to list events from. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sessions/{session}`
Pattern : ^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/sessions/[^/]+$
Location : path
Required : Yes
Type : string
pageSize
Description : Optional. The maximum number of events to return. The service may return fewer than this value. If unspecified, at most 100 events will be returned.
Location : query
Type : integer
Format : int32
pageToken
Description : Optional. The next_page_token value returned from a previous list SessionService.ListEvents call.
Location : query
Type : string
Parameter Order : parent
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Lists Events in a given session.
▼ ▲ aiplatform.projects.locations.sessions.create
Path : v1beta1/{+parent}/sessions
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/sessions
HTTP Method : POST
Parameters :
parent
Description : Required. The resource name of the location to create the session in. Format: `projects/{project}/locations/{location}` or `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`
Pattern : ^projects/[^/]+/locations/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : parent
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Creates a new Session in a given project and location.
▼ ▲ aiplatform.projects.locations.sessions.get
Path : v1beta1/{+name}
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/sessions/{sessionsId}
HTTP Method : GET
Parameters :
name
Description : Required. The resource name of the session. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sessions/{session}`
Pattern : ^projects/[^/]+/locations/[^/]+/sessions/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Gets details of the specific Session.
▼ ▲ aiplatform.projects.locations.sessions.list
Path : v1beta1/{+parent}/sessions
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/sessions
HTTP Method : GET
Parameters :
parent
Description : Required. The resource name of the location to list sessions from. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`
Pattern : ^projects/[^/]+/locations/[^/]+$
Location : path
Required : Yes
Type : string
pageSize
Description : Optional. The maximum number of sessions to return. The service may return fewer than this value. If unspecified, at most 100 sessions will be returned.
Location : query
Type : integer
Format : int32
pageToken
Description : Optional. The next_page_token value returned from a previous list SessionService.ListSessions call.
Location : query
Type : string
filter
Description : Optional. The standard list filter. Supported fields: * `display_name` Example: `display_name=abc`.
Location : query
Type : string
orderBy
Description : Optional. A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported fields: * `create_time` * `update_time` Example: `create_time desc`.
Location : query
Type : string
Parameter Order : parent
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Lists Sessions in a given project and location.
▼ ▲ aiplatform.projects.locations.sessions.patch
Path : v1beta1/{+name}
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/sessions/{sessionsId}
HTTP Method : PATCH
Parameters :
name
Description : Required. Identifier. The resource name of the session. Format: 'projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sessions/{session}'.
Pattern : ^projects/[^/]+/locations/[^/]+/sessions/[^/]+$
Location : path
Required : Yes
Type : string
updateMask
Description : Optional. Field mask is used to control which fields get updated. If the mask is not present, all fields will be updated.
Location : query
Type : string
Format : google-fieldmask
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Updates the specific Session.
▼ ▲ aiplatform.projects.locations.sessions.delete
Path : v1beta1/{+name}
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/sessions/{sessionsId}
HTTP Method : DELETE
Parameters :
name
Description : Required. The resource name of the session. Format: `projects/{project}/locations/{location}/sessions/{session}` or `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sessions/{session}`
Pattern : ^projects/[^/]+/locations/[^/]+/sessions/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Deletes details of the specific Session.
▼ ▲ aiplatform.projects.modelGardenEula.check
Path : v1beta1/{+parent}/modelGardenEula:check
Flat Path : v1beta1/projects/{projectsId}/modelGardenEula:check
HTTP Method : POST
Parameters :
parent
Description : Required. The project requesting access for named model. The format is `projects/{project}`.
Pattern : ^projects/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : parent
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Checks the EULA acceptance status of a publisher model.
▼ ▲ aiplatform.projects.modelGardenEula.accept
Path : v1beta1/{+parent}/modelGardenEula:accept
Flat Path : v1beta1/projects/{projectsId}/modelGardenEula:accept
HTTP Method : POST
Parameters :
parent
Description : Required. The project requesting access for named model. The format is `projects/{project}`.
Pattern : ^projects/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : parent
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Accepts the EULA acceptance status of a publisher model.
▼ ▲ aiplatform.projects.locations.list
Parameters :
extraLocationTypes
Description : Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations.
Location : query
Repeated : Yes
Type : string
▼ ▲ aiplatform.projects.locations.reasoningEngines.delete
Parameters :
force
Description : Optional. If set to true, child resources of this reasoning engine will also be deleted. Otherwise, the request will fail with FAILED_PRECONDITION error when the reasoning engine has undeleted child resources.
Location : query
Type : boolean