@maxim_mazurok/gapi.client.firebaseml-v2beta - npm Package Compare versions

Comparing version 0.0.20240610 to 0.0.20240611

index.d.ts

@@ -12,3 +12,3 @@ /* Type definitions for non-npm package Firebase ML API v2beta 0.0 */
 // Generated from: https://firebaseml.googleapis.com/$discovery/rest?version=v2beta
-// Revision: 20240610
+// Revision: 20240611
 
@@ -32,3 +32,11 @@ /// <reference types="gapi.client" />
   namespace firebaseml {
-    interface Blob {
+    interface Date {
+      /** Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. */
+      day?: number;
+      /** Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. */
+      month?: number;
+      /** Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. */
+      year?: number;
+    }
+    interface GoogleCloudAiplatformV1beta1Blob {
       /** Required. Raw bytes. */
@@ -39,7 +47,7 @@ data?: string;
     }
-    interface Candidate {
+    interface GoogleCloudAiplatformV1beta1Candidate {
       /** Output only. Source attribution of the generated content. */
-      citationMetadata?: CitationMetadata;
+      citationMetadata?: GoogleCloudAiplatformV1beta1CitationMetadata;
       /** Output only. Content parts of the candidate. */
-      content?: Content;
+      content?: GoogleCloudAiplatformV1beta1Content;
       /** Output only. Describes the reason the mode stopped generating tokens in more detail. This is only filled when `finish_reason` is set. */
@@ -50,9 +58,9 @@ finishMessage?: string;
       /** Output only. Metadata specifies sources used to ground generated content. */
-      groundingMetadata?: GroundingMetadata;
+      groundingMetadata?: GoogleCloudAiplatformV1beta1GroundingMetadata;
       /** Output only. Index of the candidate. */
       index?: number;
       /** Output only. List of ratings for the safety of a response candidate. There is at most one rating per category. */
-      safetyRatings?: SafetyRating[];
+      safetyRatings?: GoogleCloudAiplatformV1beta1SafetyRating[];
     }
-    interface Citation {
+    interface GoogleCloudAiplatformV1beta1Citation {
       /** Output only. End index into the content. */
@@ -71,15 +79,15 @@ endIndex?: number;
     }
-    interface CitationMetadata {
+    interface GoogleCloudAiplatformV1beta1CitationMetadata {
       /** Output only. List of citations. */
-      citations?: Citation[];
+      citations?: GoogleCloudAiplatformV1beta1Citation[];
     }
-    interface Content {
+    interface GoogleCloudAiplatformV1beta1Content {
       /** Required. Ordered `Parts` that constitute a single message. Parts may have different IANA MIME types. */
-      parts?: Part[];
+      parts?: GoogleCloudAiplatformV1beta1Part[];
       /** Optional. The producer of the content. Must be either 'user' or 'model'. Useful to set for multi-turn conversations, otherwise can be left blank or unset. */
       role?: string;
     }
-    interface CountTokensRequest {
+    interface GoogleCloudAiplatformV1beta1CountTokensRequest {
       /** Required. Input content. */
-      contents?: Content[];
+      contents?: GoogleCloudAiplatformV1beta1Content[];
       /** Required. The instances that are the input to token counting call. Schema is identical to the prediction schema of the underlying model. */
@@ -90,3 +98,3 @@ instances?: any[];
     }
-    interface CountTokensResponse {
+    interface GoogleCloudAiplatformV1beta1CountTokensResponse {
       /** The total number of billable characters counted across all instances from the request. */
@@ -97,11 +105,3 @@ totalBillableCharacters?: number;
     }
-    interface Date {
-      /** Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. */
-      day?: number;
-      /** Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. */
-      month?: number;
-      /** Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. */
-      year?: number;
-    }
-    interface FileData {
+    interface GoogleCloudAiplatformV1beta1FileData {
       /** Required. URI. */
@@ -112,3 +112,3 @@ fileUri?: string;
     }
-    interface FunctionCall {
+    interface GoogleCloudAiplatformV1beta1FunctionCall {
       /** Optional. Required. The function parameters and values in JSON object format. See [FunctionDeclaration.parameters] for parameter details. */
@@ -119,3 +119,3 @@ args?: {[P in string]: any};
     }
-    interface FunctionCallingConfig {
+    interface GoogleCloudAiplatformV1beta1FunctionCallingConfig {
       /** Optional. Function names to call. Only set when the Mode is ANY. Function names should match [FunctionDeclaration.name]. With mode set to ANY, model will predict a function call from the set of function names provided. */
@@ -126,3 +126,3 @@ allowedFunctionNames?: string[];
     }
-    interface FunctionDeclaration {
+    interface GoogleCloudAiplatformV1beta1FunctionDeclaration {
       /** Optional. Description and purpose of the function. Model uses it to decide how and whether to call the function. */
@@ -133,7 +133,7 @@ description?: string;
       /** Optional. Describes the parameters to this function in JSON Schema Object format. Reflects the Open API 3.03 Parameter Object. string Key: the name of the parameter. Parameter names are case sensitive. Schema Value: the Schema defining the type used for the parameter. For function with no parameters, this can be left unset. Parameter names must start with a letter or an underscore and must only contain chars a-z, A-Z, 0-9, or underscores with a maximum length of 64. Example with 1 required and 1 optional parameter: type: OBJECT properties: param1: type: STRING param2: type: INTEGER required: - param1 */
-      parameters?: Schema;
+      parameters?: GoogleCloudAiplatformV1beta1Schema;
       /** Optional. Describes the output from this function in JSON Schema format. Reflects the Open API 3.03 Response Object. The Schema defines the type used for the response value of the function. */
-      response?: Schema;
+      response?: GoogleCloudAiplatformV1beta1Schema;
     }
-    interface FunctionResponse {
+    interface GoogleCloudAiplatformV1beta1FunctionResponse {
       /** Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. */
@@ -144,27 +144,42 @@ name?: string;
     }
-    interface GenerateContentRequest {
+    interface GoogleCloudAiplatformV1beta1GenerateContentRequest {
       /** 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}` */
       cachedContent?: string;
       /** 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. */
-      contents?: Content[];
+      contents?: GoogleCloudAiplatformV1beta1Content[];
       /** Optional. Generation config. */
-      generationConfig?: GenerationConfig;
+      generationConfig?: GoogleCloudAiplatformV1beta1GenerationConfig;
       /** Optional. Per request settings for blocking unsafe content. Enforced on GenerateContentResponse.candidates. */
-      safetySettings?: SafetySetting[];
+      safetySettings?: GoogleCloudAiplatformV1beta1SafetySetting[];
       /** 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. */
-      systemInstruction?: Content;
+      systemInstruction?: GoogleCloudAiplatformV1beta1Content;
       /** Optional. Tool config. This config is shared for all tools provided in the request. */
-      toolConfig?: ToolConfig;
+      toolConfig?: GoogleCloudAiplatformV1beta1ToolConfig;
       /** 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. */
-      tools?: Tool[];
+      tools?: GoogleCloudAiplatformV1beta1Tool[];
     }
-    interface GenerateContentResponse {
+    interface GoogleCloudAiplatformV1beta1GenerateContentResponse {
       /** Output only. Generated candidates. */
-      candidates?: Candidate[];
+      candidates?: GoogleCloudAiplatformV1beta1Candidate[];
       /** Output only. Content filter results for a prompt sent in the request. Note: Sent only in the first stream chunk. Only happens when no candidates were generated due to content violations. */
-      promptFeedback?: PromptFeedback;
+      promptFeedback?: GoogleCloudAiplatformV1beta1GenerateContentResponsePromptFeedback;
       /** Usage metadata about the response(s). */
-      usageMetadata?: UsageMetadata;
+      usageMetadata?: GoogleCloudAiplatformV1beta1GenerateContentResponseUsageMetadata;
     }
-    interface GenerationConfig {
+    interface GoogleCloudAiplatformV1beta1GenerateContentResponsePromptFeedback {
+      /** Output only. Blocked reason. */
+      blockReason?: string;
+      /** Output only. A readable block reason message. */
+      blockReasonMessage?: string;
+      /** Output only. Safety ratings. */
+      safetyRatings?: GoogleCloudAiplatformV1beta1SafetyRating[];
+    }
+    interface GoogleCloudAiplatformV1beta1GenerateContentResponseUsageMetadata {
+      /** Number of tokens in the response(s). */
+      candidatesTokenCount?: number;
+      /** Number of tokens in the request. */
+      promptTokenCount?: number;
+      totalTokenCount?: number;
+    }
+    interface GoogleCloudAiplatformV1beta1GenerationConfig {
       /** Optional. Number of candidates to generate. */
@@ -181,3 +196,3 @@ candidateCount?: number;
       /** Optional. The `Schema` object allows the definition of input and output data types. These types can be objects, but also primitives and arrays. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema). If set, a compatible response_mime_type must also be set. Compatible mimetypes: `application/json`: Schema for JSON response. */
-      responseSchema?: Schema;
+      responseSchema?: GoogleCloudAiplatformV1beta1Schema;
       /** Optional. Stop sequences. */
@@ -192,53 +207,34 @@ stopSequences?: string[];
     }
-    interface GoogleSearchRetrieval {}
-    interface GroundingMetadata {
+    interface GoogleCloudAiplatformV1beta1GoogleSearchRetrieval {}
+    interface GoogleCloudAiplatformV1beta1GroundingMetadata {
       /** Optional. Queries executed by the retrieval tools. */
       retrievalQueries?: string[];
       /** Optional. Google search entry for the following-up web searches. */
-      searchEntryPoint?: SearchEntryPoint;
+      searchEntryPoint?: GoogleCloudAiplatformV1beta1SearchEntryPoint;
       /** Optional. Web search queries for the following-up web search. */
       webSearchQueries?: string[];
     }
-    interface ModelOperationMetadata {
-      basicOperationStatus?: string;
-      /** The name of the model we are creating/updating The name must have the form `projects/{project_id}/models/{model_id}` */
-      name?: string;
-    }
-    interface Part {
+    interface GoogleCloudAiplatformV1beta1Part {
       /** Optional. URI based data. */
-      fileData?: FileData;
+      fileData?: GoogleCloudAiplatformV1beta1FileData;
       /** Optional. A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] with the parameters and their values. */
-      functionCall?: FunctionCall;
+      functionCall?: GoogleCloudAiplatformV1beta1FunctionCall;
       /** Optional. The result output of a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function call. It is used as context to the model. */
-      functionResponse?: FunctionResponse;
+      functionResponse?: GoogleCloudAiplatformV1beta1FunctionResponse;
       /** Optional. Inlined bytes data. */
-      inlineData?: Blob;
+      inlineData?: GoogleCloudAiplatformV1beta1Blob;
       /** Optional. Text part (can be code). */
       text?: string;
       /** Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. */
-      videoMetadata?: VideoMetadata;
+      videoMetadata?: GoogleCloudAiplatformV1beta1VideoMetadata;
     }
-    interface PromptFeedback {
-      /** Output only. Blocked reason. */
-      blockReason?: string;
-      /** Output only. A readable block reason message. */
-      blockReasonMessage?: string;
-      /** Output only. Safety ratings. */
-      safetyRatings?: SafetyRating[];
-    }
-    interface RagResource {
-      /** Optional. RagCorpora resource name. Format: `projects/{project}/locations/{location}/ragCorpora/{rag_corpus}` */
-      ragCorpus?: string;
-      /** Optional. rag_file_id. The files should be in the same rag_corpus set in rag_corpus field. */
-      ragFileIds?: string[];
-    }
-    interface Retrieval {
+    interface GoogleCloudAiplatformV1beta1Retrieval {
       /** Optional. Disable using the result from this tool in detecting grounding attribution. This does not affect how the result is given to the model for generation. */
       disableAttribution?: boolean;
       /** Set to use data source powered by Vertex AI Search. */
-      vertexAiSearch?: VertexAISearch;
+      vertexAiSearch?: GoogleCloudAiplatformV1beta1VertexAISearch;
       /** Set to use data source powered by Vertex RAG store. User data is uploaded via the VertexRagDataService. */
-      vertexRagStore?: VertexRagStore;
+      vertexRagStore?: GoogleCloudAiplatformV1beta1VertexRagStore;
     }
-    interface SafetyRating {
+    interface GoogleCloudAiplatformV1beta1SafetyRating {
       /** Output only. Indicates whether the content was filtered out because of this rating. */
@@ -257,3 +253,3 @@ blocked?: boolean;
     }
-    interface SafetySetting {
+    interface GoogleCloudAiplatformV1beta1SafetySetting {
       /** Required. Harm category. */
@@ -266,3 +262,3 @@ category?: string;
     }
-    interface Schema {
+    interface GoogleCloudAiplatformV1beta1Schema {
       /** Optional. Default value of the data. */
@@ -279,3 +275,3 @@ default?: any;
       /** Optional. SCHEMA FIELDS FOR TYPE ARRAY Schema of the elements of Type.ARRAY. */
-      items?: Schema;
+      items?: GoogleCloudAiplatformV1beta1Schema;
       /** Optional. Maximum value of the Type.INTEGER and Type.NUMBER */
@@ -302,3 +298,3 @@ maximum?: number;
       /** Optional. SCHEMA FIELDS FOR TYPE OBJECT Properties of Type.OBJECT. */
-      properties?: {[P in string]: Schema};
+      properties?: {[P in string]: GoogleCloudAiplatformV1beta1Schema};
       /** Optional. Required properties of Type.OBJECT. */
@@ -311,3 +307,3 @@ required?: string[];
     }
-    interface SearchEntryPoint {
+    interface GoogleCloudAiplatformV1beta1SearchEntryPoint {
       /** Optional. Web content snippet that can be embedded in a web page or an app webview. */
@@ -318,30 +314,23 @@ renderedContent?: string;
     }
-    interface Tool {
+    interface GoogleCloudAiplatformV1beta1Tool {
       /** Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 64 function declarations can be provided. */
-      functionDeclarations?: FunctionDeclaration[];
+      functionDeclarations?: GoogleCloudAiplatformV1beta1FunctionDeclaration[];
       /** Optional. GoogleSearchRetrieval tool type. Specialized retrieval tool that is powered by Google search. */
       googleSearchRetrieval?: any;
       /** Optional. Retrieval tool type. System will always execute the provided retrieval tool(s) to get external knowledge to answer the prompt. Retrieval results are presented to the model for generation. */
-      retrieval?: Retrieval;
+      retrieval?: GoogleCloudAiplatformV1beta1Retrieval;
     }
-    interface ToolConfig {
+    interface GoogleCloudAiplatformV1beta1ToolConfig {
       /** Optional. Function calling config. */
-      functionCallingConfig?: FunctionCallingConfig;
+      functionCallingConfig?: GoogleCloudAiplatformV1beta1FunctionCallingConfig;
     }
-    interface UsageMetadata {
-      /** Number of tokens in the response(s). */
-      candidatesTokenCount?: number;
-      /** Number of tokens in the request. */
-      promptTokenCount?: number;
-      totalTokenCount?: number;
-    }
-    interface VertexAISearch {
+    interface GoogleCloudAiplatformV1beta1VertexAISearch {
       /** Required. Fully-qualified Vertex AI Search's datastore resource ID. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}` */
       datastore?: string;
     }
-    interface VertexRagStore {
+    interface GoogleCloudAiplatformV1beta1VertexRagStore {
       /** Optional. Deprecated. Please use rag_resources instead. */
       ragCorpora?: string[];
       /** Optional. The representation of the rag source. It can be used to specify corpus only or ragfiles. Currently only support one corpus or multiple files from one corpus. In the future we may open up multiple corpora support. */
-      ragResources?: RagResource[];
+      ragResources?: GoogleCloudAiplatformV1beta1VertexRagStoreRagResource[];
       /** Optional. Number of top k results to return from the selected corpora. */
@@ -352,3 +341,9 @@ similarityTopK?: number;
     }
-    interface VideoMetadata {
+    interface GoogleCloudAiplatformV1beta1VertexRagStoreRagResource {
+      /** Optional. RagCorpora resource name. Format: `projects/{project}/locations/{location}/ragCorpora/{rag_corpus}` */
+      ragCorpus?: string;
+      /** Optional. rag_file_id. The files should be in the same rag_corpus set in rag_corpus field. */
+      ragFileIds?: string[];
+    }
+    interface GoogleCloudAiplatformV1beta1VideoMetadata {
       /** Optional. The end offset of the video. */
@@ -359,2 +354,7 @@ endOffset?: string;
     }
+    interface ModelOperationMetadata {
+      basicOperationStatus?: string;
+      /** The name of the model we are creating/updating The name must have the form `projects/{project_id}/models/{model_id}` */
+      name?: string;
+    }
     interface ModelsResource {
@@ -388,4 +388,4 @@ /** Perform a token counting. */
         /** Request body */
-        resource: CountTokensRequest;
-      }): Request<CountTokensResponse>;
+        resource: GoogleCloudAiplatformV1beta1CountTokensRequest;
+      }): Request<GoogleCloudAiplatformV1beta1CountTokensResponse>;
       countTokens(
@@ -418,4 +418,4 @@ request: {
         },
-        body: CountTokensRequest
-      ): Request<CountTokensResponse>;
+        body: GoogleCloudAiplatformV1beta1CountTokensRequest
+      ): Request<GoogleCloudAiplatformV1beta1CountTokensResponse>;
       /** Generate content with multimodal inputs. */
@@ -448,4 +448,4 @@ generateContent(request: {
         /** Request body */
-        resource: GenerateContentRequest;
-      }): Request<GenerateContentResponse>;
+        resource: GoogleCloudAiplatformV1beta1GenerateContentRequest;
+      }): Request<GoogleCloudAiplatformV1beta1GenerateContentResponse>;
       generateContent(
@@ -478,4 +478,4 @@ request: {
         },
-        body: GenerateContentRequest
-      ): Request<GenerateContentResponse>;
+        body: GoogleCloudAiplatformV1beta1GenerateContentRequest
+      ): Request<GoogleCloudAiplatformV1beta1GenerateContentResponse>;
       /** Generate content with multimodal inputs with streaming support. */
@@ -508,4 +508,4 @@ streamGenerateContent(request: {
         /** Request body */
-        resource: GenerateContentRequest;
-      }): Request<GenerateContentResponse>;
+        resource: GoogleCloudAiplatformV1beta1GenerateContentRequest;
+      }): Request<GoogleCloudAiplatformV1beta1GenerateContentResponse>;
       streamGenerateContent(
@@ -538,4 +538,4 @@ request: {
         },
-        body: GenerateContentRequest
-      ): Request<GenerateContentResponse>;
+        body: GoogleCloudAiplatformV1beta1GenerateContentRequest
+      ): Request<GoogleCloudAiplatformV1beta1GenerateContentResponse>;
     }
@@ -542,0 +542,0 @@ interface PublishersResource {

package.json

 {
   "name": "@maxim_mazurok/gapi.client.firebaseml-v2beta",
-  "version": "0.0.20240610",
+  "version": "0.0.20240611",
   "description": "TypeScript typings for Firebase ML API v2beta",
@@ -5,0 +5,0 @@ "repository": {

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

32807

increased by7.45%

No dependency changes