Class v1beta1.PredictionServiceClient (6.6.0)

6.6.0 (latest) 6.4.0 6.3.0 6.2.0 6.1.0 6.0.0 5.14.0 5.13.0 3.15.0 3.13.0 3.11.0 3.10.1 3.9.0 3.7.0 3.6.0 3.4.0 3.3.0 3.0.0 2.12.0 2.11.0 2.10.0 2.7.0 2.6.1 2.5.0 2.3.0 1.19.0 1.18.0 1.17.0 1.16.0 1.15.0 1.14.1 1.13.0 1.11.0 1.7.2

A service for online predictions and explanations. v1beta1

Package

@google-cloud/aiplatform

Constructors

(constructor)(opts, gaxInstance)

constructor(opts?: ClientOptions, gaxInstance?: typeof gax | typeof gax.fallback);

Construct an instance of PredictionServiceClient.

Parameters
Name	Description
opts	ClientOptions
gaxInstance	typeof gax | typeof fallback : loaded instance of google-gax. Useful if you need to avoid loading the default gRPC version and want to use the fallback HTTP implementation. Load only fallback version and pass it to the constructor: ``` const gax = require('google-gax/build/src/fallback'); // avoids loading google-gax with gRPC const client = new PredictionServiceClient({fallback: true}, gax); ```

Properties

apiEndpoint

get apiEndpoint(): string;

The DNS address for this API service.

apiEndpoint

static get apiEndpoint(): string;

The DNS address for this API service - same as servicePath.

auth

auth: gax.GoogleAuth;

descriptors

descriptors: Descriptors;

iamClient

iamClient: IamClient;

innerApiCalls

innerApiCalls: {
        [name: string]: Function;
    };

locationsClient

locationsClient: LocationsClient;

pathTemplates

pathTemplates: {
        [name: string]: gax.PathTemplate;
    };

port

static get port(): number;

The port for this API service.

predictionServiceStub

predictionServiceStub?: Promise<{
        [name: string]: Function;
    }>;

scopes

static get scopes(): string[];

The scopes needed to make gRPC calls for every method defined in this service.

servicePath

static get servicePath(): string;

The DNS address for this API service.

universeDomain

get universeDomain(): string;

warn

warn: (code: string, message: string, warnType?: string) => void;

Methods

annotationPath(project, location, dataset, dataItem, annotation)

annotationPath(project: string, location: string, dataset: string, dataItem: string, annotation: string): string;

Return a fully-qualified annotation resource name string.

Parameters
Name	Description
project	string
location	string
dataset	string
dataItem	string
annotation	string

Returns
Type	Description
string	{string} Resource name string.

annotationSpecPath(project, location, dataset, annotationSpec)

annotationSpecPath(project: string, location: string, dataset: string, annotationSpec: string): string;

Return a fully-qualified annotationSpec resource name string.

Parameters
Name	Description
project	string
location	string
dataset	string
annotationSpec	string

Returns
Type	Description
string	{string} Resource name string.

artifactPath(project, location, metadataStore, artifact)

artifactPath(project: string, location: string, metadataStore: string, artifact: string): string;

Return a fully-qualified artifact resource name string.

Parameters
Name	Description
project	string
location	string
metadataStore	string
artifact	string

Returns
Type	Description
string	{string} Resource name string.

batchPredictionJobPath(project, location, batchPredictionJob)

batchPredictionJobPath(project: string, location: string, batchPredictionJob: string): string;

Return a fully-qualified batchPredictionJob resource name string.

Parameters
Name	Description
project	string
location	string
batchPredictionJob	string

Returns
Type	Description
string	{string} Resource name string.

cachedContentPath(project, location, cachedContent)

cachedContentPath(project: string, location: string, cachedContent: string): string;

Return a fully-qualified cachedContent resource name string.

Parameters
Name	Description
project	string
location	string
cachedContent	string

Returns
Type	Description
string	{string} Resource name string.

chatCompletions(request, options)

chatCompletions(request?: protos.google.cloud.aiplatform.v1beta1.IChatCompletionsRequest, options?: CallOptions): gax.CancellableStream;

Exposes an OpenAI-compatible endpoint for chat completions.

Parameters
Name	Description
request	IChatCompletionsRequest The request object that will be sent.
options	CallOptions Call options. See CallOptions for more details.

Returns
Type	Description
gax.CancellableStream	{Stream} An object stream which emits HttpBody on 'data' event. Please see the documentation for more details and examples.

Example

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The name of the endpoint requested to serve the prediction.
   *  Format:
   *  `projects/{project}/locations/{location}/endpoints/{endpoint}`
   */
  // const endpoint = 'abc123'
  /**
   *  Optional. The prediction input. Supports HTTP headers and arbitrary data
   *  payload.
   */
  // const httpBody = {}

  // Imports the Aiplatform library
  const {PredictionServiceClient} = require('@google-cloud/aiplatform').v1beta1;

  // Instantiates a client
  const aiplatformClient = new PredictionServiceClient();

  async function callChatCompletions() {
    // Construct request
    const request = {
      endpoint,
    };

    // Run request
    const stream = await aiplatformClient.chatCompletions(request);
    stream.on('data', (response) => { console.log(response) });
    stream.on('error', (err) => { throw(err) });
    stream.on('end', () => { /* API call completed */ });
  }

  callChatCompletions();

close()

close(): Promise<void>;

Terminate the gRPC channel and close the client.

The client will no longer be usable and all future behavior is undefined.

Returns
Type	Description
Promise<void>	{Promise} A promise that resolves when the client is closed.

contextPath(project, location, metadataStore, context)

contextPath(project: string, location: string, metadataStore: string, context: string): string;

Return a fully-qualified context resource name string.

Parameters
Name	Description
project	string
location	string
metadataStore	string
context	string

Returns
Type	Description
string	{string} Resource name string.

countTokens(request, options)

countTokens(request?: protos.google.cloud.aiplatform.v1beta1.ICountTokensRequest, options?: CallOptions): Promise<[
        protos.google.cloud.aiplatform.v1beta1.ICountTokensResponse,
        protos.google.cloud.aiplatform.v1beta1.ICountTokensRequest | undefined,
        {} | undefined
    ]>;

Perform a token counting.

Parameters
Name	Description
request	ICountTokensRequest The request object that will be sent.
options	CallOptions Call options. See CallOptions for more details.

Returns
Type	Description
Promise<[ protos.google.cloud.aiplatform.v1beta1.ICountTokensResponse, protos.google.cloud.aiplatform.v1beta1.ICountTokensRequest | undefined, {} | undefined ]>	{Promise} - The promise which resolves to an array. The first element of the array is an object representing CountTokensResponse. Please see the documentation for more details and examples.

Example

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The name of the Endpoint requested to perform token counting.
   *  Format:
   *  `projects/{project}/locations/{location}/endpoints/{endpoint}`
   */
  // const endpoint = 'abc123'
  /**
   *  Optional. The name of the publisher model requested to serve the
   *  prediction. Format:
   *  `projects/{project}/locations/{location}/publishers/* /models/*`
   */
  // const model = 'abc123'
  /**
   *  Optional. The instances that are the input to token counting call.
   *  Schema is identical to the prediction schema of the underlying model.
   */
  // const instances = [1,2,3,4]
  /**
   *  Optional. Input content.
   */
  // const contents = [1,2,3,4]
  /**
   *  Optional. The user provided system instructions for the model.
   *  Note: only text should be used in parts and content in each part will be in
   *  a separate paragraph.
   */
  // const systemInstruction = {}
  /**
   *  Optional. A list of `Tools` the model may use to generate the next
   *  response.
   *  A `Tool` is a piece of code that enables the system to interact with
   *  external systems to perform an action, or set of actions, outside of
   *  knowledge and scope of the model.
   */
  // const tools = [1,2,3,4]
  /**
   *  Optional. Generation config that the model will use to generate the
   *  response.
   */
  // const generationConfig = {}

  // Imports the Aiplatform library
  const {PredictionServiceClient} = require('@google-cloud/aiplatform').v1beta1;

  // Instantiates a client
  const aiplatformClient = new PredictionServiceClient();

  async function callCountTokens() {
    // Construct request
    const request = {
      endpoint,
    };

    // Run request
    const response = await aiplatformClient.countTokens(request);
    console.log(response);
  }

  callCountTokens();

countTokens(request, options, callback)

