Skip to content

Commit

Permalink
feat(samples): add feature apis samples (#340)
Browse files Browse the repository at this point in the history
* added create-featurestore-sample.js and create-featurestore-sample.test.js

* feat(samples): added createFeaturestore sample (#313)

* feat(samples): added remaining featurestore samples (#313)

* removed the extraneous files

* feat(samples): add feature apis samples (#313)

* 🦉 Updates from OwlBot post-processor

See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md

* feat(samples): updated feature-samples.test.js (#313)

* 🦉 Updates from OwlBot post-processor

See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md

* 🦉 Updates from OwlBot post-processor

See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md

Co-authored-by: Owl Bot <gcf-owl-bot[bot]@users.noreply.github.com>
Co-authored-by: junkourata <102059808+junkourata@users.noreply.github.com>
  • Loading branch information
3 people authored and pattishin committed Nov 22, 2022
1 parent b92bdec commit f08ea11
Show file tree
Hide file tree
Showing 12 changed files with 1,223 additions and 0 deletions.
124 changes: 124 additions & 0 deletions ai-platform/snippets/batch-create-features-sample.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,124 @@
/*
* 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.
*/

/*
* Creates a batch of Features in a given EntityType.
* See https://cloud.google.com/vertex-ai/docs/featurestore/setup before running
* the code snippet
*/

'use strict';

async function main(
project,
featurestoreId,
entityTypeId,
location = 'us-central1',
apiEndpoint = 'us-central1-aiplatform.googleapis.com',
timeout = 300000
) {
// [START aiplatform_batch_create_features_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 location = 'YOUR_PROJECT_LOCATION';
// const apiEndpoint = 'YOUR_API_ENDPOINT';
// const timeout = <TIMEOUT_IN_MILLI_SECONDS>;

// Imports the Google Cloud Featurestore Service Client library
const {FeaturestoreServiceClient} = require('@google-cloud/aiplatform').v1;

// Specifies the location of the api endpoint
const clientOptions = {
apiEndpoint: apiEndpoint,
};

// Instantiates a client
const featurestoreServiceClient = new FeaturestoreServiceClient(
clientOptions
);

async function batchCreateFeatures() {
// 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: Number(timeout)}
);
const [response] = await operation.promise();

console.log('Batch create features response');
console.log('Raw response:');
console.log(JSON.stringify(response, null, 2));
}
batchCreateFeatures();
// [END aiplatform_batch_create_features_sample]
}

process.on('unhandledRejection', err => {
console.error(err.message);
process.exitCode = 1;
});

main(...process.argv.slice(2));
100 changes: 100 additions & 0 deletions ai-platform/snippets/create-feature-sample.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,100 @@
/*
* 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.
*/

/*
* Creates a new Feature in a given EntityType.
* See https://cloud.google.com/vertex-ai/docs/featurestore/setup before running
* the code snippet
*/

'use strict';

async function main(
project,
featurestoreId,
entityTypeId,
featureId,
valueType,
description,
location = 'us-central1',
apiEndpoint = 'us-central1-aiplatform.googleapis.com',
timeout = 300000
) {
// [START aiplatform_create_feature_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 featureId = 'YOUR_FEATURE_ID';
// const valueType = 'FEATURE_VALUE_DATA_TYPE';
// const description = 'YOUR_ENTITY_TYPE_DESCRIPTION';
// 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 {FeaturestoreServiceClient} = require('@google-cloud/aiplatform').v1;

// Specifies the location of the api endpoint
const clientOptions = {
apiEndpoint: apiEndpoint,
};

// Instantiates a client
const featurestoreServiceClient = new FeaturestoreServiceClient(
clientOptions
);

async function createFeature() {
// Configure the parent resource
const parent = `projects/${project}/locations/${location}/featurestores/${featurestoreId}/entityTypes/${entityTypeId}`;

const feature = {
valueType: valueType,
description: description,
};

const request = {
parent: parent,
feature: feature,
featureId: featureId,
};

// Create Feature request
const [operation] = await featurestoreServiceClient.createFeature(request, {
timeout: Number(timeout),
});
const [response] = await operation.promise();

console.log('Create feature response');
console.log(`Name : ${response.name}`);
console.log('Raw response:');
console.log(JSON.stringify(response, null, 2));
}
createFeature();
// [END aiplatform_create_feature_sample]
}

process.on('unhandledRejection', err => {
console.error(err.message);
process.exitCode = 1;
});

main(...process.argv.slice(2));
88 changes: 88 additions & 0 deletions ai-platform/snippets/delete-feature-sample.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,88 @@
/*
* 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.
*/

/*
* Deletes a single Feature.
* See https://cloud.google.com/vertex-ai/docs/featurestore/setup before running
* the code snippet
*/

'use strict';

async function main(
project,
featurestoreId,
entityTypeId,
featureId,
location = 'us-central1',
apiEndpoint = 'us-central1-aiplatform.googleapis.com',
timeout = 300000
) {
// [START aiplatform_delete_feature_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 featureId = 'YOUR_FEATURE_ID';
// 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 {FeaturestoreServiceClient} = require('@google-cloud/aiplatform').v1;

// Specifies the location of the api endpoint
const clientOptions = {
apiEndpoint: apiEndpoint,
};

// Instantiates a client
const featurestoreServiceClient = new FeaturestoreServiceClient(
clientOptions
);

async function deleteFeature() {
// Configure the name resource
const name = `projects/${project}/locations/${location}/featurestores/${featurestoreId}/entityTypes/${entityTypeId}/features/${featureId}`;

const request = {
name: name,
};

// Delete Feature request
const [operation] = await featurestoreServiceClient.deleteFeature(request, {
timeout: Number(timeout),
});
const [response] = await operation.promise();

console.log('Delete feature response');
console.log('Raw response:');
console.log(JSON.stringify(response, null, 2));
}
deleteFeature();
// [END aiplatform_delete_feature_sample]
}

process.on('unhandledRejection', err => {
console.error(err.message);
process.exitCode = 1;
});

main(...process.argv.slice(2));
Loading

0 comments on commit f08ea11

Please sign in to comment.