fix up comments, docs

Author: hsubox76

packages/vertexai/package.json

@@ -30,7 +30,7 @@
   "scripts": {
     "lint": "eslint -c .eslintrc.js '**/*.ts' --ignore-path '../../.gitignore'",
     "lint:fix": "eslint --fix -c .eslintrc.js '**/*.ts' --ignore-path '../../.gitignore'",
-    "build": "rollup -c",
+    "build": "rollup -c && yarn api-report",
     "build:deps": "lerna run --scope @firebase/vertexai --include-dependencies build",
     "dev": "rollup -c -w",
     "testsetup": "yarn ts-node ./test-utils/convert-mocks.ts",

packages/vertexai/src/api.ts

@@ -52,6 +52,12 @@ export function getVertexAI(app: FirebaseApp = getApp()): VertexAI {
   });
 }
 
+/**
+ * Returns a {@link GenerativeModel} class with methods for inference
+ * and other functionality.
+ * 
+ * @public
+ */
 export function getGenerativeModel(
   vertexAI: VertexAI,
   modelParams: ModelParams,

packages/vertexai/src/errors.ts

@@ -39,7 +39,7 @@ const ERRORS: ErrorMap<VertexError> = {
     `contain a valid project ID.`,
   [VertexError.NO_MODEL]:
     `Must provide a model name. ` +
-    `Example: genai.getGenerativeModel({ model: 'my-model-name' })`,
+    `Example: getGenerativeModel({ model: 'my-model-name' })`,
   [VertexError.PARSE_FAILED]: `Parsing failed: {$message}`,
   [VertexError.RESPONSE_ERROR]:
     `Response error: {$message}. Response body stored in ` +

packages/vertexai/src/types/requests.ts

@@ -33,7 +33,7 @@ export interface BaseParams {
 }
 
 /**
- * Params passed to {@link GoogleGenerativeAI.getGenerativeModel}.
+ * Params passed to {@link getGenerativeModel}.
  * @public
  */
 export interface ModelParams extends BaseParams {

packages/vertexai/src/types/responses.ts

@@ -74,6 +74,11 @@ export interface GenerateContentResponse {
   usageMetadata?: UsageMetadata;
 }
 
+/**
+ * Usage metadata about response.
+ * 
+ * @public
+ */
 export interface UsageMetadata {
   promptTokenCount: number;
   candidatesTokenCount: number;