2024-08-27
▼ ▲ aiplatform.endpoints.countTokens
Flat Path : v1/endpoints/{endpointsId}:countTokens
HTTP Method : POST
Description : Perform a token counting.
Parameter Order : endpoint
Path : v1/{+endpoint}:countTokens
Parameters :
endpoint
Description : Required. The name of the Endpoint requested to perform token counting. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`
Type : string
Location : path
Pattern : ^endpoints/[^/]+$
Required : Yes
▼ ▲ aiplatform.endpoints.generateContent
Scopes :
Description : Generate content with multimodal inputs.
Flat Path : v1/endpoints/{endpointsId}:generateContent
HTTP Method : POST
Path : v1/{+model}:generateContent
Parameter Order : model
Parameters :
model
Pattern : ^endpoints/[^/]+$
Location : path
Type : string
Description : Required. The fully qualified name of the publisher model or tuned model endpoint to use. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Tuned model endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}`
Required : Yes
▼ ▲ aiplatform.endpoints.streamGenerateContent
Description : Generate content with multimodal inputs with streaming support.
HTTP Method : POST
Path : v1/{+model}:streamGenerateContent
Parameters :
model
Description : Required. The fully qualified name of the publisher model or tuned model endpoint to use. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Tuned model endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}`
Type : string
Required : Yes
Location : path
Pattern : ^endpoints/[^/]+$
Parameter Order : model
Scopes :
Flat Path : v1/endpoints/{endpointsId}:streamGenerateContent
▼ ▲ aiplatform.endpoints.computeTokens
Parameters :
endpoint
Pattern : ^endpoints/[^/]+$
Type : string
Description : Required. The name of the Endpoint requested to get lists of tokens and token ids.
Location : path
Required : Yes
Path : v1/{+endpoint}:computeTokens
Parameter Order : endpoint
Description : Return a list of tokens based on the input text.
HTTP Method : POST
Scopes : https://www.googleapis.com/auth/cloud-platform
Flat Path : v1/endpoints/{endpointsId}:computeTokens
▼ ▲ aiplatform.datasets.datasetVersions.get
Parameters :
readMask
Format : google-fieldmask
Location : query
Description : Mask specifying which fields to read.
Type : string
name
Required : Yes
Pattern : ^datasets/[^/]+/datasetVersions/[^/]+$
Type : string
Description : Required. The resource name of the Dataset version to delete. Format: `projects/{project}/locations/{location}/datasets/{dataset}/datasetVersions/{dataset_version}`
Location : path
Description : Gets a Dataset version.
Scopes : https://www.googleapis.com/auth/cloud-platform
Path : v1/{+name}
Parameter Order : name
HTTP Method : GET
Flat Path : v1/datasets/{datasetsId}/datasetVersions/{datasetVersionsId}
▼ ▲ aiplatform.datasets.datasetVersions.delete
Parameters :
name
Description : Required. The resource name of the Dataset version to delete. Format: `projects/{project}/locations/{location}/datasets/{dataset}/datasetVersions/{dataset_version}`
Type : string
Required : Yes
Location : path
Pattern : ^datasets/[^/]+/datasetVersions/[^/]+$
Parameter Order : name
HTTP Method : DELETE
Path : v1/{+name}
Flat Path : v1/datasets/{datasetsId}/datasetVersions/{datasetVersionsId}
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Deletes a Dataset version.
▼ ▲ aiplatform.datasets.datasetVersions.patch
Description : Updates a DatasetVersion.
Flat Path : v1/datasets/{datasetsId}/datasetVersions/{datasetVersionsId}
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
HTTP Method : PATCH
Parameters :
updateMask
Format : google-fieldmask
Location : query
Description : Required. The update mask applies to the resource. For the `FieldMask` definition, see google.protobuf.FieldMask. Updatable fields: * `display_name`
Type : string
name
Location : path
Type : string
Pattern : ^datasets/[^/]+/datasetVersions/[^/]+$
Description : Output only. Identifier. The resource name of the DatasetVersion.
Required : Yes
Path : v1/{+name}
▼ ▲ aiplatform.datasets.datasetVersions.restore
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Restores a dataset version.
Flat Path : v1/datasets/{datasetsId}/datasetVersions/{datasetVersionsId}:restore
Parameters :
name
Description : Required. The name of the DatasetVersion resource. Format: `projects/{project}/locations/{location}/datasets/{dataset}/datasetVersions/{dataset_version}`
Type : string
Pattern : ^datasets/[^/]+/datasetVersions/[^/]+$
Required : Yes
Location : path
Path : v1/{+name}:restore
HTTP Method : GET
▼ ▲ aiplatform.datasets.datasetVersions.create
HTTP Method : POST
Parameters :
parent
Type : string
Pattern : ^datasets/[^/]+$
Description : Required. The name of the Dataset resource. Format: `projects/{project}/locations/{location}/datasets/{dataset}`
Required : Yes
Location : path
Parameter Order : parent
Flat Path : v1/datasets/{datasetsId}/datasetVersions
Description : Create a version from a Dataset.
Scopes : https://www.googleapis.com/auth/cloud-platform
Path : v1/{+parent}/datasetVersions
▼ ▲ aiplatform.datasets.datasetVersions.list
Parameter Order : parent
Description : Lists DatasetVersions in a Dataset.
Flat Path : v1/datasets/{datasetsId}/datasetVersions
Path : v1/{+parent}/datasetVersions
Parameters :
pageSize
Description : Optional. The standard list page size.
Format : int32
Location : query
Type : integer
readMask
Format : google-fieldmask
Location : query
Type : string
Description : Optional. Mask specifying which fields to read.
pageToken
Location : query
Description : Optional. The standard list page token.
Type : string
filter
Description : Optional. The standard list filter.
Type : string
Location : query
parent
Pattern : ^datasets/[^/]+$
Type : string
Required : Yes
Description : Required. The resource name of the Dataset to list DatasetVersions from. Format: `projects/{project}/locations/{location}/datasets/{dataset}`
Location : path
orderBy
Location : query
Description : Optional. A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending.
Type : string
HTTP Method : GET
▼ ▲ aiplatform.datasets.get
Description : Gets a Dataset.
Path : v1/{+name}
Parameters :
name
Required : Yes
Type : string
Location : path
Description : Required. The name of the Dataset resource.
Pattern : ^datasets/[^/]+$
readMask
Type : string
Format : google-fieldmask
Location : query
Description : Mask specifying which fields to read.
Parameter Order : name
Flat Path : v1/datasets/{datasetsId}
Scopes : https://www.googleapis.com/auth/cloud-platform
HTTP Method : GET
▼ ▲ aiplatform.datasets.create
HTTP Method : POST
Description : Creates a Dataset.
Parameters :
parent
Location : query
Description : Required. The resource name of the Location to create the Dataset in. Format: `projects/{project}/locations/{location}`
Type : string
Flat Path : v1/datasets
Path : v1/datasets
▼ ▲ aiplatform.datasets.delete
Path : v1/{+name}
Description : Deletes a Dataset.
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameters :
name
Description : Required. The resource name of the Dataset to delete. Format: `projects/{project}/locations/{location}/datasets/{dataset}`
Type : string
Location : path
Required : Yes
Pattern : ^datasets/[^/]+$
Parameter Order : name
Flat Path : v1/datasets/{datasetsId}
HTTP Method : DELETE
▼ ▲ aiplatform.datasets.patch
Description : Updates a Dataset.
Parameter Order : name
Parameters :
updateMask
Type : string
Description : Required. The update mask applies to the resource. For the `FieldMask` definition, see google.protobuf.FieldMask. Updatable fields: * `display_name` * `description` * `labels`
Format : google-fieldmask
Location : query
name
Type : string
Pattern : ^datasets/[^/]+$
Required : Yes
Location : path
Description : Output only. Identifier. The resource name of the Dataset.
HTTP Method : PATCH
Flat Path : v1/datasets/{datasetsId}
Path : v1/{+name}
▼ ▲ aiplatform.datasets.list
Parameters :
filter
Type : string
Location : query
Description : An expression for filtering the results of the request. For field names both snake_case and camelCase are supported. * `display_name`: supports = and != * `metadata_schema_uri`: 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"`. Some examples: * `displayName="myDisplayName"` * `labels.myKey="myValue"`
pageToken
Description : The standard list page token.
Type : string
Location : query
orderBy
Type : string
Location : query
Description : A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported fields: * `display_name` * `create_time` * `update_time`
pageSize
Location : query
Description : The standard list page size.
Type : integer
Format : int32
readMask
Type : string
Format : google-fieldmask
Location : query
Description : Mask specifying which fields to read.
parent
Location : query
Type : string
Description : Required. The name of the Dataset's parent resource. Format: `projects/{project}/locations/{location}`
HTTP Method : GET
Scopes : https://www.googleapis.com/auth/cloud-platform
Flat Path : v1/datasets
Description : Lists Datasets in a Location.
Path : v1/datasets
▼ ▲ aiplatform.publishers.models.countTokens
Scopes : https://www.googleapis.com/auth/cloud-platform
Flat Path : v1/publishers/{publishersId}/models/{modelsId}:countTokens
Path : v1/{+endpoint}:countTokens
HTTP Method : POST
Parameters :
endpoint
Description : Required. The name of the Endpoint requested to perform token counting. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`
Pattern : ^publishers/[^/]+/models/[^/]+$
Type : string
Location : path
Required : Yes
Parameter Order : endpoint
Description : Perform a token counting.
▼ ▲ aiplatform.publishers.models.streamGenerateContent
Description : Generate content with multimodal inputs with streaming support.
Parameters :
model
Type : string
Pattern : ^publishers/[^/]+/models/[^/]+$
Required : Yes
Description : Required. The fully qualified name of the publisher model or tuned model endpoint to use. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Tuned model endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}`
Location : path
Flat Path : v1/publishers/{publishersId}/models/{modelsId}:streamGenerateContent
Path : v1/{+model}:streamGenerateContent
HTTP Method : POST
Parameter Order : model
Scopes :
▼ ▲ aiplatform.publishers.models.computeTokens
Flat Path : v1/publishers/{publishersId}/models/{modelsId}:computeTokens
Parameters :
endpoint
Description : Required. The name of the Endpoint requested to get lists of tokens and token ids.
Required : Yes
Type : string
Location : path
Pattern : ^publishers/[^/]+/models/[^/]+$
Parameter Order : endpoint
HTTP Method : POST
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Return a list of tokens based on the input text.
Path : v1/{+endpoint}:computeTokens
▼ ▲ aiplatform.publishers.models.generateContent
Parameters :
model
Location : path
Pattern : ^publishers/[^/]+/models/[^/]+$
Description : Required. The fully qualified name of the publisher model or tuned model endpoint to use. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Tuned model endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}`
Type : string
Required : Yes
Flat Path : v1/publishers/{publishersId}/models/{modelsId}:generateContent
Scopes :
Description : Generate content with multimodal inputs.
Parameter Order : model
HTTP Method : POST
Path : v1/{+model}:generateContent