addressed PR comments

Author: hsubox76

packages/vertexai/src/public-types.ts

@@ -20,7 +20,7 @@ import { FirebaseApp } from '@firebase/app';
 export * from './types';
 
 /**
- * An instance of Firebase Vertex AI.
+ * An instance of the Vertex AI for Firebase SDK.
  * @public
  */
 export interface VertexAI {

packages/vertexai/src/types/content.ts

@@ -27,7 +27,8 @@ export interface Content {
 }
 
 /**
- * Content part - includes text, image/video, or function call/response part types.
+ * Content part - includes text, image/video, or function call/response
+ * part types.
  * @public
  */
 export type Part =
@@ -115,8 +116,8 @@ export interface FileDataPart {
 }
 
 /**
- * A predicted [FunctionCall] returned from the model
- * that contains a string representing the [FunctionDeclaration.name]
+ * A predicted {@link FunctionCall} returned from the model
+ * that contains a string representing the {@link FunctionDeclaration.name}
  * and a structured JSON object containing the parameters and their values.
  * @public
  */
@@ -126,11 +127,11 @@ export interface FunctionCall {
 }
 
 /**
- * The result output from a [FunctionCall] that contains a string
- * representing the [FunctionDeclaration.name]
+ * The result output from a {@link FunctionCall} that contains a string
+ * representing the {@link FunctionDeclaration.name}
  * and a structured JSON object containing any output
  * from the function is used as context to the model.
- * This should contain the result of a [FunctionCall]
+ * This should contain the result of a {@link FunctionCall}
  * made based on model prediction.
  * @public
  */

packages/vertexai/src/types/requests.ts

@@ -44,7 +44,7 @@ export interface ModelParams extends BaseParams {
 }
 
 /**
- * Request sent to `generateContent` endpoint.
+ * Request sent through {@link GenerativeModel.generateContent}
  * @public
  */
 export interface GenerateContentRequest extends BaseParams {
@@ -121,9 +121,10 @@ export declare type Tool = FunctionDeclarationsTool;
 
 /**
  * Structured representation of a function declaration as defined by the
- * [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included
+ * {@link https://spec.openapis.org/oas/v3.0.3 | OpenAPI 3.0 specification}.
+ * Included
  * in this declaration are the function name and parameters. This
- * FunctionDeclaration is a representation of a block of code that can be used
+ * `FunctionDeclaration` is a representation of a block of code that can be used
  * as a Tool by the model and executed by the client.
  * @public
  */
@@ -148,7 +149,7 @@ export declare interface FunctionDeclaration {
 }
 
 /**
- * A FunctionDeclarationsTool is a piece of code that enables the system to
+ * A `FunctionDeclarationsTool` 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.
  * @public

packages/vertexai/src/types/responses.ts

@@ -25,7 +25,7 @@ import {
 } from './enums';
 
 /**
- * Result object returned from generateContent() call.
+ * Result object returned from {@link GenerativeModel.generateContent} call.
  *
  * @public
  */
@@ -34,7 +34,7 @@ export interface GenerateContentResult {
 }
 
 /**
- * Result object returned from generateContentStream() call.
+ * Result object returned from {@link GenerativeModel.generateContentStream} call.
  * Iterate over `stream` to get chunks as they come in and/or
  * use the `response` promise to get the aggregated response when
  * the stream is done.