@maxim_mazurok/gapi.client.aiplatform-v1beta1 0.0.20241001 → 0.0.20241007

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/index.d.ts +186 -3
  2. package/package.json +1 -1
package/index.d.ts CHANGED
@@ -9,7 +9,7 @@
9
9
  // This file was generated by https://github.com/Maxim-Mazurok/google-api-typings-generator. Please do not edit it manually.
10
10
  // In case of any problems please post issue to https://github.com/Maxim-Mazurok/google-api-typings-generator
11
11
  // Generated from: https://aiplatform.googleapis.com/$discovery/rest?version=v1beta1
12
- // Revision: 20241001
12
+ // Revision: 20241007
13
13
 
14
14
  /// <reference types="gapi.client" />
15
15
 
@@ -45,6 +45,8 @@ declare namespace gapi.client {
45
45
  image?: string;
46
46
  /** RAI scores for generated image. */
47
47
  imageRaiScores?: CloudAiLargeModelsVisionImageRAIScores;
48
+ /** Image size. The size of the image. Can be self reported, or computed from the image bytes. */
49
+ imageSize?: CloudAiLargeModelsVisionImageImageSize;
48
50
  /** RAI info for image. */
49
51
  raiInfo?: CloudAiLargeModelsVisionRaiInfo;
50
52
  /** Semantic filter info for image. */
@@ -54,6 +56,11 @@ declare namespace gapi.client {
54
56
  /** Path to another storage (typically Google Cloud Storage). */
55
57
  uri?: string;
56
58
  }
59
+ interface CloudAiLargeModelsVisionImageImageSize {
60
+ channels?: number;
61
+ height?: number;
62
+ width?: number;
63
+ }
57
64
  interface CloudAiLargeModelsVisionImageRAIScores {
58
65
  /** Agile watermark score for image. */
59
66
  agileWatermarkDetectionScore?: number;
@@ -1103,6 +1110,8 @@ declare namespace gapi.client {
1103
1110
  persistentResourceId?: string;
1104
1111
  /** The ID of the location to store protected artifacts. e.g. us-central1. Populate only when the location is different than CustomJob location. List of supported locations: https://cloud.google.com/vertex-ai/docs/general/locations */
1105
1112
  protectedArtifactLocationId?: string;
1113
+ /** Optional. Configuration for PSC-I for CustomJob. */
1114
+ pscInterfaceConfig?: GoogleCloudAiplatformV1beta1PscInterfaceConfig;
1106
1115
  /** Optional. A list of names for the reserved ip ranges under the VPC network that can be used for this job. If set, we will deploy the job within the provided ip ranges. Otherwise, the job will be deployed to any ip ranges under the provided VPC network. Example: ['vertex-ai-ip-range']. */
1107
1116
  reservedIpRanges?: string[];
1108
1117
  /** Scheduling options for a CustomJob. */
@@ -2533,6 +2542,8 @@ declare namespace gapi.client {
2533
2542
  syncSummary?: GoogleCloudAiplatformV1beta1FeatureViewSyncSyncSummary;
2534
2543
  }
2535
2544
  interface GoogleCloudAiplatformV1beta1FeatureViewSyncConfig {
2545
+ /** Optional. If true, syncs the FeatureView in a continuous manner to Online Store. */
2546
+ continuous?: boolean;
2536
2547
  /** Cron schedule (https://en.wikipedia.org/wiki/Cron) to launch scheduled runs. To explicitly set a timezone to the cron tab, apply a prefix in the cron tab: "CRON_TZ=${IANA_TIME_ZONE}" or "TZ=${IANA_TIME_ZONE}". The ${IANA_TIME_ZONE} may only be a valid string from IANA time zone database. For example, "CRON_TZ=America/New_York 1 * * * *", or "TZ=America/New_York 1 * * * *". */
2537
2548
  cron?: string;
2538
2549
  }
@@ -2822,6 +2833,8 @@ declare namespace gapi.client {
2822
2833
  raiMediaFilteredReasons?: string[];
2823
2834
  }
2824
2835
  interface GoogleCloudAiplatformV1beta1GenerationConfig {
2836
+ /** Optional. If enabled, audio timestamp will be included in the request to the model. */
2837
+ audioTimestamp?: boolean;
2825
2838
  /** Optional. Number of candidates to generate. */
2826
2839
  candidateCount?: number;
2827
2840
  /** Optional. Frequency penalties. */
@@ -5066,6 +5079,8 @@ declare namespace gapi.client {
5066
5079
  pipelineTaskRerunConfigs?: GoogleCloudAiplatformV1beta1PipelineTaskRerunConfig[];
5067
5080
  /** Optional. Whether to do component level validations before job creation. */
5068
5081
  preflightValidations?: boolean;
5082
+ /** Optional. Configuration for PSC-I for PipelineJob. */
5083
+ pscInterfaceConfig?: GoogleCloudAiplatformV1beta1PscInterfaceConfig;
5069
5084
  /** A list of names for the reserved ip ranges under the VPC network that can be used for this Pipeline Job's workload. If set, we will deploy the Pipeline Job's workload within the provided ip ranges. Otherwise, the job will be deployed to any ip ranges under the provided VPC network. Example: ['vertex-ai-ip-range']. */
5070
5085
  reservedIpRanges?: string[];
5071
5086
  /** Runtime config of the pipeline. */
@@ -6323,7 +6338,7 @@ declare namespace gapi.client {
6323
6338
  default?: any;
6324
6339
  /** Optional. The description of the data. */
6325
6340
  description?: string;
6326
- /** Optional. Possible values of the element of Type.STRING with enum format. For example we can define an Enum Direction as : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]} */
6341
+ /** Optional. Possible values of the element of primitive type with enum format. Examples: 1. We can define direction as : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]} 2. We can define apartment number as : {type:INTEGER, format:enum, enum:["101", "201", "301"]} */
6327
6342
  enum?: string[];
6328
6343
  /** Optional. Example of the object. Will only populated when the object is the root. */
6329
6344
  example?: any;
@@ -6802,6 +6817,22 @@ declare namespace gapi.client {
6802
6817
  /** Error status. This will be serialized into the enum name e.g. "NOT_FOUND". */
6803
6818
  status?: string;
6804
6819
  }
6820
+ interface GoogleCloudAiplatformV1beta1SchemaPredictParamsGroundingConfig {
6821
+ /** If set, skip finding claim attributions (i.e not generate grounding citation). */
6822
+ disableAttribution?: boolean;
6823
+ /** The sources for the grounding checking. */
6824
+ sources?: GoogleCloudAiplatformV1beta1SchemaPredictParamsGroundingConfigSourceEntry[];
6825
+ }
6826
+ interface GoogleCloudAiplatformV1beta1SchemaPredictParamsGroundingConfigSourceEntry {
6827
+ /** The uri of the Vertex AI Search data source. Deprecated. Use vertex_ai_search_datastore instead. */
6828
+ enterpriseDatastore?: string;
6829
+ /** The grounding text passed inline with the Predict API. It can support up to 1 million bytes. */
6830
+ inlineContext?: string;
6831
+ /** The type of the grounding checking source. */
6832
+ type?: string;
6833
+ /** The uri of the Vertex AI Search data source. */
6834
+ vertexAiSearchDatastore?: string;
6835
+ }
6805
6836
  interface GoogleCloudAiplatformV1beta1SchemaPredictParamsImageClassificationPredictionParams {
6806
6837
  /** The Model only returns predictions with at least this confidence score. Default value is 0.0 */
6807
6838
  confidenceThreshold?: number;
@@ -6973,6 +7004,62 @@ declare namespace gapi.client {
6973
7004
  /** The topmost coordinate of the bounding box. */
6974
7005
  yMin?: number;
6975
7006
  }
7007
+ interface GoogleCloudAiplatformV1beta1SchemaPromptApiSchema {
7008
+ /** The Schema version that represents changes to the API behavior. */
7009
+ apiSchemaVersion?: string;
7010
+ /** A list of execution instances for constructing a ready-to-use prompt. */
7011
+ executions?: GoogleCloudAiplatformV1beta1SchemaPromptInstancePromptExecution[];
7012
+ /** Multimodal prompt which embeds preambles to prompt string. */
7013
+ multimodalPrompt?: GoogleCloudAiplatformV1beta1SchemaPromptSpecMultimodalPrompt;
7014
+ /** The prompt variation that stores preambles in separate fields. */
7015
+ structuredPrompt?: GoogleCloudAiplatformV1beta1SchemaPromptSpecStructuredPrompt;
7016
+ }
7017
+ interface GoogleCloudAiplatformV1beta1SchemaPromptInstancePromptExecution {
7018
+ /** Maps variable names to their value. */
7019
+ arguments?: {
7020
+ [P in string]: GoogleCloudAiplatformV1beta1SchemaPromptInstanceVariableValue;
7021
+ };
7022
+ }
7023
+ interface GoogleCloudAiplatformV1beta1SchemaPromptInstanceVariableValue {
7024
+ /** The parts of the variable value. */
7025
+ partList?: GoogleCloudAiplatformV1beta1SchemaPromptSpecPartList;
7026
+ }
7027
+ interface GoogleCloudAiplatformV1beta1SchemaPromptSpecMultimodalPrompt {
7028
+ /** The prompt message. */
7029
+ promptMessage?: GoogleCloudAiplatformV1beta1SchemaPromptSpecPromptMessage;
7030
+ }
7031
+ interface GoogleCloudAiplatformV1beta1SchemaPromptSpecPartList {
7032
+ /** A list of elements that can be part of a prompt. */
7033
+ parts?: GoogleCloudAiplatformV1beta1Part[];
7034
+ }
7035
+ interface GoogleCloudAiplatformV1beta1SchemaPromptSpecPromptMessage {
7036
+ /** 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. */
7037
+ contents?: GoogleCloudAiplatformV1beta1Content[];
7038
+ /** Generation config. */
7039
+ generationConfig?: GoogleCloudAiplatformV1beta1GenerationConfig;
7040
+ /** The model name. */
7041
+ model?: string;
7042
+ /** Per request settings for blocking unsafe content. Enforced on GenerateContentResponse.candidates. */
7043
+ safetySettings?: GoogleCloudAiplatformV1beta1SafetySetting[];
7044
+ /** 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. */
7045
+ systemInstruction?: GoogleCloudAiplatformV1beta1Content;
7046
+ /** Tool config. This config is shared for all tools provided in the request. */
7047
+ toolConfig?: GoogleCloudAiplatformV1beta1ToolConfig;
7048
+ /** 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. */
7049
+ tools?: GoogleCloudAiplatformV1beta1Tool[];
7050
+ }
7051
+ interface GoogleCloudAiplatformV1beta1SchemaPromptSpecStructuredPrompt {
7052
+ /** Preamble: The context of the prompt. */
7053
+ context?: GoogleCloudAiplatformV1beta1Content;
7054
+ /** Preamble: A set of examples for expected model response. */
7055
+ examples?: GoogleCloudAiplatformV1beta1SchemaPromptSpecPartList[];
7056
+ /** Preamble: The input prefixes before each example input. */
7057
+ inputPrefixes?: string[];
7058
+ /** Preamble: The output prefixes before each example output. */
7059
+ outputPrefixes?: string[];
7060
+ /** The prompt message. */
7061
+ promptMessage?: GoogleCloudAiplatformV1beta1SchemaPromptSpecPromptMessage;
7062
+ }
6976
7063
  interface GoogleCloudAiplatformV1beta1SchemaTablesDatasetMetadata {
6977
7064
  inputConfig?: GoogleCloudAiplatformV1beta1SchemaTablesDatasetMetadataInputConfig;
6978
7065
  }
@@ -7012,6 +7099,44 @@ declare namespace gapi.client {
7012
7099
  /** The segment of the text content. */
7013
7100
  textSegment?: GoogleCloudAiplatformV1beta1SchemaTextSegment;
7014
7101
  }
7102
+ interface GoogleCloudAiplatformV1beta1SchemaTextPromptDatasetMetadata {
7103
+ /** Number of candidates. */
7104
+ candidateCount?: string;
7105
+ /** The Google Cloud Storage URI that stores the prompt data. */
7106
+ gcsUri?: string;
7107
+ /** Grounding checking configuration. */
7108
+ groundingConfig?: GoogleCloudAiplatformV1beta1SchemaPredictParamsGroundingConfig;
7109
+ /** Whether the prompt dataset has prompt variable. */
7110
+ hasPromptVariable?: boolean;
7111
+ /** Whether or not the user has enabled logit probabilities in the model parameters. */
7112
+ logprobs?: boolean;
7113
+ /** Value of the maximum number of tokens generated set when the dataset was saved. */
7114
+ maxOutputTokens?: string;
7115
+ /** User-created prompt note. Note size limit is 2KB. */
7116
+ note?: string;
7117
+ /** The API schema of the prompt to support both UI and SDK usages. */
7118
+ promptApiSchema?: GoogleCloudAiplatformV1beta1SchemaPromptApiSchema;
7119
+ /** Type of the prompt dataset. */
7120
+ promptType?: string;
7121
+ /** Seeding enables model to return a deterministic response on a best effort basis. Determinism isn't guaranteed. This field determines whether or not seeding is enabled. */
7122
+ seedEnabled?: boolean;
7123
+ /** The actual value of the seed. */
7124
+ seedValue?: string;
7125
+ /** Customized stop sequences. */
7126
+ stopSequences?: string[];
7127
+ /** The content of the prompt dataset system instruction. */
7128
+ systemInstruction?: string;
7129
+ /** The Google Cloud Storage URI that stores the system instruction, starting with gs://. */
7130
+ systemInstructionGcsUri?: string;
7131
+ /** Temperature value used for sampling set when the dataset was saved. This value is used to tune the degree of randomness. */
7132
+ temperature?: number;
7133
+ /** The content of the prompt dataset. */
7134
+ text?: string;
7135
+ /** Top K value set when the dataset was saved. This value determines how many candidates with highest probability from the vocab would be selected for each decoding step. */
7136
+ topK?: string;
7137
+ /** Top P value set when the dataset was saved. Given topK tokens for decoding, top candidates will be selected until the sum of their probabilities is topP. */
7138
+ topP?: number;
7139
+ }
7015
7140
  interface GoogleCloudAiplatformV1beta1SchemaTextSegment {
7016
7141
  /** The text content in the segment for output only. */
7017
7142
  content?: string;
@@ -8546,7 +8671,7 @@ declare namespace gapi.client {
8546
8671
  toolParameterKvMatchMetricValues?: GoogleCloudAiplatformV1beta1ToolParameterKVMatchMetricValue[];
8547
8672
  }
8548
8673
  interface GoogleCloudAiplatformV1beta1ToolParameterKVMatchSpec {
8549
- /** Optional. Whether to use STRCIT string match on parameter values. */
8674
+ /** Optional. Whether to use STRICT string match on parameter values. */
8550
8675
  useStrictStringMatch?: boolean;
8551
8676
  }
8552
8677
  interface GoogleCloudAiplatformV1beta1ToolUseExample {
@@ -15633,6 +15758,64 @@ declare namespace gapi.client {
15633
15758
  }): Request<GoogleLongrunningOperation>;
15634
15759
  }
15635
15760
  interface FeaturesResource {
15761
+ /** Creates a batch of Features in a given FeatureGroup. */
15762
+ batchCreate(request: {
15763
+ /** V1 error format. */
15764
+ '$.xgafv'?: string;
15765
+ /** OAuth access token. */
15766
+ access_token?: string;
15767
+ /** Data format for response. */
15768
+ alt?: string;
15769
+ /** JSONP */
15770
+ callback?: string;
15771
+ /** Selector specifying which fields to include in a partial response. */
15772
+ fields?: string;
15773
+ /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
15774
+ key?: string;
15775
+ /** OAuth 2.0 token for the current user. */
15776
+ oauth_token?: string;
15777
+ /** Required. The resource name of the EntityType/FeatureGroup to create the batch of Features under. Format: `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}` `projects/{project}/locations/{location}/featureGroups/{feature_group}` */
15778
+ parent: string;
15779
+ /** Returns response with indentations and line breaks. */
15780
+ prettyPrint?: boolean;
15781
+ /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
15782
+ quotaUser?: string;
15783
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
15784
+ upload_protocol?: string;
15785
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
15786
+ uploadType?: string;
15787
+ /** Request body */
15788
+ resource: GoogleCloudAiplatformV1beta1BatchCreateFeaturesRequest;
15789
+ }): Request<GoogleLongrunningOperation>;
15790
+ batchCreate(
15791
+ request: {
15792
+ /** V1 error format. */
15793
+ '$.xgafv'?: string;
15794
+ /** OAuth access token. */
15795
+ access_token?: string;
15796
+ /** Data format for response. */
15797
+ alt?: string;
15798
+ /** JSONP */
15799
+ callback?: string;
15800
+ /** Selector specifying which fields to include in a partial response. */
15801
+ fields?: string;
15802
+ /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
15803
+ key?: string;
15804
+ /** OAuth 2.0 token for the current user. */
15805
+ oauth_token?: string;
15806
+ /** Required. The resource name of the EntityType/FeatureGroup to create the batch of Features under. Format: `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}` `projects/{project}/locations/{location}/featureGroups/{feature_group}` */
15807
+ parent: string;
15808
+ /** Returns response with indentations and line breaks. */
15809
+ prettyPrint?: boolean;
15810
+ /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
15811
+ quotaUser?: string;
15812
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
15813
+ upload_protocol?: string;
15814
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
15815
+ uploadType?: string;
15816
+ },
15817
+ body: GoogleCloudAiplatformV1beta1BatchCreateFeaturesRequest
15818
+ ): Request<GoogleLongrunningOperation>;
15636
15819
  /** Creates a new Feature in a given FeatureGroup. */
15637
15820
  create(request: {
15638
15821
  /** V1 error format. */
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@maxim_mazurok/gapi.client.aiplatform-v1beta1",
3
- "version": "0.0.20241001",
3
+ "version": "0.0.20241007",
4
4
  "description": "TypeScript typings for Vertex AI API v1beta1",
5
5
  "repository": {
6
6
  "type": "git",