feat(samples): add read-feature-values sample (googleapis#313)

samples/read-feature-values-sample.js

@@ -0,0 +1,96 @@
+/*
+ * Copyright 2022 Google LLC
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+/*
+ * Reads Feature values of a specific entity of an EntityType.
+ * See https://cloud.google.com/vertex-ai/docs/featurestore/setup before running
+ * the code snippet
+ */
+
+'use strict';
+
+async function main(
+  project,
+  featurestoreId,
+  entityTypeId,
+  entityId,
+  location = 'us-central1',
+  apiEndpoint = 'us-central1-aiplatform.googleapis.com',
+  timeout = 300000
+) {
+  // [START aiplatform_read_feature_values_sample]
+  /**
+   * TODO(developer): Uncomment these variables before running the sample.\
+   * (Not necessary if passing values as arguments)
+   */
+
+  // const project = 'YOUR_PROJECT_ID';
+  // const featurestoreId = 'YOUR_FEATURESTORE_ID';
+  // const entityTypeId = 'YOUR_ENTITY_TYPE_ID';
+  // const entityId = 'ENTITY_ID_TO_SERVE';
+  // const location = 'YOUR_PROJECT_LOCATION';
+  // const apiEndpoint = 'YOUR_API_ENDPOINT';
+  // const timeout = <TIMEOUT_IN_MILLI_SECONDS>;
+
+  // Imports the Google Cloud Featurestore Service Client library
+  const {FeaturestoreOnlineServingServiceClient} =
+    require('@google-cloud/aiplatform').v1;
+
+  // Specifies the location of the api endpoint
+  const clientOptions = {
+    apiEndpoint: apiEndpoint,
+  };
+
+  // Instantiates a client
+  const featurestoreOnlineServingServiceClient =
+    new FeaturestoreOnlineServingServiceClient(clientOptions);
+
+  async function readFeatureValues() {
+    // Configure the entityType resource
+    const entityType = `projects/${project}/locations/${location}/featurestores/${featurestoreId}/entityTypes/${entityTypeId}`;
+
+    const featureSelector = {
+      idMatcher: {
+        ids: ['age', 'gender', 'liked_genres'],
+      },
+    };
+
+    const request = {
+      entityType: entityType,
+      entityId: entityId,
+      featureSelector: featureSelector,
+    };
+
+    // Read Feature Values Request
+    const [response] =
+      await featurestoreOnlineServingServiceClient.readFeatureValues(request, {
+        timeout: Number(timeout),
+      });
+
+    console.log('Read feature values response');
+    console.log('Raw response:');
+    console.log(JSON.stringify(response, null, 2));
+  }
+  readFeatureValues();
+  // [END aiplatform_read_feature_values_sample]
+}
+
+process.on('unhandledRejection', err => {
+  console.error(err.message);
+  process.exitCode = 1;
+});
+
+main(...process.argv.slice(2));

samples/test/read-feature-values-sample.test.js

@@ -0,0 +1,215 @@
+/*
+ * Copyright 2022 Google LLC
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+'use strict';
+
+const {assert} = require('chai');
+const {FeaturestoreServiceClient} = require('@google-cloud/aiplatform').v1;
+const {after, before, describe, it} = require('mocha');
+const uuid = require('uuid').v4;
+const cp = require('child_process');
+const execSync = cmd => cp.execSync(cmd, {encoding: 'utf-8'});
+
+const project = process.env.CAIP_PROJECT_ID;
+const featurestoreId = `featurestore_sample_${uuid()
+  .replace(/-/g, '_')
+  .slice(10, 20)}`;
+const fixedNodeCount = 1;
+const entityTypeId = 'users';
+const entityTypeDescription = 'Users Entity';
+const avroGcsUri =
+  'gs://cloud-samples-data-us-central1/vertex-ai/feature-store/datasets/users.avro';
+const entityIdField = 'user_id';
+const featureTimeField = 'update_time';
+const workerCount = 2;
+const entityId = 'alice';
+const location = 'us-central1';
+const apiEndpoint = 'us-central1-aiplatform.googleapis.com';
+
+// Instantiates a featurestore clients
+const featurestoreServiceClient = new FeaturestoreServiceClient({
+  apiEndpoint: apiEndpoint,
+});
+
+const createFeaturestore = async () => {
+  // Configure the parent resource
+  const parent = `projects/${project}/locations/${location}`;
+
+  const featurestore = {
+    onlineServingConfig: {
+      fixedNodeCount: fixedNodeCount,
+    },
+  };
+
+  const request = {
+    parent: parent,
+    featurestore: featurestore,
+    featurestoreId: featurestoreId,
+  };
+
+  // Create Featurestore request
+  const [operation] = await featurestoreServiceClient.createFeaturestore(
+    request,
+    {timeout: 900000}
+  );
+  await operation.promise();
+};
+
+const createEntityType = async () => {
+  // Configure the parent resource
+  const parent = `projects/${project}/locations/${location}/featurestores/${featurestoreId}`;
+
+  const entityType = {
+    description: entityTypeDescription,
+  };
+
+  const request = {
+    parent: parent,
+    entityTypeId: entityTypeId,
+    entityType: entityType,
+  };
+
+  // CreateEntityType request
+  const [operation] = await featurestoreServiceClient.createEntityType(
+    request,
+    {timeout: 300000}
+  );
+  await operation.promise();
+};
+
+const batchCreateFeatures = async () => {
+  // Configure the parent resource
+  const parent = `projects/${project}/locations/${location}/featurestores/${featurestoreId}/entityTypes/${entityTypeId}`;
+
+  const ageFeature = {
+    valueType: 'INT64',
+    description: 'User age',
+  };
+
+  const ageFeatureRequest = {
+    feature: ageFeature,
+    featureId: 'age',
+  };
+
+  const genderFeature = {
+    valueType: 'STRING',
+    description: 'User gender',
+  };
+
+  const genderFeatureRequest = {
+    feature: genderFeature,
+    featureId: 'gender',
+  };
+
+  const likedGenresFeature = {
+    valueType: 'STRING_ARRAY',
+    description: 'An array of genres that this user liked',
+  };
+
+  const likedGenresFeatureRequest = {
+    feature: likedGenresFeature,
+    featureId: 'liked_genres',
+  };
+
+  const requests = [
+    ageFeatureRequest,
+    genderFeatureRequest,
+    likedGenresFeatureRequest,
+  ];
+
+  const request = {
+    parent: parent,
+    requests: requests,
+  };
+
+  // Batch Create Features request
+  const [operation] = await featurestoreServiceClient.batchCreateFeatures(
+    request,
+    {timeout: 300000}
+  );
+  await operation.promise();
+};
+
+const importFeatureValues = async () => {
+  // Configure the entityType resource
+  const entityType = `projects/${project}/locations/${location}/featurestores/${featurestoreId}/entityTypes/${entityTypeId}`;
+
+  const avroSource = {
+    gcsSource: {
+      uris: [avroGcsUri],
+    },
+  };
+
+  const featureSpecs = [{id: 'age'}, {id: 'gender'}, {id: 'liked_genres'}];
+
+  const request = {
+    entityType: entityType,
+    avroSource: avroSource,
+    entityIdField: entityIdField,
+    featureSpecs: featureSpecs,
+    featureTimeField: featureTimeField,
+    workerCount: workerCount,
+  };
+
+  // Import Feature Values Request
+  const [operation] = await featurestoreServiceClient.importFeatureValues(
+    request,
+    {timeout: 300000}
+  );
+  await operation.promise();
+};
+
+const deleteFeaturestore = async () => {
+  // Configure the name resource
+  const name = `projects/${project}/locations/${location}/featurestores/${featurestoreId}`;
+
+  const request = {
+    name: name,
+    force: true,
+  };
+
+  // Delete Featurestore request
+  const [operation] = await featurestoreServiceClient.deleteFeaturestore(
+    request,
+    {timeout: 60000}
+  );
+  await operation.promise();
+};
+
+describe('AI platform read feature values', async function () {
+  this.retries(2);
+  before('should create the featurestore', async () => {
+    await createFeaturestore();
+  });
+  before('should create the entity type', async () => {
+    await createEntityType();
+  });
+  before('should create the batch features', async () => {
+    await batchCreateFeatures();
+  });
+  before('should import feature values', async () => {
+    await importFeatureValues();
+  });
+  it('should read feature values', async () => {
+    const stdout = execSync(
+      `node ./read-feature-values-sample.js ${project} ${featurestoreId} ${entityTypeId} ${entityId} ${location} ${apiEndpoint}`
+    );
+    assert.match(stdout, /Read feature values response/);
+  });
+  after('should delete the created featurestore', async () => {
+    await deleteFeaturestore();
+  });
+});