countTokens(request: protos.google.cloud.aiplatform.v1beta1.ICountTokensRequest, options: CallOptions, callback: Callback<protos.google.cloud.aiplatform.v1beta1.ICountTokensResponse, protos.google.cloud.aiplatform.v1beta1.ICountTokensRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	ICountTokensRequest
options	CallOptions
callback	Callback<protos.google.cloud.aiplatform.v1beta1.ICountTokensResponse, protos.google.cloud.aiplatform.v1beta1.ICountTokensRequest | null | undefined, {} | null | undefined>

Returns
Type	Description
void

countTokens(request, callback)

countTokens(request: protos.google.cloud.aiplatform.v1beta1.ICountTokensRequest, callback: Callback<protos.google.cloud.aiplatform.v1beta1.ICountTokensResponse, protos.google.cloud.aiplatform.v1beta1.ICountTokensRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	ICountTokensRequest
callback	Callback<protos.google.cloud.aiplatform.v1beta1.ICountTokensResponse, protos.google.cloud.aiplatform.v1beta1.ICountTokensRequest | null | undefined, {} | null | undefined>

Returns
Type	Description
void

customJobPath(project, location, customJob)

customJobPath(project: string, location: string, customJob: string): string;

Return a fully-qualified customJob resource name string.

Parameters
Name	Description
project	string
location	string
customJob	string

Returns
Type	Description
string	{string} Resource name string.

dataItemPath(project, location, dataset, dataItem)

dataItemPath(project: string, location: string, dataset: string, dataItem: string): string;

Return a fully-qualified dataItem resource name string.

Parameters
Name	Description
project	string
location	string
dataset	string
dataItem	string

Returns
Type	Description
string	{string} Resource name string.

dataLabelingJobPath(project, location, dataLabelingJob)

dataLabelingJobPath(project: string, location: string, dataLabelingJob: string): string;

Return a fully-qualified dataLabelingJob resource name string.

Parameters
Name	Description
project	string
location	string
dataLabelingJob	string

Returns
Type	Description
string	{string} Resource name string.

datasetPath(project, location, dataset)

datasetPath(project: string, location: string, dataset: string): string;

Return a fully-qualified dataset resource name string.

Parameters
Name	Description
project	string
location	string
dataset	string

Returns
Type	Description
string	{string} Resource name string.

datasetVersionPath(project, location, dataset, datasetVersion)

datasetVersionPath(project: string, location: string, dataset: string, datasetVersion: string): string;

Return a fully-qualified datasetVersion resource name string.

Parameters
Name	Description
project	string
location	string
dataset	string
datasetVersion	string

Returns
Type	Description
string	{string} Resource name string.

deploymentResourcePoolPath(project, location, deploymentResourcePool)

deploymentResourcePoolPath(project: string, location: string, deploymentResourcePool: string): string;

Return a fully-qualified deploymentResourcePool resource name string.

Parameters
Name	Description
project	string
location	string
deploymentResourcePool	string

Returns
Type	Description
string	{string} Resource name string.

directPredict(request, options)

directPredict(request?: protos.google.cloud.aiplatform.v1beta1.IDirectPredictRequest, options?: CallOptions): Promise<[
        protos.google.cloud.aiplatform.v1beta1.IDirectPredictResponse,
        protos.google.cloud.aiplatform.v1beta1.IDirectPredictRequest | undefined,
        {} | undefined
    ]>;

Perform an unary online prediction request to a gRPC model server for Vertex first-party products and frameworks.

Parameters
Name	Description
request	IDirectPredictRequest The request object that will be sent.
options	CallOptions Call options. See CallOptions for more details.

Returns
Type	Description
Promise<[ protos.google.cloud.aiplatform.v1beta1.IDirectPredictResponse, protos.google.cloud.aiplatform.v1beta1.IDirectPredictRequest | undefined, {} | undefined ]>	{Promise} - The promise which resolves to an array. The first element of the array is an object representing DirectPredictResponse. Please see the documentation for more details and examples.

Example

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The name of the Endpoint requested to serve the prediction.
   *  Format:
   *  `projects/{project}/locations/{location}/endpoints/{endpoint}`
   */
  // const endpoint = 'abc123'
  /**
   *  The prediction input.
   */
  // const inputs = [1,2,3,4]
  /**
   *  The parameters that govern the prediction.
   */
  // const parameters = {}

  // Imports the Aiplatform library
  const {PredictionServiceClient} = require('@google-cloud/aiplatform').v1beta1;

  // Instantiates a client
  const aiplatformClient = new PredictionServiceClient();

  async function callDirectPredict() {
    // Construct request
    const request = {
      endpoint,
    };

    // Run request
    const response = await aiplatformClient.directPredict(request);
    console.log(response);
  }

  callDirectPredict();

directPredict(request, options, callback)

directPredict(request: protos.google.cloud.aiplatform.v1beta1.IDirectPredictRequest, options: CallOptions, callback: Callback<protos.google.cloud.aiplatform.v1beta1.IDirectPredictResponse, protos.google.cloud.aiplatform.v1beta1.IDirectPredictRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	IDirectPredictRequest
options	CallOptions
callback	Callback<protos.google.cloud.aiplatform.v1beta1.IDirectPredictResponse, protos.google.cloud.aiplatform.v1beta1.IDirectPredictRequest | null | undefined, {} | null | undefined>

Returns
Type	Description
void

directPredict(request, callback)

directPredict(request: protos.google.cloud.aiplatform.v1beta1.IDirectPredictRequest, callback: Callback<protos.google.cloud.aiplatform.v1beta1.IDirectPredictResponse, protos.google.cloud.aiplatform.v1beta1.IDirectPredictRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	IDirectPredictRequest
callback	Callback<protos.google.cloud.aiplatform.v1beta1.IDirectPredictResponse, protos.google.cloud.aiplatform.v1beta1.IDirectPredictRequest | null | undefined, {} | null | undefined>

Returns
Type	Description
void

directRawPredict(request, options)

directRawPredict(request?: protos.google.cloud.aiplatform.v1beta1.IDirectRawPredictRequest, options?: CallOptions): Promise<[
        protos.google.cloud.aiplatform.v1beta1.IDirectRawPredictResponse,
        protos.google.cloud.aiplatform.v1beta1.IDirectRawPredictRequest | undefined,
        {} | undefined
    ]>;

Perform an unary online prediction request to a gRPC model server for custom containers.

Parameters
Name	Description
request	IDirectRawPredictRequest The request object that will be sent.
options	CallOptions Call options. See CallOptions for more details.

Returns
Type	Description
Promise<[ protos.google.cloud.aiplatform.v1beta1.IDirectRawPredictResponse, protos.google.cloud.aiplatform.v1beta1.IDirectRawPredictRequest | undefined, {} | undefined ]>	{Promise} - The promise which resolves to an array. The first element of the array is an object representing DirectRawPredictResponse. Please see the documentation for more details and examples.

Example

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The name of the Endpoint requested to serve the prediction.
   *  Format:
   *  `projects/{project}/locations/{location}/endpoints/{endpoint}`
   */
  // const endpoint = 'abc123'
  /**
   *  Fully qualified name of the API method being invoked to perform
   *  predictions.
   *  Format:
   *  `/namespace.Service/Method/`
   *  Example:
   *  `/tensorflow.serving.PredictionService/Predict`
   */
  // const methodName = 'abc123'
  /**
   *  The prediction input.
   */
  // const input = Buffer.from('string')

  // Imports the Aiplatform library
  const {PredictionServiceClient} = require('@google-cloud/aiplatform').v1beta1;

  // Instantiates a client
  const aiplatformClient = new PredictionServiceClient();

  async function callDirectRawPredict() {
    // Construct request
    const request = {
      endpoint,
    };

    // Run request
    const response = await aiplatformClient.directRawPredict(request);
    console.log(response);
  }

  callDirectRawPredict();

directRawPredict(request, options, callback)

directRawPredict(request: protos.google.cloud.aiplatform.v1beta1.IDirectRawPredictRequest, options: CallOptions, callback: Callback<protos.google.cloud.aiplatform.v1beta1.IDirectRawPredictResponse, protos.google.cloud.aiplatform.v1beta1.IDirectRawPredictRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	IDirectRawPredictRequest
options	CallOptions
callback	Callback<protos.google.cloud.aiplatform.v1beta1.IDirectRawPredictResponse, protos.google.cloud.aiplatform.v1beta1.IDirectRawPredictRequest | null | undefined, {} | null | undefined>

Returns
Type	Description
void

directRawPredict(request, callback)

directRawPredict(request: protos.google.cloud.aiplatform.v1beta1.IDirectRawPredictRequest, callback: Callback<protos.google.cloud.aiplatform.v1beta1.IDirectRawPredictResponse, protos.google.cloud.aiplatform.v1beta1.IDirectRawPredictRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	IDirectRawPredictRequest
callback	Callback<protos.google.cloud.aiplatform.v1beta1.IDirectRawPredictResponse, protos.google.cloud.aiplatform.v1beta1.IDirectRawPredictRequest | null | undefined, {} | null | undefined>

Returns
Type	Description
void

embedContent(request, options)

embedContent(request?: protos.google.cloud.aiplatform.v1beta1.IEmbedContentRequest, options?: CallOptions): Promise<[
        protos.google.cloud.aiplatform.v1beta1.IEmbedContentResponse,
        protos.google.cloud.aiplatform.v1beta1.IEmbedContentRequest | undefined,
        {} | undefined
    ]>;

Embed content with multimodal inputs.

Parameters
Name	Description
request	IEmbedContentRequest The request object that will be sent.
options	CallOptions Call options. See CallOptions for more details.

Returns
Type	Description
Promise<[ protos.google.cloud.aiplatform.v1beta1.IEmbedContentResponse, protos.google.cloud.aiplatform.v1beta1.IEmbedContentRequest | undefined, {} | undefined ]>	{Promise} - The promise which resolves to an array. The first element of the array is an object representing . Please see the documentation for more details and examples.

Example

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The name of the publisher model requested to serve the
   *  prediction. Format:
   *  `projects/{project}/locations/{location}/publishers/* /models/*`
   */
  // const model = 'abc123'
  /**
   *  Required. Input content to be embedded.
   */
  // const content = {}
  /**
   *  Optional. Configuration for the EmbedContent request.
   */
  // const embedContentConfig = {}

  // Imports the Aiplatform library
  const {PredictionServiceClient} = require('@google-cloud/aiplatform').v1beta1;

  // Instantiates a client
  const aiplatformClient = new PredictionServiceClient();

  async function callEmbedContent() {
    // Construct request
    const request = {
    };

    // Run request
    const response = await aiplatformClient.embedContent(request);
    console.log(response);
  }

  callEmbedContent();

embedContent(request, options, callback)

embedContent(request: protos.google.cloud.aiplatform.v1beta1.IEmbedContentRequest, options: CallOptions, callback: Callback<protos.google.cloud.aiplatform.v1beta1.IEmbedContentResponse, protos.google.cloud.aiplatform.v1beta1.IEmbedContentRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	IEmbedContentRequest
options	CallOptions
callback	Callback<protos.google.cloud.aiplatform.v1beta1.IEmbedContentResponse, protos.google.cloud.aiplatform.v1beta1.IEmbedContentRequest | null | undefined, {} | null | undefined>

Returns
Type	Description
void

embedContent(request, callback)

embedContent(request: protos.google.cloud.aiplatform.v1beta1.IEmbedContentRequest, callback: Callback<protos.google.cloud.aiplatform.v1beta1.IEmbedContentResponse, protos.google.cloud.aiplatform.v1beta1.IEmbedContentRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	IEmbedContentRequest
callback	Callback<protos.google.cloud.aiplatform.v1beta1.IEmbedContentResponse, protos.google.cloud.aiplatform.v1beta1.IEmbedContentRequest | null | undefined, {} | null | undefined>

Returns
Type	Description
void

entityTypePath(project, location, featurestore, entityType)

entityTypePath(project: string, location: string, featurestore: string, entityType: string): string;

Return a fully-qualified entityType resource name string.

Parameters
Name	Description
project	string
location	string
featurestore	string
entityType	string

Returns
Type	Description
string	{string} Resource name string.

exampleStorePath(project, location, exampleStore)

exampleStorePath(project: string, location: string, exampleStore: string): string;

Return a fully-qualified exampleStore resource name string.

Parameters
Name	Description
project	string
location	string
exampleStore	string

Returns
Type	Description
string	{string} Resource name string.

executionPath(project, location, metadataStore, execution)

executionPath(project: string, location: string, metadataStore: string, execution: string): string;

Return a fully-qualified execution resource name string.

Parameters
Name	Description
project	string
location	string
metadataStore	string
execution	string

Returns
Type	Description
string	{string} Resource name string.

explain(request, options)

explain(request?: protos.google.cloud.aiplatform.v1beta1.IExplainRequest, options?: CallOptions): Promise<[
        protos.google.cloud.aiplatform.v1beta1.IExplainResponse,
        protos.google.cloud.aiplatform.v1beta1.IExplainRequest | undefined,
        {} | undefined
    ]>;

Perform an online explanation.

If is specified, the corresponding DeployModel must have populated. If is not specified, all DeployedModels must have populated.

Parameters
Name	Description
request	IExplainRequest The request object that will be sent.
options	CallOptions Call options. See CallOptions for more details.

Returns
Type	Description
Promise<[ protos.google.cloud.aiplatform.v1beta1.IExplainResponse, protos.google.cloud.aiplatform.v1beta1.IExplainRequest | undefined, {} | undefined ]>	{Promise} - The promise which resolves to an array. The first element of the array is an object representing . Please see the documentation for more details and examples.

Example

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The name of the Endpoint requested to serve the explanation.
   *  Format:
   *  `projects/{project}/locations/{location}/endpoints/{endpoint}`
   */
  // const endpoint = 'abc123'
  /**
   *  Required. The instances that are the input to the explanation call.
   *  A DeployedModel may have an upper limit on the number of instances it
   *  supports per request, and when it is exceeded the explanation call errors
   *  in case of AutoML Models, or, in case of customer created Models, the
   *  behaviour is as documented by that Model.
   *  The schema of any single instance may be specified via Endpoint's
   *  DeployedModels'
   *  Model's google.cloud.aiplatform.v1beta1.DeployedModel.model 
   *  PredictSchemata's google.cloud.aiplatform.v1beta1.Model.predict_schemata 
   *  instance_schema_uri google.cloud.aiplatform.v1beta1.PredictSchemata.instance_schema_uri.
   */
  // const instances = [1,2,3,4]
  /**
   *  The parameters that govern the prediction. The schema of the parameters may
   *  be specified via Endpoint's DeployedModels' Model's
   *   google.cloud.aiplatform.v1beta1.DeployedModel.model 
   *  PredictSchemata's google.cloud.aiplatform.v1beta1.Model.predict_schemata 
   *  parameters_schema_uri google.cloud.aiplatform.v1beta1.PredictSchemata.parameters_schema_uri.
   */
  // const parameters = {}
  /**
   *  If specified, overrides the
   *  explanation_spec google.cloud.aiplatform.v1beta1.DeployedModel.explanation_spec 
   *  of the DeployedModel. Can be used for explaining prediction results with
   *  different configurations, such as:
   *   - Explaining top-5 predictions results as opposed to top-1;
   *   - Increasing path count or step count of the attribution methods to reduce
   *     approximate errors;
   *   - Using different baselines for explaining the prediction results.
   */
  // const explanationSpecOverride = {}
  /**
   *  Optional. This field is the same as the one above, but supports multiple
   *  explanations to occur in parallel. The key can be any string. Each override
   *  will be run against the model, then its explanations will be grouped
   *  together.
   *  Note - these explanations are run **In Addition** to the default
   *  Explanation in the deployed model.
   */
  // const concurrentExplanationSpecOverride = [1,2,3,4]
  /**
   *  If specified, this ExplainRequest will be served by the chosen
   *  DeployedModel, overriding
   *  Endpoint.traffic_split google.cloud.aiplatform.v1beta1.Endpoint.traffic_split.
   */
  // const deployedModelId = 'abc123'

  // Imports the Aiplatform library
  const {PredictionServiceClient} = require('@google-cloud/aiplatform').v1beta1;

  // Instantiates a client
  const aiplatformClient = new PredictionServiceClient();

  async function callExplain() {
    // Construct request
    const request = {
      endpoint,
      instances,
    };

    // Run request
    const response = await aiplatformClient.explain(request);
    console.log(response);
  }

  callExplain();

explain(request, options, callback)

explain(request: protos.google.cloud.aiplatform.v1beta1.IExplainRequest, options: CallOptions, callback: Callback<protos.google.cloud.aiplatform.v1beta1.IExplainResponse, protos.google.cloud.aiplatform.v1beta1.IExplainRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	IExplainRequest
options	CallOptions
callback	Callback<protos.google.cloud.aiplatform.v1beta1.IExplainResponse, protos.google.cloud.aiplatform.v1beta1.IExplainRequest | null | undefined, {} | null | undefined>

Returns
Type	Description
void

explain(request, callback)

explain(request: protos.google.cloud.aiplatform.v1beta1.IExplainRequest, callback: Callback<protos.google.cloud.aiplatform.v1beta1.IExplainResponse, protos.google.cloud.aiplatform.v1beta1.IExplainRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	IExplainRequest
callback	Callback<protos.google.cloud.aiplatform.v1beta1.IExplainResponse, protos.google.cloud.aiplatform.v1beta1.IExplainRequest | null | undefined, {} | null | undefined>

Returns
Type	Description
void

extensionPath(project, location, extension)

extensionPath(project: string, location: string, extension: string): string;

Return a fully-qualified extension resource name string.

Parameters
Name	Description
project	string
location	string
extension	string

Returns
Type	Description
string	{string} Resource name string.

featureGroupPath(project, location, featureGroup)

featureGroupPath(project: string, location: string, featureGroup: string): string;

Return a fully-qualified featureGroup resource name string.

Parameters
Name	Description
project	string
location	string
featureGroup	string

Returns
Type	Description
string	{string} Resource name string.

featureMonitorJobPath(project, location, featureGroup, featureMonitor, featureMonitorJob)

featureMonitorJobPath(project: string, location: string, featureGroup: string, featureMonitor: string, featureMonitorJob: string): string;

Return a fully-qualified featureMonitorJob resource name string.

Parameters
Name	Description
project	string
location	string
featureGroup	string
featureMonitor	string
featureMonitorJob	string

Returns
Type	Description
string	{string} Resource name string.

featureMonitorPath(project, location, featureGroup, featureMonitor)

featureMonitorPath(project: string, location: string, featureGroup: string, featureMonitor: string): string;

Return a fully-qualified featureMonitor resource name string.

Parameters
Name	Description
project	string
location	string
featureGroup	string
featureMonitor	string

Returns
Type	Description
string	{string} Resource name string.

featureOnlineStorePath(project, location, featureOnlineStore)

featureOnlineStorePath(project: string, location: string, featureOnlineStore: string): string;

Return a fully-qualified featureOnlineStore resource name string.

Parameters
Name	Description
project	string
location	string
featureOnlineStore	string

Returns
Type	Description
string	{string} Resource name string.

featurestorePath(project, location, featurestore)

featurestorePath(project: string, location: string, featurestore: string): string;

Return a fully-qualified featurestore resource name string.

Parameters
Name	Description
project	string
location	string
featurestore	string

Returns
Type	Description
string	{string} Resource name string.

featureViewPath(project, location, featureOnlineStore, featureView)

featureViewPath(project: string, location: string, featureOnlineStore: string, featureView: string): string;

Return a fully-qualified featureView resource name string.

Parameters
Name	Description
project	string
location	string
featureOnlineStore	string
featureView	string

Returns
Type	Description
string	{string} Resource name string.

featureViewSyncPath(project, location, featureOnlineStore, featureView)

featureViewSyncPath(project: string, location: string, featureOnlineStore: string, featureView: string): string;

Return a fully-qualified featureViewSync resource name string.

Parameters
Name	Description
project	string
location	string
featureOnlineStore	string
featureView	string

Returns
Type	Description
string	{string} Resource name string.

generateContent(request, options)

generateContent(request?: protos.google.cloud.aiplatform.v1beta1.IGenerateContentRequest, options?: CallOptions): Promise<[
        protos.google.cloud.aiplatform.v1beta1.IGenerateContentResponse,
        protos.google.cloud.aiplatform.v1beta1.IGenerateContentRequest | undefined,
        {} | undefined
    ]>;

Generate content with multimodal inputs.

Parameters
Name	Description
request	IGenerateContentRequest The request object that will be sent.
options	CallOptions Call options. See CallOptions for more details.

Returns
Type	Description
Promise<[ protos.google.cloud.aiplatform.v1beta1.IGenerateContentResponse, protos.google.cloud.aiplatform.v1beta1.IGenerateContentRequest | undefined, {} | undefined ]>	{Promise} - The promise which resolves to an array. The first element of the array is an object representing . Please see the documentation for more details and examples.

Example

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  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}`
   */
  // const model = 'abc123'
  /**
   *  Required. The content of the current conversation with the model.
   *  For single-turn queries, this is a single instance. For multi-turn queries,
   *  this is a repeated field that contains conversation history + latest
   *  request.
   */
  // const contents = [1,2,3,4]
  /**
   *  Optional. The user provided system instructions for the model.
   *  Note: only text should be used in parts and content in each part will be in
   *  a separate paragraph.
   */
  // const systemInstruction = {}
  /**
   *  Optional. The name of the cached content used as context to serve the
   *  prediction. Note: only used in explicit caching, where users can have
   *  control over caching (e.g. what content to cache) and enjoy guaranteed cost
   *  savings. Format:
   *  `projects/{project}/locations/{location}/cachedContents/{cachedContent}`
   */
  // const cachedContent = 'abc123'
  /**
   *  Optional. A list of `Tools` the model may use to generate the next
   *  response.
   *  A `Tool` is a piece of code that enables the system to interact with
   *  external systems to perform an action, or set of actions, outside of
   *  knowledge and scope of the model.
   */
  // const tools = [1,2,3,4]
  /**
   *  Optional. Tool config. This config is shared for all tools provided in the
   *  request.
   */
  // const toolConfig = {}
  /**
   *  Optional. The labels with user-defined metadata for the request. It is used
   *  for billing and reporting only.
   *  Label keys and values can be no longer than 63 characters
   *  (Unicode codepoints) and can only contain lowercase letters, numeric
   *  characters, underscores, and dashes. International characters are allowed.
   *  Label values are optional. Label keys must start with a letter.
   */
  // const labels = [1,2,3,4]
  /**
   *  Optional. Per request settings for blocking unsafe content.
   *  Enforced on GenerateContentResponse.candidates.
   */
  // const safetySettings = [1,2,3,4]
  /**
   *  Optional. Settings for prompt and response sanitization using the Model
   *  Armor service. If supplied, safety_settings must not be supplied.
   */
  // const modelArmorConfig = {}
  /**
   *  Optional. Generation config.
   */
  // const generationConfig = {}

  // Imports the Aiplatform library
  const {PredictionServiceClient} = require('@google-cloud/aiplatform').v1beta1;

  // Instantiates a client
  const aiplatformClient = new PredictionServiceClient();

  async function callGenerateContent() {
    // Construct request
    const request = {
      model,
      contents,
    };

    // Run request
    const response = await aiplatformClient.generateContent(request);
    console.log(response);
  }

  callGenerateContent();

generateContent(request, options, callback)

generateContent(request: protos.google.cloud.aiplatform.v1beta1.IGenerateContentRequest, options: CallOptions, callback: Callback<protos.google.cloud.aiplatform.v1beta1.IGenerateContentResponse, protos.google.cloud.aiplatform.v1beta1.IGenerateContentRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	IGenerateContentRequest
options	CallOptions
callback	Callback<protos.google.cloud.aiplatform.v1beta1.IGenerateContentResponse, protos.google.cloud.aiplatform.v1beta1.IGenerateContentRequest | null | undefined, {} | null | undefined>

Returns
Type	Description
void

generateContent(request, callback)

generateContent(request: protos.google.cloud.aiplatform.v1beta1.IGenerateContentRequest, callback: Callback<protos.google.cloud.aiplatform.v1beta1.IGenerateContentResponse, protos.google.cloud.aiplatform.v1beta1.IGenerateContentRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	IGenerateContentRequest
callback	Callback<protos.google.cloud.aiplatform.v1beta1.IGenerateContentResponse, protos.google.cloud.aiplatform.v1beta1.IGenerateContentRequest | null | undefined, {} | null | undefined>

Returns
Type	Description
void

getIamPolicy(request, options, callback)

getIamPolicy(request: IamProtos.google.iam.v1.GetIamPolicyRequest, options?: gax.CallOptions | Callback<IamProtos.google.iam.v1.Policy, IamProtos.google.iam.v1.GetIamPolicyRequest | null | undefined, {} | null | undefined>, callback?: Callback<IamProtos.google.iam.v1.Policy, IamProtos.google.iam.v1.GetIamPolicyRequest | null | undefined, {} | null | undefined>): Promise<[IamProtos.google.iam.v1.Policy]>;

Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.

Parameters
Name	Description
request	IamProtos.google.iam.v1.GetIamPolicyRequest The request object that will be sent.
options	CallOptions | Callback<google.iam.v1.Policy, google.iam.v1.GetIamPolicyRequest | null | undefined, {} | null | undefined> Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details.
callback	Callback<google.iam.v1.Policy, google.iam.v1.GetIamPolicyRequest | null | undefined, {} | null | undefined> The function which will be called with the result of the API call. The second parameter to the callback is an object representing .

Returns
Type	Description
Promise<[google.iam.v1.Policy]>	{Promise} - The promise which resolves to an array. The first element of the array is an object representing . The promise has a method named "cancel" which cancels the ongoing API call.

getLocation(request, options, callback)

getLocation(request: LocationProtos.google.cloud.location.IGetLocationRequest, options?: gax.CallOptions | Callback<LocationProtos.google.cloud.location.ILocation, LocationProtos.google.cloud.location.IGetLocationRequest | null | undefined, {} | null | undefined>, callback?: Callback<LocationProtos.google.cloud.location.ILocation, LocationProtos.google.cloud.location.IGetLocationRequest | null | undefined, {} | null | undefined>): Promise<LocationProtos.google.cloud.location.ILocation>;

Gets information about a location.

Parameters
Name	Description
request	LocationProtos.google.cloud.location.IGetLocationRequest The request object that will be sent.
options	CallOptions | Callback<google.cloud.location.ILocation, google.cloud.location.IGetLocationRequest | null | undefined, {} | null | undefined> Call options. See CallOptions for more details.
callback	Callback<google.cloud.location.ILocation, google.cloud.location.IGetLocationRequest | null | undefined, {} | null | undefined>

Returns
Type	Description
Promise<google.cloud.location.ILocation>	{Promise} - The promise which resolves to an array. The first element of the array is an object representing . Please see the documentation for more details and examples.

Example

const [response] = await client.getLocation(request);

getProjectId()

getProjectId(): Promise<string>;

Returns
Type	Description
Promise<string>

getProjectId(callback)

getProjectId(callback: Callback<string, undefined, undefined>): void;

Parameter
Name	Description
callback	Callback<string, undefined, undefined>

Returns
Type	Description
void

hyperparameterTuningJobPath(project, location, hyperparameterTuningJob)

hyperparameterTuningJobPath(project: string, location: string, hyperparameterTuningJob: string): string;

Return a fully-qualified hyperparameterTuningJob resource name string.

Parameters
Name	Description
project	string
location	string
hyperparameterTuningJob	string

Returns
Type	Description
string	{string} Resource name string.

indexEndpointPath(project, location, indexEndpoint)

indexEndpointPath(project: string, location: string, indexEndpoint: string): string;

Return a fully-qualified indexEndpoint resource name string.

Parameters
Name	Description
project	string
location	string
indexEndpoint	string

Returns
Type	Description
string	{string} Resource name string.

indexPath(project, location, index)

indexPath(project: string, location: string, index: string): string;

Return a fully-qualified index resource name string.

Parameters
Name	Description
project	string
location	string
index	string

Returns
Type	Description
string	{string} Resource name string.

initialize()

initialize(): Promise<{
        [name: string]: Function;
    }>;

Initialize the client. Performs asynchronous operations (such as authentication) and prepares the client. This function will be called automatically when any class method is called for the first time, but if you need to initialize it before calling an actual method, feel free to call initialize() directly.

You can await on this method if you want to make sure the client is initialized.

Returns
Type	Description
Promise<{ [name: string]: Function; }>	{Promise} A promise that resolves to an authenticated service stub.

listLocationsAsync(request, options)

listLocationsAsync(request: LocationProtos.google.cloud.location.IListLocationsRequest, options?: CallOptions): AsyncIterable<LocationProtos.google.cloud.location.ILocation>;

Lists information about the supported locations for this service. Returns an iterable object.

for-await-of syntax is used with the iterable to get response elements on-demand.

Parameters
Name	Description
request	LocationProtos.google.cloud.location.IListLocationsRequest The request object that will be sent.
options	CallOptions Call options. See CallOptions for more details.

Returns
Type	Description
AsyncIterable<google.cloud.location.ILocation>	{Object} An iterable Object that allows async iteration. When you iterate the returned iterable, each element will be an object representing . The API will be called under the hood as needed, once per the page, so you can stop the iteration when you don't need more results. Please see the documentation for more details and examples.

Example

const iterable = client.listLocationsAsync(request);
for await (const response of iterable) {
  // process response
}

matchAnnotationFromAnnotationName(annotationName)

matchAnnotationFromAnnotationName(annotationName: string): string | number;

Parse the annotation from Annotation resource.

Parameter
Name	Description
annotationName	string A fully-qualified path representing Annotation resource.

Returns
Type	Description
string | number	{string} A string representing the annotation.

matchAnnotationSpecFromAnnotationSpecName(annotationSpecName)

matchAnnotationSpecFromAnnotationSpecName(annotationSpecName: string): string | number;

Parse the annotation_spec from AnnotationSpec resource.

Parameter
Name	Description
annotationSpecName	string A fully-qualified path representing AnnotationSpec resource.

Returns
Type	Description
string | number	{string} A string representing the annotation_spec.

matchArtifactFromArtifactName(artifactName)

matchArtifactFromArtifactName(artifactName: string): string | number;

Parse the artifact from Artifact resource.

Parameter
Name	Description
artifactName	string A fully-qualified path representing Artifact resource.

Returns
Type	Description
string | number	{string} A string representing the artifact.

matchBatchPredictionJobFromBatchPredictionJobName(batchPredictionJobName)

matchBatchPredictionJobFromBatchPredictionJobName(batchPredictionJobName: string): string | number;

Parse the batch_prediction_job from BatchPredictionJob resource.

Parameter
Name	Description
batchPredictionJobName	string A fully-qualified path representing BatchPredictionJob resource.

Returns
Type	Description
string | number	{string} A string representing the batch_prediction_job.

matchCachedContentFromCachedContentName(cachedContentName)

matchCachedContentFromCachedContentName(cachedContentName: string): string | number;

Parse the cached_content from CachedContent resource.

Parameter
Name	Description
cachedContentName	string A fully-qualified path representing CachedContent resource.

Returns
Type	Description
string | number	{string} A string representing the cached_content.

matchContextFromContextName(contextName)

matchContextFromContextName(contextName: string): string | number;

Parse the context from Context resource.

Parameter
Name	Description
contextName	string A fully-qualified path representing Context resource.

Returns
Type	Description
string | number	{string} A string representing the context.

matchCustomJobFromCustomJobName(customJobName)

matchCustomJobFromCustomJobName(customJobName: string): string | number;

Parse the custom_job from CustomJob resource.

Parameter
Name	Description
customJobName	string A fully-qualified path representing CustomJob resource.

Returns
Type	Description
string | number	{string} A string representing the custom_job.

matchDataItemFromAnnotationName(annotationName)

matchDataItemFromAnnotationName(annotationName: string): string | number;

Parse the data_item from Annotation resource.

Parameter
Name	Description
annotationName	string A fully-qualified path representing Annotation resource.

Returns
Type	Description
string | number	{string} A string representing the data_item.

matchDataItemFromDataItemName(dataItemName)

matchDataItemFromDataItemName(dataItemName: string): string | number;

Parse the data_item from DataItem resource.

Parameter
Name	Description
dataItemName	string A fully-qualified path representing DataItem resource.

Returns
Type	Description
string | number	{string} A string representing the data_item.

matchDataLabelingJobFromDataLabelingJobName(dataLabelingJobName)

matchDataLabelingJobFromDataLabelingJobName(dataLabelingJobName: string): string | number;

Parse the data_labeling_job from DataLabelingJob resource.

Parameter
Name	Description
dataLabelingJobName	string A fully-qualified path representing DataLabelingJob resource.

Returns
Type	Description
string | number	{string} A string representing the data_labeling_job.

matchDatasetFromAnnotationName(annotationName)

matchDatasetFromAnnotationName(annotationName: string): string | number;

Parse the dataset from Annotation resource.

Parameter
Name	Description
annotationName	string A fully-qualified path representing Annotation resource.

Returns
Type	Description
string | number	{string} A string representing the dataset.

matchDatasetFromAnnotationSpecName(annotationSpecName)

matchDatasetFromAnnotationSpecName(annotationSpecName: string): string | number;

Parse the dataset from AnnotationSpec resource.

Parameter
Name	Description
annotationSpecName	string A fully-qualified path representing AnnotationSpec resource.

Returns
Type	Description
string | number	{string} A string representing the dataset.

matchDatasetFromDataItemName(dataItemName)

matchDatasetFromDataItemName(dataItemName: string): string | number;

Parse the dataset from DataItem resource.

Parameter
Name	Description
dataItemName	string A fully-qualified path representing DataItem resource.

Returns
Type	Description
string | number	{string} A string representing the dataset.

matchDatasetFromDatasetName(datasetName)

matchDatasetFromDatasetName(datasetName: string): string | number;

Parse the dataset from Dataset resource.

Parameter
Name	Description
datasetName	string A fully-qualified path representing Dataset resource.

Returns
Type	Description
string | number	{string} A string representing the dataset.

matchDatasetFromDatasetVersionName(datasetVersionName)

matchDatasetFromDatasetVersionName(datasetVersionName: string): string | number;

Parse the dataset from DatasetVersion resource.

Parameter
Name	Description
datasetVersionName	string A fully-qualified path representing DatasetVersion resource.

Returns
Type	Description
string | number	{string} A string representing the dataset.

matchDatasetFromSavedQueryName(savedQueryName)

matchDatasetFromSavedQueryName(savedQueryName: string): string | number;

Parse the dataset from SavedQuery resource.

Parameter
Name	Description
savedQueryName	string A fully-qualified path representing SavedQuery resource.

Returns
Type	Description
string | number	{string} A string representing the dataset.

matchDatasetVersionFromDatasetVersionName(datasetVersionName)

matchDatasetVersionFromDatasetVersionName(datasetVersionName: string): string | number;

Parse the dataset_version from DatasetVersion resource.

Parameter
Name	Description
datasetVersionName	string A fully-qualified path representing DatasetVersion resource.

Returns
Type	Description
string | number	{string} A string representing the dataset_version.

matchDeploymentResourcePoolFromDeploymentResourcePoolName(deploymentResourcePoolName)

matchDeploymentResourcePoolFromDeploymentResourcePoolName(deploymentResourcePoolName: string): string | number;

Parse the deployment_resource_pool from DeploymentResourcePool resource.

Parameter
Name	Description
deploymentResourcePoolName	string A fully-qualified path representing DeploymentResourcePool resource.

Returns
Type	Description
string | number	{string} A string representing the deployment_resource_pool.

matchEndpointFromProjectLocationEndpointName(projectLocationEndpointName)

matchEndpointFromProjectLocationEndpointName(projectLocationEndpointName: string): string | number;

Parse the endpoint from ProjectLocationEndpoint resource.

Parameter
Name	Description
projectLocationEndpointName	string A fully-qualified path representing project_location_endpoint resource.

Returns
Type	Description
string | number	{string} A string representing the endpoint.

matchEntityTypeFromEntityTypeName(entityTypeName)

matchEntityTypeFromEntityTypeName(entityTypeName: string): string | number;

Parse the entity_type from EntityType resource.

Parameter
Name	Description
entityTypeName	string A fully-qualified path representing EntityType resource.

Returns
Type	Description
string | number	{string} A string representing the entity_type.

matchEntityTypeFromProjectLocationFeaturestoreEntityTypeFeaturesName(projectLocationFeaturestoreEntityTypeFeaturesName)

matchEntityTypeFromProjectLocationFeaturestoreEntityTypeFeaturesName(projectLocationFeaturestoreEntityTypeFeaturesName: string): string | number;

Parse the entity_type from ProjectLocationFeaturestoreEntityTypeFeatures resource.

Parameter
Name	Description
projectLocationFeaturestoreEntityTypeFeaturesName	string A fully-qualified path representing project_location_featurestore_entity_type_features resource.

Returns
Type	Description
string | number	{string} A string representing the entity_type.

matchEvaluationFromModelEvaluationName(modelEvaluationName)

matchEvaluationFromModelEvaluationName(modelEvaluationName: string): string | number;

Parse the evaluation from ModelEvaluation resource.

Parameter
Name	Description
modelEvaluationName	string A fully-qualified path representing ModelEvaluation resource.

Returns
Type	Description
string | number	{string} A string representing the evaluation.

matchEvaluationFromModelEvaluationSliceName(modelEvaluationSliceName)

matchEvaluationFromModelEvaluationSliceName(modelEvaluationSliceName: string): string | number;

Parse the evaluation from ModelEvaluationSlice resource.

Parameter
Name	Description
modelEvaluationSliceName	string A fully-qualified path representing ModelEvaluationSlice resource.

Returns
Type	Description
string | number	{string} A string representing the evaluation.

matchEventFromSessionEventName(sessionEventName)

matchEventFromSessionEventName(sessionEventName: string): string | number;

Parse the event from SessionEvent resource.

Parameter
Name	Description
sessionEventName	string A fully-qualified path representing SessionEvent resource.

Returns
Type	Description
string | number	{string} A string representing the event.

matchExampleStoreFromExampleStoreName(exampleStoreName)

matchExampleStoreFromExampleStoreName(exampleStoreName: string): string | number;

Parse the example_store from ExampleStore resource.

Parameter
Name	Description
exampleStoreName	string A fully-qualified path representing ExampleStore resource.

Returns
Type	Description
string | number	{string} A string representing the example_store.

matchExecutionFromExecutionName(executionName)

matchExecutionFromExecutionName(executionName: string): string | number;

Parse the execution from Execution resource.

Parameter
Name	Description
executionName	string A fully-qualified path representing Execution resource.

Returns
Type	Description
string | number	{string} A string representing the execution.

matchExperimentFromTensorboardExperimentName(tensorboardExperimentName)

matchExperimentFromTensorboardExperimentName(tensorboardExperimentName: string): string | number;

Parse the experiment from TensorboardExperiment resource.

Parameter
Name	Description
tensorboardExperimentName	string A fully-qualified path representing TensorboardExperiment resource.

Returns
Type	Description
string | number	{string} A string representing the experiment.

matchExperimentFromTensorboardRunName(tensorboardRunName)

matchExperimentFromTensorboardRunName(tensorboardRunName: string): string | number;

Parse the experiment from TensorboardRun resource.

Parameter
Name	Description
tensorboardRunName	string A fully-qualified path representing TensorboardRun resource.

Returns
Type	Description
string | number	{string} A string representing the experiment.

matchExperimentFromTensorboardTimeSeriesName(tensorboardTimeSeriesName)

matchExperimentFromTensorboardTimeSeriesName(tensorboardTimeSeriesName: string): string | number;

Parse the experiment from TensorboardTimeSeries resource.

Parameter
Name	Description
tensorboardTimeSeriesName	string A fully-qualified path representing TensorboardTimeSeries resource.

Returns
Type	Description
string | number	{string} A string representing the experiment.

matchExtensionFromExtensionName(extensionName)

matchExtensionFromExtensionName(extensionName: string): string | number;

Parse the extension from Extension resource.

Parameter
Name	Description
extensionName	string A fully-qualified path representing Extension resource.

Returns
Type	Description
string | number	{string} A string representing the extension.

matchFeatureFromProjectLocationFeatureGroupFeaturesName(projectLocationFeatureGroupFeaturesName)

matchFeatureFromProjectLocationFeatureGroupFeaturesName(projectLocationFeatureGroupFeaturesName: string): string | number;

Parse the feature from ProjectLocationFeatureGroupFeatures resource.

Parameter
Name	Description
projectLocationFeatureGroupFeaturesName	string A fully-qualified path representing project_location_feature_group_features resource.

Returns
Type	Description
string | number	{string} A string representing the feature.

matchFeatureFromProjectLocationFeaturestoreEntityTypeFeaturesName(projectLocationFeaturestoreEntityTypeFeaturesName)

matchFeatureFromProjectLocationFeaturestoreEntityTypeFeaturesName(projectLocationFeaturestoreEntityTypeFeaturesName: string): string | number;

Parse the feature from ProjectLocationFeaturestoreEntityTypeFeatures resource.

Parameter
Name	Description
projectLocationFeaturestoreEntityTypeFeaturesName	string A fully-qualified path representing project_location_featurestore_entity_type_features resource.

Returns
Type	Description
string | number	{string} A string representing the feature.

matchFeatureGroupFromFeatureGroupName(featureGroupName)

matchFeatureGroupFromFeatureGroupName(featureGroupName: string): string | number;

Parse the feature_group from FeatureGroup resource.

Parameter
Name	Description
featureGroupName	string A fully-qualified path representing FeatureGroup resource.

Returns
Type	Description
string | number	{string} A string representing the feature_group.

matchFeatureGroupFromFeatureMonitorJobName(featureMonitorJobName)

matchFeatureGroupFromFeatureMonitorJobName(featureMonitorJobName: string): string | number;

Parse the feature_group from FeatureMonitorJob resource.

Parameter
Name	Description
featureMonitorJobName	string A fully-qualified path representing FeatureMonitorJob resource.

Returns
Type	Description
string | number	{string} A string representing the feature_group.

matchFeatureGroupFromFeatureMonitorName(featureMonitorName)

matchFeatureGroupFromFeatureMonitorName(featureMonitorName: string): string | number;

Parse the feature_group from FeatureMonitor resource.

Parameter
Name	Description
featureMonitorName	string A fully-qualified path representing FeatureMonitor resource.

Returns
Type	Description
string | number	{string} A string representing the feature_group.

matchFeatureGroupFromProjectLocationFeatureGroupFeaturesName(projectLocationFeatureGroupFeaturesName)

matchFeatureGroupFromProjectLocationFeatureGroupFeaturesName(projectLocationFeatureGroupFeaturesName: string): string | number;

Parse the feature_group from ProjectLocationFeatureGroupFeatures resource.

Parameter
Name	Description
projectLocationFeatureGroupFeaturesName	string A fully-qualified path representing project_location_feature_group_features resource.

Returns
Type	Description
string | number	{string} A string representing the feature_group.

matchFeatureMonitorFromFeatureMonitorJobName(featureMonitorJobName)

matchFeatureMonitorFromFeatureMonitorJobName(featureMonitorJobName: string): string | number;

Parse the feature_monitor from FeatureMonitorJob resource.

Parameter
Name	Description
featureMonitorJobName	string A fully-qualified path representing FeatureMonitorJob resource.

Returns
Type	Description
string | number	{string} A string representing the feature_monitor.

matchFeatureMonitorFromFeatureMonitorName(featureMonitorName)

matchFeatureMonitorFromFeatureMonitorName(featureMonitorName: string): string | number;

Parse the feature_monitor from FeatureMonitor resource.

Parameter
Name	Description
featureMonitorName	string A fully-qualified path representing FeatureMonitor resource.

Returns
Type	Description
string | number	{string} A string representing the feature_monitor.

matchFeatureMonitorJobFromFeatureMonitorJobName(featureMonitorJobName)

matchFeatureMonitorJobFromFeatureMonitorJobName(featureMonitorJobName: string): string | number;

Parse the feature_monitor_job from FeatureMonitorJob resource.

Parameter
Name	Description
featureMonitorJobName	string A fully-qualified path representing FeatureMonitorJob resource.

Returns
Type	Description
string | number	{string} A string representing the feature_monitor_job.

matchFeatureOnlineStoreFromFeatureOnlineStoreName(featureOnlineStoreName)

matchFeatureOnlineStoreFromFeatureOnlineStoreName(featureOnlineStoreName: string): string | number;

Parse the feature_online_store from FeatureOnlineStore resource.

Parameter
Name	Description
featureOnlineStoreName	string A fully-qualified path representing FeatureOnlineStore resource.

Returns
Type	Description
string | number	{string} A string representing the feature_online_store.

matchFeatureOnlineStoreFromFeatureViewName(featureViewName)

matchFeatureOnlineStoreFromFeatureViewName(featureViewName: string): string | number;

Parse the feature_online_store from FeatureView resource.

Parameter
Name	Description
featureViewName	string A fully-qualified path representing FeatureView resource.

Returns
Type	Description
string | number	{string} A string representing the feature_online_store.

matchFeatureOnlineStoreFromFeatureViewSyncName(featureViewSyncName)

matchFeatureOnlineStoreFromFeatureViewSyncName(featureViewSyncName: string): string | number;

Parse the feature_online_store from FeatureViewSync resource.

Parameter
Name	Description
featureViewSyncName	string A fully-qualified path representing FeatureViewSync resource.

Returns
Type	Description
string | number	{string} A string representing the feature_online_store.

matchFeaturestoreFromEntityTypeName(entityTypeName)

matchFeaturestoreFromEntityTypeName(entityTypeName: string): string | number;

Parse the featurestore from EntityType resource.

Parameter
Name	Description
entityTypeName	string A fully-qualified path representing EntityType resource.

Returns
Type	Description
string | number	{string} A string representing the featurestore.

matchFeaturestoreFromFeaturestoreName(featurestoreName)

matchFeaturestoreFromFeaturestoreName(featurestoreName: string): string | number;

Parse the featurestore from Featurestore resource.

Parameter
Name	Description
featurestoreName	string A fully-qualified path representing Featurestore resource.

Returns
Type	Description
string | number	{string} A string representing the featurestore.

matchFeaturestoreFromProjectLocationFeaturestoreEntityTypeFeaturesName(projectLocationFeaturestoreEntityTypeFeaturesName)

matchFeaturestoreFromProjectLocationFeaturestoreEntityTypeFeaturesName(projectLocationFeaturestoreEntityTypeFeaturesName: string): string | number;

Parse the featurestore from ProjectLocationFeaturestoreEntityTypeFeatures resource.

Parameter
Name	Description
projectLocationFeaturestoreEntityTypeFeaturesName	string A fully-qualified path representing project_location_featurestore_entity_type_features resource.

Returns
Type	Description
string | number	{string} A string representing the featurestore.

matchFeatureViewFromFeatureViewName(featureViewName)

matchFeatureViewFromFeatureViewName(featureViewName: string): string | number;

Parse the feature_view from FeatureView resource.

Parameter
Name	Description
featureViewName	string A fully-qualified path representing FeatureView resource.

Returns
Type	Description
string | number	{string} A string representing the feature_view.

matchFeatureViewFromFeatureViewSyncName(featureViewSyncName)

matchFeatureViewFromFeatureViewSyncName(featureViewSyncName: string): string | number;

Parse the feature_view from FeatureViewSync resource.

Parameter
Name	Description
featureViewSyncName	string A fully-qualified path representing FeatureViewSync resource.

Returns
Type	Description
string | number	{string} A string representing the feature_view.

matchHyperparameterTuningJobFromHyperparameterTuningJobName(hyperparameterTuningJobName)

matchHyperparameterTuningJobFromHyperparameterTuningJobName(hyperparameterTuningJobName: string): string | number;

Parse the hyperparameter_tuning_job from HyperparameterTuningJob resource.

Parameter
Name	Description
hyperparameterTuningJobName	string A fully-qualified path representing HyperparameterTuningJob resource.

Returns
Type	Description
string | number	{string} A string representing the hyperparameter_tuning_job.

matchIndexEndpointFromIndexEndpointName(indexEndpointName)

matchIndexEndpointFromIndexEndpointName(indexEndpointName: string): string | number;

Parse the index_endpoint from IndexEndpoint resource.

Parameter
Name	Description
indexEndpointName	string A fully-qualified path representing IndexEndpoint resource.

Returns
Type	Description
string | number	{string} A string representing the index_endpoint.

matchIndexFromIndexName(indexName)

matchIndexFromIndexName(indexName: string): string | number;

Parse the index from Index resource.

Parameter
Name	Description
indexName	string A fully-qualified path representing Index resource.

Returns
Type	Description
string | number	{string} A string representing the index.

matchLocationFromAnnotationName(annotationName)

matchLocationFromAnnotationName(annotationName: string): string | number;

Parse the location from Annotation resource.

Parameter
Name	Description
annotationName	string A fully-qualified path representing Annotation resource.

Returns
Type	Description
string | number	{string} A string representing the location.

matchLocationFromAnnotationSpecName(annotationSpecName)

matchLocationFromAnnotationSpecName(annotationSpecName: string): string | number;

Parse the location from AnnotationSpec resource.

Parameter
Name	Description
annotationSpecName	string A fully-qualified path representing AnnotationSpec resource.

Returns
Type	Description
string | number	{string} A string representing the location.

matchLocationFromArtifactName(artifactName)

matchLocationFromArtifactName(artifactName: string): string | number;

Parse the location from Artifact resource.

Parameter
Name	Description
artifactName	string A fully-qualified path representing Artifact resource.

Returns
Type	Description
string | number	{string} A string representing the location.

matchLocationFromBatchPredictionJobName(batchPredictionJobName)

matchLocationFromBatchPredictionJobName(batchPredictionJobName: string): string | number;

Parse the location from BatchPredictionJob resource.

Parameter
Name	Description
batchPredictionJobName	string A fully-qualified path representing BatchPredictionJob resource.

Returns
Type	Description
string | number	{string} A string representing the location.

matchLocationFromCachedContentName(cachedContentName)

matchLocationFromCachedContentName(cachedContentName: string): string | number;

Parse the location from CachedContent resource.

Parameter
Name	Description
cachedContentName	string A fully-qualified path representing CachedContent resource.

Returns
Type	Description
string | number	{string} A string representing the location.

matchLocationFromContextName(contextName)

matchLocationFromContextName(contextName: string): string | number;

Parse the location from Context resource.

Parameter
Name	Description
contextName	string A fully-qualified path representing Context resource.

Returns
Type	Description
string | number	{string} A string representing the location.

matchLocationFromCustomJobName(customJobName)

matchLocationFromCustomJobName(customJobName: string): string | number;

Parse the location from CustomJob resource.

Parameter
Name	Description
customJobName	string A fully-qualified path representing CustomJob resource.

Returns
Type	Description
string | number	{string} A string representing the location.

matchLocationFromDataItemName(dataItemName)

matchLocationFromDataItemName(dataItemName: string): string | number;

Parse the location from DataItem resource.

Parameter
Name	Description
dataItemName	string A fully-qualified path representing DataItem resource.

Returns
Type	Description
string | number	{string} A string representing the location.

matchLocationFromDataLabelingJobName(dataLabelingJobName)

matchLocationFromDataLabelingJobName(dataLabelingJobName: string): string | number;

Parse the location from DataLabelingJob resource.

Parameter
Name	Description
dataLabelingJobName	string A fully-qualified path representing DataLabelingJob resource.

Returns
Type	Description
string | number	{string} A string representing the location.

matchLocationFromDatasetName(datasetName)

matchLocationFromDatasetName(datasetName: string): string | number;

Parse the location from Dataset resource.

Parameter
Name	Description
datasetName	string A fully-qualified path representing Dataset resource.

Returns
Type	Description
string | number	{string} A string representing the location.

matchLocationFromDatasetVersionName(datasetVersionName)

matchLocationFromDatasetVersionName(datasetVersionName: string): string | number;

Parse the location from DatasetVersion resource.

Parameter
Name	Description
datasetVersionName	string A fully-qualified path representing DatasetVersion resource.

Returns
Type	Description
string | number	{string} A string representing the location.

matchLocationFromDeploymentResourcePoolName(deploymentResourcePoolName)

matchLocationFromDeploymentResourcePoolName(deploymentResourcePoolName: string): string | number;

Parse the location from DeploymentResourcePool resource.

Parameter
Name	Description
deploymentResourcePoolName	string A fully-qualified path representing DeploymentResourcePool resource.

Returns
Type	Description
string | number	{string} A string representing the location.

matchLocationFromEntityTypeName(entityTypeName)

matchLocationFromEntityTypeName(entityTypeName: string): string | number;

Parse the location from EntityType resource.

Parameter
Name	Description
entityTypeName	string A fully-qualified path representing EntityType resource.

Returns
Type	Description
string | number	{string} A string representing the location.

matchLocationFromExampleStoreName(exampleStoreName)

matchLocationFromExampleStoreName(exampleStoreName: string): string | number;

Parse the location from ExampleStore resource.

Parameter
Name	Description
exampleStoreName	string A fully-qualified path representing ExampleStore resource.

Returns
Type	Description
string | number	{string} A string representing the location.

matchLocationFromExecutionName(executionName)

matchLocationFromExecutionName(executionName: string): string | number;

Parse the location from Execution resource.

Parameter
Name	Description
executionName	string A fully-qualified path representing Execution resource.

Returns
Type	Description
string | number	{string} A string representing the location.

matchLocationFromExtensionName(extensionName)

matchLocationFromExtensionName(extensionName: string): string | number;

Parse the location from Extension resource.

Parameter
Name	Description
extensionName	string A fully-qualified path representing Extension resource.

Returns
Type	Description
string | number	{string} A string representing the location.

matchLocationFromFeatureGroupName(featureGroupName)

matchLocationFromFeatureGroupName(featureGroupName: string): string | number;

Parse the location from FeatureGroup resource.

Parameter
Name	Description
featureGroupName	string A fully-qualified path representing FeatureGroup resource.

Returns
Type	Description
string | number	{string} A string representing the location.

matchLocationFromFeatureMonitorJobName(featureMonitorJobName)

matchLocationFromFeatureMonitorJobName(featureMonitorJobName: string): string | number;

Parse the location from FeatureMonitorJob resource.

Parameter
Name	Description
featureMonitorJobName	string A fully-qualified path representing FeatureMonitorJob resource.

Returns
Type	Description
string | number	{string} A string representing the location.

matchLocationFromFeatureMonitorName(featureMonitorName)

matchLocationFromFeatureMonitorName(featureMonitorName: string): string | number;

Parse the location from FeatureMonitor resource.

Parameter
Name	Description
featureMonitorName	string A fully-qualified path representing FeatureMonitor resource.

Returns
Type	Description
string | number	{string} A string representing the location.

matchLocationFromFeatureOnlineStoreName(featureOnlineStoreName)

matchLocationFromFeatureOnlineStoreName(featureOnlineStoreName: string): string | number;

Parse the location from FeatureOnlineStore resource.

Parameter
Name	Description
featureOnlineStoreName	string A fully-qualified path representing FeatureOnlineStore resource.

Returns
Type	Description
string | number	{string} A string representing the location.

matchLocationFromFeaturestoreName(featurestoreName)

matchLocationFromFeaturestoreName(featurestoreName: string): string | number;

Parse the location from Featurestore resource.

Parameter
Name	Description
featurestoreName	string A fully-qualified path representing Featurestore resource.

Returns
Type	Description
string | number	{string} A string representing the location.

matchLocationFromFeatureViewName(featureViewName)

matchLocationFromFeatureViewName(featureViewName: string): string | number;

Parse the location from FeatureView resource.

Parameter
Name	Description
featureViewName	string A fully-qualified path representing FeatureView resource.

Returns
Type	Description
string | number	{string} A string representing the location.

matchLocationFromFeatureViewSyncName(featureViewSyncName)

matchLocationFromFeatureViewSyncName(featureViewSyncName: string): string | number;

Parse the location from FeatureViewSync resource.

Parameter
Name	Description
featureViewSyncName	string A fully-qualified path representing FeatureViewSync resource.

Returns
Type	Description
string | number	{string} A string representing the location.

matchLocationFromHyperparameterTuningJobName(hyperparameterTuningJobName)

matchLocationFromHyperparameterTuningJobName(hyperparameterTuningJobName: string): string | number;

Parse the location from HyperparameterTuningJob resource.

Parameter
Name	Description
hyperparameterTuningJobName	string A fully-qualified path representing HyperparameterTuningJob resource.

Returns
Type	Description
string | number	{string} A string representing the location.

matchLocationFromIndexEndpointName(indexEndpointName)

matchLocationFromIndexEndpointName(indexEndpointName: string): string | number;

Parse the location from IndexEndpoint resource.

Parameter
Name	Description
indexEndpointName	string A fully-qualified path representing IndexEndpoint resource.

Returns
Type	Description
string | number	{string} A string representing the location.

matchLocationFromIndexName(indexName)

matchLocationFromIndexName(indexName: string): string | number;

Parse the location from Index resource.

Parameter
Name	Description
indexName	string A fully-qualified path representing Index resource.

Returns
Type	Description
string | number	{string} A string representing the location.

matchLocationFromMemoryName(memoryName)

matchLocationFromMemoryName(memoryName: string): string | number;

Parse the location from Memory resource.

Parameter
Name	Description
memoryName	string A fully-qualified path representing Memory resource.

Returns
Type	Description
string | number	{string} A string representing the location.

matchLocationFromMetadataSchemaName(metadataSchemaName)

matchLocationFromMetadataSchemaName(metadataSchemaName: string): string | number;

Parse the location from MetadataSchema resource.

Parameter
Name	Description
metadataSchemaName	string A fully-qualified path representing MetadataSchema resource.

Returns
Type	Description
string | number	{string} A string representing the location.

matchLocationFromMetadataStoreName(metadataStoreName)

matchLocationFromMetadataStoreName(metadataStoreName: string): string | number;

Parse the location from MetadataStore resource.

Parameter
Name	Description
metadataStoreName	string A fully-qualified path representing MetadataStore resource.

Returns
Type	Description
string | number	{string} A string representing the location.

matchLocationFromModelDeploymentMonitoringJobName(modelDeploymentMonitoringJobName)

matchLocationFromModelDeploymentMonitoringJobName(modelDeploymentMonitoringJobName: string): string | number;

Parse the location from ModelDeploymentMonitoringJob resource.

Parameter
Name	Description
modelDeploymentMonitoringJobName	string A fully-qualified path representing ModelDeploymentMonitoringJob resource.

Returns
Type	Description
string | number	{string} A string representing the location.

matchLocationFromModelEvaluationName(modelEvaluationName)

matchLocationFromModelEvaluationName(modelEvaluationName: string): string | number;

Parse the location from ModelEvaluation resource.

Parameter
Name	Description
modelEvaluationName	string A fully-qualified path representing ModelEvaluation resource.

Returns
Type	Description
string | number	{string} A string representing the location.

matchLocationFromModelEvaluationSliceName(modelEvaluationSliceName)

matchLocationFromModelEvaluationSliceName(modelEvaluationSliceName: string): string | number;

Parse the location from ModelEvaluationSlice resource.

Parameter
Name	Description
modelEvaluationSliceName	string A fully-qualified path representing ModelEvaluationSlice resource.

Returns
Type	Description
string | number	{string} A string representing the location.

matchLocationFromModelMonitoringJobName(modelMonitoringJobName)

matchLocationFromModelMonitoringJobName(modelMonitoringJobName: string): string | number;

Parse the location from ModelMonitoringJob resource.

Parameter
Name	Description
modelMonitoringJobName	string A fully-qualified path representing ModelMonitoringJob resource.

Returns
Type	Description
string | number	{string} A string representing the location.

matchLocationFromModelMonitorName(modelMonitorName)

matchLocationFromModelMonitorName(modelMonitorName: string): string | number;

Parse the location from ModelMonitor resource.

Parameter
Name	Description
modelMonitorName	string A fully-qualified path representing ModelMonitor resource.

Returns
Type	Description
string | number	{string} A string representing the location.

matchLocationFromModelName(modelName)

matchLocationFromModelName(modelName: string): string | number;

Parse the location from Model resource.

Parameter
Name	Description
modelName	string A fully-qualified path representing Model resource.

Returns
Type	Description
string | number	{string} A string representing the location.

matchLocationFromNasJobName(nasJobName)

matchLocationFromNasJobName(nasJobName: string): string | number;

Parse the location from NasJob resource.

Parameter
Name	Description
nasJobName	string A fully-qualified path representing NasJob resource.

Returns
Type	Description
string | number	{string} A string representing the location.

matchLocationFromNasTrialDetailName(nasTrialDetailName)

matchLocationFromNasTrialDetailName(nasTrialDetailName: string): string | number;

Parse the location from NasTrialDetail resource.

Parameter
Name	Description
nasTrialDetailName	string A fully-qualified path representing NasTrialDetail resource.

Returns
Type	Description
string | number	{string} A string representing the location.

matchLocationFromNotebookExecutionJobName(notebookExecutionJobName)

matchLocationFromNotebookExecutionJobName(notebookExecutionJobName: string): string | number;

Parse the location from NotebookExecutionJob resource.

Parameter
Name	Description
notebookExecutionJobName	string A fully-qualified path representing NotebookExecutionJob resource.

Returns
Type	Description
string | number	{string} A string representing the location.

matchLocationFromNotebookRuntimeName(notebookRuntimeName)

matchLocationFromNotebookRuntimeName(notebookRuntimeName: string): string | number;

Parse the location from NotebookRuntime resource.

Parameter
Name	Description
notebookRuntimeName	string A fully-qualified path representing NotebookRuntime resource.

Returns
Type	Description
string | number	{string} A string representing the location.

matchLocationFromNotebookRuntimeTemplateName(notebookRuntimeTemplateName)

matchLocationFromNotebookRuntimeTemplateName(notebookRuntimeTemplateName: string): string | number;

Parse the location from NotebookRuntimeTemplate resource.

Parameter
Name	Description
notebookRuntimeTemplateName	string A fully-qualified path representing NotebookRuntimeTemplate resource.

Returns
Type	Description
string | number	{string} A string representing the location.

matchLocationFromPersistentResourceName(persistentResourceName)

matchLocationFromPersistentResourceName(persistentResourceName: string): string | number;

Parse the location from PersistentResource resource.

Parameter
Name	Description
persistentResourceName	string A fully-qualified path representing PersistentResource resource.

Returns
Type	Description
string | number	{string} A string representing the location.

matchLocationFromPipelineJobName(pipelineJobName)

matchLocationFromPipelineJobName(pipelineJobName: string): string | number;

Parse the location from PipelineJob resource.

Parameter
Name	Description
pipelineJobName	string A fully-qualified path representing PipelineJob resource.

Returns
Type	Description
string | number	{string} A string representing the location.

matchLocationFromProjectLocationEndpointName(projectLocationEndpointName)

matchLocationFromProjectLocationEndpointName(projectLocationEndpointName: string): string | number;

Parse the location from ProjectLocationEndpoint resource.

Parameter
Name	Description
projectLocationEndpointName	string A fully-qualified path representing project_location_endpoint resource.

Returns
Type	Description
string | number	{string} A string representing the location.

matchLocationFromProjectLocationFeatureGroupFeaturesName(projectLocationFeatureGroupFeaturesName)

matchLocationFromProjectLocationFeatureGroupFeaturesName(projectLocationFeatureGroupFeaturesName: string): string | number;

Parse the location from ProjectLocationFeatureGroupFeatures resource.

Parameter
Name	Description
projectLocationFeatureGroupFeaturesName	string A fully-qualified path representing project_location_feature_group_features resource.

Returns
Type	Description
string | number	{string} A string representing the location.

matchLocationFromProjectLocationFeaturestoreEntityTypeFeaturesName(projectLocationFeaturestoreEntityTypeFeaturesName)

matchLocationFromProjectLocationFeaturestoreEntityTypeFeaturesName(projectLocationFeaturestoreEntityTypeFeaturesName: string): string | number;

Parse the location from ProjectLocationFeaturestoreEntityTypeFeatures resource.

Parameter
Name	Description
projectLocationFeaturestoreEntityTypeFeaturesName	string A fully-qualified path representing project_location_featurestore_entity_type_features resource.

Returns
Type	Description
string | number	{string} A string representing the location.

matchLocationFromProjectLocationPublisherModelName(projectLocationPublisherModelName)

matchLocationFromProjectLocationPublisherModelName(projectLocationPublisherModelName: string): string | number;

Parse the location from ProjectLocationPublisherModel resource.

Parameter
Name	Description
projectLocationPublisherModelName	string A fully-qualified path representing project_location_publisher_model resource.

Returns
Type	Description
string | number	{string} A string representing the location.

matchLocationFromRagCorpusName(ragCorpusName)

matchLocationFromRagCorpusName(ragCorpusName: string): string | number;

Parse the location from RagCorpus resource.

Parameter
Name	Description
ragCorpusName	string A fully-qualified path representing RagCorpus resource.

Returns
Type	Description
string | number	{string} A string representing the location.

matchLocationFromRagDataSchemaName(ragDataSchemaName)

matchLocationFromRagDataSchemaName(ragDataSchemaName: string): string | number;

Parse the location from RagDataSchema resource.

Parameter
Name	Description
ragDataSchemaName	string A fully-qualified path representing RagDataSchema resource.

Returns
Type	Description
string | number	{string} A string representing the location.

matchLocationFromRagEngineConfigName(ragEngineConfigName)

matchLocationFromRagEngineConfigName(ragEngineConfigName: string): string | number;

Parse the location from RagEngineConfig resource.

Parameter
Name	Description
ragEngineConfigName	string A fully-qualified path representing RagEngineConfig resource.

Returns
Type	Description
string | number	{string} A string representing the location.

matchLocationFromRagFileName(ragFileName)

matchLocationFromRagFileName(ragFileName: string): string | number;

Parse the location from RagFile resource.

Parameter
Name	Description
ragFileName	string A fully-qualified path representing RagFile resource.

Returns
Type	Description
string | number	{string} A string representing the location.

matchLocationFromRagMetadataName(ragMetadataName)

matchLocationFromRagMetadataName(ragMetadataName: string): string | number;

Parse the location from RagMetadata resource.

Parameter
Name	Description
ragMetadataName	string A fully-qualified path representing RagMetadata resource.

Returns
Type	Description
string | number	{string} A string representing the location.

matchLocationFromReasoningEngineName(reasoningEngineName)

matchLocationFromReasoningEngineName(reasoningEngineName: string): string | number;

Parse the location from ReasoningEngine resource.

Parameter
Name	Description
reasoningEngineName	string A fully-qualified path representing ReasoningEngine resource.

Returns
Type	Description
string | number	{string} A string representing the location.

matchLocationFromSavedQueryName(savedQueryName)

matchLocationFromSavedQueryName(savedQueryName: string): string | number;

Parse the location from SavedQuery resource.

Parameter
Name	Description
savedQueryName	string A fully-qualified path representing SavedQuery resource.

Returns
Type	Description
string | number	{string} A string representing the location.

matchLocationFromScheduleName(scheduleName)

matchLocationFromScheduleName(scheduleName: string): string | number;

Parse the location from Schedule resource.

Parameter
Name	Description
scheduleName	string A fully-qualified path representing Schedule resource.

Returns
Type	Description
string | number	{string} A string representing the location.

matchLocationFromSessionEventName(sessionEventName)

matchLocationFromSessionEventName(sessionEventName: string): string | number;

Parse the location from SessionEvent resource.

Parameter
Name	Description
sessionEventName	string A fully-qualified path representing SessionEvent resource.

Returns
Type	Description
string | number	{string} A string representing the location.

matchLocationFromSessionName(sessionName)

matchLocationFromSessionName(sessionName: string): string | number;

Parse the location from Session resource.

Parameter
Name	Description
sessionName	string A fully-qualified path representing Session resource.

Returns
Type	Description
string | number	{string} A string representing the location.

matchLocationFromSpecialistPoolName(specialistPoolName)

matchLocationFromSpecialistPoolName(specialistPoolName: string): string | number;

Parse the location from SpecialistPool resource.

Parameter
Name	Description
specialistPoolName	string A fully-qualified path representing SpecialistPool resource.

Returns
Type	Description
string | number	{string} A string representing the location.

matchLocationFromStudyName(studyName)

matchLocationFromStudyName(studyName: string): string | number;

Parse the location from Study resource.

Parameter
Name	Description
studyName	string A fully-qualified path representing Study resource.

Returns
Type	Description
string | number	{string} A string representing the location.

matchLocationFromTensorboardExperimentName(tensorboardExperimentName)

matchLocationFromTensorboardExperimentName(tensorboardExperimentName: string): string | number;

Parse the location from TensorboardExperiment resource.

Parameter
Name	Description
tensorboardExperimentName	string A fully-qualified path representing TensorboardExperiment resource.

Returns
Type	Description
string | number	{string} A string representing the location.

matchLocationFromTensorboardName(tensorboardName)

matchLocationFromTensorboardName(tensorboardName: string): string | number;

Parse the location from Tensorboard resource.

Parameter
Name	Description
tensorboardName	string A fully-qualified path representing Tensorboard resource.

Returns
Type	Description
string | number	{string} A string representing the location.

matchLocationFromTensorboardRunName(tensorboardRunName)

matchLocationFromTensorboardRunName(tensorboardRunName: string): string | number;

Parse the location from TensorboardRun resource.

Parameter
Name	Description
tensorboardRunName	string A fully-qualified path representing TensorboardRun resource.

Returns
Type	Description
string | number	{string} A string representing the location.

matchLocationFromTensorboardTimeSeriesName(tensorboardTimeSeriesName)

matchLocationFromTensorboardTimeSeriesName(tensorboardTimeSeriesName: string): string | number;

Parse the location from TensorboardTimeSeries resource.

Parameter
Name	Description
tensorboardTimeSeriesName	string A fully-qualified path representing TensorboardTimeSeries resource.

Returns
Type	Description
string | number	{string} A string representing the location.

matchLocationFromTrainingPipelineName(trainingPipelineName)

matchLocationFromTrainingPipelineName(trainingPipelineName: string): string | number;

Parse the location from TrainingPipeline resource.

Parameter
Name	Description
trainingPipelineName	string A fully-qualified path representing TrainingPipeline resource.

Returns
Type	Description
string | number	{string} A string representing the location.

matchLocationFromTrialName(trialName)

matchLocationFromTrialName(trialName: string): string | number;

Parse the location from Trial resource.

Parameter
Name	Description
trialName	string A fully-qualified path representing Trial resource.

Returns
Type	Description
string | number	{string} A string representing the location.

matchLocationFromTuningJobName(tuningJobName)

matchLocationFromTuningJobName(tuningJobName: string): string | number;

Parse the location from TuningJob resource.

Parameter
Name	Description
tuningJobName	string A fully-qualified path representing TuningJob resource.

Returns
Type	Description
string | number	{string} A string representing the location.

matchMemoryFromMemoryName(memoryName)

matchMemoryFromMemoryName(memoryName: string): string | number;

Parse the memory from Memory resource.

Parameter
Name	Description
memoryName	string A fully-qualified path representing Memory resource.

Returns
Type	Description
string | number	{string} A string representing the memory.

matchMetadataSchemaFromMetadataSchemaName(metadataSchemaName)

matchMetadataSchemaFromMetadataSchemaName(metadataSchemaName: string): string | number;

Parse the metadata_schema from MetadataSchema resource.

Parameter
Name	Description
metadataSchemaName	string A fully-qualified path representing MetadataSchema resource.

Returns
Type	Description
string | number	{string} A string representing the metadata_schema.

matchMetadataStoreFromArtifactName(artifactName)

matchMetadataStoreFromArtifactName(artifactName: string): string | number;

Parse the metadata_store from Artifact resource.

Parameter
Name	Description
artifactName	string A fully-qualified path representing Artifact resource.

Returns
Type	Description
string | number	{string} A string representing the metadata_store.

matchMetadataStoreFromContextName(contextName)

matchMetadataStoreFromContextName(contextName: string): string | number;

Parse the metadata_store from Context resource.

Parameter
Name	Description
contextName	string A fully-qualified path representing Context resource.

Returns
Type	Description
string | number	{string} A string representing the metadata_store.

matchMetadataStoreFromExecutionName(executionName)

matchMetadataStoreFromExecutionName(executionName: string): string | number;

Parse the metadata_store from Execution resource.

Parameter
Name	Description
executionName	string A fully-qualified path representing Execution resource.

Returns
Type	Description
string | number	{string} A string representing the metadata_store.

matchMetadataStoreFromMetadataSchemaName(metadataSchemaName)

matchMetadataStoreFromMetadataSchemaName(metadataSchemaName: string): string | number;

Parse the metadata_store from MetadataSchema resource.

Parameter
Name	Description
metadataSchemaName	string A fully-qualified path representing MetadataSchema resource.

Returns
Type	Description
string | number	{string} A string representing the metadata_store.

matchMetadataStoreFromMetadataStoreName(metadataStoreName)

matchMetadataStoreFromMetadataStoreName(metadataStoreName: string): string | number;

Parse the metadata_store from MetadataStore resource.

Parameter
Name	Description
metadataStoreName	string A fully-qualified path representing MetadataStore resource.

Returns
Type	Description
string | number	{string} A string representing the metadata_store.

matchModelDeploymentMonitoringJobFromModelDeploymentMonitoringJobName(modelDeploymentMonitoringJobName)

matchModelDeploymentMonitoringJobFromModelDeploymentMonitoringJobName(modelDeploymentMonitoringJobName: string): string | number;

Parse the model_deployment_monitoring_job from ModelDeploymentMonitoringJob resource.

Parameter
Name	Description
modelDeploymentMonitoringJobName	string A fully-qualified path representing ModelDeploymentMonitoringJob resource.

Returns
Type	Description
string | number	{string} A string representing the model_deployment_monitoring_job.

matchModelFromModelEvaluationName(modelEvaluationName)

matchModelFromModelEvaluationName(modelEvaluationName: string): string | number;

Parse the model from ModelEvaluation resource.

Parameter
Name	Description
modelEvaluationName	string A fully-qualified path representing ModelEvaluation resource.

Returns
Type	Description
string | number	{string} A string representing the model.

matchModelFromModelEvaluationSliceName(modelEvaluationSliceName)

matchModelFromModelEvaluationSliceName(modelEvaluationSliceName: string): string | number;

Parse the model from ModelEvaluationSlice resource.

Parameter
Name	Description
modelEvaluationSliceName	string A fully-qualified path representing ModelEvaluationSlice resource.

Returns
Type	Description
string | number	{string} A string representing the model.

matchModelFromModelName(modelName)

matchModelFromModelName(modelName: string): string | number;

Parse the model from Model resource.

Parameter
Name	Description
modelName	string A fully-qualified path representing Model resource.

Returns
Type	Description
string | number	{string} A string representing the model.

matchModelFromProjectLocationPublisherModelName(projectLocationPublisherModelName)

matchModelFromProjectLocationPublisherModelName(projectLocationPublisherModelName: string): string | number;

Parse the model from ProjectLocationPublisherModel resource.

Parameter
Name	Description
projectLocationPublisherModelName	string A fully-qualified path representing project_location_publisher_model resource.

Returns
Type	Description
string | number	{string} A string representing the model.

matchModelFromPublisherModelName(publisherModelName)

matchModelFromPublisherModelName(publisherModelName: string): string | number;

Parse the model from PublisherModel resource.

Parameter
Name	Description
publisherModelName	string A fully-qualified path representing PublisherModel resource.

Returns
Type	Description
string | number	{string} A string representing the model.

matchModelMonitorFromModelMonitoringJobName(modelMonitoringJobName)

matchModelMonitorFromModelMonitoringJobName(modelMonitoringJobName: string): string | number;

Parse the model_monitor from ModelMonitoringJob resource.

Parameter
Name	Description
modelMonitoringJobName	string A fully-qualified path representing ModelMonitoringJob resource.

Returns
Type	Description
string | number	{string} A string representing the model_monitor.

matchModelMonitorFromModelMonitorName(modelMonitorName)

matchModelMonitorFromModelMonitorName(modelMonitorName: string): string | number;

Parse the model_monitor from ModelMonitor resource.

Parameter
Name	Description
modelMonitorName	string A fully-qualified path representing ModelMonitor resource.

Returns
Type	Description
string | number	{string} A string representing the model_monitor.

matchModelMonitoringJobFromModelMonitoringJobName(modelMonitoringJobName)

matchModelMonitoringJobFromModelMonitoringJobName(modelMonitoringJobName: string): string | number;

Parse the model_monitoring_job from ModelMonitoringJob resource.

Parameter
Name	Description
modelMonitoringJobName	string A fully-qualified path representing ModelMonitoringJob resource.

Returns
Type	Description
string | number	{string} A string representing the model_monitoring_job.

matchNasJobFromNasJobName(nasJobName)

matchNasJobFromNasJobName(nasJobName: string): string | number;

Parse the nas_job from NasJob resource.

Parameter
Name	Description
nasJobName	string A fully-qualified path representing NasJob resource.

Returns
Type	Description
string | number	{string} A string representing the nas_job.

matchNasJobFromNasTrialDetailName(nasTrialDetailName)

matchNasJobFromNasTrialDetailName(nasTrialDetailName: string): string | number;

Parse the nas_job from NasTrialDetail resource.

Parameter
Name	Description
nasTrialDetailName	string A fully-qualified path representing NasTrialDetail resource.

Returns
Type	Description
string | number	{string} A string representing the nas_job.

matchNasTrialDetailFromNasTrialDetailName(nasTrialDetailName)

matchNasTrialDetailFromNasTrialDetailName(nasTrialDetailName: string): string | number;

Parse the nas_trial_detail from NasTrialDetail resource.

Parameter
Name	Description
nasTrialDetailName	string A fully-qualified path representing NasTrialDetail resource.

Returns
Type	Description
string | number	{string} A string representing the nas_trial_detail.

matchNotebookExecutionJobFromNotebookExecutionJobName(notebookExecutionJobName)

matchNotebookExecutionJobFromNotebookExecutionJobName(notebookExecutionJobName: string): string | number;

Parse the notebook_execution_job from NotebookExecutionJob resource.

Parameter
Name	Description
notebookExecutionJobName	string A fully-qualified path representing NotebookExecutionJob resource.

Returns
Type	Description
string | number	{string} A string representing the notebook_execution_job.

matchNotebookRuntimeFromNotebookRuntimeName(notebookRuntimeName)

matchNotebookRuntimeFromNotebookRuntimeName(notebookRuntimeName: string): string | number;

Parse the notebook_runtime from NotebookRuntime resource.

Parameter
Name	Description
notebookRuntimeName	string A fully-qualified path representing NotebookRuntime resource.

Returns
Type	Description
string | number	{string} A string representing the notebook_runtime.

matchNotebookRuntimeTemplateFromNotebookRuntimeTemplateName(notebookRuntimeTemplateName)

matchNotebookRuntimeTemplateFromNotebookRuntimeTemplateName(notebookRuntimeTemplateName: string): string | number;

Parse the notebook_runtime_template from NotebookRuntimeTemplate resource.

Parameter
Name	Description
notebookRuntimeTemplateName	string A fully-qualified path representing NotebookRuntimeTemplate resource.

Returns
Type	Description
string | number	{string} A string representing the notebook_runtime_template.

matchPersistentResourceFromPersistentResourceName(persistentResourceName)

matchPersistentResourceFromPersistentResourceName(persistentResourceName: string): string | number;

Parse the persistent_resource from PersistentResource resource.

Parameter
Name	Description
persistentResourceName	string A fully-qualified path representing PersistentResource resource.

Returns
Type	Description
string | number	{string} A string representing the persistent_resource.

matchPipelineJobFromPipelineJobName(pipelineJobName)

matchPipelineJobFromPipelineJobName(pipelineJobName: string): string | number;

Parse the pipeline_job from PipelineJob resource.

Parameter
Name	Description
pipelineJobName	string A fully-qualified path representing PipelineJob resource.

Returns
Type	Description
string | number	{string} A string representing the pipeline_job.

matchProjectFromAnnotationName(annotationName)

matchProjectFromAnnotationName(annotationName: string): string | number;

Parse the project from Annotation resource.

Parameter
Name	Description
annotationName	string A fully-qualified path representing Annotation resource.

Returns
Type	Description
string | number	{string} A string representing the project.

matchProjectFromAnnotationSpecName(annotationSpecName)

matchProjectFromAnnotationSpecName(annotationSpecName: string): string | number;

Parse the project from AnnotationSpec resource.

Parameter
Name	Description
annotationSpecName	string A fully-qualified path representing AnnotationSpec resource.

Returns
Type	Description
string | number	{string} A string representing the project.

matchProjectFromArtifactName(artifactName)

matchProjectFromArtifactName(artifactName: string): string | number;

Parse the project from Artifact resource.

Parameter
Name	Description
artifactName	string A fully-qualified path representing Artifact resource.

Returns
Type	Description
string | number	{string} A string representing the project.

matchProjectFromBatchPredictionJobName(batchPredictionJobName)

matchProjectFromBatchPredictionJobName(batchPredictionJobName: string): string | number;

Parse the project from BatchPredictionJob resource.

Parameter
Name	Description
batchPredictionJobName	string A fully-qualified path representing BatchPredictionJob resource.

Returns
Type	Description
string | number	{string} A string representing the project.

matchProjectFromCachedContentName(cachedContentName)

matchProjectFromCachedContentName(cachedContentName: string): string | number;

Parse the project from CachedContent resource.

Parameter
Name	Description
cachedContentName	string A fully-qualified path representing CachedContent resource.

Returns
Type	Description
string | number	{string} A string representing the project.

matchProjectFromContextName(contextName)

matchProjectFromContextName(contextName: string): string | number;

Parse the project from Context resource.

Parameter
Name	Description
contextName	string A fully-qualified path representing Context resource.

Returns
Type	Description
string | number	{string} A string representing the project.

matchProjectFromCustomJobName(customJobName)

matchProjectFromCustomJobName(customJobName: string): string | number;

Parse the project from CustomJob resource.

Parameter
Name	Description
customJobName	string A fully-qualified path representing CustomJob resource.

Returns
Type	Description
string | number	{string} A string representing the project.

matchProjectFromDataItemName(dataItemName)

matchProjectFromDataItemName(dataItemName: string): string | number;

Parse the project from DataItem resource.

Parameter
Name	Description
dataItemName	string A fully-qualified path representing DataItem resource.

Returns
Type	Description
string | number	{string} A string representing the project.

matchProjectFromDataLabelingJobName(dataLabelingJobName)

matchProjectFromDataLabelingJobName(dataLabelingJobName: string): string | number;

Parse the project from DataLabelingJob resource.

Parameter
Name	Description
dataLabelingJobName	string A fully-qualified path representing DataLabelingJob resource.

Returns
Type	Description
string | number	{string} A string representing the project.

matchProjectFromDatasetName(datasetName)

matchProjectFromDatasetName(datasetName: string): string | number;

Parse the project from Dataset resource.

Parameter
Name	Description
datasetName	string A fully-qualified path representing Dataset resource.

Returns
Type	Description
string | number	{string} A string representing the project.

matchProjectFromDatasetVersionName(datasetVersionName)

matchProjectFromDatasetVersionName(datasetVersionName: string): string | number;

Parse the project from DatasetVersion resource.

Parameter
Name	Description
datasetVersionName	string A fully-qualified path representing DatasetVersion resource.

Returns
Type	Description
string | number	{string} A string representing the project.

matchProjectFromDeploymentResourcePoolName(deploymentResourcePoolName)

matchProjectFromDeploymentResourcePoolName(deploymentResourcePoolName: string): string | number;

Parse the project from DeploymentResourcePool resource.

Parameter
Name	Description
deploymentResourcePoolName	string A fully-qualified path representing DeploymentResourcePool resource.

Returns
Type	Description
string | number	{string} A string representing the project.

matchProjectFromEntityTypeName(entityTypeName)

matchProjectFromEntityTypeName(entityTypeName: string): string | number;

Parse the project from EntityType resource.

Parameter
Name	Description
entityTypeName	string A fully-qualified path representing EntityType resource.

Returns
Type	Description
string | number	{string} A string representing the project.

matchProjectFromExampleStoreName(exampleStoreName)

matchProjectFromExampleStoreName(exampleStoreName: string): string | number;

Parse the project from ExampleStore resource.

Parameter
Name	Description
exampleStoreName	string A fully-qualified path representing ExampleStore resource.

Returns
Type	Description
string | number	{string} A string representing the project.

matchProjectFromExecutionName(executionName)

matchProjectFromExecutionName(executionName: string): string | number;

Parse the project from Execution resource.

Parameter
Name	Description
executionName	string A fully-qualified path representing Execution resource.

Returns
Type	Description
string | number	{string} A string representing the project.

matchProjectFromExtensionName(extensionName)

matchProjectFromExtensionName(extensionName: string): string | number;

Parse the project from Extension resource.

Parameter
Name	Description
extensionName	string A fully-qualified path representing Extension resource.

Returns
Type	Description
string | number	{string} A string representing the project.

matchProjectFromFeatureGroupName(featureGroupName)

matchProjectFromFeatureGroupName(featureGroupName: string): string | number;

Parse the project from FeatureGroup resource.

Parameter
Name	Description
featureGroupName	string A fully-qualified path representing FeatureGroup resource.

Returns
Type	Description
string | number	{string} A string representing the project.

matchProjectFromFeatureMonitorJobName(featureMonitorJobName)

matchProjectFromFeatureMonitorJobName(featureMonitorJobName: string): string | number;

Parse the project from FeatureMonitorJob resource.

Parameter
Name	Description
featureMonitorJobName	string A fully-qualified path representing FeatureMonitorJob resource.

Returns
Type	Description
string | number	{string} A string representing the project.

matchProjectFromFeatureMonitorName(featureMonitorName)

matchProjectFromFeatureMonitorName(featureMonitorName: string): string | number;

Parse the project from FeatureMonitor resource.

Parameter
Name	Description
featureMonitorName	string A fully-qualified path representing FeatureMonitor resource.

Returns
Type	Description
string | number	{string} A string representing the project.

matchProjectFromFeatureOnlineStoreName(featureOnlineStoreName)

matchProjectFromFeatureOnlineStoreName(featureOnlineStoreName: string): string | number;

Parse the project from FeatureOnlineStore resource.

Parameter
Name	Description
featureOnlineStoreName	string A fully-qualified path representing FeatureOnlineStore resource.

Returns
Type	Description
string | number	{string} A string representing the project.

matchProjectFromFeaturestoreName(featurestoreName)

matchProjectFromFeaturestoreName(featurestoreName: string): string | number;

Parse the project from Featurestore resource.

Parameter
Name	Description
featurestoreName	string A fully-qualified path representing Featurestore resource.

Returns
Type	Description
string | number	{string} A string representing the project.

matchProjectFromFeatureViewName(featureViewName)

matchProjectFromFeatureViewName(featureViewName: string): string | number;

Parse the project from FeatureView resource.

Parameter
Name	Description
featureViewName	string A fully-qualified path representing FeatureView resource.

Returns
Type	Description
string | number	{string} A string representing the project.

matchProjectFromFeatureViewSyncName(featureViewSyncName)

matchProjectFromFeatureViewSyncName(featureViewSyncName: string): string | number;

Parse the project from FeatureViewSync resource.

Parameter
Name	Description
featureViewSyncName	string A fully-qualified path representing FeatureViewSync resource.

Returns
Type	Description
string | number	{string} A string representing the project.

matchProjectFromHyperparameterTuningJobName(hyperparameterTuningJobName)

matchProjectFromHyperparameterTuningJobName(hyperparameterTuningJobName: string): string | number;

Parse the project from HyperparameterTuningJob resource.

Parameter
Name	Description
hyperparameterTuningJobName	string A fully-qualified path representing HyperparameterTuningJob resource.

Returns
Type	Description
string | number	{string} A string representing the project.

matchProjectFromIndexEndpointName(indexEndpointName)

matchProjectFromIndexEndpointName(indexEndpointName: string): string | number;

Parse the project from IndexEndpoint resource.

Parameter
Name	Description
indexEndpointName	string A fully-qualified path representing IndexEndpoint resource.

Returns
Type	Description
string | number	{string} A string representing the project.

matchProjectFromIndexName(indexName)

matchProjectFromIndexName(indexName: string): string | number;

Parse the project from Index resource.

Parameter
Name	Description
indexName	string A fully-qualified path representing Index resource.

Returns
Type	Description
string | number	{string} A string representing the project.

matchProjectFromMemoryName(memoryName)

matchProjectFromMemoryName(memoryName: string): string | number;

Parse the project from Memory resource.

Parameter
Name	Description
memoryName	string A fully-qualified path representing Memory resource.

Returns
Type	Description
string | number	{string} A string representing the project.

matchProjectFromMetadataSchemaName(metadataSchemaName)

matchProjectFromMetadataSchemaName(metadataSchemaName: string): string | number;

Parse the project from MetadataSchema resource.

Parameter
Name	Description
metadataSchemaName	string A fully-qualified path representing MetadataSchema resource.

Returns
Type	Description
string | number	{string} A string representing the project.

matchProjectFromMetadataStoreName(metadataStoreName)

matchProjectFromMetadataStoreName(metadataStoreName: string): string | number;

Parse the project from MetadataStore resource.

Parameter
Name	Description
metadataStoreName	string A fully-qualified path representing MetadataStore resource.

Returns
Type	Description
string | number	{string} A string representing the project.

matchProjectFromModelDeploymentMonitoringJobName(modelDeploymentMonitoringJobName)

matchProjectFromModelDeploymentMonitoringJobName(modelDeploymentMonitoringJobName: string): string | number;

Parse the project from ModelDeploymentMonitoringJob resource.

Parameter
Name	Description
modelDeploymentMonitoringJobName	string A fully-qualified path representing ModelDeploymentMonitoringJob resource.

Returns
Type	Description
string | number	{string} A string representing the project.

matchProjectFromModelEvaluationName(modelEvaluationName)

matchProjectFromModelEvaluationName(modelEvaluationName: string): string | number;

Parse the project from ModelEvaluation resource.

Parameter
Name	Description
modelEvaluationName	string A fully-qualified path representing ModelEvaluation resource.

Returns
Type	Description
string | number	{string} A string representing the project.

matchProjectFromModelEvaluationSliceName(modelEvaluationSliceName)

matchProjectFromModelEvaluationSliceName(modelEvaluationSliceName: string): string | number;

Parse the project from ModelEvaluationSlice resource.

Parameter
Name	Description
modelEvaluationSliceName	string A fully-qualified path representing ModelEvaluationSlice resource.

Returns
Type	Description
string | number	{string} A string representing the project.

matchProjectFromModelMonitoringJobName(modelMonitoringJobName)

matchProjectFromModelMonitoringJobName(modelMonitoringJobName: string): string | number;

Parse the project from ModelMonitoringJob resource.

Parameter
Name	Description
modelMonitoringJobName	string A fully-qualified path representing ModelMonitoringJob resource.

Returns
Type	Description
string | number	{string} A string representing the project.

matchProjectFromModelMonitorName(modelMonitorName)

matchProjectFromModelMonitorName(modelMonitorName: string): string | number;

Parse the project from ModelMonitor resource.

Parameter
Name	Description
modelMonitorName	string A fully-qualified path representing ModelMonitor resource.

Returns
Type	Description
string | number	{string} A string representing the project.

matchProjectFromModelName(modelName)

matchProjectFromModelName(modelName: string): string | number;

Parse the project from Model resource.

Parameter
Name	Description
modelName	string A fully-qualified path representing Model resource.

Returns
Type	Description
string | number	{string} A string representing the project.

matchProjectFromNasJobName(nasJobName)

matchProjectFromNasJobName(nasJobName: string): string | number;

Parse the project from NasJob resource.

Parameter
Name	Description
nasJobName	string A fully-qualified path representing NasJob resource.

Returns
Type	Description
string | number	{string} A string representing the project.

matchProjectFromNasTrialDetailName(nasTrialDetailName)

matchProjectFromNasTrialDetailName(nasTrialDetailName: string): string | number;

Parse the project from NasTrialDetail resource.

Parameter
Name	Description
nasTrialDetailName	string A fully-qualified path representing NasTrialDetail resource.

Returns
Type	Description
string | number	{string} A string representing the project.

matchProjectFromNotebookExecutionJobName(notebookExecutionJobName)

matchProjectFromNotebookExecutionJobName(notebookExecutionJobName: string): string | number;

Parse the project from NotebookExecutionJob resource.

Parameter
Name	Description
notebookExecutionJobName	string A fully-qualified path representing NotebookExecutionJob resource.

Returns
Type	Description
string | number	{string} A string representing the project.

matchProjectFromNotebookRuntimeName(notebookRuntimeName)

matchProjectFromNotebookRuntimeName(notebookRuntimeName: string): string | number;

Parse the project from NotebookRuntime resource.

Parameter
Name	Description
notebookRuntimeName	string A fully-qualified path representing NotebookRuntime resource.

Returns
Type	Description
string | number	{string} A string representing the project.

matchProjectFromNotebookRuntimeTemplateName(notebookRuntimeTemplateName)

matchProjectFromNotebookRuntimeTemplateName(notebookRuntimeTemplateName: string): string | number;

Parse the project from NotebookRuntimeTemplate resource.

Parameter
Name	Description
notebookRuntimeTemplateName	string A fully-qualified path representing NotebookRuntimeTemplate resource.

Returns
Type	Description
string | number	{string} A string representing the project.

matchProjectFromPersistentResourceName(persistentResourceName)

matchProjectFromPersistentResourceName(persistentResourceName: string): string | number;

Parse the project from PersistentResource resource.

Parameter
Name	Description
persistentResourceName	string A fully-qualified path representing PersistentResource resource.

Returns
Type	Description
string | number	{string} A string representing the project.

matchProjectFromPipelineJobName(pipelineJobName)

matchProjectFromPipelineJobName(pipelineJobName: string): string | number;

Parse the project from PipelineJob resource.

Parameter
Name	Description
pipelineJobName	string A fully-qualified path representing PipelineJob resource.

Returns
Type	Description
string | number	{string} A string representing the project.

matchProjectFromProjectLocationEndpointName(projectLocationEndpointName)

matchProjectFromProjectLocationEndpointName(projectLocationEndpointName: string): string | number;

Parse the project from ProjectLocationEndpoint resource.

Parameter
Name	Description
projectLocationEndpointName	string A fully-qualified path representing project_location_endpoint resource.

Returns
Type	Description
string | number	{string} A string representing the project.

matchProjectFromProjectLocationFeatureGroupFeaturesName(projectLocationFeatureGroupFeaturesName)

matchProjectFromProjectLocationFeatureGroupFeaturesName(projectLocationFeatureGroupFeaturesName: string): string | number;

Parse the project from ProjectLocationFeatureGroupFeatures resource.

Parameter
Name	Description
projectLocationFeatureGroupFeaturesName	string A fully-qualified path representing project_location_feature_group_features resource.

Returns
Type	Description
string | number	{string} A string representing the project.

matchProjectFromProjectLocationFeaturestoreEntityTypeFeaturesName(projectLocationFeaturestoreEntityTypeFeaturesName)

matchProjectFromProjectLocationFeaturestoreEntityTypeFeaturesName(projectLocationFeaturestoreEntityTypeFeaturesName: string): string | number;

Parse the project from ProjectLocationFeaturestoreEntityTypeFeatures resource.

Parameter
Name	Description
projectLocationFeaturestoreEntityTypeFeaturesName	string A fully-qualified path representing project_location_featurestore_entity_type_features resource.

Returns
Type	Description
string | number	{string} A string representing the project.

matchProjectFromProjectLocationPublisherModelName(projectLocationPublisherModelName)

matchProjectFromProjectLocationPublisherModelName(projectLocationPublisherModelName: string): string | number;

Parse the project from ProjectLocationPublisherModel resource.

Parameter
Name	Description
projectLocationPublisherModelName	string A fully-qualified path representing project_location_publisher_model resource.

Returns
Type	Description
string | number	{string} A string representing the project.

matchProjectFromRagCorpusName(ragCorpusName)

matchProjectFromRagCorpusName(ragCorpusName: string): string | number;

Parse the project from RagCorpus resource.

Parameter
Name	Description
ragCorpusName	string A fully-qualified path representing RagCorpus resource.

Returns
Type	Description
string | number	{string} A string representing the project.

matchProjectFromRagDataSchemaName(ragDataSchemaName)

matchProjectFromRagDataSchemaName(ragDataSchemaName: string): string | number;

Parse the project from RagDataSchema resource.

Parameter
Name	Description
ragDataSchemaName	string A fully-qualified path representing RagDataSchema resource.

Returns
Type	Description
string | number	{string} A string representing the project.

matchProjectFromRagEngineConfigName(ragEngineConfigName)

matchProjectFromRagEngineConfigName(ragEngineConfigName: string): string | number;

Parse the project from RagEngineConfig resource.

Parameter
Name	Description
ragEngineConfigName	string A fully-qualified path representing RagEngineConfig resource.

Returns
Type	Description
string | number	{string} A string representing the project.

matchProjectFromRagFileName(ragFileName)

matchProjectFromRagFileName(ragFileName: string): string | number;

Parse the project from RagFile resource.

Parameter
Name	Description
ragFileName	string A fully-qualified path representing RagFile resource.

Returns
Type	Description
string | number	{string} A string representing the project.

matchProjectFromRagMetadataName(ragMetadataName)

matchProjectFromRagMetadataName(ragMetadataName: string): string | number;

Parse the project from RagMetadata resource.

Parameter
Name	Description
ragMetadataName	string A fully-qualified path representing RagMetadata resource.

Returns
Type	Description
string | number	{string} A string representing the project.

matchProjectFromReasoningEngineName(reasoningEngineName)

matchProjectFromReasoningEngineName(reasoningEngineName: string): string | number;

Parse the project from ReasoningEngine resource.

Parameter
Name	Description
reasoningEngineName	string A fully-qualified path representing ReasoningEngine resource.

Returns
Type	Description
string | number	{string} A string representing the project.

matchProjectFromSavedQueryName(savedQueryName)

matchProjectFromSavedQueryName(savedQueryName: string): string | number;

Parse the project from SavedQuery resource.

Parameter
Name	Description
savedQueryName	string A fully-qualified path representing SavedQuery resource.

Returns
Type	Description
string | number	{string} A string representing the project.

matchProjectFromScheduleName(scheduleName)

matchProjectFromScheduleName(scheduleName: string): string | number;

Parse the project from Schedule resource.

Parameter
Name	Description
scheduleName	string A fully-qualified path representing Schedule resource.

Returns
Type	Description
string | number	{string} A string representing the project.

matchProjectFromSessionEventName(sessionEventName)

matchProjectFromSessionEventName(sessionEventName: string): string | number;

Parse the project from SessionEvent resource.

Parameter
Name	Description
sessionEventName	string A fully-qualified path representing SessionEvent resource.

Returns
Type	Description
string | number	{string} A string representing the project.

matchProjectFromSessionName(sessionName)

matchProjectFromSessionName(sessionName: string): string | number;

Parse the project from Session resource.

Parameter
Name	Description
sessionName	string A fully-qualified path representing Session resource.

Returns
Type	Description
string | number	{string} A string representing the project.

matchProjectFromSpecialistPoolName(specialistPoolName)

matchProjectFromSpecialistPoolName(specialistPoolName: string): string | number;

Parse the project from SpecialistPool resource.

Parameter
Name	Description
specialistPoolName	string A fully-qualified path representing SpecialistPool resource.

Returns
Type	Description
string | number	{string} A string representing the project.

matchProjectFromStudyName(studyName)

matchProjectFromStudyName(studyName: string): string | number;

Parse the project from Study resource.

Parameter
Name	Description
studyName	string A fully-qualified path representing Study resource.

Returns
Type	Description
string | number	{string} A string representing the project.

matchProjectFromTensorboardExperimentName(tensorboardExperimentName)

matchProjectFromTensorboardExperimentName(tensorboardExperimentName: string): string | number;

Parse the project from TensorboardExperiment resource.

Parameter
Name	Description
tensorboardExperimentName	string A fully-qualified path representing TensorboardExperiment resource.

Returns
Type	Description
string | number	{string} A string representing the project.

matchProjectFromTensorboardName(tensorboardName)

matchProjectFromTensorboardName(tensorboardName: string): string | number;

Parse the project from Tensorboard resource.

Parameter
Name	Description
tensorboardName	string A fully-qualified path representing Tensorboard resource.

Returns
Type	Description
string | number	{string} A string representing the project.

matchProjectFromTensorboardRunName(tensorboardRunName)

matchProjectFromTensorboardRunName(tensorboardRunName: string): string | number;

Parse the project from TensorboardRun resource.

Parameter
Name	Description
tensorboardRunName	string A fully-qualified path representing TensorboardRun resource.

Returns
Type	Description
string | number	{string} A string representing the project.

matchProjectFromTensorboardTimeSeriesName(tensorboardTimeSeriesName)

matchProjectFromTensorboardTimeSeriesName(tensorboardTimeSeriesName: string): string | number;

Parse the project from TensorboardTimeSeries resource.

Parameter
Name	Description
tensorboardTimeSeriesName	string A fully-qualified path representing TensorboardTimeSeries resource.

Returns
Type	Description
string | number	{string} A string representing the project.

matchProjectFromTrainingPipelineName(trainingPipelineName)

matchProjectFromTrainingPipelineName(trainingPipelineName: string): string | number;

Parse the project from TrainingPipeline resource.

Parameter
Name	Description
trainingPipelineName	string A fully-qualified path representing TrainingPipeline resource.

Returns
Type	Description
string | number	{string} A string representing the project.

matchProjectFromTrialName(trialName)

matchProjectFromTrialName(trialName: string): string | number;

Parse the project from Trial resource.

Parameter
Name	Description
trialName	string A fully-qualified path representing Trial resource.

Returns
Type	Description
string | number	{string} A string representing the project.

matchProjectFromTuningJobName(tuningJobName)

matchProjectFromTuningJobName(tuningJobName: string): string | number;

Parse the project from TuningJob resource.

Parameter
Name	Description
tuningJobName	string A fully-qualified path representing TuningJob resource.

Returns
Type	Description
string | number	{string} A string representing the project.

matchPublisherFromProjectLocationPublisherModelName(projectLocationPublisherModelName)

matchPublisherFromProjectLocationPublisherModelName(projectLocationPublisherModelName: string): string | number;

Parse the publisher from ProjectLocationPublisherModel resource.

Parameter
Name	Description
projectLocationPublisherModelName	string A fully-qualified path representing project_location_publisher_model resource.

Returns
Type	Description
string | number	{string} A string representing the publisher.

matchPublisherFromPublisherModelName(publisherModelName)

matchPublisherFromPublisherModelName(publisherModelName: string): string | number;

Parse the publisher from PublisherModel resource.

Parameter
Name	Description
publisherModelName	string A fully-qualified path representing PublisherModel resource.

Returns
Type	Description
string | number	{string} A string representing the publisher.

matchRagCorpusFromRagCorpusName(ragCorpusName)

matchRagCorpusFromRagCorpusName(ragCorpusName: string): string | number;

Parse the rag_corpus from RagCorpus resource.

Parameter
Name	Description
ragCorpusName	string A fully-qualified path representing RagCorpus resource.

Returns
Type	Description
string | number	{string} A string representing the rag_corpus.

matchRagCorpusFromRagDataSchemaName(ragDataSchemaName)

matchRagCorpusFromRagDataSchemaName(ragDataSchemaName: string): string | number;

Parse the rag_corpus from RagDataSchema resource.

Parameter
Name	Description
ragDataSchemaName	string A fully-qualified path representing RagDataSchema resource.

Returns
Type	Description
string | number	{string} A string representing the rag_corpus.

matchRagCorpusFromRagFileName(ragFileName)

matchRagCorpusFromRagFileName(ragFileName: string): string | number;

Parse the rag_corpus from RagFile resource.

Parameter
Name	Description
ragFileName	string A fully-qualified path representing RagFile resource.

Returns
Type	Description
string | number	{string} A string representing the rag_corpus.

matchRagCorpusFromRagMetadataName(ragMetadataName)

matchRagCorpusFromRagMetadataName(ragMetadataName: string): string | number;

Parse the rag_corpus from RagMetadata resource.

Parameter
Name	Description
ragMetadataName	string A fully-qualified path representing RagMetadata resource.

Returns
Type	Description
string | number	{string} A string representing the rag_corpus.

matchRagDataSchemaFromRagDataSchemaName(ragDataSchemaName)

matchRagDataSchemaFromRagDataSchemaName(ragDataSchemaName: string): string | number;

Parse the rag_data_schema from RagDataSchema resource.

Parameter
Name	Description
ragDataSchemaName	string A fully-qualified path representing RagDataSchema resource.

Returns
Type	Description
string | number	{string} A string representing the rag_data_schema.

matchRagFileFromRagFileName(ragFileName)

matchRagFileFromRagFileName(ragFileName: string): string | number;

Parse the rag_file from RagFile resource.

Parameter
Name	Description
ragFileName	string A fully-qualified path representing RagFile resource.

Returns
Type	Description
string | number	{string} A string representing the rag_file.

matchRagFileFromRagMetadataName(ragMetadataName)

matchRagFileFromRagMetadataName(ragMetadataName: string): string | number;

Parse the rag_file from RagMetadata resource.

Parameter
Name	Description
ragMetadataName	string A fully-qualified path representing RagMetadata resource.

Returns
Type	Description
string | number	{string} A string representing the rag_file.

matchRagMetadataFromRagMetadataName(ragMetadataName)

matchRagMetadataFromRagMetadataName(ragMetadataName: string): string | number;

Parse the rag_metadata from RagMetadata resource.

Parameter
Name	Description
ragMetadataName	string A fully-qualified path representing RagMetadata resource.

Returns
Type	Description
string | number	{string} A string representing the rag_metadata.

matchReasoningEngineFromMemoryName(memoryName)

matchReasoningEngineFromMemoryName(memoryName: string): string | number;

Parse the reasoning_engine from Memory resource.

Parameter
Name	Description
memoryName	string A fully-qualified path representing Memory resource.

Returns
Type	Description
string | number	{string} A string representing the reasoning_engine.

matchReasoningEngineFromReasoningEngineName(reasoningEngineName)

matchReasoningEngineFromReasoningEngineName(reasoningEngineName: string): string | number;

Parse the reasoning_engine from ReasoningEngine resource.

Parameter
Name	Description
reasoningEngineName	string A fully-qualified path representing ReasoningEngine resource.

Returns
Type	Description
string | number	{string} A string representing the reasoning_engine.

matchReasoningEngineFromSessionEventName(sessionEventName)

matchReasoningEngineFromSessionEventName(sessionEventName: string): string | number;

Parse the reasoning_engine from SessionEvent resource.

Parameter
Name	Description
sessionEventName	string A fully-qualified path representing SessionEvent resource.

Returns
Type	Description
string | number	{string} A string representing the reasoning_engine.

matchReasoningEngineFromSessionName(sessionName)

matchReasoningEngineFromSessionName(sessionName: string): string | number;

Parse the reasoning_engine from Session resource.

Parameter
Name	Description
sessionName	string A fully-qualified path representing Session resource.

Returns
Type	Description
string | number	{string} A string representing the reasoning_engine.

matchRunFromTensorboardRunName(tensorboardRunName)

matchRunFromTensorboardRunName(tensorboardRunName: string): string | number;

Parse the run from TensorboardRun resource.

Parameter
Name	Description
tensorboardRunName	string A fully-qualified path representing TensorboardRun resource.

Returns
Type	Description
string | number	{string} A string representing the run.

matchRunFromTensorboardTimeSeriesName(tensorboardTimeSeriesName)

matchRunFromTensorboardTimeSeriesName(tensorboardTimeSeriesName: string): string | number;

Parse the run from TensorboardTimeSeries resource.

Parameter
Name	Description
tensorboardTimeSeriesName	string A fully-qualified path representing TensorboardTimeSeries resource.

Returns
Type	Description
string | number	{string} A string representing the run.

matchSavedQueryFromSavedQueryName(savedQueryName)

matchSavedQueryFromSavedQueryName(savedQueryName: string): string | number;

Parse the saved_query from SavedQuery resource.

Parameter
Name	Description
savedQueryName	string A fully-qualified path representing SavedQuery resource.

Returns
Type	Description
string | number	{string} A string representing the saved_query.

matchScheduleFromScheduleName(scheduleName)

matchScheduleFromScheduleName(scheduleName: string): string | number;

Parse the schedule from Schedule resource.

Parameter
Name	Description
scheduleName	string A fully-qualified path representing Schedule resource.

Returns
Type	Description
string | number	{string} A string representing the schedule.

matchSessionFromSessionEventName(sessionEventName)

matchSessionFromSessionEventName(sessionEventName: string): string | number;

Parse the session from SessionEvent resource.

Parameter
Name	Description
sessionEventName	string A fully-qualified path representing SessionEvent resource.

Returns
Type	Description
string | number	{string} A string representing the session.

matchSessionFromSessionName(sessionName)

matchSessionFromSessionName(sessionName: string): string | number;

Parse the session from Session resource.

Parameter
Name	Description
sessionName	string A fully-qualified path representing Session resource.

Returns
Type	Description
string | number	{string} A string representing the session.

matchSliceFromModelEvaluationSliceName(modelEvaluationSliceName)

matchSliceFromModelEvaluationSliceName(modelEvaluationSliceName: string): string | number;

Parse the slice from ModelEvaluationSlice resource.

Parameter
Name	Description
modelEvaluationSliceName	string A fully-qualified path representing ModelEvaluationSlice resource.

Returns
Type	Description
string | number	{string} A string representing the slice.

matchSpecialistPoolFromSpecialistPoolName(specialistPoolName)

matchSpecialistPoolFromSpecialistPoolName(specialistPoolName: string): string | number;

Parse the specialist_pool from SpecialistPool resource.

Parameter
Name	Description
specialistPoolName	string A fully-qualified path representing SpecialistPool resource.

Returns
Type	Description
string | number	{string} A string representing the specialist_pool.

matchStudyFromStudyName(studyName)

matchStudyFromStudyName(studyName: string): string | number;

Parse the study from Study resource.

Parameter
Name	Description
studyName	string A fully-qualified path representing Study resource.

Returns
Type	Description
string | number	{string} A string representing the study.

matchStudyFromTrialName(trialName)

matchStudyFromTrialName(trialName: string): string | number;

Parse the study from Trial resource.

Parameter
Name	Description
trialName	string A fully-qualified path representing Trial resource.

Returns
Type	Description
string | number	{string} A string representing the study.

matchTensorboardFromTensorboardExperimentName(tensorboardExperimentName)

matchTensorboardFromTensorboardExperimentName(tensorboardExperimentName: string): string | number;

Parse the tensorboard from TensorboardExperiment resource.

Parameter
Name	Description
tensorboardExperimentName	string A fully-qualified path representing TensorboardExperiment resource.

Returns
Type	Description
string | number	{string} A string representing the tensorboard.

matchTensorboardFromTensorboardName(tensorboardName)

matchTensorboardFromTensorboardName(tensorboardName: string): string | number;

Parse the tensorboard from Tensorboard resource.

Parameter
Name	Description
tensorboardName	string A fully-qualified path representing Tensorboard resource.

Returns
Type	Description
string | number	{string} A string representing the tensorboard.

matchTensorboardFromTensorboardRunName(tensorboardRunName)

matchTensorboardFromTensorboardRunName(tensorboardRunName: string): string | number;

Parse the tensorboard from TensorboardRun resource.

Parameter
Name	Description
tensorboardRunName	string A fully-qualified path representing TensorboardRun resource.

Returns
Type	Description
string | number	{string} A string representing the tensorboard.

matchTensorboardFromTensorboardTimeSeriesName(tensorboardTimeSeriesName)

matchTensorboardFromTensorboardTimeSeriesName(tensorboardTimeSeriesName: string): string | number;

Parse the tensorboard from TensorboardTimeSeries resource.

Parameter
Name	Description
tensorboardTimeSeriesName	string A fully-qualified path representing TensorboardTimeSeries resource.

Returns
Type	Description
string | number	{string} A string representing the tensorboard.

matchTimeSeriesFromTensorboardTimeSeriesName(tensorboardTimeSeriesName)

matchTimeSeriesFromTensorboardTimeSeriesName(tensorboardTimeSeriesName: string): string | number;

Parse the time_series from TensorboardTimeSeries resource.

Parameter
Name	Description
tensorboardTimeSeriesName	string A fully-qualified path representing TensorboardTimeSeries resource.

Returns
Type	Description
string | number	{string} A string representing the time_series.

matchTrainingPipelineFromTrainingPipelineName(trainingPipelineName)

matchTrainingPipelineFromTrainingPipelineName(trainingPipelineName: string): string | number;

Parse the training_pipeline from TrainingPipeline resource.

Parameter
Name	Description
trainingPipelineName	string A fully-qualified path representing TrainingPipeline resource.

Returns
Type	Description
string | number	{string} A string representing the training_pipeline.

matchTrialFromTrialName(trialName)

matchTrialFromTrialName(trialName: string): string | number;

Parse the trial from Trial resource.

Parameter
Name	Description
trialName	string A fully-qualified path representing Trial resource.

Returns
Type	Description
string | number	{string} A string representing the trial.

matchTuningJobFromTuningJobName(tuningJobName)

matchTuningJobFromTuningJobName(tuningJobName: string): string | number;

Parse the tuning_job from TuningJob resource.

Parameter
Name	Description
tuningJobName	string A fully-qualified path representing TuningJob resource.

Returns
Type	Description
string | number	{string} A string representing the tuning_job.

memoryPath(project, location, reasoningEngine, memory)

memoryPath(project: string, location: string, reasoningEngine: string, memory: string): string;

Return a fully-qualified memory resource name string.

Parameters
Name	Description
project	string
location	string
reasoningEngine	string
memory	string

Returns
Type	Description
string	{string} Resource name string.

metadataSchemaPath(project, location, metadataStore, metadataSchema)

metadataSchemaPath(project: string, location: string, metadataStore: string, metadataSchema: string): string;

Return a fully-qualified metadataSchema resource name string.

Parameters
Name	Description
project	string
location	string
metadataStore	string
metadataSchema	string

Returns
Type	Description
string	{string} Resource name string.

metadataStorePath(project, location, metadataStore)

metadataStorePath(project: string, location: string, metadataStore: string): string;

Return a fully-qualified metadataStore resource name string.

Parameters
Name	Description
project	string
location	string
metadataStore	string

Returns
Type	Description
string	{string} Resource name string.

modelDeploymentMonitoringJobPath(project, location, modelDeploymentMonitoringJob)

modelDeploymentMonitoringJobPath(project: string, location: string, modelDeploymentMonitoringJob: string): string;

Return a fully-qualified modelDeploymentMonitoringJob resource name string.

Parameters
Name	Description
project	string
location	string
modelDeploymentMonitoringJob	string

Returns
Type	Description
string	{string} Resource name string.

modelEvaluationPath(project, location, model, evaluation)

modelEvaluationPath(project: string, location: string, model: string, evaluation: string): string;

Return a fully-qualified modelEvaluation resource name string.

Parameters
Name	Description
project	string
location	string
model	string
evaluation	string

Returns
Type	Description
string	{string} Resource name string.

modelEvaluationSlicePath(project, location, model, evaluation, slice)

modelEvaluationSlicePath(project: string, location: string, model: string, evaluation: string, slice: string): string;

Return a fully-qualified modelEvaluationSlice resource name string.

Parameters
Name	Description
project	string
location	string
model	string
evaluation	string
slice	string

Returns
Type	Description
string	{string} Resource name string.

modelMonitoringJobPath(project, location, modelMonitor, modelMonitoringJob)

modelMonitoringJobPath(project: string, location: string, modelMonitor: string, modelMonitoringJob: string): string;

Return a fully-qualified modelMonitoringJob resource name string.

Parameters
Name	Description
project	string
location	string
modelMonitor	string
modelMonitoringJob	string

Returns
Type	Description
string	{string} Resource name string.

modelMonitorPath(project, location, modelMonitor)

modelMonitorPath(project: string, location: string, modelMonitor: string): string;

Return a fully-qualified modelMonitor resource name string.

Parameters
Name	Description
project	string
location	string
modelMonitor	string

Returns
Type	Description
string	{string} Resource name string.

modelPath(project, location, model)

modelPath(project: string, location: string, model: string): string;

Return a fully-qualified model resource name string.

Parameters
Name	Description
project	string
location	string
model	string

Returns
Type	Description
string	{string} Resource name string.

nasJobPath(project, location, nasJob)

nasJobPath(project: string, location: string, nasJob: string): string;

Return a fully-qualified nasJob resource name string.

Parameters
Name	Description
project	string
location	string
nasJob	string

Returns
Type	Description
string	{string} Resource name string.

nasTrialDetailPath(project, location, nasJob, nasTrialDetail)

nasTrialDetailPath(project: string, location: string, nasJob: string, nasTrialDetail: string): string;

Return a fully-qualified nasTrialDetail resource name string.

Parameters
Name	Description
project	string
location	string
nasJob	string
nasTrialDetail	string

Returns
Type	Description
string	{string} Resource name string.

notebookExecutionJobPath(project, location, notebookExecutionJob)

notebookExecutionJobPath(project: string, location: string, notebookExecutionJob: string): string;

Return a fully-qualified notebookExecutionJob resource name string.

Parameters
Name	Description
project	string
location	string
notebookExecutionJob	string

Returns
Type	Description
string	{string} Resource name string.

notebookRuntimePath(project, location, notebookRuntime)

notebookRuntimePath(project: string, location: string, notebookRuntime: string): string;

Return a fully-qualified notebookRuntime resource name string.

Parameters
Name	Description
project	string
location	string
notebookRuntime	string

Returns
Type	Description
string	{string} Resource name string.

notebookRuntimeTemplatePath(project, location, notebookRuntimeTemplate)

notebookRuntimeTemplatePath(project: string, location: string, notebookRuntimeTemplate: string): string;

Return a fully-qualified notebookRuntimeTemplate resource name string.

Parameters
Name	Description
project	string
location	string
notebookRuntimeTemplate	string

Returns
Type	Description
string	{string} Resource name string.

persistentResourcePath(project, location, persistentResource)

persistentResourcePath(project: string, location: string, persistentResource: string): string;

Return a fully-qualified persistentResource resource name string.

Parameters
Name	Description
project	string
location	string
persistentResource	string

Returns
Type	Description
string	{string} Resource name string.

pipelineJobPath(project, location, pipelineJob)

pipelineJobPath(project: string, location: string, pipelineJob: string): string;

Return a fully-qualified pipelineJob resource name string.

Parameters
Name	Description
project	string
location	string
pipelineJob	string

Returns
Type	Description
string	{string} Resource name string.

predict(request, options)

predict(request?: protos.google.cloud.aiplatform.v1beta1.IPredictRequest, options?: CallOptions): Promise<[
        protos.google.cloud.aiplatform.v1beta1.IPredictResponse,
        protos.google.cloud.aiplatform.v1beta1.IPredictRequest | undefined,
        {} | undefined
    ]>;

Perform an online prediction.

Parameters
Name	Description
request	IPredictRequest The request object that will be sent.
options	CallOptions Call options. See CallOptions for more details.

Returns
Type	Description
Promise<[ protos.google.cloud.aiplatform.v1beta1.IPredictResponse, protos.google.cloud.aiplatform.v1beta1.IPredictRequest | undefined, {} | undefined ]>	{Promise} - The promise which resolves to an array. The first element of the array is an object representing PredictResponse. Please see the documentation for more details and examples.

Example

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The name of the Endpoint requested to serve the prediction.
   *  Format:
   *  `projects/{project}/locations/{location}/endpoints/{endpoint}`
   */
  // const endpoint = 'abc123'
  /**
   *  Required. The instances that are the input to the prediction call.
   *  A DeployedModel may have an upper limit on the number of instances it
   *  supports per request, and when it is exceeded the prediction call errors
   *  in case of AutoML Models, or, in case of customer created Models, the
   *  behaviour is as documented by that Model.
   *  The schema of any single instance may be specified via Endpoint's
   *  DeployedModels'
   *  Model's google.cloud.aiplatform.v1beta1.DeployedModel.model 
   *  PredictSchemata's google.cloud.aiplatform.v1beta1.Model.predict_schemata 
   *  instance_schema_uri google.cloud.aiplatform.v1beta1.PredictSchemata.instance_schema_uri.
   */
  // const instances = [1,2,3,4]
  /**
   *  The parameters that govern the prediction. The schema of the parameters may
   *  be specified via Endpoint's DeployedModels' Model's
   *   google.cloud.aiplatform.v1beta1.DeployedModel.model 
   *  PredictSchemata's google.cloud.aiplatform.v1beta1.Model.predict_schemata 
   *  parameters_schema_uri google.cloud.aiplatform.v1beta1.PredictSchemata.parameters_schema_uri.
   */
  // const parameters = {}
  /**
   *  Optional. The user labels for Imagen billing usage only. Only Imagen
   *  supports labels. For other use cases, it will be ignored.
   */
  // const labels = [1,2,3,4]

  // Imports the Aiplatform library
  const {PredictionServiceClient} = require('@google-cloud/aiplatform').v1beta1;

  // Instantiates a client
  const aiplatformClient = new PredictionServiceClient();

  async function callPredict() {
    // Construct request
    const request = {
      endpoint,
      instances,
    };

    // Run request
    const response = await aiplatformClient.predict(request);
    console.log(response);
  }

  callPredict();

predict(request, options, callback)

predict(request: protos.google.cloud.aiplatform.v1beta1.IPredictRequest, options: CallOptions, callback: Callback<protos.google.cloud.aiplatform.v1beta1.IPredictResponse, protos.google.cloud.aiplatform.v1beta1.IPredictRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	IPredictRequest
options	CallOptions
callback	Callback<protos.google.cloud.aiplatform.v1beta1.IPredictResponse, protos.google.cloud.aiplatform.v1beta1.IPredictRequest | null | undefined, {} | null | undefined>

Returns
Type	Description
void

predict(request, callback)

predict(request: protos.google.cloud.aiplatform.v1beta1.IPredictRequest, callback: Callback<protos.google.cloud.aiplatform.v1beta1.IPredictResponse, protos.google.cloud.aiplatform.v1beta1.IPredictRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	IPredictRequest
callback	Callback<protos.google.cloud.aiplatform.v1beta1.IPredictResponse, protos.google.cloud.aiplatform.v1beta1.IPredictRequest | null | undefined, {} | null | undefined>

Returns
Type	Description
void

projectLocationEndpointPath(project, location, endpoint)

projectLocationEndpointPath(project: string, location: string, endpoint: string): string;

Return a fully-qualified projectLocationEndpoint resource name string.

Parameters
Name	Description
project	string
location	string
endpoint	string

Returns
Type	Description
string	{string} Resource name string.

projectLocationFeatureGroupFeaturesPath(project, location, featureGroup, feature)

projectLocationFeatureGroupFeaturesPath(project: string, location: string, featureGroup: string, feature: string): string;

Return a fully-qualified projectLocationFeatureGroupFeatures resource name string.

Parameters
Name	Description
project	string
location	string
featureGroup	string
feature	string

Returns
Type	Description
string	{string} Resource name string.

projectLocationFeaturestoreEntityTypeFeaturesPath(project, location, featurestore, entityType, feature)

projectLocationFeaturestoreEntityTypeFeaturesPath(project: string, location: string, featurestore: string, entityType: string, feature: string): string;

Return a fully-qualified projectLocationFeaturestoreEntityTypeFeatures resource name string.

Parameters
Name	Description
project	string
location	string
featurestore	string
entityType	string
feature	string

Returns
Type	Description
string	{string} Resource name string.

projectLocationPublisherModelPath(project, location, publisher, model)

projectLocationPublisherModelPath(project: string, location: string, publisher: string, model: string): string;

Return a fully-qualified projectLocationPublisherModel resource name string.

Parameters
Name	Description
project	string
location	string
publisher	string
model	string

Returns
Type	Description
string	{string} Resource name string.

publisherModelPath(publisher, model)

publisherModelPath(publisher: string, model: string): string;

Return a fully-qualified publisherModel resource name string.

Parameters
Name	Description
publisher	string
model	string

Returns
Type	Description
string	{string} Resource name string.

ragCorpusPath(project, location, ragCorpus)

ragCorpusPath(project: string, location: string, ragCorpus: string): string;

Return a fully-qualified ragCorpus resource name string.

Parameters
Name	Description
project	string
location	string
ragCorpus	string

Returns
Type	Description
string	{string} Resource name string.

ragDataSchemaPath(project, location, ragCorpus, ragDataSchema)

ragDataSchemaPath(project: string, location: string, ragCorpus: string, ragDataSchema: string): string;

Return a fully-qualified ragDataSchema resource name string.

Parameters
Name	Description
project	string
location	string
ragCorpus	string
ragDataSchema	string

Returns
Type	Description
string	{string} Resource name string.

ragEngineConfigPath(project, location)

ragEngineConfigPath(project: string, location: string): string;

Return a fully-qualified ragEngineConfig resource name string.

Parameters
Name	Description
project	string
location	string

Returns
Type	Description
string	{string} Resource name string.

ragFilePath(project, location, ragCorpus, ragFile)

ragFilePath(project: string, location: string, ragCorpus: string, ragFile: string): string;

Return a fully-qualified ragFile resource name string.

Parameters
Name	Description
project	string
location	string
ragCorpus	string
ragFile	string

Returns
Type	Description
string	{string} Resource name string.

ragMetadataPath(project, location, ragCorpus, ragFile, ragMetadata)

ragMetadataPath(project: string, location: string, ragCorpus: string, ragFile: string, ragMetadata: string): string;

Return a fully-qualified ragMetadata resource name string.

Parameters
Name	Description
project	string
location	string
ragCorpus	string
ragFile	string
ragMetadata	string

Returns
Type	Description
string	{string} Resource name string.

rawPredict(request, options)

rawPredict(request?: protos.google.cloud.aiplatform.v1beta1.IRawPredictRequest, options?: CallOptions): Promise<[
        protos.google.api.IHttpBody,
        protos.google.cloud.aiplatform.v1beta1.IRawPredictRequest | undefined,
        {} | undefined
    ]>;

Perform an online prediction with an arbitrary HTTP payload.

The response includes the following HTTP headers:

* X-Vertex-AI-Endpoint-Id: ID of the Endpoint that served this prediction.

* X-Vertex-AI-Deployed-Model-Id: ID of the Endpoint's that served this prediction.

Parameters
Name	Description
request	IRawPredictRequest The request object that will be sent.
options	CallOptions Call options. See CallOptions for more details.

Returns
Type	Description
Promise<[ protos.google.api.IHttpBody, protos.google.cloud.aiplatform.v1beta1.IRawPredictRequest | undefined, {} | undefined ]>	{Promise} - The promise which resolves to an array. The first element of the array is an object representing HttpBody. Please see the documentation for more details and examples.

Example

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The name of the Endpoint requested to serve the prediction.
   *  Format:
   *  `projects/{project}/locations/{location}/endpoints/{endpoint}`
   */
  // const endpoint = 'abc123'
  /**
   *  The prediction input. Supports HTTP headers and arbitrary data payload.
   *  A DeployedModel google.cloud.aiplatform.v1beta1.DeployedModel  may have
   *  an upper limit on the number of instances it supports per request. When
   *  this limit it is exceeded for an AutoML model, the
   *  RawPredict google.cloud.aiplatform.v1beta1.PredictionService.RawPredict 
   *  method returns an error. When this limit is exceeded for a custom-trained
   *  model, the behavior varies depending on the model.
   *  You can specify the schema for each instance in the
   *  predict_schemata.instance_schema_uri google.cloud.aiplatform.v1beta1.PredictSchemata.instance_schema_uri 
   *  field when you create a Model google.cloud.aiplatform.v1beta1.Model.
   *  This schema applies when you deploy the `Model` as a `DeployedModel` to an
   *  Endpoint google.cloud.aiplatform.v1beta1.Endpoint  and use the
   *  `RawPredict` method.
   */
  // const httpBody = {}

  // Imports the Aiplatform library
  const {PredictionServiceClient} = require('@google-cloud/aiplatform').v1beta1;

  // Instantiates a client
  const aiplatformClient = new PredictionServiceClient();

  async function callRawPredict() {
    // Construct request
    const request = {
      endpoint,
    };

    // Run request
    const response = await aiplatformClient.rawPredict(request);
    console.log(response);
  }

  callRawPredict();

rawPredict(request, options, callback)

rawPredict(request: protos.google.cloud.aiplatform.v1beta1.IRawPredictRequest, options: CallOptions, callback: Callback<protos.google.api.IHttpBody, protos.google.cloud.aiplatform.v1beta1.IRawPredictRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	IRawPredictRequest
options	CallOptions
callback	Callback<protos.google.api.IHttpBody, protos.google.cloud.aiplatform.v1beta1.IRawPredictRequest | null | undefined, {} | null | undefined>

Returns
Type	Description
void

rawPredict(request, callback)

rawPredict(request: protos.google.cloud.aiplatform.v1beta1.IRawPredictRequest, callback: Callback<protos.google.api.IHttpBody, protos.google.cloud.aiplatform.v1beta1.IRawPredictRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	IRawPredictRequest
callback	Callback<protos.google.api.IHttpBody, protos.google.cloud.aiplatform.v1beta1.IRawPredictRequest | null | undefined, {} | null | undefined>

Returns
Type	Description
void

reasoningEnginePath(project, location, reasoningEngine)

reasoningEnginePath(project: string, location: string, reasoningEngine: string): string;

Return a fully-qualified reasoningEngine resource name string.

Parameters
Name	Description
project	string
location	string
reasoningEngine	string

Returns
Type	Description
string	{string} Resource name string.

savedQueryPath(project, location, dataset, savedQuery)

savedQueryPath(project: string, location: string, dataset: string, savedQuery: string): string;

Return a fully-qualified savedQuery resource name string.

Parameters
Name	Description
project	string
location	string
dataset	string
savedQuery	string

Returns
Type	Description
string	{string} Resource name string.

schedulePath(project, location, schedule)

schedulePath(project: string, location: string, schedule: string): string;

Return a fully-qualified schedule resource name string.

Parameters
Name	Description
project	string
location	string
schedule	string

Returns
Type	Description
string	{string} Resource name string.

serverStreamingPredict(request, options)

serverStreamingPredict(request?: protos.google.cloud.aiplatform.v1beta1.IStreamingPredictRequest, options?: CallOptions): gax.CancellableStream;

Perform a server-side streaming online prediction request for Vertex LLM streaming.

Parameters
Name	Description
request	IStreamingPredictRequest The request object that will be sent.
options	CallOptions Call options. See CallOptions for more details.

Returns
Type	Description
gax.CancellableStream	{Stream} An object stream which emits StreamingPredictResponse on 'data' event. Please see the documentation for more details and examples.

Example

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The name of the Endpoint requested to serve the prediction.
   *  Format:
   *  `projects/{project}/locations/{location}/endpoints/{endpoint}`
   */
  // const endpoint = 'abc123'
  /**
   *  The prediction input.
   */
  // const inputs = [1,2,3,4]
  /**
   *  The parameters that govern the prediction.
   */
  // const parameters = {}

  // Imports the Aiplatform library
  const {PredictionServiceClient} = require('@google-cloud/aiplatform').v1beta1;

  // Instantiates a client
  const aiplatformClient = new PredictionServiceClient();

  async function callServerStreamingPredict() {
    // Construct request
    const request = {
      endpoint,
    };

    // Run request
    const stream = await aiplatformClient.serverStreamingPredict(request);
    stream.on('data', (response) => { console.log(response) });
    stream.on('error', (err) => { throw(err) });
    stream.on('end', () => { /* API call completed */ });
  }

  callServerStreamingPredict();

sessionEventPath(project, location, reasoningEngine, session, event)

sessionEventPath(project: string, location: string, reasoningEngine: string, session: string, event: string): string;

Return a fully-qualified sessionEvent resource name string.

Parameters
Name	Description
project	string
location	string
reasoningEngine	string
session	string
event	string

Returns
Type	Description
string	{string} Resource name string.

sessionPath(project, location, reasoningEngine, session)

sessionPath(project: string, location: string, reasoningEngine: string, session: string): string;

Return a fully-qualified session resource name string.

Parameters
Name	Description
project	string
location	string
reasoningEngine	string
session	string

Returns
Type	Description
string	{string} Resource name string.

setIamPolicy(request, options, callback)

setIamPolicy(request: IamProtos.google.iam.v1.SetIamPolicyRequest, options?: gax.CallOptions | Callback<IamProtos.google.iam.v1.Policy, IamProtos.google.iam.v1.SetIamPolicyRequest | null | undefined, {} | null | undefined>, callback?: Callback<IamProtos.google.iam.v1.Policy, IamProtos.google.iam.v1.SetIamPolicyRequest | null | undefined, {} | null | undefined>): Promise<[IamProtos.google.iam.v1.Policy]>;

Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error.

Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.

Parameters
Name	Description
request	IamProtos.google.iam.v1.SetIamPolicyRequest The request object that will be sent.
options	CallOptions | Callback<google.iam.v1.Policy, google.iam.v1.SetIamPolicyRequest | null | undefined, {} | null | undefined> Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details.
callback	Callback<google.iam.v1.Policy, google.iam.v1.SetIamPolicyRequest | null | undefined, {} | null | undefined> The function which will be called with the result of the API call. The second parameter to the callback is an object representing .

Returns
Type	Description
Promise<[google.iam.v1.Policy]>	{Promise} - The promise which resolves to an array. The first element of the array is an object representing . The promise has a method named "cancel" which cancels the ongoing API call.

specialistPoolPath(project, location, specialistPool)

specialistPoolPath(project: string, location: string, specialistPool: string): string;

Return a fully-qualified specialistPool resource name string.

Parameters
Name	Description
project	string
location	string
specialistPool	string

Returns
Type	Description
string	{string} Resource name string.

streamDirectPredict(options)

streamDirectPredict(options?: CallOptions): gax.CancellableStream;

Perform a streaming online prediction request to a gRPC model server for Vertex first-party products and frameworks.

Parameter
Name	Description
options	CallOptions Call options. See CallOptions for more details.

Returns
Type	Description
gax.CancellableStream	{Stream} An object stream which is both readable and writable. It accepts objects representing StreamDirectPredictRequest for write() method, and will emit objects representing StreamDirectPredictResponse on 'data' event asynchronously. Please see the documentation for more details and examples.

Example

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The name of the Endpoint requested to serve the prediction.
   *  Format:
   *  `projects/{project}/locations/{location}/endpoints/{endpoint}`
   */
  // const endpoint = 'abc123'
  /**
   *  Optional. The prediction input.
   */
  // const inputs = [1,2,3,4]
  /**
   *  Optional. The parameters that govern the prediction.
   */
  // const parameters = {}

  // Imports the Aiplatform library
  const {PredictionServiceClient} = require('@google-cloud/aiplatform').v1beta1;

  // Instantiates a client
  const aiplatformClient = new PredictionServiceClient();

  async function callStreamDirectPredict() {
    // Construct request
    const request = {
      endpoint,
    };

    // Run request
    const stream = await aiplatformClient.streamDirectPredict();
    stream.on('data', (response) => { console.log(response) });
    stream.on('error', (err) => { throw(err) });
    stream.on('end', () => { /* API call completed */ });
    stream.write(request);
    stream.end();
  }

  callStreamDirectPredict();

streamDirectRawPredict(options)

streamDirectRawPredict(options?: CallOptions): gax.CancellableStream;

Perform a streaming online prediction request to a gRPC model server for custom containers.

Parameter
Name	Description
options	CallOptions Call options. See CallOptions for more details.

Returns
Type	Description
gax.CancellableStream	{Stream} An object stream which is both readable and writable. It accepts objects representing StreamDirectRawPredictRequest for write() method, and will emit objects representing StreamDirectRawPredictResponse on 'data' event asynchronously. Please see the documentation for more details and examples.

Example

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The name of the Endpoint requested to serve the prediction.
   *  Format:
   *  `projects/{project}/locations/{location}/endpoints/{endpoint}`
   */
  // const endpoint = 'abc123'
  /**
   *  Optional. Fully qualified name of the API method being invoked to perform
   *  predictions.
   *  Format:
   *  `/namespace.Service/Method/`
   *  Example:
   *  `/tensorflow.serving.PredictionService/Predict`
   */
  // const methodName = 'abc123'
  /**
   *  Optional. The prediction input.
   */
  // const input = Buffer.from('string')

  // Imports the Aiplatform library
  const {PredictionServiceClient} = require('@google-cloud/aiplatform').v1beta1;

  // Instantiates a client
  const aiplatformClient = new PredictionServiceClient();

  async function callStreamDirectRawPredict() {
    // Construct request
    const request = {
      endpoint,
    };

    // Run request
    const stream = await aiplatformClient.streamDirectRawPredict();
    stream.on('data', (response) => { console.log(response) });
    stream.on('error', (err) => { throw(err) });
    stream.on('end', () => { /* API call completed */ });
    stream.write(request);
    stream.end();
  }

  callStreamDirectRawPredict();

streamGenerateContent(request, options)

streamGenerateContent(request?: protos.google.cloud.aiplatform.v1beta1.IGenerateContentRequest, options?: CallOptions): gax.CancellableStream;

Generate content with multimodal inputs with streaming support.

Parameters
Name	Description
request	IGenerateContentRequest The request object that will be sent.
options	CallOptions Call options. See CallOptions for more details.

Returns
Type	Description
gax.CancellableStream	{Stream} An object stream which emits on 'data' event. Please see the documentation for more details and examples.

Example

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  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}`
   */
  // const model = 'abc123'
  /**
   *  Required. The content of the current conversation with the model.
   *  For single-turn queries, this is a single instance. For multi-turn queries,
   *  this is a repeated field that contains conversation history + latest
   *  request.
   */
  // const contents = [1,2,3,4]
  /**
   *  Optional. The user provided system instructions for the model.
   *  Note: only text should be used in parts and content in each part will be in
   *  a separate paragraph.
   */
  // const systemInstruction = {}
  /**
   *  Optional. The name of the cached content used as context to serve the
   *  prediction. Note: only used in explicit caching, where users can have
   *  control over caching (e.g. what content to cache) and enjoy guaranteed cost
   *  savings. Format:
   *  `projects/{project}/locations/{location}/cachedContents/{cachedContent}`
   */
  // const cachedContent = 'abc123'
  /**
   *  Optional. A list of `Tools` the model may use to generate the next
   *  response.
   *  A `Tool` is a piece of code that enables the system to interact with
   *  external systems to perform an action, or set of actions, outside of
   *  knowledge and scope of the model.
   */
  // const tools = [1,2,3,4]
  /**
   *  Optional. Tool config. This config is shared for all tools provided in the
   *  request.
   */
  // const toolConfig = {}
  /**
   *  Optional. The labels with user-defined metadata for the request. It is used
   *  for billing and reporting only.
   *  Label keys and values can be no longer than 63 characters
   *  (Unicode codepoints) and can only contain lowercase letters, numeric
   *  characters, underscores, and dashes. International characters are allowed.
   *  Label values are optional. Label keys must start with a letter.
   */
  // const labels = [1,2,3,4]
  /**
   *  Optional. Per request settings for blocking unsafe content.
   *  Enforced on GenerateContentResponse.candidates.
   */
  // const safetySettings = [1,2,3,4]
  /**
   *  Optional. Settings for prompt and response sanitization using the Model
   *  Armor service. If supplied, safety_settings must not be supplied.
   */
  // const modelArmorConfig = {}
  /**
   *  Optional. Generation config.
   */
  // const generationConfig = {}

  // Imports the Aiplatform library
  const {PredictionServiceClient} = require('@google-cloud/aiplatform').v1beta1;

  // Instantiates a client
  const aiplatformClient = new PredictionServiceClient();

  async function callStreamGenerateContent() {
    // Construct request
    const request = {
      model,
      contents,
    };

    // Run request
    const stream = await aiplatformClient.streamGenerateContent(request);
    stream.on('data', (response) => { console.log(response) });
    stream.on('error', (err) => { throw(err) });
    stream.on('end', () => { /* API call completed */ });
  }

  callStreamGenerateContent();

streamingPredict(options)

streamingPredict(options?: CallOptions): gax.CancellableStream;

Perform a streaming online prediction request for Vertex first-party products and frameworks.

Parameter
Name	Description
options	CallOptions Call options. See CallOptions for more details.

Returns
Type	Description
gax.CancellableStream	{Stream} An object stream which is both readable and writable. It accepts objects representing StreamingPredictRequest for write() method, and will emit objects representing StreamingPredictResponse on 'data' event asynchronously. Please see the documentation for more details and examples.

Example

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The name of the Endpoint requested to serve the prediction.
   *  Format:
   *  `projects/{project}/locations/{location}/endpoints/{endpoint}`
   */
  // const endpoint = 'abc123'
  /**
   *  The prediction input.
   */
  // const inputs = [1,2,3,4]
  /**
   *  The parameters that govern the prediction.
   */
  // const parameters = {}

  // Imports the Aiplatform library
  const {PredictionServiceClient} = require('@google-cloud/aiplatform').v1beta1;

  // Instantiates a client
  const aiplatformClient = new PredictionServiceClient();

  async function callStreamingPredict() {
    // Construct request
    const request = {
      endpoint,
    };

    // Run request
    const stream = await aiplatformClient.streamingPredict();
    stream.on('data', (response) => { console.log(response) });
    stream.on('error', (err) => { throw(err) });
    stream.on('end', () => { /* API call completed */ });
    stream.write(request);
    stream.end();
  }

  callStreamingPredict();

streamingRawPredict(options)

streamingRawPredict(options?: CallOptions): gax.CancellableStream;

Perform a streaming online prediction request through gRPC.

Parameter
Name	Description
options	CallOptions Call options. See CallOptions for more details.

Returns
Type	Description
gax.CancellableStream	{Stream} An object stream which is both readable and writable. It accepts objects representing StreamingRawPredictRequest for write() method, and will emit objects representing StreamingRawPredictResponse on 'data' event asynchronously. Please see the documentation for more details and examples.

Example

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The name of the Endpoint requested to serve the prediction.
   *  Format:
   *  `projects/{project}/locations/{location}/endpoints/{endpoint}`
   */
  // const endpoint = 'abc123'
  /**
   *  Fully qualified name of the API method being invoked to perform
   *  predictions.
   *  Format:
   *  `/namespace.Service/Method/`
   *  Example:
   *  `/tensorflow.serving.PredictionService/Predict`
   */
  // const methodName = 'abc123'
  /**
   *  The prediction input.
   */
  // const input = Buffer.from('string')

  // Imports the Aiplatform library
  const {PredictionServiceClient} = require('@google-cloud/aiplatform').v1beta1;

  // Instantiates a client
  const aiplatformClient = new PredictionServiceClient();

  async function callStreamingRawPredict() {
    // Construct request
    const request = {
      endpoint,
    };

    // Run request
    const stream = await aiplatformClient.streamingRawPredict();
    stream.on('data', (response) => { console.log(response) });
    stream.on('error', (err) => { throw(err) });
    stream.on('end', () => { /* API call completed */ });
    stream.write(request);
    stream.end();
  }

  callStreamingRawPredict();

streamRawPredict(request, options)

streamRawPredict(request?: protos.google.cloud.aiplatform.v1beta1.IStreamRawPredictRequest, options?: CallOptions): gax.CancellableStream;

Perform a streaming online prediction with an arbitrary HTTP payload.

Parameters
Name	Description
request	IStreamRawPredictRequest The request object that will be sent.
options	CallOptions Call options. See CallOptions for more details.

Returns
Type	Description
gax.CancellableStream	{Stream} An object stream which emits HttpBody on 'data' event. Please see the documentation for more details and examples.

Example

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The name of the Endpoint requested to serve the prediction.
   *  Format:
   *  `projects/{project}/locations/{location}/endpoints/{endpoint}`
   */
  // const endpoint = 'abc123'
  /**
   *  The prediction input. Supports HTTP headers and arbitrary data payload.
   */
  // const httpBody = {}

  // Imports the Aiplatform library
  const {PredictionServiceClient} = require('@google-cloud/aiplatform').v1beta1;

  // Instantiates a client
  const aiplatformClient = new PredictionServiceClient();

  async function callStreamRawPredict() {
    // Construct request
    const request = {
      endpoint,
    };

    // Run request
    const stream = await aiplatformClient.streamRawPredict(request);
    stream.on('data', (response) => { console.log(response) });
    stream.on('error', (err) => { throw(err) });
    stream.on('end', () => { /* API call completed */ });
  }

  callStreamRawPredict();

studyPath(project, location, study)

studyPath(project: string, location: string, study: string): string;

Return a fully-qualified study resource name string.

Parameters
Name	Description
project	string
location	string
study	string

Returns
Type	Description
string	{string} Resource name string.

tensorboardExperimentPath(project, location, tensorboard, experiment)

tensorboardExperimentPath(project: string, location: string, tensorboard: string, experiment: string): string;

Return a fully-qualified tensorboardExperiment resource name string.

Parameters
Name	Description
project	string
location	string
tensorboard	string
experiment	string

Returns
Type	Description
string	{string} Resource name string.

tensorboardPath(project, location, tensorboard)

tensorboardPath(project: string, location: string, tensorboard: string): string;

Return a fully-qualified tensorboard resource name string.

Parameters
Name	Description
project	string
location	string
tensorboard	string

Returns
Type	Description
string	{string} Resource name string.

tensorboardRunPath(project, location, tensorboard, experiment, run)

tensorboardRunPath(project: string, location: string, tensorboard: string, experiment: string, run: string): string;

Return a fully-qualified tensorboardRun resource name string.

Parameters
Name	Description
project	string
location	string
tensorboard	string
experiment	string
run	string

Returns
Type	Description
string	{string} Resource name string.

tensorboardTimeSeriesPath(project, location, tensorboard, experiment, run, timeSeries)

tensorboardTimeSeriesPath(project: string, location: string, tensorboard: string, experiment: string, run: string, timeSeries: string): string;

Return a fully-qualified tensorboardTimeSeries resource name string.

Parameters
Name	Description
project	string
location	string
tensorboard	string
experiment	string
run	string
timeSeries	string

Returns
Type	Description
string	{string} Resource name string.

testIamPermissions(request, options, callback)

testIamPermissions(request: IamProtos.google.iam.v1.TestIamPermissionsRequest, options?: gax.CallOptions | Callback<IamProtos.google.iam.v1.TestIamPermissionsResponse, IamProtos.google.iam.v1.TestIamPermissionsRequest | null | undefined, {} | null | undefined>, callback?: Callback<IamProtos.google.iam.v1.TestIamPermissionsResponse, IamProtos.google.iam.v1.TestIamPermissionsRequest | null | undefined, {} | null | undefined>): Promise<[IamProtos.google.iam.v1.TestIamPermissionsResponse]>;

Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error.

Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.

Parameters
Name	Description
request	IamProtos.google.iam.v1.TestIamPermissionsRequest The request object that will be sent.
options	CallOptions | Callback<google.iam.v1.TestIamPermissionsResponse, google.iam.v1.TestIamPermissionsRequest | null | undefined, {} | null | undefined> Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details.
callback	Callback<google.iam.v1.TestIamPermissionsResponse, google.iam.v1.TestIamPermissionsRequest | null | undefined, {} | null | undefined> The function which will be called with the result of the API call. The second parameter to the callback is an object representing .

Returns
Type	Description
Promise<[google.iam.v1.TestIamPermissionsResponse]>	{Promise} - The promise which resolves to an array. The first element of the array is an object representing . The promise has a method named "cancel" which cancels the ongoing API call.

trainingPipelinePath(project, location, trainingPipeline)

trainingPipelinePath(project: string, location: string, trainingPipeline: string): string;

Return a fully-qualified trainingPipeline resource name string.

Parameters
Name	Description
project	string
location	string
trainingPipeline	string

Returns
Type	Description
string	{string} Resource name string.

trialPath(project, location, study, trial)

trialPath(project: string, location: string, study: string, trial: string): string;

Return a fully-qualified trial resource name string.

Parameters
Name	Description
project	string
location	string
study	string
trial	string

Returns
Type	Description
string	{string} Resource name string.

tuningJobPath(project, location, tuningJob)

tuningJobPath(project: string, location: string, tuningJob: string): string;

Return a fully-qualified tuningJob resource name string.

Parameters
Name	Description
project	string
location	string
tuningJob	string

Returns
Type	Description
string	{string} Resource name string.