@googleapis/discoveryengine 29.0.0 → 31.0.0
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.
- package/CHANGELOG.md +22 -0
- package/build/tsconfig.tsbuildinfo +1 -1
- package/build/v1.d.ts +1033 -38
- package/build/v1.js +32 -0
- package/build/v1.js.map +1 -1
- package/build/v1alpha.d.ts +3048 -230
- package/build/v1alpha.js +741 -105
- package/build/v1alpha.js.map +1 -1
- package/build/v1beta.d.ts +849 -30
- package/build/v1beta.js +32 -0
- package/build/v1beta.js.map +1 -1
- package/package.json +1 -1
- package/v1.ts +1197 -198
- package/v1alpha.ts +5098 -732
- package/v1beta.ts +1014 -192
package/build/v1beta.d.ts
CHANGED
|
@@ -690,6 +690,283 @@ export declare namespace discoveryengine_v1beta {
|
|
|
690
690
|
[key: string]: string;
|
|
691
691
|
} | null;
|
|
692
692
|
}
|
|
693
|
+
/**
|
|
694
|
+
* Evaluation insights for a program.
|
|
695
|
+
*/
|
|
696
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaAlphaEvolveEvaluationInsights {
|
|
697
|
+
/**
|
|
698
|
+
* Optional. List of evaluation insights.
|
|
699
|
+
*/
|
|
700
|
+
insights?: Schema$GoogleCloudDiscoveryengineV1alphaAlphaEvolveEvaluationInsightsAlphaEvolveEvaluationInsight[];
|
|
701
|
+
}
|
|
702
|
+
/**
|
|
703
|
+
* A single evaluation insight.
|
|
704
|
+
*/
|
|
705
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaAlphaEvolveEvaluationInsightsAlphaEvolveEvaluationInsight {
|
|
706
|
+
/**
|
|
707
|
+
* Optional. Label of the insight.
|
|
708
|
+
*/
|
|
709
|
+
label?: string | null;
|
|
710
|
+
/**
|
|
711
|
+
* Optional. Text of the insight.
|
|
712
|
+
*/
|
|
713
|
+
text?: string | null;
|
|
714
|
+
}
|
|
715
|
+
/**
|
|
716
|
+
* Contains the evaluation scores for the target metrics to optimize.
|
|
717
|
+
*/
|
|
718
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaAlphaEvolveEvaluationScores {
|
|
719
|
+
/**
|
|
720
|
+
* Required. List of evaluation scores.
|
|
721
|
+
*/
|
|
722
|
+
scores?: Schema$GoogleCloudDiscoveryengineV1alphaAlphaEvolveEvaluationScoresAlphaEvolveEvaluationScore[];
|
|
723
|
+
}
|
|
724
|
+
/**
|
|
725
|
+
* Score for a single metric.
|
|
726
|
+
*/
|
|
727
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaAlphaEvolveEvaluationScoresAlphaEvolveEvaluationScore {
|
|
728
|
+
/**
|
|
729
|
+
* Required. Name of the metric.
|
|
730
|
+
*/
|
|
731
|
+
metric?: string | null;
|
|
732
|
+
/**
|
|
733
|
+
* Required. Score of a program for this metric.
|
|
734
|
+
*/
|
|
735
|
+
score?: number | null;
|
|
736
|
+
}
|
|
737
|
+
/**
|
|
738
|
+
* An experiment is a single run of the AlphaEvolve agent, an evolutionary coding agent powered by LLM for algorithm discovery and optimization.
|
|
739
|
+
*/
|
|
740
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaAlphaEvolveExperiment {
|
|
741
|
+
/**
|
|
742
|
+
* Required. Experiment configuration.
|
|
743
|
+
*/
|
|
744
|
+
config?: Schema$GoogleCloudDiscoveryengineV1alphaAlphaEvolveExperimentConfig;
|
|
745
|
+
/**
|
|
746
|
+
* Output only. Time when the experiment was created.
|
|
747
|
+
*/
|
|
748
|
+
createTime?: string | null;
|
|
749
|
+
/**
|
|
750
|
+
* Output only. Specifies the name of the seed program used to start the experiment.
|
|
751
|
+
*/
|
|
752
|
+
initialAlphaEvolveProgram?: string | null;
|
|
753
|
+
/**
|
|
754
|
+
* Identifier. The full resource name of the experiment. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}/sessions/{session\}/alphaEvolveExperiments/{alpha_evolve_experiment\}`
|
|
755
|
+
*/
|
|
756
|
+
name?: string | null;
|
|
757
|
+
/**
|
|
758
|
+
* Output only. The state of the experiment.
|
|
759
|
+
*/
|
|
760
|
+
state?: string | null;
|
|
761
|
+
/**
|
|
762
|
+
* Output only. Experiment stats.
|
|
763
|
+
*/
|
|
764
|
+
stats?: Schema$GoogleCloudDiscoveryengineV1alphaAlphaEvolveExperimentStats;
|
|
765
|
+
}
|
|
766
|
+
/**
|
|
767
|
+
* Configuration of an experiment.
|
|
768
|
+
*/
|
|
769
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaAlphaEvolveExperimentConfig {
|
|
770
|
+
/**
|
|
771
|
+
* Optional. Evolution settings for the experiment.
|
|
772
|
+
*/
|
|
773
|
+
evolutionSettings?: Schema$GoogleCloudDiscoveryengineV1alphaAlphaEvolveExperimentConfigEvolutionSettings;
|
|
774
|
+
/**
|
|
775
|
+
* Optional. Generation settings for the experiment, controlling how new program candidates are generated, including things LLM parameters and user-provided context and prompts.
|
|
776
|
+
*/
|
|
777
|
+
generationSettings?: Schema$GoogleCloudDiscoveryengineV1alphaAlphaEvolveExperimentConfigGenerationSettings;
|
|
778
|
+
/**
|
|
779
|
+
* Required. Description of the problem to be solved by the experiment.
|
|
780
|
+
*/
|
|
781
|
+
problemDescription?: string | null;
|
|
782
|
+
/**
|
|
783
|
+
* Required. Primary programming language of the code being optimized.
|
|
784
|
+
*/
|
|
785
|
+
programLanguage?: string | null;
|
|
786
|
+
/**
|
|
787
|
+
* Required. Run settings for the experiment, controlling the overall behavior of the experiment run.
|
|
788
|
+
*/
|
|
789
|
+
runSettings?: Schema$GoogleCloudDiscoveryengineV1alphaAlphaEvolveExperimentConfigRunSettings;
|
|
790
|
+
/**
|
|
791
|
+
* Required. Title of the experiment.
|
|
792
|
+
*/
|
|
793
|
+
title?: string | null;
|
|
794
|
+
}
|
|
795
|
+
/**
|
|
796
|
+
* Evolution settings for the experiment.
|
|
797
|
+
*/
|
|
798
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaAlphaEvolveExperimentConfigEvolutionSettings {
|
|
799
|
+
/**
|
|
800
|
+
* Optional. Parent sampling configuration.
|
|
801
|
+
*/
|
|
802
|
+
parentSamplingConfig?: Schema$GoogleCloudDiscoveryengineV1alphaAlphaEvolveExperimentConfigEvolutionSettingsParentSamplingConfig;
|
|
803
|
+
}
|
|
804
|
+
/**
|
|
805
|
+
* Configuration for parent sampling.
|
|
806
|
+
*/
|
|
807
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaAlphaEvolveExperimentConfigEvolutionSettingsParentSamplingConfig {
|
|
808
|
+
/**
|
|
809
|
+
* Optional. Pareto sampling configuration.
|
|
810
|
+
*/
|
|
811
|
+
paretoSamplingConfig?: Schema$GoogleCloudDiscoveryengineV1alphaAlphaEvolveExperimentConfigEvolutionSettingsParentSamplingConfigParetoSamplingConfig;
|
|
812
|
+
}
|
|
813
|
+
/**
|
|
814
|
+
* Configuration for Pareto sampling.
|
|
815
|
+
*/
|
|
816
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaAlphaEvolveExperimentConfigEvolutionSettingsParentSamplingConfigParetoSamplingConfig {
|
|
817
|
+
/**
|
|
818
|
+
* Optional. Probability [0.0, 1.0] of sampling parent programs from the Pareto frontier instead of normal fitness-based sampling during candidate generation. Useful when optimizing multiple metrics simultaneously. Default 0.0 (disabled). Only effective when evaluation returns multiple metrics in scores_to_optimize.
|
|
819
|
+
*/
|
|
820
|
+
paretoSamplingProbability?: number | null;
|
|
821
|
+
}
|
|
822
|
+
/**
|
|
823
|
+
* Generation settings for the experiment.
|
|
824
|
+
*/
|
|
825
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaAlphaEvolveExperimentConfigGenerationSettings {
|
|
826
|
+
/**
|
|
827
|
+
* Optional. Additional user-provided context to be used during generation.
|
|
828
|
+
*/
|
|
829
|
+
context?: string | null;
|
|
830
|
+
/**
|
|
831
|
+
* Optional. When true, the LLM prompt includes the full program text (both mutable EVOLVE-BLOCK regions and immutable boilerplate). When false (default), only the mutable EVOLVE-BLOCK regions are shown, saving context window.
|
|
832
|
+
*/
|
|
833
|
+
includeFullProgramInPrompt?: boolean | null;
|
|
834
|
+
/**
|
|
835
|
+
* Optional. Per-model configuration. See `ModelConfig` for details. If left unset, the server selects a default model.
|
|
836
|
+
*/
|
|
837
|
+
models?: Schema$GoogleCloudDiscoveryengineV1alphaAlphaEvolveExperimentConfigGenerationSettingsModelConfig[];
|
|
838
|
+
}
|
|
839
|
+
/**
|
|
840
|
+
* Per-model configuration. Mutually exclusive with `model_mixture` and `model`: when `models` is set, both `model_mixture` and `model` must be left unset. The same allowed-model list and at-most-2-models rule as for `model_mixture` apply. In addition, each entry may specify a per-model `temperature` for LLM sampling. Unlike `model_mixture`, weights here are *relative*: only their ratios matter (the server normalizes them), so callers may use any positive numbers without having to ensure they sum to 1.0.
|
|
841
|
+
*/
|
|
842
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaAlphaEvolveExperimentConfigGenerationSettingsModelConfig {
|
|
843
|
+
/**
|
|
844
|
+
* Required. Model name (e.g. `gemini-2.5-flash`, `gemini-3.1-pro-preview`). See `model_mixture` for the list of allowed models.
|
|
845
|
+
*/
|
|
846
|
+
name?: string | null;
|
|
847
|
+
/**
|
|
848
|
+
* Optional. Relative weight for this model in the mixture. Must be a finite, strictly positive value. Weights across all entries are normalized server-side, so they need not sum to 1.0. Defaults to 1.0 when unset, which is convenient when configuring a single model or an even mixture. Some Pro-tier models are capped at most 50% of the total weight; requests violating that cap are rejected with INVALID_ARGUMENT.
|
|
849
|
+
*/
|
|
850
|
+
weight?: number | null;
|
|
851
|
+
}
|
|
852
|
+
/**
|
|
853
|
+
* Run settings for the experiment.
|
|
854
|
+
*/
|
|
855
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaAlphaEvolveExperimentConfigRunSettings {
|
|
856
|
+
/**
|
|
857
|
+
* Required. Maximum number of programs that can be generated in parallel. Must be positive.
|
|
858
|
+
*/
|
|
859
|
+
concurrency?: number | null;
|
|
860
|
+
/**
|
|
861
|
+
* Optional. Maximum duration of the experiment. If unset, defaults to 24 hours.
|
|
862
|
+
*/
|
|
863
|
+
maxDuration?: string | null;
|
|
864
|
+
/**
|
|
865
|
+
* Required. Maximum number of programs to generate during the experiment run. The initial program counts towards this limit. Must be greater than 1.
|
|
866
|
+
*/
|
|
867
|
+
maxPrograms?: number | null;
|
|
868
|
+
}
|
|
869
|
+
/**
|
|
870
|
+
* Stats about the experiment.
|
|
871
|
+
*/
|
|
872
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaAlphaEvolveExperimentStats {
|
|
873
|
+
/**
|
|
874
|
+
* Output only. Number of candidates generated.
|
|
875
|
+
*/
|
|
876
|
+
candidatesCount?: number | null;
|
|
877
|
+
/**
|
|
878
|
+
* Output only. Number of candidates evaluated.
|
|
879
|
+
*/
|
|
880
|
+
evaluatedCandidatesCount?: number | null;
|
|
881
|
+
/**
|
|
882
|
+
* Output only. Number of billed input tokens consumed by the experiment.
|
|
883
|
+
*/
|
|
884
|
+
inputTokenCount?: string | null;
|
|
885
|
+
/**
|
|
886
|
+
* Output only. Number of billed output tokens consumed by the experiment.
|
|
887
|
+
*/
|
|
888
|
+
outputTokenCount?: string | null;
|
|
889
|
+
}
|
|
890
|
+
/**
|
|
891
|
+
* Represents a single program to be used within the context of an AlphaEvolve experiment.
|
|
892
|
+
*/
|
|
893
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaAlphaEvolveProgram {
|
|
894
|
+
/**
|
|
895
|
+
* Optional. Content of the program.
|
|
896
|
+
*/
|
|
897
|
+
content?: Schema$GoogleCloudDiscoveryengineV1alphaAlphaEvolveProgramContent;
|
|
898
|
+
/**
|
|
899
|
+
* Output only. Time when the program was created.
|
|
900
|
+
*/
|
|
901
|
+
createTime?: string | null;
|
|
902
|
+
/**
|
|
903
|
+
* Optional. Evaluation results for the program.
|
|
904
|
+
*/
|
|
905
|
+
evaluation?: Schema$GoogleCloudDiscoveryengineV1alphaAlphaEvolveProgramEvaluation;
|
|
906
|
+
/**
|
|
907
|
+
* Optional. Lock token for the program.
|
|
908
|
+
*/
|
|
909
|
+
lockToken?: string | null;
|
|
910
|
+
/**
|
|
911
|
+
* Identifier. Unique identifier for the program. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}/sessions/{session\}/alphaEvolveExperiments/{alpha_evolve_experiment\}/alphaEvolvePrograms/{alpha_evolve_program\}`
|
|
912
|
+
*/
|
|
913
|
+
name?: string | null;
|
|
914
|
+
/**
|
|
915
|
+
* Output only. Optionally specifies which parent programs this program was evolved from. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}/sessions/{session\}/alphaEvolveExperiments/{alpha_evolve_experiment\}/alphaEvolvePrograms/{alpha_evolve_program\}`
|
|
916
|
+
*/
|
|
917
|
+
parentPrograms?: string[] | null;
|
|
918
|
+
/**
|
|
919
|
+
* Output only. State of the program.
|
|
920
|
+
*/
|
|
921
|
+
state?: string | null;
|
|
922
|
+
}
|
|
923
|
+
/**
|
|
924
|
+
* A self-contained message containing the content of a program. Can represent a collection of files.
|
|
925
|
+
*/
|
|
926
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaAlphaEvolveProgramContent {
|
|
927
|
+
/**
|
|
928
|
+
* Optional. Description of the program.
|
|
929
|
+
*/
|
|
930
|
+
description?: string | null;
|
|
931
|
+
/**
|
|
932
|
+
* Required. A list of source files that make up the overall program.
|
|
933
|
+
*/
|
|
934
|
+
files?: Schema$GoogleCloudDiscoveryengineV1alphaAlphaEvolveSourceFile[];
|
|
935
|
+
}
|
|
936
|
+
/**
|
|
937
|
+
* Evaluation results for a program candidate.
|
|
938
|
+
*/
|
|
939
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaAlphaEvolveProgramEvaluation {
|
|
940
|
+
/**
|
|
941
|
+
* Optional. Represents various insights about the candidate, which are not directly used as optimization target, but that can be used to improve subsequent generations, and as such can be used to construct the evolution prompt.
|
|
942
|
+
*/
|
|
943
|
+
insights?: Schema$GoogleCloudDiscoveryengineV1alphaAlphaEvolveEvaluationInsights;
|
|
944
|
+
/**
|
|
945
|
+
* Optional. Contains the evaluation scores for the target metrics to optimize.
|
|
946
|
+
*/
|
|
947
|
+
scores?: Schema$GoogleCloudDiscoveryengineV1alphaAlphaEvolveEvaluationScores;
|
|
948
|
+
}
|
|
949
|
+
/**
|
|
950
|
+
* A single source file with its path, content and metadata.
|
|
951
|
+
*/
|
|
952
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaAlphaEvolveSourceFile {
|
|
953
|
+
/**
|
|
954
|
+
* Required. The raw content of the file. This is a string and not bytes, because it should be ultimately processed by the LLM as text.
|
|
955
|
+
*/
|
|
956
|
+
content?: string | null;
|
|
957
|
+
/**
|
|
958
|
+
* Optional. Additional description of the file.
|
|
959
|
+
*/
|
|
960
|
+
description?: string | null;
|
|
961
|
+
/**
|
|
962
|
+
* Required. The relative path of the file, including the filename. e.g., "src/main.py", "utils/helpers.js", "README.md"
|
|
963
|
+
*/
|
|
964
|
+
path?: string | null;
|
|
965
|
+
/**
|
|
966
|
+
* Optional. The programming language of the file.
|
|
967
|
+
*/
|
|
968
|
+
programLanguage?: string | null;
|
|
969
|
+
}
|
|
693
970
|
/**
|
|
694
971
|
* Defines an answer.
|
|
695
972
|
*/
|
|
@@ -1406,6 +1683,25 @@ export declare namespace discoveryengine_v1beta {
|
|
|
1406
1683
|
* Required. The supported connector modes for the associated BAP connection.
|
|
1407
1684
|
*/
|
|
1408
1685
|
supportedConnectorModes?: string[] | null;
|
|
1686
|
+
/**
|
|
1687
|
+
* Optional. Custom toolspec overrides for this connection. For Enterprise BAP connectors that support admin-curated tool definitions, this holds the (simplified) per-tool overrides. On Get, populated by the server by merging persisted overrides with live runtime tool definitions and trimming the result for UI consumption. On Update, the supplied value replaces the persisted overrides after server-side validation and merging: the `base_version` field MUST match the server's current base toolspec version (otherwise the request is rejected with a user-facing error directing the admin to re-download the latest tools first).
|
|
1688
|
+
*/
|
|
1689
|
+
toolspecOverride?: Schema$GoogleCloudDiscoveryengineV1alphaBAPConfigToolspecOverride;
|
|
1690
|
+
}
|
|
1691
|
+
/**
|
|
1692
|
+
* Customer-facing view of the admin-curated toolspec for a BAP connection. Holds the (simplified) per-tool definitions surfaced to and editable by the admin in the Discovery Engine UI. Mirrors the shape of the backend `google.cloud.connectorexecution.v1.ToolspecOverride` message, but is intentionally kept as a separate public type so the Discovery Engine API surface can evolve independently of the fed-API surface (AIP-215). Handlers convert between the two via helpers in //cloud/ml/discoveryengine/external_service/v1main/data_connector_service/lib:bap_custom_tool_util.
|
|
1693
|
+
*/
|
|
1694
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaBAPConfigToolspecOverride {
|
|
1695
|
+
/**
|
|
1696
|
+
* Required. Base toolspec version against which `tools` were authored. On Update, MUST match the server's current stable toolspec version for the connection; mismatch is rejected with a user-facing error directing the admin to re-download the latest tools first.
|
|
1697
|
+
*/
|
|
1698
|
+
baseVersion?: string | null;
|
|
1699
|
+
/**
|
|
1700
|
+
* Required. Tool definitions (one Struct per tool) that the admin has customised on top of the base toolspec returned by the fed API. REQUIRED because it is the only user-editable field in the modify API; the request must carry at least one tool.
|
|
1701
|
+
*/
|
|
1702
|
+
tools?: Array<{
|
|
1703
|
+
[key: string]: any;
|
|
1704
|
+
}> | null;
|
|
1409
1705
|
}
|
|
1410
1706
|
/**
|
|
1411
1707
|
* Metadata related to the progress of the SiteSearchEngineService.BatchCreateTargetSites operation. This will be returned by the google.longrunning.Operation.metadata field.
|
|
@@ -2015,6 +2311,10 @@ export declare namespace discoveryengine_v1beta {
|
|
|
2015
2311
|
* Optional. The modes enabled for this connector. Default state is CONNECTOR_MODE_UNSPECIFIED.
|
|
2016
2312
|
*/
|
|
2017
2313
|
connectorModes?: string[] | null;
|
|
2314
|
+
/**
|
|
2315
|
+
* Optional. If set, this value instead of `data_source` is used to fetch the corresponding connector source.
|
|
2316
|
+
*/
|
|
2317
|
+
connectorSourceId?: string | null;
|
|
2018
2318
|
/**
|
|
2019
2319
|
* Output only. The type of connector. Each source can only map to one type. For example, salesforce, confluence and jira have THIRD_PARTY connector type. It is not mutable once set by system.
|
|
2020
2320
|
*/
|
|
@@ -2032,7 +2332,7 @@ export declare namespace discoveryengine_v1beta {
|
|
|
2032
2332
|
*/
|
|
2033
2333
|
dataProtectionPolicy?: Schema$GoogleCloudDiscoveryengineV1alphaDataProtectionPolicy;
|
|
2034
2334
|
/**
|
|
2035
|
-
* Required. The identifier for the data source.
|
|
2335
|
+
* Required. The identifier for the data source. For the full, up-to-date list of supported connectors and their values, see [Connect a third-party data source](https://docs.cloud.google.com/gemini/enterprise/docs/connectors/connect-third-party-data-source#sources-by-launch-stage).
|
|
2036
2336
|
*/
|
|
2037
2337
|
dataSource?: string | null;
|
|
2038
2338
|
/**
|
|
@@ -2099,6 +2399,10 @@ export declare namespace discoveryengine_v1beta {
|
|
|
2099
2399
|
* Output only. The most recent timestamp when this DataConnector was paused, affecting all functionalities such as data synchronization. Pausing a connector has the following effects: - All functionalities, including data synchronization, are halted. - Any ongoing data synchronization job will be canceled. - No future data synchronization runs will be scheduled nor can be triggered.
|
|
2100
2400
|
*/
|
|
2101
2401
|
latestPauseTime?: string | null;
|
|
2402
|
+
/**
|
|
2403
|
+
* Optional. User-facing metadata for the connector. Populated from the connector's generated metadata / registry `ConnectorSource`.
|
|
2404
|
+
*/
|
|
2405
|
+
metadata?: Schema$GoogleCloudDiscoveryengineV1alphaDataConnectorConnectorMetadata;
|
|
2102
2406
|
/**
|
|
2103
2407
|
* Identifier. The full resource name of the Data Connector. Format: `projects/x/locations/x/collections/x/dataConnector`.
|
|
2104
2408
|
*/
|
|
@@ -2107,6 +2411,10 @@ export declare namespace discoveryengine_v1beta {
|
|
|
2107
2411
|
* Defines the scheduled time for the next data synchronization. This field requires hour , minute, and time_zone from the [IANA Time Zone Database](https://www.iana.org/time-zones). This is utilized when the data connector has a refresh interval greater than 1 day. When the hours or minutes are not specified, we will assume a sync time of 0:00. The user must provide a time zone to avoid ambiguity.
|
|
2108
2412
|
*/
|
|
2109
2413
|
nextSyncTime?: Schema$GoogleTypeDateTime;
|
|
2414
|
+
/**
|
|
2415
|
+
* Output only. The static IP addresses used by this connector for OAuth APIs (e.g. end user authentication). These are surfaced separately from `static_ip_addresses` so that customers can apply granular firewall settings for OAuth endpoints. Only populated for connectors that have static IP enabled and are used for actions and/or federated search.
|
|
2416
|
+
*/
|
|
2417
|
+
oauthStaticIpAddresses?: string[] | null;
|
|
2110
2418
|
/**
|
|
2111
2419
|
* Required data connector parameters in structured json format.
|
|
2112
2420
|
*/
|
|
@@ -2149,6 +2457,10 @@ export declare namespace discoveryengine_v1beta {
|
|
|
2149
2457
|
* The data synchronization mode supported by the data connector.
|
|
2150
2458
|
*/
|
|
2151
2459
|
syncMode?: string | null;
|
|
2460
|
+
/**
|
|
2461
|
+
* Optional. Immutable. User-facing, version-independent label for this connector. May be shared by multiple connectors under the same (project, location, collection, data_source); tag-based lookup returns the one with the greatest create_time. Optional at Create time. Agent Designer resolves connectors via (data_source, tag) when set, falling back to the legacy resource-name lookup when unset, so connectors created before the tag-write launch continue to work without a backfill.
|
|
2462
|
+
*/
|
|
2463
|
+
tag?: string | null;
|
|
2152
2464
|
/**
|
|
2153
2465
|
* Output only. Timestamp the DataConnector was last updated.
|
|
2154
2466
|
*/
|
|
@@ -2158,6 +2470,35 @@ export declare namespace discoveryengine_v1beta {
|
|
|
2158
2470
|
*/
|
|
2159
2471
|
vpcscEnabled?: boolean | null;
|
|
2160
2472
|
}
|
|
2473
|
+
/**
|
|
2474
|
+
* User-facing metadata for the connector, shown on the connector detail page (title, description, short_description, author, authenticated_account, note).
|
|
2475
|
+
*/
|
|
2476
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaDataConnectorConnectorMetadata {
|
|
2477
|
+
/**
|
|
2478
|
+
* Optional. The end user's account as authenticated to the connector, so the end user can see which account is connected. May be an email, a username, or any identifier the connector/third party provides.
|
|
2479
|
+
*/
|
|
2480
|
+
authenticatedAccount?: string | null;
|
|
2481
|
+
/**
|
|
2482
|
+
* Optional. The party that authored the connector, e.g. "Google" or a third-party provider name. Lets end users see who authored a connector (future: third-party-authored connectors).
|
|
2483
|
+
*/
|
|
2484
|
+
author?: string | null;
|
|
2485
|
+
/**
|
|
2486
|
+
* Optional. Human-readable description of the connector, shown on the connector detail page. One connector has a single description.
|
|
2487
|
+
*/
|
|
2488
|
+
description?: string | null;
|
|
2489
|
+
/**
|
|
2490
|
+
* Optional. Free-form, multi-line note about the connector's capabilities or a custom note that can be set for the connector.
|
|
2491
|
+
*/
|
|
2492
|
+
note?: string | null;
|
|
2493
|
+
/**
|
|
2494
|
+
* Optional. Short, subtitle-length description of the connector (e.g. shown beneath the connector name in list and detail views).
|
|
2495
|
+
*/
|
|
2496
|
+
shortDescription?: string | null;
|
|
2497
|
+
/**
|
|
2498
|
+
* Optional. Display title of the connector.
|
|
2499
|
+
*/
|
|
2500
|
+
title?: string | null;
|
|
2501
|
+
}
|
|
2161
2502
|
/**
|
|
2162
2503
|
* Any params and credentials used specifically for EUA connectors.
|
|
2163
2504
|
*/
|
|
@@ -2349,6 +2690,10 @@ export declare namespace discoveryengine_v1beta {
|
|
|
2349
2690
|
* Optional. Configuration for `HEALTHCARE_FHIR` vertical.
|
|
2350
2691
|
*/
|
|
2351
2692
|
healthcareFhirConfig?: Schema$GoogleCloudDiscoveryengineV1alphaHealthcareFhirConfig;
|
|
2693
|
+
/**
|
|
2694
|
+
* Output only. Provides the icon URI of the data store's connector source, if this is a connector-backed data store. Empty for data stores without an associated connector source. In DataStoreService.ListDataStores and DataStoreService.GetDataStore, this is only populated when DataStoreView.DATA_STORE_VIEW_FULL is requested via ListDataStoresRequest.view or GetDataStoreRequest.view respectively.
|
|
2695
|
+
*/
|
|
2696
|
+
iconUri?: string | null;
|
|
2352
2697
|
/**
|
|
2353
2698
|
* Immutable. The fully qualified resource name of the associated IdentityMappingStore. This field can only be set for acl_enabled DataStores with `THIRD_PARTY` or `GSUITE` IdP. Format: `projects/{project\}/locations/{location\}/identityMappingStores/{identity_mapping_store\}`.
|
|
2354
2699
|
*/
|
|
@@ -2698,6 +3043,10 @@ export declare namespace discoveryengine_v1beta {
|
|
|
2698
3043
|
* The number of end users under the user store that were successfully deleted.
|
|
2699
3044
|
*/
|
|
2700
3045
|
successCount?: string | null;
|
|
3046
|
+
/**
|
|
3047
|
+
* Operation last update time. If the operation is done, this is also the finish time.
|
|
3048
|
+
*/
|
|
3049
|
+
updateTime?: string | null;
|
|
2701
3050
|
}
|
|
2702
3051
|
/**
|
|
2703
3052
|
* Defines target endpoints used to connect to third-party sources.
|
|
@@ -2921,6 +3270,10 @@ export declare namespace discoveryengine_v1beta {
|
|
|
2921
3270
|
* Optional. Immutable. This the application type which this engine resource represents. NOTE: this is a new concept independ of existing industry vertical or solution type.
|
|
2922
3271
|
*/
|
|
2923
3272
|
appType?: string | null;
|
|
3273
|
+
/**
|
|
3274
|
+
* Output only. The Agent registry containing the agents, MCP servers and tools associated with this engine. Derived server-side from the linked Agent Gateway's registry.
|
|
3275
|
+
*/
|
|
3276
|
+
associatedAgentRegistry?: string | null;
|
|
2924
3277
|
/**
|
|
2925
3278
|
* Configurations for the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT.
|
|
2926
3279
|
*/
|
|
@@ -2964,7 +3317,7 @@ export declare namespace discoveryengine_v1beta {
|
|
|
2964
3317
|
*/
|
|
2965
3318
|
displayName?: string | null;
|
|
2966
3319
|
/**
|
|
2967
|
-
* Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `personalization-suggested-highlights` * `
|
|
3320
|
+
* Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `personalization-suggested-highlights` * `mobile-app-access` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload` * `disable-welcome-emails` * `disable-canvas` * `canvas-workspace` * `disable-skills` * `disable-projects` * `enable-end-user-sharing-with-groups` * `single-agent-orchestration` * `multi-agent-orchestration` * `cross-product-intelligence`
|
|
2968
3321
|
*/
|
|
2969
3322
|
features?: {
|
|
2970
3323
|
[key: string]: string;
|
|
@@ -3225,7 +3578,7 @@ export declare namespace discoveryengine_v1beta {
|
|
|
3225
3578
|
*/
|
|
3226
3579
|
export interface Schema$GoogleCloudDiscoveryengineV1alphaEngineSearchEngineConfig {
|
|
3227
3580
|
/**
|
|
3228
|
-
* Optional. The required subscription tier of this engine.
|
|
3581
|
+
* Optional. The required subscription tier of this engine. If the required subscription tier is search, user with higher license tier like assist can still access the standalone app associated with this engine. Web grounding feature is only available on the app if it is set as SubscriptionTier.SUBSCRIPTION_TIER_SEARCH_AND_ASSISTANT.
|
|
3229
3582
|
*/
|
|
3230
3583
|
requiredSubscriptionTier?: string | null;
|
|
3231
3584
|
/**
|
|
@@ -3390,7 +3743,7 @@ export declare namespace discoveryengine_v1beta {
|
|
|
3390
3743
|
*/
|
|
3391
3744
|
schemaOrgPaths?: string[] | null;
|
|
3392
3745
|
/**
|
|
3393
|
-
* Optional. Specifies the importance of the field when `searchable_option` is `SEARCHABLE_ENABLED`. If `searchable_option` is `SEARCHABLE_DISABLED`, this field is ignored. If `searchable_option` is `SEARCHABLE_ENABLED` and this is `SEARCHABLE_FIELD_IMPORTANCE_UNSPECIFIED`, it behaves as `DEFAULT_IMPORTANCE`.
|
|
3746
|
+
* Optional. Specifies the importance of the field when `searchable_option` is `SEARCHABLE_ENABLED`. If `searchable_option` is `SEARCHABLE_DISABLED`, this field is ignored. If `searchable_option` is `SEARCHABLE_ENABLED` and this is `SEARCHABLE_FIELD_IMPORTANCE_UNSPECIFIED`, it behaves as `DEFAULT_IMPORTANCE`. For more information, see [Weight searchable fields](https://cloud.google.com/generative-ai-app-builder/docs/configure-field-settings#weight-search).
|
|
3394
3747
|
*/
|
|
3395
3748
|
searchableFieldImportance?: string | null;
|
|
3396
3749
|
/**
|
|
@@ -3767,6 +4120,10 @@ export declare namespace discoveryengine_v1beta {
|
|
|
3767
4120
|
* Output only. Whether the license config is for Gemini bundle.
|
|
3768
4121
|
*/
|
|
3769
4122
|
geminiBundle?: boolean | null;
|
|
4123
|
+
/**
|
|
4124
|
+
* Optional. Timestamp of the most recent user-initiated update (seat count change or subscription term change). Unlike `update_time`, this field is only stamped when a customer explicitly updates the license (e.g. via the UI), and is not touched by system-driven writes (subscription pipeline, BALC propagation, etc.).
|
|
4125
|
+
*/
|
|
4126
|
+
lastUserUpdateTime?: string | null;
|
|
3770
4127
|
/**
|
|
3771
4128
|
* Required. Number of licenses purchased.
|
|
3772
4129
|
*/
|
|
@@ -3801,7 +4158,7 @@ export declare namespace discoveryengine_v1beta {
|
|
|
3801
4158
|
*/
|
|
3802
4159
|
filter?: string | null;
|
|
3803
4160
|
/**
|
|
3804
|
-
* A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported fields: * `update_time` * `create_time` * `session_name` * `is_pinned` Example: * `update_time desc` * `create_time` * `is_pinned desc,update_time desc`: list sessions by is_pinned first, then by update_time.
|
|
4161
|
+
* A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported fields: * `update_time` * `create_time` * `session_name` * `is_pinned` * `display_name` Example: * `update_time desc` * `create_time` * `is_pinned desc,update_time desc`: list sessions by is_pinned first, then by update_time.
|
|
3805
4162
|
*/
|
|
3806
4163
|
orderBy?: string | null;
|
|
3807
4164
|
/**
|
|
@@ -3942,6 +4299,10 @@ export declare namespace discoveryengine_v1beta {
|
|
|
3942
4299
|
* Represents the currently effective configurable billing parameters. These values are derived from the customer's subscription history stored internally and reflect the thresholds actively being used for billing purposes at the time of the GetProject call. This includes the start_time of the subscription and may differ from the values in `customer_provided_config` due to billing rules (e.g., scale-downs taking effect only at the start of a new month). We also include the update type to indicate the type of update performed on the configurable billing configuration in the UpdateProject operation.
|
|
3943
4300
|
*/
|
|
3944
4301
|
export interface Schema$GoogleCloudDiscoveryengineV1alphaProjectConfigurableBillingStatus {
|
|
4302
|
+
/**
|
|
4303
|
+
* Output only. Per-model Agent Search TPM subscription status.
|
|
4304
|
+
*/
|
|
4305
|
+
agentSearchTokenSubscriptionStatuses?: Schema$GoogleCloudDiscoveryengineV1alphaProjectConfigurableBillingStatusAgentSearchTokenSubscriptionStatus[];
|
|
3945
4306
|
/**
|
|
3946
4307
|
* Optional. The currently effective Indexing Core threshold. This is the threshold against which Indexing Core usage is compared for overage calculations.
|
|
3947
4308
|
*/
|
|
@@ -3971,6 +4332,35 @@ export declare namespace discoveryengine_v1beta {
|
|
|
3971
4332
|
*/
|
|
3972
4333
|
updateType?: string | null;
|
|
3973
4334
|
}
|
|
4335
|
+
/**
|
|
4336
|
+
* Per-model Agent Search TPM subscription status. One entry per active `core_subscription.agent_search_token_subscriptions[*]` entry in the customer-provided config; populated by UpdateProject and GetProject. The lifecycle scalars on this message (`start_time`, `terminate_time`, `update_type`, `tpm_threshold_next_update_time`) are per (project, model_version) — siblings of the whole-relationship `start_time` / `terminate_time` / `update_type` on the enclosing ConfigurableBillingStatus, but scoped to this specific Agent Search TPM subscription instead of to the overall customer-configurable- pricing relationship. This per-instance granularity is intentional: the underlying SubV3 storage is per-(project, model_version), so each model has its own activation, termination, and deferred-update clock; surfacing that on the response gives customers the granularity they need to manage per-model commitments independently. QPM / IndexingCore differ — their storage is one row per (project, location), so their lifecycle is represented only by the whole- relationship scalars on ConfigurableBillingStatus.
|
|
4337
|
+
*/
|
|
4338
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaProjectConfigurableBillingStatusAgentSearchTokenSubscriptionStatus {
|
|
4339
|
+
/**
|
|
4340
|
+
* Output only. The currently effective TPM threshold. Reflects scale-up immediately and scale-down at the next billing cycle, matching `effective_search_qpm_threshold` semantics.
|
|
4341
|
+
*/
|
|
4342
|
+
effectiveTpmThreshold?: string | null;
|
|
4343
|
+
/**
|
|
4344
|
+
* Output only. The Gemini model version this status corresponds to. Matches CoreSubscription.AgentSearchTokenSubscription.model_version (a stable Gemini model version from the Gemini Enterprise Agent Platform model-versions registry; see https://docs.cloud.google.com/gemini-enterprise-agent-platform/models/model-versions#gemini-models).
|
|
4345
|
+
*/
|
|
4346
|
+
modelVersion?: string | null;
|
|
4347
|
+
/**
|
|
4348
|
+
* Output only. When this (project, model_version) Agent Search TPM subscription was first activated. Set once on first activation of this model version and never moved by subsequent threshold updates; on termination + re-activation a new value is recorded. Does NOT move the whole-relationship `start_time` on the enclosing ConfigurableBillingStatus, which continues to represent the first activation of the overall customer-configurable-pricing relationship.
|
|
4349
|
+
*/
|
|
4350
|
+
startTime?: string | null;
|
|
4351
|
+
/**
|
|
4352
|
+
* Output only. If set, the scheduled effective time at which this (project, model_version) Agent Search TPM subscription will terminate. Populated when the customer removes this entry from `core_subscription.agent_search_token_subscriptions[*]`. Does NOT move the whole-relationship `terminate_time` on the enclosing ConfigurableBillingStatus, which is populated only when the entire customer-configurable-pricing relationship is being torn down.
|
|
4353
|
+
*/
|
|
4354
|
+
terminateTime?: string | null;
|
|
4355
|
+
/**
|
|
4356
|
+
* Output only. The earliest next update time for the TPM subscription threshold for this (project, model_version). Populated only after a successful update.
|
|
4357
|
+
*/
|
|
4358
|
+
tpmThresholdNextUpdateTime?: string | null;
|
|
4359
|
+
/**
|
|
4360
|
+
* Output only. The type of the most recent update to this (project, model_version) subscription, as performed by the most recent UpdateProject call. `UPDATE_TYPE_UNSPECIFIED` indicates this model_version was not touched by the most recent UpdateProject (its `effective_tpm_threshold` reflects an earlier update). The whole-relationship `update_type` on the enclosing ConfigurableBillingStatus continues to summarize the direction of the most recent update across all surfaces in the project (QPM, IndexingCore, and Agent Search TPM together).
|
|
4361
|
+
*/
|
|
4362
|
+
updateType?: string | null;
|
|
4363
|
+
}
|
|
3974
4364
|
/**
|
|
3975
4365
|
* Customer provided configurations.
|
|
3976
4366
|
*/
|
|
@@ -4076,7 +4466,7 @@ export declare namespace discoveryengine_v1beta {
|
|
|
4076
4466
|
updateTime?: string | null;
|
|
4077
4467
|
}
|
|
4078
4468
|
/**
|
|
4079
|
-
* Response message for CompletionService.PurgeCompletionSuggestions method.
|
|
4469
|
+
* Response message for CompletionService.PurgeCompletionSuggestions method. If the long running operation is successfully done, then this message is returned by the google.longrunning.Operations.response field.
|
|
4080
4470
|
*/
|
|
4081
4471
|
export interface Schema$GoogleCloudDiscoveryengineV1alphaPurgeCompletionSuggestionsResponse {
|
|
4082
4472
|
/**
|
|
@@ -4232,6 +4622,10 @@ export declare namespace discoveryengine_v1beta {
|
|
|
4232
4622
|
* Defines a user inputed query.
|
|
4233
4623
|
*/
|
|
4234
4624
|
export interface Schema$GoogleCloudDiscoveryengineV1alphaQuery {
|
|
4625
|
+
/**
|
|
4626
|
+
* Output only. The time at which the server accepted this query.
|
|
4627
|
+
*/
|
|
4628
|
+
createTime?: string | null;
|
|
4235
4629
|
/**
|
|
4236
4630
|
* Query content parts.
|
|
4237
4631
|
*/
|
|
@@ -4509,6 +4903,19 @@ export declare namespace discoveryengine_v1beta {
|
|
|
4509
4903
|
*/
|
|
4510
4904
|
filterGroups?: string[] | null;
|
|
4511
4905
|
}
|
|
4906
|
+
/**
|
|
4907
|
+
* Metadata for AlphaEvolveService.ResumeExperiment long running operation.
|
|
4908
|
+
*/
|
|
4909
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaResumeExperimentMetadata {
|
|
4910
|
+
/**
|
|
4911
|
+
* Output only. The time the operation was created.
|
|
4912
|
+
*/
|
|
4913
|
+
createTime?: string | null;
|
|
4914
|
+
/**
|
|
4915
|
+
* Output only. The time the operation was last updated.
|
|
4916
|
+
*/
|
|
4917
|
+
updateTime?: string | null;
|
|
4918
|
+
}
|
|
4512
4919
|
/**
|
|
4513
4920
|
* Safety rating corresponding to the generated content.
|
|
4514
4921
|
*/
|
|
@@ -4705,7 +5112,7 @@ export declare namespace discoveryengine_v1beta {
|
|
|
4705
5112
|
*/
|
|
4706
5113
|
queryExpansionSpec?: Schema$GoogleCloudDiscoveryengineV1alphaSearchRequestQueryExpansionSpec;
|
|
4707
5114
|
/**
|
|
4708
|
-
* Optional. The ranking expression controls the customized ranking on retrieval documents. This overrides ServingConfig.ranking_expression. The syntax and supported features depend on the `ranking_expression_backend` value. If `ranking_expression_backend` is not provided, it defaults to `RANK_BY_EMBEDDING`. If ranking_expression_backend is not provided or set to `RANK_BY_EMBEDDING`, it should be a single function or multiple functions that are joined by "+". * ranking_expression = function, { " + ", function \}; Supported functions: * double * relevance_score * double * dotProduct(embedding_field_path) Function variables: * `relevance_score`: pre-defined keywords, used for measure relevance between query and document. * `embedding_field_path`: the document embedding field used with query embedding vector. * `dotProduct`: embedding function between `embedding_field_path` and query embedding vector. Example ranking expression: If document has an embedding field doc_embedding, the ranking expression could be `0.5 * relevance_score + 0.3 * dotProduct(doc_embedding)`. If ranking_expression_backend is set to `RANK_BY_FORMULA`, the following expression types (and combinations of those chained using + or * operators) are supported: * `double` * `signal` * `log(signal)` * `exp(signal)` * `rr(signal, double \> 0)` -- reciprocal rank transformation with second argument being a denominator constant. * `is_nan(signal)` -- returns 0 if signal is NaN, 1 otherwise. * `fill_nan(signal1, signal2 | double)` -- if signal1 is NaN, returns signal2 | double, else returns signal1. Here are a few examples of ranking formulas that use the supported ranking expression types: - `0.2 * semantic_similarity_score + 0.8 * log(keyword_similarity_score)` -- mostly rank by the logarithm of `keyword_similarity_score` with slight `semantic_smilarity_score` adjustment. - `0.2 * exp(fill_nan(semantic_similarity_score, 0)) + 0.3 * is_nan(keyword_similarity_score)` -- rank by the exponent of `semantic_similarity_score` filling the value with 0 if it's NaN, also add constant 0.3 adjustment to the final score if `semantic_similarity_score` is NaN. - `0.2 * rr(semantic_similarity_score, 16) + 0.8 * rr(keyword_similarity_score, 16)` -- mostly rank by the reciprocal rank of `keyword_similarity_score` with slight adjustment of reciprocal rank of `semantic_smilarity_score`. The following signals are supported: * `semantic_similarity_score`: semantic similarity adjustment that is calculated using the embeddings generated by a proprietary Google model. This score determines how semantically similar a search query is to a document. * `keyword_similarity_score`: keyword match adjustment uses the Best Match 25 (BM25) ranking function. This score is calculated using a probabilistic model to estimate the probability that a document is relevant to a given query. * `relevance_score`: semantic relevance adjustment that uses a proprietary Google model to determine the meaning and intent behind a user's query in context with the content in the documents. * `pctr_rank`: predicted conversion rate adjustment as a rank use predicted Click-through rate (pCTR) to gauge the relevance and attractiveness of a search result from a user's perspective. A higher pCTR suggests that the result is more likely to satisfy the user's query and intent, making it a valuable signal for ranking. * `freshness_rank`: freshness adjustment as a rank * `document_age`: The time in hours elapsed since the document was last updated, a floating-point number (e.g., 0.25 means 15 minutes). * `topicality_rank`: topicality adjustment as a rank. Uses proprietary Google model to determine the keyword-based overlap between the query and the document. * `base_rank`: the default rank of the result
|
|
5115
|
+
* Optional. The ranking expression controls the customized ranking on retrieval documents. This overrides ServingConfig.ranking_expression. The syntax and supported features depend on the `ranking_expression_backend` value. If `ranking_expression_backend` is not provided, it defaults to `RANK_BY_EMBEDDING`. If ranking_expression_backend is not provided or set to `RANK_BY_EMBEDDING`, it should be a single function or multiple functions that are joined by "+". * ranking_expression = function, { " + ", function \}; Supported functions: * double * relevance_score * double * dotProduct(embedding_field_path) Function variables: * `relevance_score`: pre-defined keywords, used for measure relevance between query and document. * `embedding_field_path`: the document embedding field used with query embedding vector. * `dotProduct`: embedding function between `embedding_field_path` and query embedding vector. Example ranking expression: If document has an embedding field doc_embedding, the ranking expression could be `0.5 * relevance_score + 0.3 * dotProduct(doc_embedding)`. If ranking_expression_backend is set to `RANK_BY_FORMULA`, the following expression types (and combinations of those chained using + or * operators) are supported: * `double` * `signal` * `log(signal)` * `exp(signal)` * `rr(signal, double \> 0)` -- reciprocal rank transformation with second argument being a denominator constant. * `is_nan(signal)` -- returns 0 if signal is NaN, 1 otherwise. * `fill_nan(signal1, signal2 | double)` -- if signal1 is NaN, returns signal2 | double, else returns signal1. Here are a few examples of ranking formulas that use the supported ranking expression types: - `0.2 * semantic_similarity_score + 0.8 * log(keyword_similarity_score)` -- mostly rank by the logarithm of `keyword_similarity_score` with slight `semantic_smilarity_score` adjustment. - `0.2 * exp(fill_nan(semantic_similarity_score, 0)) + 0.3 * is_nan(keyword_similarity_score)` -- rank by the exponent of `semantic_similarity_score` filling the value with 0 if it's NaN, also add constant 0.3 adjustment to the final score if `semantic_similarity_score` is NaN. - `0.2 * rr(semantic_similarity_score, 16) + 0.8 * rr(keyword_similarity_score, 16)` -- mostly rank by the reciprocal rank of `keyword_similarity_score` with slight adjustment of reciprocal rank of `semantic_smilarity_score`. The following signals are supported: * `semantic_similarity_score`: semantic similarity adjustment that is calculated using the embeddings generated by a proprietary Google model. This score determines how semantically similar a search query is to a document. * `keyword_similarity_score`: keyword match adjustment uses the Best Match 25 (BM25) ranking function. This score is calculated using a probabilistic model to estimate the probability that a document is relevant to a given query. * `relevance_score`: semantic relevance adjustment that uses a proprietary Google model to determine the meaning and intent behind a user's query in context with the content in the documents. * `pctr_rank`: predicted conversion rate adjustment as a rank use predicted Click-through rate (pCTR) to gauge the relevance and attractiveness of a search result from a user's perspective. A higher pCTR suggests that the result is more likely to satisfy the user's query and intent, making it a valuable signal for ranking. * `freshness_rank`: freshness adjustment as a rank * `document_age`: The time in hours elapsed since the document was last updated, a floating-point number (e.g., 0.25 means 15 minutes). * `topicality_rank`: topicality adjustment as a rank. Uses proprietary Google model to determine the keyword-based overlap between the query and the document. * `base_rank`: the default rank of the result * `media_actor_match`: whether the media actor matches the query * `media_director_match`: whether the media director matches the query * `media_genre_match`: whether the media genre matches the query * `media_language_match`: whether the media language matches the query * `media_title_match`: whether the media title matches the query * `media_prefix_similarity_rank`: prefix similarity rank for media results * `media_semantic_similarity_rank`: semantic similarity rank for media results
|
|
4709
5116
|
*/
|
|
4710
5117
|
rankingExpression?: string | null;
|
|
4711
5118
|
/**
|
|
@@ -5286,6 +5693,10 @@ export declare namespace discoveryengine_v1beta {
|
|
|
5286
5693
|
* Immutable. Fully qualified name `projects/{project\}/locations/global/collections/{collection\}/engines/{engine\}/sessions/x`
|
|
5287
5694
|
*/
|
|
5288
5695
|
name?: string | null;
|
|
5696
|
+
/**
|
|
5697
|
+
* Output only. Full resource name of an in-progress AsyncAssist operation for this session, e.g. `projects/x/locations/x/collections/x/engines/x/sessions/x/operations/x`. Set when the operation starts and cleared when it finishes.
|
|
5698
|
+
*/
|
|
5699
|
+
pendingAsyncAssistOperationId?: string | null;
|
|
5289
5700
|
/**
|
|
5290
5701
|
* Output only. The time the session started.
|
|
5291
5702
|
*/
|
|
@@ -5422,6 +5833,28 @@ export declare namespace discoveryengine_v1beta {
|
|
|
5422
5833
|
*/
|
|
5423
5834
|
verifyTime?: string | null;
|
|
5424
5835
|
}
|
|
5836
|
+
/**
|
|
5837
|
+
* Metadata for AlphaEvolveService.StartExperiment long running operation.
|
|
5838
|
+
*/
|
|
5839
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaStartExperimentMetadata {
|
|
5840
|
+
/**
|
|
5841
|
+
* Output only. The time the operation was created.
|
|
5842
|
+
*/
|
|
5843
|
+
createTime?: string | null;
|
|
5844
|
+
/**
|
|
5845
|
+
* Output only. The time the operation was last updated.
|
|
5846
|
+
*/
|
|
5847
|
+
updateTime?: string | null;
|
|
5848
|
+
}
|
|
5849
|
+
/**
|
|
5850
|
+
* Request message for AlphaEvolveService.StartExperiment.
|
|
5851
|
+
*/
|
|
5852
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaStartExperimentRequest {
|
|
5853
|
+
/**
|
|
5854
|
+
* Required. Experiment to start. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}/sessions/{session\}/alphaEvolveExperiments/{alpha_evolve_experiment\}`
|
|
5855
|
+
*/
|
|
5856
|
+
name?: string | null;
|
|
5857
|
+
}
|
|
5425
5858
|
/**
|
|
5426
5859
|
* A target site for the SiteSearchEngine.
|
|
5427
5860
|
*/
|
|
@@ -5643,11 +6076,11 @@ export declare namespace discoveryengine_v1beta {
|
|
|
5643
6076
|
userId?: string | null;
|
|
5644
6077
|
}
|
|
5645
6078
|
/**
|
|
5646
|
-
* Precise location info with multiple representation options.
|
|
6079
|
+
* Precise location info with multiple representation options.
|
|
5647
6080
|
*/
|
|
5648
6081
|
export interface Schema$GoogleCloudDiscoveryengineV1alphaUserInfoPreciseLocation {
|
|
5649
6082
|
/**
|
|
5650
|
-
*
|
|
6083
|
+
* Location represented by a natural language address. Will later be geocoded and converted to either a point or a polygon.
|
|
5651
6084
|
*/
|
|
5652
6085
|
address?: string | null;
|
|
5653
6086
|
/**
|
|
@@ -5693,7 +6126,7 @@ export declare namespace discoveryengine_v1beta {
|
|
|
5693
6126
|
*/
|
|
5694
6127
|
export interface Schema$GoogleCloudDiscoveryengineV1alphaWorkspaceConfig {
|
|
5695
6128
|
/**
|
|
5696
|
-
* Obfuscated Dasher customer ID.
|
|
6129
|
+
* Output only. Obfuscated Dasher customer ID. Derived by the server from the project's GCP organization at data store creation time; any value supplied in the request payload is ignored.
|
|
5697
6130
|
*/
|
|
5698
6131
|
dasherCustomerId?: string | null;
|
|
5699
6132
|
/**
|
|
@@ -5913,6 +6346,25 @@ export declare namespace discoveryengine_v1beta {
|
|
|
5913
6346
|
* Required. The supported connector modes for the associated BAP connection.
|
|
5914
6347
|
*/
|
|
5915
6348
|
supportedConnectorModes?: string[] | null;
|
|
6349
|
+
/**
|
|
6350
|
+
* Optional. Custom toolspec overrides for this connection. For Enterprise BAP connectors that support admin-curated tool definitions, this holds the (simplified) per-tool overrides. On Get, populated by the server by merging persisted overrides with live runtime tool definitions and trimming the result for UI consumption. On Update, the supplied value replaces the persisted overrides after server-side validation and merging: the `base_version` field MUST match the server's current base toolspec version (otherwise the request is rejected with a user-facing error directing the admin to re-download the latest tools first).
|
|
6351
|
+
*/
|
|
6352
|
+
toolspecOverride?: Schema$GoogleCloudDiscoveryengineV1BAPConfigToolspecOverride;
|
|
6353
|
+
}
|
|
6354
|
+
/**
|
|
6355
|
+
* Customer-facing view of the admin-curated toolspec for a BAP connection. Holds the (simplified) per-tool definitions surfaced to and editable by the admin in the Discovery Engine UI. Mirrors the shape of the backend `google.cloud.connectorexecution.v1.ToolspecOverride` message, but is intentionally kept as a separate public type so the Discovery Engine API surface can evolve independently of the fed-API surface (AIP-215). Handlers convert between the two via helpers in //cloud/ml/discoveryengine/external_service/v1main/data_connector_service/lib:bap_custom_tool_util.
|
|
6356
|
+
*/
|
|
6357
|
+
export interface Schema$GoogleCloudDiscoveryengineV1BAPConfigToolspecOverride {
|
|
6358
|
+
/**
|
|
6359
|
+
* Required. Base toolspec version against which `tools` were authored. On Update, MUST match the server's current stable toolspec version for the connection; mismatch is rejected with a user-facing error directing the admin to re-download the latest tools first.
|
|
6360
|
+
*/
|
|
6361
|
+
baseVersion?: string | null;
|
|
6362
|
+
/**
|
|
6363
|
+
* Required. Tool definitions (one Struct per tool) that the admin has customised on top of the base toolspec returned by the fed API. REQUIRED because it is the only user-editable field in the modify API; the request must carry at least one tool.
|
|
6364
|
+
*/
|
|
6365
|
+
tools?: Array<{
|
|
6366
|
+
[key: string]: any;
|
|
6367
|
+
}> | null;
|
|
5916
6368
|
}
|
|
5917
6369
|
/**
|
|
5918
6370
|
* Metadata related to the progress of the SiteSearchEngineService.BatchCreateTargetSites operation. This will be returned by the google.longrunning.Operation.metadata field.
|
|
@@ -9397,6 +9849,10 @@ export declare namespace discoveryengine_v1beta {
|
|
|
9397
9849
|
* Optional. Immutable. This the application type which this engine resource represents. NOTE: this is a new concept independ of existing industry vertical or solution type.
|
|
9398
9850
|
*/
|
|
9399
9851
|
appType?: string | null;
|
|
9852
|
+
/**
|
|
9853
|
+
* Output only. The Agent registry containing the agents, MCP servers and tools associated with this engine. Derived server-side from the linked Agent Gateway's registry.
|
|
9854
|
+
*/
|
|
9855
|
+
associatedAgentRegistry?: string | null;
|
|
9400
9856
|
/**
|
|
9401
9857
|
* Configurations for the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT.
|
|
9402
9858
|
*/
|
|
@@ -9440,7 +9896,7 @@ export declare namespace discoveryengine_v1beta {
|
|
|
9440
9896
|
*/
|
|
9441
9897
|
displayName?: string | null;
|
|
9442
9898
|
/**
|
|
9443
|
-
* Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `personalization-suggested-highlights` * `
|
|
9899
|
+
* Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `personalization-suggested-highlights` * `mobile-app-access` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload` * `disable-welcome-emails` * `disable-canvas` * `canvas-workspace` * `disable-skills` * `disable-projects` * `enable-end-user-sharing-with-groups` * `single-agent-orchestration` * `multi-agent-orchestration` * `cross-product-intelligence`
|
|
9444
9900
|
*/
|
|
9445
9901
|
features?: {
|
|
9446
9902
|
[key: string]: string;
|
|
@@ -9668,7 +10124,7 @@ export declare namespace discoveryengine_v1beta {
|
|
|
9668
10124
|
*/
|
|
9669
10125
|
export interface Schema$GoogleCloudDiscoveryengineV1betaEngineSearchEngineConfig {
|
|
9670
10126
|
/**
|
|
9671
|
-
* Optional. The required subscription tier of this engine.
|
|
10127
|
+
* Optional. The required subscription tier of this engine. If the required subscription tier is search, user with higher license tier like assist can still access the standalone app associated with this engine. Web grounding feature is only available on the app if it is set as SubscriptionTier.SUBSCRIPTION_TIER_SEARCH_AND_ASSISTANT.
|
|
9672
10128
|
*/
|
|
9673
10129
|
requiredSubscriptionTier?: string | null;
|
|
9674
10130
|
/**
|
|
@@ -9774,6 +10230,68 @@ export declare namespace discoveryengine_v1beta {
|
|
|
9774
10230
|
*/
|
|
9775
10231
|
uri?: string | null;
|
|
9776
10232
|
}
|
|
10233
|
+
/**
|
|
10234
|
+
* Information about the user feedback. This information will be used for logging and metrics purpose.
|
|
10235
|
+
*/
|
|
10236
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaFeedback {
|
|
10237
|
+
/**
|
|
10238
|
+
* Optional. The additional user comment of the feedback if user gives a thumb down.
|
|
10239
|
+
*/
|
|
10240
|
+
comment?: string | null;
|
|
10241
|
+
/**
|
|
10242
|
+
* Optional. The version of the component that this report is being sent from.
|
|
10243
|
+
*/
|
|
10244
|
+
componentVersion?: string | null;
|
|
10245
|
+
/**
|
|
10246
|
+
* The related conversation information when user gives feedback.
|
|
10247
|
+
*/
|
|
10248
|
+
conversationInfo?: Schema$GoogleCloudDiscoveryengineV1betaFeedbackConversationInfo;
|
|
10249
|
+
/**
|
|
10250
|
+
* Optional. Whether the customer accepted data use terms.
|
|
10251
|
+
*/
|
|
10252
|
+
dataTermsAccepted?: boolean | null;
|
|
10253
|
+
/**
|
|
10254
|
+
* Optional. The UI component the user feedback comes from, which could be GOOGLE_CONSOLE, GOOGLE_WIDGET, GOOGLE_WEBAPP.
|
|
10255
|
+
*/
|
|
10256
|
+
feedbackSource?: string | null;
|
|
10257
|
+
/**
|
|
10258
|
+
* Required. Indicate whether the user gives a positive or negative feedback. If the user gives a negative feedback, there might be more feedback details.
|
|
10259
|
+
*/
|
|
10260
|
+
feedbackType?: string | null;
|
|
10261
|
+
/**
|
|
10262
|
+
* The version of the LLM model that was used to generate the response.
|
|
10263
|
+
*/
|
|
10264
|
+
llmModelVersion?: string | null;
|
|
10265
|
+
/**
|
|
10266
|
+
* Optional. The reason if user gives a thumb down.
|
|
10267
|
+
*/
|
|
10268
|
+
reasons?: string[] | null;
|
|
10269
|
+
}
|
|
10270
|
+
/**
|
|
10271
|
+
* The conversation information such as the question index and session name.
|
|
10272
|
+
*/
|
|
10273
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaFeedbackConversationInfo {
|
|
10274
|
+
/**
|
|
10275
|
+
* Optional. The token which could be used to fetch the answer log.
|
|
10276
|
+
*/
|
|
10277
|
+
answerQueryToken?: string | null;
|
|
10278
|
+
/**
|
|
10279
|
+
* Optional. The token which could be used to fetch the assistant log.
|
|
10280
|
+
*/
|
|
10281
|
+
assistToken?: string | null;
|
|
10282
|
+
/**
|
|
10283
|
+
* Required. The user's search query.
|
|
10284
|
+
*/
|
|
10285
|
+
query?: Schema$GoogleCloudDiscoveryengineV1betaQuery;
|
|
10286
|
+
/**
|
|
10287
|
+
* The index of the user input within the conversation messages.
|
|
10288
|
+
*/
|
|
10289
|
+
questionIndex?: number | null;
|
|
10290
|
+
/**
|
|
10291
|
+
* Name of the newly generated or continued session.
|
|
10292
|
+
*/
|
|
10293
|
+
session?: string | null;
|
|
10294
|
+
}
|
|
9777
10295
|
/**
|
|
9778
10296
|
* Response message for SiteSearchEngineService.FetchDomainVerificationStatus method.
|
|
9779
10297
|
*/
|
|
@@ -10447,6 +10965,10 @@ export declare namespace discoveryengine_v1beta {
|
|
|
10447
10965
|
* Output only. Whether the license config is for Gemini bundle.
|
|
10448
10966
|
*/
|
|
10449
10967
|
geminiBundle?: boolean | null;
|
|
10968
|
+
/**
|
|
10969
|
+
* Optional. Timestamp of the most recent user-initiated update (seat count change or subscription term change). Unlike `update_time`, this field is only stamped when a customer explicitly updates the license (e.g. via the UI), and is not touched by system-driven writes (subscription pipeline, BALC propagation, etc.).
|
|
10970
|
+
*/
|
|
10971
|
+
lastUserUpdateTime?: string | null;
|
|
10450
10972
|
/**
|
|
10451
10973
|
* Required. Number of licenses purchased.
|
|
10452
10974
|
*/
|
|
@@ -10646,6 +11168,19 @@ export declare namespace discoveryengine_v1beta {
|
|
|
10646
11168
|
*/
|
|
10647
11169
|
nextPageToken?: string | null;
|
|
10648
11170
|
}
|
|
11171
|
+
/**
|
|
11172
|
+
* Response message for LicenseConfigService.ListLicenseConfigs method.
|
|
11173
|
+
*/
|
|
11174
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaListLicenseConfigsResponse {
|
|
11175
|
+
/**
|
|
11176
|
+
* All the customer's LicenseConfigs.
|
|
11177
|
+
*/
|
|
11178
|
+
licenseConfigs?: Schema$GoogleCloudDiscoveryengineV1betaLicenseConfig[];
|
|
11179
|
+
/**
|
|
11180
|
+
* Not supported.
|
|
11181
|
+
*/
|
|
11182
|
+
nextPageToken?: string | null;
|
|
11183
|
+
}
|
|
10649
11184
|
/**
|
|
10650
11185
|
* Response message for UserLicenseService.ListLicenseConfigsUsageStats method.
|
|
10651
11186
|
*/
|
|
@@ -10931,6 +11466,10 @@ export declare namespace discoveryengine_v1beta {
|
|
|
10931
11466
|
* Represents the currently effective configurable billing parameters. These values are derived from the customer's subscription history stored internally and reflect the thresholds actively being used for billing purposes at the time of the GetProject call. This includes the start_time of the subscription and may differ from the values in `customer_provided_config` due to billing rules (e.g., scale-downs taking effect only at the start of a new month). We also include the update type to indicate the type of update performed on the configurable billing configuration in the UpdateProject operation.
|
|
10932
11467
|
*/
|
|
10933
11468
|
export interface Schema$GoogleCloudDiscoveryengineV1betaProjectConfigurableBillingStatus {
|
|
11469
|
+
/**
|
|
11470
|
+
* Output only. Per-model Agent Search TPM subscription status.
|
|
11471
|
+
*/
|
|
11472
|
+
agentSearchTokenSubscriptionStatuses?: Schema$GoogleCloudDiscoveryengineV1betaProjectConfigurableBillingStatusAgentSearchTokenSubscriptionStatus[];
|
|
10934
11473
|
/**
|
|
10935
11474
|
* Optional. The currently effective Indexing Core threshold. This is the threshold against which Indexing Core usage is compared for overage calculations.
|
|
10936
11475
|
*/
|
|
@@ -10960,6 +11499,35 @@ export declare namespace discoveryengine_v1beta {
|
|
|
10960
11499
|
*/
|
|
10961
11500
|
updateType?: string | null;
|
|
10962
11501
|
}
|
|
11502
|
+
/**
|
|
11503
|
+
* Per-model Agent Search TPM subscription status. One entry per active `core_subscription.agent_search_token_subscriptions[*]` entry in the customer-provided config; populated by UpdateProject and GetProject. The lifecycle scalars on this message (`start_time`, `terminate_time`, `update_type`, `tpm_threshold_next_update_time`) are per (project, model_version) — siblings of the whole-relationship `start_time` / `terminate_time` / `update_type` on the enclosing ConfigurableBillingStatus, but scoped to this specific Agent Search TPM subscription instead of to the overall customer-configurable- pricing relationship. This per-instance granularity is intentional: the underlying SubV3 storage is per-(project, model_version), so each model has its own activation, termination, and deferred-update clock; surfacing that on the response gives customers the granularity they need to manage per-model commitments independently. QPM / IndexingCore differ — their storage is one row per (project, location), so their lifecycle is represented only by the whole- relationship scalars on ConfigurableBillingStatus.
|
|
11504
|
+
*/
|
|
11505
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaProjectConfigurableBillingStatusAgentSearchTokenSubscriptionStatus {
|
|
11506
|
+
/**
|
|
11507
|
+
* Output only. The currently effective TPM threshold. Reflects scale-up immediately and scale-down at the next billing cycle, matching `effective_search_qpm_threshold` semantics.
|
|
11508
|
+
*/
|
|
11509
|
+
effectiveTpmThreshold?: string | null;
|
|
11510
|
+
/**
|
|
11511
|
+
* Output only. The Gemini model version this status corresponds to. Matches CoreSubscription.AgentSearchTokenSubscription.model_version (a stable Gemini model version from the Gemini Enterprise Agent Platform model-versions registry; see https://docs.cloud.google.com/gemini-enterprise-agent-platform/models/model-versions#gemini-models).
|
|
11512
|
+
*/
|
|
11513
|
+
modelVersion?: string | null;
|
|
11514
|
+
/**
|
|
11515
|
+
* Output only. When this (project, model_version) Agent Search TPM subscription was first activated. Set once on first activation of this model version and never moved by subsequent threshold updates; on termination + re-activation a new value is recorded. Does NOT move the whole-relationship `start_time` on the enclosing ConfigurableBillingStatus, which continues to represent the first activation of the overall customer-configurable-pricing relationship.
|
|
11516
|
+
*/
|
|
11517
|
+
startTime?: string | null;
|
|
11518
|
+
/**
|
|
11519
|
+
* Output only. If set, the scheduled effective time at which this (project, model_version) Agent Search TPM subscription will terminate. Populated when the customer removes this entry from `core_subscription.agent_search_token_subscriptions[*]`. Does NOT move the whole-relationship `terminate_time` on the enclosing ConfigurableBillingStatus, which is populated only when the entire customer-configurable-pricing relationship is being torn down.
|
|
11520
|
+
*/
|
|
11521
|
+
terminateTime?: string | null;
|
|
11522
|
+
/**
|
|
11523
|
+
* Output only. The earliest next update time for the TPM subscription threshold for this (project, model_version). Populated only after a successful update.
|
|
11524
|
+
*/
|
|
11525
|
+
tpmThresholdNextUpdateTime?: string | null;
|
|
11526
|
+
/**
|
|
11527
|
+
* Output only. The type of the most recent update to this (project, model_version) subscription, as performed by the most recent UpdateProject call. `UPDATE_TYPE_UNSPECIFIED` indicates this model_version was not touched by the most recent UpdateProject (its `effective_tpm_threshold` reflects an earlier update). The whole-relationship `update_type` on the enclosing ConfigurableBillingStatus continues to summarize the direction of the most recent update across all surfaces in the project (QPM, IndexingCore, and Agent Search TPM together).
|
|
11528
|
+
*/
|
|
11529
|
+
updateType?: string | null;
|
|
11530
|
+
}
|
|
10963
11531
|
/**
|
|
10964
11532
|
* Customer provided configurations.
|
|
10965
11533
|
*/
|
|
@@ -11850,7 +12418,7 @@ export declare namespace discoveryengine_v1beta {
|
|
|
11850
12418
|
*/
|
|
11851
12419
|
queryExpansionSpec?: Schema$GoogleCloudDiscoveryengineV1betaSearchRequestQueryExpansionSpec;
|
|
11852
12420
|
/**
|
|
11853
|
-
* Optional. The ranking expression controls the customized ranking on retrieval documents. This overrides ServingConfig.ranking_expression. The syntax and supported features depend on the `ranking_expression_backend` value. If `ranking_expression_backend` is not provided, it defaults to `RANK_BY_EMBEDDING`. If ranking_expression_backend is not provided or set to `RANK_BY_EMBEDDING`, it should be a single function or multiple functions that are joined by "+". * ranking_expression = function, { " + ", function \}; Supported functions: * double * relevance_score * double * dotProduct(embedding_field_path) Function variables: * `relevance_score`: pre-defined keywords, used for measure relevance between query and document. * `embedding_field_path`: the document embedding field used with query embedding vector. * `dotProduct`: embedding function between `embedding_field_path` and query embedding vector. Example ranking expression: If document has an embedding field doc_embedding, the ranking expression could be `0.5 * relevance_score + 0.3 * dotProduct(doc_embedding)`. If ranking_expression_backend is set to `RANK_BY_FORMULA`, the following expression types (and combinations of those chained using + or * operators) are supported: * `double` * `signal` * `log(signal)` * `exp(signal)` * `rr(signal, double \> 0)` -- reciprocal rank transformation with second argument being a denominator constant. * `is_nan(signal)` -- returns 0 if signal is NaN, 1 otherwise. * `fill_nan(signal1, signal2 | double)` -- if signal1 is NaN, returns signal2 | double, else returns signal1. Here are a few examples of ranking formulas that use the supported ranking expression types: - `0.2 * semantic_similarity_score + 0.8 * log(keyword_similarity_score)` -- mostly rank by the logarithm of `keyword_similarity_score` with slight `semantic_smilarity_score` adjustment. - `0.2 * exp(fill_nan(semantic_similarity_score, 0)) + 0.3 * is_nan(keyword_similarity_score)` -- rank by the exponent of `semantic_similarity_score` filling the value with 0 if it's NaN, also add constant 0.3 adjustment to the final score if `semantic_similarity_score` is NaN. - `0.2 * rr(semantic_similarity_score, 16) + 0.8 * rr(keyword_similarity_score, 16)` -- mostly rank by the reciprocal rank of `keyword_similarity_score` with slight adjustment of reciprocal rank of `semantic_smilarity_score`. The following signals are supported: * `semantic_similarity_score`: semantic similarity adjustment that is calculated using the embeddings generated by a proprietary Google model. This score determines how semantically similar a search query is to a document. * `keyword_similarity_score`: keyword match adjustment uses the Best Match 25 (BM25) ranking function. This score is calculated using a probabilistic model to estimate the probability that a document is relevant to a given query. * `relevance_score`: semantic relevance adjustment that uses a proprietary Google model to determine the meaning and intent behind a user's query in context with the content in the documents. * `pctr_rank`: predicted conversion rate adjustment as a rank use predicted Click-through rate (pCTR) to gauge the relevance and attractiveness of a search result from a user's perspective. A higher pCTR suggests that the result is more likely to satisfy the user's query and intent, making it a valuable signal for ranking. * `freshness_rank`: freshness adjustment as a rank * `document_age`: The time in hours elapsed since the document was last updated, a floating-point number (e.g., 0.25 means 15 minutes). * `topicality_rank`: topicality adjustment as a rank. Uses proprietary Google model to determine the keyword-based overlap between the query and the document. * `base_rank`: the default rank of the result
|
|
12421
|
+
* Optional. The ranking expression controls the customized ranking on retrieval documents. This overrides ServingConfig.ranking_expression. The syntax and supported features depend on the `ranking_expression_backend` value. If `ranking_expression_backend` is not provided, it defaults to `RANK_BY_EMBEDDING`. If ranking_expression_backend is not provided or set to `RANK_BY_EMBEDDING`, it should be a single function or multiple functions that are joined by "+". * ranking_expression = function, { " + ", function \}; Supported functions: * double * relevance_score * double * dotProduct(embedding_field_path) Function variables: * `relevance_score`: pre-defined keywords, used for measure relevance between query and document. * `embedding_field_path`: the document embedding field used with query embedding vector. * `dotProduct`: embedding function between `embedding_field_path` and query embedding vector. Example ranking expression: If document has an embedding field doc_embedding, the ranking expression could be `0.5 * relevance_score + 0.3 * dotProduct(doc_embedding)`. If ranking_expression_backend is set to `RANK_BY_FORMULA`, the following expression types (and combinations of those chained using + or * operators) are supported: * `double` * `signal` * `log(signal)` * `exp(signal)` * `rr(signal, double \> 0)` -- reciprocal rank transformation with second argument being a denominator constant. * `is_nan(signal)` -- returns 0 if signal is NaN, 1 otherwise. * `fill_nan(signal1, signal2 | double)` -- if signal1 is NaN, returns signal2 | double, else returns signal1. Here are a few examples of ranking formulas that use the supported ranking expression types: - `0.2 * semantic_similarity_score + 0.8 * log(keyword_similarity_score)` -- mostly rank by the logarithm of `keyword_similarity_score` with slight `semantic_smilarity_score` adjustment. - `0.2 * exp(fill_nan(semantic_similarity_score, 0)) + 0.3 * is_nan(keyword_similarity_score)` -- rank by the exponent of `semantic_similarity_score` filling the value with 0 if it's NaN, also add constant 0.3 adjustment to the final score if `semantic_similarity_score` is NaN. - `0.2 * rr(semantic_similarity_score, 16) + 0.8 * rr(keyword_similarity_score, 16)` -- mostly rank by the reciprocal rank of `keyword_similarity_score` with slight adjustment of reciprocal rank of `semantic_smilarity_score`. The following signals are supported: * `semantic_similarity_score`: semantic similarity adjustment that is calculated using the embeddings generated by a proprietary Google model. This score determines how semantically similar a search query is to a document. * `keyword_similarity_score`: keyword match adjustment uses the Best Match 25 (BM25) ranking function. This score is calculated using a probabilistic model to estimate the probability that a document is relevant to a given query. * `relevance_score`: semantic relevance adjustment that uses a proprietary Google model to determine the meaning and intent behind a user's query in context with the content in the documents. * `pctr_rank`: predicted conversion rate adjustment as a rank use predicted Click-through rate (pCTR) to gauge the relevance and attractiveness of a search result from a user's perspective. A higher pCTR suggests that the result is more likely to satisfy the user's query and intent, making it a valuable signal for ranking. * `freshness_rank`: freshness adjustment as a rank * `document_age`: The time in hours elapsed since the document was last updated, a floating-point number (e.g., 0.25 means 15 minutes). * `topicality_rank`: topicality adjustment as a rank. Uses proprietary Google model to determine the keyword-based overlap between the query and the document. * `base_rank`: the default rank of the result * `media_actor_match`: whether the media actor matches the query * `media_director_match`: whether the media director matches the query * `media_genre_match`: whether the media genre matches the query * `media_language_match`: whether the media language matches the query * `media_title_match`: whether the media title matches the query * `media_prefix_similarity_rank`: prefix similarity rank for media results * `media_semantic_similarity_rank`: semantic similarity rank for media results
|
|
11854
12422
|
*/
|
|
11855
12423
|
rankingExpression?: string | null;
|
|
11856
12424
|
/**
|
|
@@ -13115,6 +13683,10 @@ export declare namespace discoveryengine_v1beta {
|
|
|
13115
13683
|
* Immutable. Fully qualified name `projects/{project\}/locations/global/collections/{collection\}/engines/{engine\}/sessions/x`
|
|
13116
13684
|
*/
|
|
13117
13685
|
name?: string | null;
|
|
13686
|
+
/**
|
|
13687
|
+
* Output only. Full resource name of an in-progress AsyncAssist operation for this session, e.g. `projects/x/locations/x/collections/x/engines/x/sessions/x/operations/x`. Set when the operation starts and cleared when it finishes.
|
|
13688
|
+
*/
|
|
13689
|
+
pendingAsyncAssistOperationId?: string | null;
|
|
13118
13690
|
/**
|
|
13119
13691
|
* Output only. The time the session started.
|
|
13120
13692
|
*/
|
|
@@ -13378,15 +13950,49 @@ export declare namespace discoveryengine_v1beta {
|
|
|
13378
13950
|
* A global unique ID that identifies the current pair of request and stream of responses. Used for feedback and support.
|
|
13379
13951
|
*/
|
|
13380
13952
|
assistToken?: string | null;
|
|
13953
|
+
/**
|
|
13954
|
+
* Per-connector authentication errors encountered during the request. Present when one or more connectors failed authentication but the request proceeded with the remaining connectors.
|
|
13955
|
+
*/
|
|
13956
|
+
connectorAuthErrors?: Schema$GoogleCloudDiscoveryengineV1betaStreamAssistResponseConnectorAuthError[];
|
|
13381
13957
|
/**
|
|
13382
13958
|
* The tool names of the tools that were invoked.
|
|
13383
13959
|
*/
|
|
13384
13960
|
invocationTools?: string[] | null;
|
|
13961
|
+
/**
|
|
13962
|
+
* The skills executed during the turn.
|
|
13963
|
+
*/
|
|
13964
|
+
invokedSkills?: Schema$GoogleCloudDiscoveryengineV1betaStreamAssistResponseInvokedSkill[];
|
|
13385
13965
|
/**
|
|
13386
13966
|
* Session information. Only included in the final StreamAssistResponse of the response stream.
|
|
13387
13967
|
*/
|
|
13388
13968
|
sessionInfo?: Schema$GoogleCloudDiscoveryengineV1betaStreamAssistResponseSessionInfo;
|
|
13389
13969
|
}
|
|
13970
|
+
/**
|
|
13971
|
+
* Describes an authentication error for a specific data connector.
|
|
13972
|
+
*/
|
|
13973
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaStreamAssistResponseConnectorAuthError {
|
|
13974
|
+
/**
|
|
13975
|
+
* Resource name of the data connector that failed authentication.
|
|
13976
|
+
*/
|
|
13977
|
+
dataConnector?: string | null;
|
|
13978
|
+
/**
|
|
13979
|
+
* Human-readable error message describing the auth failure.
|
|
13980
|
+
*/
|
|
13981
|
+
errorMessage?: string | null;
|
|
13982
|
+
}
|
|
13983
|
+
/**
|
|
13984
|
+
* Represents a skill used during the assist call.
|
|
13985
|
+
*/
|
|
13986
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaStreamAssistResponseInvokedSkill {
|
|
13987
|
+
/**
|
|
13988
|
+
* The display name of the skill.
|
|
13989
|
+
*/
|
|
13990
|
+
displayName?: string | null;
|
|
13991
|
+
/**
|
|
13992
|
+
* The resource name of the skill.
|
|
13993
|
+
*/
|
|
13994
|
+
name?: string | null;
|
|
13995
|
+
}
|
|
13390
13996
|
/**
|
|
13391
13997
|
* Information about the session.
|
|
13392
13998
|
*/
|
|
@@ -13691,6 +14297,10 @@ export declare namespace discoveryengine_v1beta {
|
|
|
13691
14297
|
* Required. User event type. Allowed values are: Generic values: * `search`: Search for Documents. * `view-item`: Detailed page view of a Document. * `view-item-list`: View of a panel or ordered list of Documents. * `view-home-page`: View of the home page. * `view-category-page`: View of a category page, e.g. Home \> Men \> Jeans Retail-related values: * `add-to-cart`: Add an item(s) to cart, e.g. in Retail online shopping * `purchase`: Purchase an item(s) Media-related values: * `media-play`: Start/resume watching a video, playing a song, etc. * `media-complete`: Finished or stopped midway through a video, song, etc. Custom conversion value: * `conversion`: Customer defined conversion event.
|
|
13692
14298
|
*/
|
|
13693
14299
|
eventType?: string | null;
|
|
14300
|
+
/**
|
|
14301
|
+
* Optional. This field is optional except for the `add-feedback` event types.
|
|
14302
|
+
*/
|
|
14303
|
+
feedback?: Schema$GoogleCloudDiscoveryengineV1betaFeedback;
|
|
13694
14304
|
/**
|
|
13695
14305
|
* Optional. The filter syntax consists of an expression language for constructing a predicate from one or more fields of the documents being filtered. One example is for `search` events, the associated SearchRequest may contain a filter expression in SearchRequest.filter conforming to https://google.aip.dev/160#filtering. Similarly, for `view-item-list` events that are generated from a RecommendRequest, this field may be populated directly from RecommendRequest.filter conforming to https://google.aip.dev/160#filtering. The value must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an `INVALID_ARGUMENT` error is returned.
|
|
13696
14306
|
*/
|
|
@@ -13762,11 +14372,11 @@ export declare namespace discoveryengine_v1beta {
|
|
|
13762
14372
|
userId?: string | null;
|
|
13763
14373
|
}
|
|
13764
14374
|
/**
|
|
13765
|
-
* Precise location info with multiple representation options.
|
|
14375
|
+
* Precise location info with multiple representation options.
|
|
13766
14376
|
*/
|
|
13767
14377
|
export interface Schema$GoogleCloudDiscoveryengineV1betaUserInfoPreciseLocation {
|
|
13768
14378
|
/**
|
|
13769
|
-
*
|
|
14379
|
+
* Location represented by a natural language address. Will later be geocoded and converted to either a point or a polygon.
|
|
13770
14380
|
*/
|
|
13771
14381
|
address?: string | null;
|
|
13772
14382
|
/**
|
|
@@ -13837,7 +14447,7 @@ export declare namespace discoveryengine_v1beta {
|
|
|
13837
14447
|
*/
|
|
13838
14448
|
export interface Schema$GoogleCloudDiscoveryengineV1betaWorkspaceConfig {
|
|
13839
14449
|
/**
|
|
13840
|
-
* Obfuscated Dasher customer ID.
|
|
14450
|
+
* Output only. Obfuscated Dasher customer ID. Derived by the server from the project's GCP organization at data store creation time; any value supplied in the request payload is ignored.
|
|
13841
14451
|
*/
|
|
13842
14452
|
dasherCustomerId?: string | null;
|
|
13843
14453
|
/**
|
|
@@ -14216,6 +14826,10 @@ export declare namespace discoveryengine_v1beta {
|
|
|
14216
14826
|
* Optional. The modes enabled for this connector. Default state is CONNECTOR_MODE_UNSPECIFIED.
|
|
14217
14827
|
*/
|
|
14218
14828
|
connectorModes?: string[] | null;
|
|
14829
|
+
/**
|
|
14830
|
+
* Optional. If set, this value instead of `data_source` is used to fetch the corresponding connector source.
|
|
14831
|
+
*/
|
|
14832
|
+
connectorSourceId?: string | null;
|
|
14219
14833
|
/**
|
|
14220
14834
|
* Output only. The type of connector. Each source can only map to one type. For example, salesforce, confluence and jira have THIRD_PARTY connector type. It is not mutable once set by system.
|
|
14221
14835
|
*/
|
|
@@ -14229,7 +14843,7 @@ export declare namespace discoveryengine_v1beta {
|
|
|
14229
14843
|
*/
|
|
14230
14844
|
createTime?: string | null;
|
|
14231
14845
|
/**
|
|
14232
|
-
* Required. The identifier for the data source.
|
|
14846
|
+
* Required. The identifier for the data source. For the full, up-to-date list of supported connectors and their values, see [Connect a third-party data source](https://docs.cloud.google.com/gemini/enterprise/docs/connectors/connect-third-party-data-source#sources-by-launch-stage).
|
|
14233
14847
|
*/
|
|
14234
14848
|
dataSource?: string | null;
|
|
14235
14849
|
/**
|
|
@@ -14296,6 +14910,10 @@ export declare namespace discoveryengine_v1beta {
|
|
|
14296
14910
|
* Output only. The most recent timestamp when this DataConnector was paused, affecting all functionalities such as data synchronization. Pausing a connector has the following effects: - All functionalities, including data synchronization, are halted. - Any ongoing data synchronization job will be canceled. - No future data synchronization runs will be scheduled nor can be triggered.
|
|
14297
14911
|
*/
|
|
14298
14912
|
latestPauseTime?: string | null;
|
|
14913
|
+
/**
|
|
14914
|
+
* Optional. User-facing metadata for the connector. Populated from the connector's generated metadata / registry `ConnectorSource`.
|
|
14915
|
+
*/
|
|
14916
|
+
metadata?: Schema$GoogleCloudDiscoveryengineV1DataConnectorConnectorMetadata;
|
|
14299
14917
|
/**
|
|
14300
14918
|
* Identifier. The full resource name of the Data Connector. Format: `projects/x/locations/x/collections/x/dataConnector`.
|
|
14301
14919
|
*/
|
|
@@ -14304,6 +14922,10 @@ export declare namespace discoveryengine_v1beta {
|
|
|
14304
14922
|
* Defines the scheduled time for the next data synchronization. This field requires hour , minute, and time_zone from the [IANA Time Zone Database](https://www.iana.org/time-zones). This is utilized when the data connector has a refresh interval greater than 1 day. When the hours or minutes are not specified, we will assume a sync time of 0:00. The user must provide a time zone to avoid ambiguity.
|
|
14305
14923
|
*/
|
|
14306
14924
|
nextSyncTime?: Schema$GoogleTypeDateTime;
|
|
14925
|
+
/**
|
|
14926
|
+
* Output only. The static IP addresses used by this connector for OAuth APIs (e.g. end user authentication). These are surfaced separately from `static_ip_addresses` so that customers can apply granular firewall settings for OAuth endpoints. Only populated for connectors that have static IP enabled and are used for actions and/or federated search.
|
|
14927
|
+
*/
|
|
14928
|
+
oauthStaticIpAddresses?: string[] | null;
|
|
14307
14929
|
/**
|
|
14308
14930
|
* Required data connector parameters in structured json format.
|
|
14309
14931
|
*/
|
|
@@ -14346,6 +14968,10 @@ export declare namespace discoveryengine_v1beta {
|
|
|
14346
14968
|
* The data synchronization mode supported by the data connector.
|
|
14347
14969
|
*/
|
|
14348
14970
|
syncMode?: string | null;
|
|
14971
|
+
/**
|
|
14972
|
+
* Optional. Immutable. User-facing, version-independent label for this connector. May be shared by multiple connectors under the same (project, location, collection, data_source); tag-based lookup returns the one with the greatest create_time. Optional at Create time. Agent Designer resolves connectors via (data_source, tag) when set, falling back to the legacy resource-name lookup when unset, so connectors created before the tag-write launch continue to work without a backfill.
|
|
14973
|
+
*/
|
|
14974
|
+
tag?: string | null;
|
|
14349
14975
|
/**
|
|
14350
14976
|
* Output only. Timestamp the DataConnector was last updated.
|
|
14351
14977
|
*/
|
|
@@ -14355,6 +14981,35 @@ export declare namespace discoveryengine_v1beta {
|
|
|
14355
14981
|
*/
|
|
14356
14982
|
vpcscEnabled?: boolean | null;
|
|
14357
14983
|
}
|
|
14984
|
+
/**
|
|
14985
|
+
* User-facing metadata for the connector, shown on the connector detail page (title, description, short_description, author, authenticated_account, note).
|
|
14986
|
+
*/
|
|
14987
|
+
export interface Schema$GoogleCloudDiscoveryengineV1DataConnectorConnectorMetadata {
|
|
14988
|
+
/**
|
|
14989
|
+
* Optional. The end user's account as authenticated to the connector, so the end user can see which account is connected. May be an email, a username, or any identifier the connector/third party provides.
|
|
14990
|
+
*/
|
|
14991
|
+
authenticatedAccount?: string | null;
|
|
14992
|
+
/**
|
|
14993
|
+
* Optional. The party that authored the connector, e.g. "Google" or a third-party provider name. Lets end users see who authored a connector (future: third-party-authored connectors).
|
|
14994
|
+
*/
|
|
14995
|
+
author?: string | null;
|
|
14996
|
+
/**
|
|
14997
|
+
* Optional. Human-readable description of the connector, shown on the connector detail page. One connector has a single description.
|
|
14998
|
+
*/
|
|
14999
|
+
description?: string | null;
|
|
15000
|
+
/**
|
|
15001
|
+
* Optional. Free-form, multi-line note about the connector's capabilities or a custom note that can be set for the connector.
|
|
15002
|
+
*/
|
|
15003
|
+
note?: string | null;
|
|
15004
|
+
/**
|
|
15005
|
+
* Optional. Short, subtitle-length description of the connector (e.g. shown beneath the connector name in list and detail views).
|
|
15006
|
+
*/
|
|
15007
|
+
shortDescription?: string | null;
|
|
15008
|
+
/**
|
|
15009
|
+
* Optional. Display title of the connector.
|
|
15010
|
+
*/
|
|
15011
|
+
title?: string | null;
|
|
15012
|
+
}
|
|
14358
15013
|
/**
|
|
14359
15014
|
* Any params and credentials used specifically for EUA connectors.
|
|
14360
15015
|
*/
|
|
@@ -15023,6 +15678,10 @@ export declare namespace discoveryengine_v1beta {
|
|
|
15023
15678
|
* Optional. Immutable. This the application type which this engine resource represents. NOTE: this is a new concept independ of existing industry vertical or solution type.
|
|
15024
15679
|
*/
|
|
15025
15680
|
appType?: string | null;
|
|
15681
|
+
/**
|
|
15682
|
+
* Output only. The Agent registry containing the agents, MCP servers and tools associated with this engine. Derived server-side from the linked Agent Gateway's registry.
|
|
15683
|
+
*/
|
|
15684
|
+
associatedAgentRegistry?: string | null;
|
|
15026
15685
|
/**
|
|
15027
15686
|
* Configurations for the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT.
|
|
15028
15687
|
*/
|
|
@@ -15066,7 +15725,7 @@ export declare namespace discoveryengine_v1beta {
|
|
|
15066
15725
|
*/
|
|
15067
15726
|
displayName?: string | null;
|
|
15068
15727
|
/**
|
|
15069
|
-
* Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `personalization-suggested-highlights` * `
|
|
15728
|
+
* Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `personalization-suggested-highlights` * `mobile-app-access` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload` * `disable-welcome-emails` * `disable-canvas` * `canvas-workspace` * `disable-skills` * `disable-projects` * `enable-end-user-sharing-with-groups` * `single-agent-orchestration` * `multi-agent-orchestration` * `cross-product-intelligence`
|
|
15070
15729
|
*/
|
|
15071
15730
|
features?: {
|
|
15072
15731
|
[key: string]: string;
|
|
@@ -15294,7 +15953,7 @@ export declare namespace discoveryengine_v1beta {
|
|
|
15294
15953
|
*/
|
|
15295
15954
|
export interface Schema$GoogleCloudDiscoveryengineV1EngineSearchEngineConfig {
|
|
15296
15955
|
/**
|
|
15297
|
-
* Optional. The required subscription tier of this engine.
|
|
15956
|
+
* Optional. The required subscription tier of this engine. If the required subscription tier is search, user with higher license tier like assist can still access the standalone app associated with this engine. Web grounding feature is only available on the app if it is set as SubscriptionTier.SUBSCRIPTION_TIER_SEARCH_AND_ASSISTANT.
|
|
15298
15957
|
*/
|
|
15299
15958
|
requiredSubscriptionTier?: string | null;
|
|
15300
15959
|
/**
|
|
@@ -15565,6 +16224,10 @@ export declare namespace discoveryengine_v1beta {
|
|
|
15565
16224
|
* Output only. Whether the license config is for Gemini bundle.
|
|
15566
16225
|
*/
|
|
15567
16226
|
geminiBundle?: boolean | null;
|
|
16227
|
+
/**
|
|
16228
|
+
* Optional. Timestamp of the most recent user-initiated update (seat count change or subscription term change). Unlike `update_time`, this field is only stamped when a customer explicitly updates the license (e.g. via the UI), and is not touched by system-driven writes (subscription pipeline, BALC propagation, etc.).
|
|
16229
|
+
*/
|
|
16230
|
+
lastUserUpdateTime?: string | null;
|
|
15568
16231
|
/**
|
|
15569
16232
|
* Required. Number of licenses purchased.
|
|
15570
16233
|
*/
|
|
@@ -15647,6 +16310,10 @@ export declare namespace discoveryengine_v1beta {
|
|
|
15647
16310
|
* Represents the currently effective configurable billing parameters. These values are derived from the customer's subscription history stored internally and reflect the thresholds actively being used for billing purposes at the time of the GetProject call. This includes the start_time of the subscription and may differ from the values in `customer_provided_config` due to billing rules (e.g., scale-downs taking effect only at the start of a new month). We also include the update type to indicate the type of update performed on the configurable billing configuration in the UpdateProject operation.
|
|
15648
16311
|
*/
|
|
15649
16312
|
export interface Schema$GoogleCloudDiscoveryengineV1ProjectConfigurableBillingStatus {
|
|
16313
|
+
/**
|
|
16314
|
+
* Output only. Per-model Agent Search TPM subscription status.
|
|
16315
|
+
*/
|
|
16316
|
+
agentSearchTokenSubscriptionStatuses?: Schema$GoogleCloudDiscoveryengineV1ProjectConfigurableBillingStatusAgentSearchTokenSubscriptionStatus[];
|
|
15650
16317
|
/**
|
|
15651
16318
|
* Optional. The currently effective Indexing Core threshold. This is the threshold against which Indexing Core usage is compared for overage calculations.
|
|
15652
16319
|
*/
|
|
@@ -15676,6 +16343,35 @@ export declare namespace discoveryengine_v1beta {
|
|
|
15676
16343
|
*/
|
|
15677
16344
|
updateType?: string | null;
|
|
15678
16345
|
}
|
|
16346
|
+
/**
|
|
16347
|
+
* Per-model Agent Search TPM subscription status. One entry per active `core_subscription.agent_search_token_subscriptions[*]` entry in the customer-provided config; populated by UpdateProject and GetProject. The lifecycle scalars on this message (`start_time`, `terminate_time`, `update_type`, `tpm_threshold_next_update_time`) are per (project, model_version) — siblings of the whole-relationship `start_time` / `terminate_time` / `update_type` on the enclosing ConfigurableBillingStatus, but scoped to this specific Agent Search TPM subscription instead of to the overall customer-configurable- pricing relationship. This per-instance granularity is intentional: the underlying SubV3 storage is per-(project, model_version), so each model has its own activation, termination, and deferred-update clock; surfacing that on the response gives customers the granularity they need to manage per-model commitments independently. QPM / IndexingCore differ — their storage is one row per (project, location), so their lifecycle is represented only by the whole- relationship scalars on ConfigurableBillingStatus.
|
|
16348
|
+
*/
|
|
16349
|
+
export interface Schema$GoogleCloudDiscoveryengineV1ProjectConfigurableBillingStatusAgentSearchTokenSubscriptionStatus {
|
|
16350
|
+
/**
|
|
16351
|
+
* Output only. The currently effective TPM threshold. Reflects scale-up immediately and scale-down at the next billing cycle, matching `effective_search_qpm_threshold` semantics.
|
|
16352
|
+
*/
|
|
16353
|
+
effectiveTpmThreshold?: string | null;
|
|
16354
|
+
/**
|
|
16355
|
+
* Output only. The Gemini model version this status corresponds to. Matches CoreSubscription.AgentSearchTokenSubscription.model_version (a stable Gemini model version from the Gemini Enterprise Agent Platform model-versions registry; see https://docs.cloud.google.com/gemini-enterprise-agent-platform/models/model-versions#gemini-models).
|
|
16356
|
+
*/
|
|
16357
|
+
modelVersion?: string | null;
|
|
16358
|
+
/**
|
|
16359
|
+
* Output only. When this (project, model_version) Agent Search TPM subscription was first activated. Set once on first activation of this model version and never moved by subsequent threshold updates; on termination + re-activation a new value is recorded. Does NOT move the whole-relationship `start_time` on the enclosing ConfigurableBillingStatus, which continues to represent the first activation of the overall customer-configurable-pricing relationship.
|
|
16360
|
+
*/
|
|
16361
|
+
startTime?: string | null;
|
|
16362
|
+
/**
|
|
16363
|
+
* Output only. If set, the scheduled effective time at which this (project, model_version) Agent Search TPM subscription will terminate. Populated when the customer removes this entry from `core_subscription.agent_search_token_subscriptions[*]`. Does NOT move the whole-relationship `terminate_time` on the enclosing ConfigurableBillingStatus, which is populated only when the entire customer-configurable-pricing relationship is being torn down.
|
|
16364
|
+
*/
|
|
16365
|
+
terminateTime?: string | null;
|
|
16366
|
+
/**
|
|
16367
|
+
* Output only. The earliest next update time for the TPM subscription threshold for this (project, model_version). Populated only after a successful update.
|
|
16368
|
+
*/
|
|
16369
|
+
tpmThresholdNextUpdateTime?: string | null;
|
|
16370
|
+
/**
|
|
16371
|
+
* Output only. The type of the most recent update to this (project, model_version) subscription, as performed by the most recent UpdateProject call. `UPDATE_TYPE_UNSPECIFIED` indicates this model_version was not touched by the most recent UpdateProject (its `effective_tpm_threshold` reflects an earlier update). The whole-relationship `update_type` on the enclosing ConfigurableBillingStatus continues to summarize the direction of the most recent update across all surfaces in the project (QPM, IndexingCore, and Agent Search TPM together).
|
|
16372
|
+
*/
|
|
16373
|
+
updateType?: string | null;
|
|
16374
|
+
}
|
|
15679
16375
|
/**
|
|
15680
16376
|
* Customer provided configurations.
|
|
15681
16377
|
*/
|
|
@@ -15781,7 +16477,7 @@ export declare namespace discoveryengine_v1beta {
|
|
|
15781
16477
|
updateTime?: string | null;
|
|
15782
16478
|
}
|
|
15783
16479
|
/**
|
|
15784
|
-
* Response message for CompletionService.PurgeCompletionSuggestions method.
|
|
16480
|
+
* Response message for CompletionService.PurgeCompletionSuggestions method. If the long running operation is successfully done, then this message is returned by the google.longrunning.Operations.response field.
|
|
15785
16481
|
*/
|
|
15786
16482
|
export interface Schema$GoogleCloudDiscoveryengineV1PurgeCompletionSuggestionsResponse {
|
|
15787
16483
|
/**
|
|
@@ -16433,7 +17129,7 @@ export declare namespace discoveryengine_v1beta {
|
|
|
16433
17129
|
*/
|
|
16434
17130
|
export interface Schema$GoogleCloudDiscoveryengineV1WorkspaceConfig {
|
|
16435
17131
|
/**
|
|
16436
|
-
* Obfuscated Dasher customer ID.
|
|
17132
|
+
* Output only. Obfuscated Dasher customer ID. Derived by the server from the project's GCP organization at data store creation time; any value supplied in the request payload is ignored.
|
|
16437
17133
|
*/
|
|
16438
17134
|
dasherCustomerId?: string | null;
|
|
16439
17135
|
/**
|
|
@@ -23545,6 +24241,7 @@ export declare namespace discoveryengine_v1beta {
|
|
|
23545
24241
|
* // "isPinned": false,
|
|
23546
24242
|
* // "labels": [],
|
|
23547
24243
|
* // "name": "my_name",
|
|
24244
|
+
* // "pendingAsyncAssistOperationId": "my_pendingAsyncAssistOperationId",
|
|
23548
24245
|
* // "startTime": "my_startTime",
|
|
23549
24246
|
* // "state": "my_state",
|
|
23550
24247
|
* // "turns": [],
|
|
@@ -23562,6 +24259,7 @@ export declare namespace discoveryengine_v1beta {
|
|
|
23562
24259
|
* // "isPinned": false,
|
|
23563
24260
|
* // "labels": [],
|
|
23564
24261
|
* // "name": "my_name",
|
|
24262
|
+
* // "pendingAsyncAssistOperationId": "my_pendingAsyncAssistOperationId",
|
|
23565
24263
|
* // "startTime": "my_startTime",
|
|
23566
24264
|
* // "state": "my_state",
|
|
23567
24265
|
* // "turns": [],
|
|
@@ -23706,6 +24404,7 @@ export declare namespace discoveryengine_v1beta {
|
|
|
23706
24404
|
* // "isPinned": false,
|
|
23707
24405
|
* // "labels": [],
|
|
23708
24406
|
* // "name": "my_name",
|
|
24407
|
+
* // "pendingAsyncAssistOperationId": "my_pendingAsyncAssistOperationId",
|
|
23709
24408
|
* // "startTime": "my_startTime",
|
|
23710
24409
|
* // "state": "my_state",
|
|
23711
24410
|
* // "turns": [],
|
|
@@ -23771,7 +24470,7 @@ export declare namespace discoveryengine_v1beta {
|
|
|
23771
24470
|
* {
|
|
23772
24471
|
* // A comma-separated list of fields to filter by, in EBNF grammar. The supported fields are: * `user_pseudo_id` * `state` * `display_name` * `starred` * `is_pinned` * `labels` * `create_time` * `update_time` * `collaborative_project` Examples: * `user_pseudo_id = some_id` * `display_name = "some_name"` * `starred = true` * `is_pinned=true AND (NOT labels:hidden)` * `create_time \> "1970-01-01T12:00:00Z"` * `collaborative_project = "projects/123/locations/global/collections/default_collection/engines/" "default_engine/collaborative_projects/cp1"`
|
|
23773
24472
|
* filter: 'placeholder-value',
|
|
23774
|
-
* // A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported fields: * `update_time` * `create_time` * `session_name` * `is_pinned` Example: * `update_time desc` * `create_time` * `is_pinned desc,update_time desc`: list sessions by is_pinned first, then by update_time.
|
|
24473
|
+
* // A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported fields: * `update_time` * `create_time` * `session_name` * `is_pinned` * `display_name` Example: * `update_time desc` * `create_time` * `is_pinned desc,update_time desc`: list sessions by is_pinned first, then by update_time.
|
|
23775
24474
|
* orderBy: 'placeholder-value',
|
|
23776
24475
|
* // Maximum number of results to return. If unspecified, defaults to 50. Max allowed value is 1000.
|
|
23777
24476
|
* pageSize: 'placeholder-value',
|
|
@@ -23861,6 +24560,7 @@ export declare namespace discoveryengine_v1beta {
|
|
|
23861
24560
|
* // "isPinned": false,
|
|
23862
24561
|
* // "labels": [],
|
|
23863
24562
|
* // "name": "my_name",
|
|
24563
|
+
* // "pendingAsyncAssistOperationId": "my_pendingAsyncAssistOperationId",
|
|
23864
24564
|
* // "startTime": "my_startTime",
|
|
23865
24565
|
* // "state": "my_state",
|
|
23866
24566
|
* // "turns": [],
|
|
@@ -23878,6 +24578,7 @@ export declare namespace discoveryengine_v1beta {
|
|
|
23878
24578
|
* // "isPinned": false,
|
|
23879
24579
|
* // "labels": [],
|
|
23880
24580
|
* // "name": "my_name",
|
|
24581
|
+
* // "pendingAsyncAssistOperationId": "my_pendingAsyncAssistOperationId",
|
|
23881
24582
|
* // "startTime": "my_startTime",
|
|
23882
24583
|
* // "state": "my_state",
|
|
23883
24584
|
* // "turns": [],
|
|
@@ -23940,7 +24641,7 @@ export declare namespace discoveryengine_v1beta {
|
|
|
23940
24641
|
*/
|
|
23941
24642
|
filter?: string;
|
|
23942
24643
|
/**
|
|
23943
|
-
* A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported fields: * `update_time` * `create_time` * `session_name` * `is_pinned` Example: * `update_time desc` * `create_time` * `is_pinned desc,update_time desc`: list sessions by is_pinned first, then by update_time.
|
|
24644
|
+
* A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported fields: * `update_time` * `create_time` * `session_name` * `is_pinned` * `display_name` Example: * `update_time desc` * `create_time` * `is_pinned desc,update_time desc`: list sessions by is_pinned first, then by update_time.
|
|
23944
24645
|
*/
|
|
23945
24646
|
orderBy?: string;
|
|
23946
24647
|
/**
|
|
@@ -26153,6 +26854,7 @@ export declare namespace discoveryengine_v1beta {
|
|
|
26153
26854
|
* // "entity": "my_entity",
|
|
26154
26855
|
* // "eventTime": "my_eventTime",
|
|
26155
26856
|
* // "eventType": "my_eventType",
|
|
26857
|
+
* // "feedback": {},
|
|
26156
26858
|
* // "filter": "my_filter",
|
|
26157
26859
|
* // "mediaInfo": {},
|
|
26158
26860
|
* // "pageInfo": {},
|
|
@@ -26184,6 +26886,7 @@ export declare namespace discoveryengine_v1beta {
|
|
|
26184
26886
|
* // "entity": "my_entity",
|
|
26185
26887
|
* // "eventTime": "my_eventTime",
|
|
26186
26888
|
* // "eventType": "my_eventType",
|
|
26889
|
+
* // "feedback": {},
|
|
26187
26890
|
* // "filter": "my_filter",
|
|
26188
26891
|
* // "mediaInfo": {},
|
|
26189
26892
|
* // "pageInfo": {},
|
|
@@ -26328,6 +27031,7 @@ export declare namespace discoveryengine_v1beta {
|
|
|
26328
27031
|
* // {
|
|
26329
27032
|
* // "agentGatewaySetting": {},
|
|
26330
27033
|
* // "appType": "my_appType",
|
|
27034
|
+
* // "associatedAgentRegistry": "my_associatedAgentRegistry",
|
|
26331
27035
|
* // "chatEngineConfig": {},
|
|
26332
27036
|
* // "chatEngineMetadata": {},
|
|
26333
27037
|
* // "cmekConfig": {},
|
|
@@ -26496,6 +27200,7 @@ export declare namespace discoveryengine_v1beta {
|
|
|
26496
27200
|
* // {
|
|
26497
27201
|
* // "agentGatewaySetting": {},
|
|
26498
27202
|
* // "appType": "my_appType",
|
|
27203
|
+
* // "associatedAgentRegistry": "my_associatedAgentRegistry",
|
|
26499
27204
|
* // "chatEngineConfig": {},
|
|
26500
27205
|
* // "chatEngineMetadata": {},
|
|
26501
27206
|
* // "cmekConfig": {},
|
|
@@ -26730,6 +27435,7 @@ export declare namespace discoveryengine_v1beta {
|
|
|
26730
27435
|
* // {
|
|
26731
27436
|
* // "agentGatewaySetting": {},
|
|
26732
27437
|
* // "appType": "my_appType",
|
|
27438
|
+
* // "associatedAgentRegistry": "my_associatedAgentRegistry",
|
|
26733
27439
|
* // "chatEngineConfig": {},
|
|
26734
27440
|
* // "chatEngineMetadata": {},
|
|
26735
27441
|
* // "cmekConfig": {},
|
|
@@ -26761,6 +27467,7 @@ export declare namespace discoveryengine_v1beta {
|
|
|
26761
27467
|
* // {
|
|
26762
27468
|
* // "agentGatewaySetting": {},
|
|
26763
27469
|
* // "appType": "my_appType",
|
|
27470
|
+
* // "associatedAgentRegistry": "my_associatedAgentRegistry",
|
|
26764
27471
|
* // "chatEngineConfig": {},
|
|
26765
27472
|
* // "chatEngineMetadata": {},
|
|
26766
27473
|
* // "cmekConfig": {},
|
|
@@ -26855,6 +27562,7 @@ export declare namespace discoveryengine_v1beta {
|
|
|
26855
27562
|
* // {
|
|
26856
27563
|
* // "agentGatewaySetting": {},
|
|
26857
27564
|
* // "appType": "my_appType",
|
|
27565
|
+
* // "associatedAgentRegistry": "my_associatedAgentRegistry",
|
|
26858
27566
|
* // "chatEngineConfig": {},
|
|
26859
27567
|
* // "chatEngineMetadata": {},
|
|
26860
27568
|
* // "cmekConfig": {},
|
|
@@ -26949,6 +27657,7 @@ export declare namespace discoveryengine_v1beta {
|
|
|
26949
27657
|
* // {
|
|
26950
27658
|
* // "agentGatewaySetting": {},
|
|
26951
27659
|
* // "appType": "my_appType",
|
|
27660
|
+
* // "associatedAgentRegistry": "my_associatedAgentRegistry",
|
|
26952
27661
|
* // "chatEngineConfig": {},
|
|
26953
27662
|
* // "chatEngineMetadata": {},
|
|
26954
27663
|
* // "cmekConfig": {},
|
|
@@ -26993,7 +27702,7 @@ export declare namespace discoveryengine_v1beta {
|
|
|
26993
27702
|
resume(params: Params$Resource$Projects$Locations$Collections$Engines$Resume, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaEngine>): void;
|
|
26994
27703
|
resume(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaEngine>): void;
|
|
26995
27704
|
/**
|
|
26996
|
-
* Sets the IAM access control policy for an Engine. A `NOT_FOUND` error is returned if the resource does not exist. **Important:** When setting a policy directly on an Engine resource, the only recommended roles in the bindings are: `roles/discoveryengine.user`
|
|
27705
|
+
* Sets the IAM access control policy for an Engine. A `NOT_FOUND` error is returned if the resource does not exist. **Important:** When setting a policy directly on an Engine resource, the only recommended roles in the bindings are: `roles/discoveryengine.admin`, `roles/discoveryengine.agentspaceAdmin`, `roles/discoveryengine.user`, `roles/discoveryengine.agentspaceUser`, `roles/discoveryengine.viewer`, `roles/discoveryengine.agentspaceViewer`. Attempting to grant any other role will result in a warning in logging.
|
|
26997
27706
|
* @example
|
|
26998
27707
|
* ```js
|
|
26999
27708
|
* // Before running the sample:
|
|
@@ -27727,7 +28436,9 @@ export declare namespace discoveryengine_v1beta {
|
|
|
27727
28436
|
* // {
|
|
27728
28437
|
* // "answer": {},
|
|
27729
28438
|
* // "assistToken": "my_assistToken",
|
|
28439
|
+
* // "connectorAuthErrors": [],
|
|
27730
28440
|
* // "invocationTools": [],
|
|
28441
|
+
* // "invokedSkills": [],
|
|
27731
28442
|
* // "sessionInfo": {}
|
|
27732
28443
|
* // }
|
|
27733
28444
|
* }
|
|
@@ -30450,6 +31161,7 @@ export declare namespace discoveryengine_v1beta {
|
|
|
30450
31161
|
* // "isPinned": false,
|
|
30451
31162
|
* // "labels": [],
|
|
30452
31163
|
* // "name": "my_name",
|
|
31164
|
+
* // "pendingAsyncAssistOperationId": "my_pendingAsyncAssistOperationId",
|
|
30453
31165
|
* // "startTime": "my_startTime",
|
|
30454
31166
|
* // "state": "my_state",
|
|
30455
31167
|
* // "turns": [],
|
|
@@ -30467,6 +31179,7 @@ export declare namespace discoveryengine_v1beta {
|
|
|
30467
31179
|
* // "isPinned": false,
|
|
30468
31180
|
* // "labels": [],
|
|
30469
31181
|
* // "name": "my_name",
|
|
31182
|
+
* // "pendingAsyncAssistOperationId": "my_pendingAsyncAssistOperationId",
|
|
30470
31183
|
* // "startTime": "my_startTime",
|
|
30471
31184
|
* // "state": "my_state",
|
|
30472
31185
|
* // "turns": [],
|
|
@@ -30609,6 +31322,7 @@ export declare namespace discoveryengine_v1beta {
|
|
|
30609
31322
|
* // "isPinned": false,
|
|
30610
31323
|
* // "labels": [],
|
|
30611
31324
|
* // "name": "my_name",
|
|
31325
|
+
* // "pendingAsyncAssistOperationId": "my_pendingAsyncAssistOperationId",
|
|
30612
31326
|
* // "startTime": "my_startTime",
|
|
30613
31327
|
* // "state": "my_state",
|
|
30614
31328
|
* // "turns": [],
|
|
@@ -30673,7 +31387,7 @@ export declare namespace discoveryengine_v1beta {
|
|
|
30673
31387
|
* await discoveryengine.projects.locations.collections.engines.sessions.list({
|
|
30674
31388
|
* // A comma-separated list of fields to filter by, in EBNF grammar. The supported fields are: * `user_pseudo_id` * `state` * `display_name` * `starred` * `is_pinned` * `labels` * `create_time` * `update_time` * `collaborative_project` Examples: * `user_pseudo_id = some_id` * `display_name = "some_name"` * `starred = true` * `is_pinned=true AND (NOT labels:hidden)` * `create_time \> "1970-01-01T12:00:00Z"` * `collaborative_project = "projects/123/locations/global/collections/default_collection/engines/" "default_engine/collaborative_projects/cp1"`
|
|
30675
31389
|
* filter: 'placeholder-value',
|
|
30676
|
-
* // A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported fields: * `update_time` * `create_time` * `session_name` * `is_pinned` Example: * `update_time desc` * `create_time` * `is_pinned desc,update_time desc`: list sessions by is_pinned first, then by update_time.
|
|
31390
|
+
* // A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported fields: * `update_time` * `create_time` * `session_name` * `is_pinned` * `display_name` Example: * `update_time desc` * `create_time` * `is_pinned desc,update_time desc`: list sessions by is_pinned first, then by update_time.
|
|
30677
31391
|
* orderBy: 'placeholder-value',
|
|
30678
31392
|
* // Maximum number of results to return. If unspecified, defaults to 50. Max allowed value is 1000.
|
|
30679
31393
|
* pageSize: 'placeholder-value',
|
|
@@ -30762,6 +31476,7 @@ export declare namespace discoveryengine_v1beta {
|
|
|
30762
31476
|
* // "isPinned": false,
|
|
30763
31477
|
* // "labels": [],
|
|
30764
31478
|
* // "name": "my_name",
|
|
31479
|
+
* // "pendingAsyncAssistOperationId": "my_pendingAsyncAssistOperationId",
|
|
30765
31480
|
* // "startTime": "my_startTime",
|
|
30766
31481
|
* // "state": "my_state",
|
|
30767
31482
|
* // "turns": [],
|
|
@@ -30779,6 +31494,7 @@ export declare namespace discoveryengine_v1beta {
|
|
|
30779
31494
|
* // "isPinned": false,
|
|
30780
31495
|
* // "labels": [],
|
|
30781
31496
|
* // "name": "my_name",
|
|
31497
|
+
* // "pendingAsyncAssistOperationId": "my_pendingAsyncAssistOperationId",
|
|
30782
31498
|
* // "startTime": "my_startTime",
|
|
30783
31499
|
* // "state": "my_state",
|
|
30784
31500
|
* // "turns": [],
|
|
@@ -30841,7 +31557,7 @@ export declare namespace discoveryengine_v1beta {
|
|
|
30841
31557
|
*/
|
|
30842
31558
|
filter?: string;
|
|
30843
31559
|
/**
|
|
30844
|
-
* A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported fields: * `update_time` * `create_time` * `session_name` * `is_pinned` Example: * `update_time desc` * `create_time` * `is_pinned desc,update_time desc`: list sessions by is_pinned first, then by update_time.
|
|
31560
|
+
* A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported fields: * `update_time` * `create_time` * `session_name` * `is_pinned` * `display_name` Example: * `update_time desc` * `create_time` * `is_pinned desc,update_time desc`: list sessions by is_pinned first, then by update_time.
|
|
30845
31561
|
*/
|
|
30846
31562
|
orderBy?: string;
|
|
30847
31563
|
/**
|
|
@@ -36094,6 +36810,7 @@ export declare namespace discoveryengine_v1beta {
|
|
|
36094
36810
|
* // "isPinned": false,
|
|
36095
36811
|
* // "labels": [],
|
|
36096
36812
|
* // "name": "my_name",
|
|
36813
|
+
* // "pendingAsyncAssistOperationId": "my_pendingAsyncAssistOperationId",
|
|
36097
36814
|
* // "startTime": "my_startTime",
|
|
36098
36815
|
* // "state": "my_state",
|
|
36099
36816
|
* // "turns": [],
|
|
@@ -36110,6 +36827,7 @@ export declare namespace discoveryengine_v1beta {
|
|
|
36110
36827
|
* // "isPinned": false,
|
|
36111
36828
|
* // "labels": [],
|
|
36112
36829
|
* // "name": "my_name",
|
|
36830
|
+
* // "pendingAsyncAssistOperationId": "my_pendingAsyncAssistOperationId",
|
|
36113
36831
|
* // "startTime": "my_startTime",
|
|
36114
36832
|
* // "state": "my_state",
|
|
36115
36833
|
* // "turns": [],
|
|
@@ -36249,6 +36967,7 @@ export declare namespace discoveryengine_v1beta {
|
|
|
36249
36967
|
* // "isPinned": false,
|
|
36250
36968
|
* // "labels": [],
|
|
36251
36969
|
* // "name": "my_name",
|
|
36970
|
+
* // "pendingAsyncAssistOperationId": "my_pendingAsyncAssistOperationId",
|
|
36252
36971
|
* // "startTime": "my_startTime",
|
|
36253
36972
|
* // "state": "my_state",
|
|
36254
36973
|
* // "turns": [],
|
|
@@ -36313,7 +37032,7 @@ export declare namespace discoveryengine_v1beta {
|
|
|
36313
37032
|
* {
|
|
36314
37033
|
* // A comma-separated list of fields to filter by, in EBNF grammar. The supported fields are: * `user_pseudo_id` * `state` * `display_name` * `starred` * `is_pinned` * `labels` * `create_time` * `update_time` * `collaborative_project` Examples: * `user_pseudo_id = some_id` * `display_name = "some_name"` * `starred = true` * `is_pinned=true AND (NOT labels:hidden)` * `create_time \> "1970-01-01T12:00:00Z"` * `collaborative_project = "projects/123/locations/global/collections/default_collection/engines/" "default_engine/collaborative_projects/cp1"`
|
|
36315
37034
|
* filter: 'placeholder-value',
|
|
36316
|
-
* // A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported fields: * `update_time` * `create_time` * `session_name` * `is_pinned` Example: * `update_time desc` * `create_time` * `is_pinned desc,update_time desc`: list sessions by is_pinned first, then by update_time.
|
|
37035
|
+
* // A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported fields: * `update_time` * `create_time` * `session_name` * `is_pinned` * `display_name` Example: * `update_time desc` * `create_time` * `is_pinned desc,update_time desc`: list sessions by is_pinned first, then by update_time.
|
|
36317
37036
|
* orderBy: 'placeholder-value',
|
|
36318
37037
|
* // Maximum number of results to return. If unspecified, defaults to 50. Max allowed value is 1000.
|
|
36319
37038
|
* pageSize: 'placeholder-value',
|
|
@@ -36402,6 +37121,7 @@ export declare namespace discoveryengine_v1beta {
|
|
|
36402
37121
|
* // "isPinned": false,
|
|
36403
37122
|
* // "labels": [],
|
|
36404
37123
|
* // "name": "my_name",
|
|
37124
|
+
* // "pendingAsyncAssistOperationId": "my_pendingAsyncAssistOperationId",
|
|
36405
37125
|
* // "startTime": "my_startTime",
|
|
36406
37126
|
* // "state": "my_state",
|
|
36407
37127
|
* // "turns": [],
|
|
@@ -36418,6 +37138,7 @@ export declare namespace discoveryengine_v1beta {
|
|
|
36418
37138
|
* // "isPinned": false,
|
|
36419
37139
|
* // "labels": [],
|
|
36420
37140
|
* // "name": "my_name",
|
|
37141
|
+
* // "pendingAsyncAssistOperationId": "my_pendingAsyncAssistOperationId",
|
|
36421
37142
|
* // "startTime": "my_startTime",
|
|
36422
37143
|
* // "state": "my_state",
|
|
36423
37144
|
* // "turns": [],
|
|
@@ -36480,7 +37201,7 @@ export declare namespace discoveryengine_v1beta {
|
|
|
36480
37201
|
*/
|
|
36481
37202
|
filter?: string;
|
|
36482
37203
|
/**
|
|
36483
|
-
* A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported fields: * `update_time` * `create_time` * `session_name` * `is_pinned` Example: * `update_time desc` * `create_time` * `is_pinned desc,update_time desc`: list sessions by is_pinned first, then by update_time.
|
|
37204
|
+
* A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported fields: * `update_time` * `create_time` * `session_name` * `is_pinned` * `display_name` Example: * `update_time desc` * `create_time` * `is_pinned desc,update_time desc`: list sessions by is_pinned first, then by update_time.
|
|
36484
37205
|
*/
|
|
36485
37206
|
orderBy?: string;
|
|
36486
37207
|
/**
|
|
@@ -38145,6 +38866,7 @@ export declare namespace discoveryengine_v1beta {
|
|
|
38145
38866
|
* // "entity": "my_entity",
|
|
38146
38867
|
* // "eventTime": "my_eventTime",
|
|
38147
38868
|
* // "eventType": "my_eventType",
|
|
38869
|
+
* // "feedback": {},
|
|
38148
38870
|
* // "filter": "my_filter",
|
|
38149
38871
|
* // "mediaInfo": {},
|
|
38150
38872
|
* // "pageInfo": {},
|
|
@@ -38175,6 +38897,7 @@ export declare namespace discoveryengine_v1beta {
|
|
|
38175
38897
|
* // "entity": "my_entity",
|
|
38176
38898
|
* // "eventTime": "my_eventTime",
|
|
38177
38899
|
* // "eventType": "my_eventType",
|
|
38900
|
+
* // "feedback": {},
|
|
38178
38901
|
* // "filter": "my_filter",
|
|
38179
38902
|
* // "mediaInfo": {},
|
|
38180
38903
|
* // "pageInfo": {},
|
|
@@ -39620,6 +40343,7 @@ export declare namespace discoveryengine_v1beta {
|
|
|
39620
40343
|
* // "endDate": {},
|
|
39621
40344
|
* // "freeTrial": false,
|
|
39622
40345
|
* // "geminiBundle": false,
|
|
40346
|
+
* // "lastUserUpdateTime": "my_lastUserUpdateTime",
|
|
39623
40347
|
* // "licenseCount": "my_licenseCount",
|
|
39624
40348
|
* // "name": "my_name",
|
|
39625
40349
|
* // "startDate": {},
|
|
@@ -39639,6 +40363,7 @@ export declare namespace discoveryengine_v1beta {
|
|
|
39639
40363
|
* // "endDate": {},
|
|
39640
40364
|
* // "freeTrial": false,
|
|
39641
40365
|
* // "geminiBundle": false,
|
|
40366
|
+
* // "lastUserUpdateTime": "my_lastUserUpdateTime",
|
|
39642
40367
|
* // "licenseCount": "my_licenseCount",
|
|
39643
40368
|
* // "name": "my_name",
|
|
39644
40369
|
* // "startDate": {},
|
|
@@ -39714,6 +40439,7 @@ export declare namespace discoveryengine_v1beta {
|
|
|
39714
40439
|
* // "endDate": {},
|
|
39715
40440
|
* // "freeTrial": false,
|
|
39716
40441
|
* // "geminiBundle": false,
|
|
40442
|
+
* // "lastUserUpdateTime": "my_lastUserUpdateTime",
|
|
39717
40443
|
* // "licenseCount": "my_licenseCount",
|
|
39718
40444
|
* // "name": "my_name",
|
|
39719
40445
|
* // "startDate": {},
|
|
@@ -39741,6 +40467,77 @@ export declare namespace discoveryengine_v1beta {
|
|
|
39741
40467
|
get(params: Params$Resource$Projects$Locations$Licenseconfigs$Get, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaLicenseConfig>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaLicenseConfig>): void;
|
|
39742
40468
|
get(params: Params$Resource$Projects$Locations$Licenseconfigs$Get, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaLicenseConfig>): void;
|
|
39743
40469
|
get(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaLicenseConfig>): void;
|
|
40470
|
+
/**
|
|
40471
|
+
* Lists all the LicenseConfigs associated with the project.
|
|
40472
|
+
* @example
|
|
40473
|
+
* ```js
|
|
40474
|
+
* // Before running the sample:
|
|
40475
|
+
* // - Enable the API at:
|
|
40476
|
+
* // https://console.developers.google.com/apis/api/discoveryengine.googleapis.com
|
|
40477
|
+
* // - Login into gcloud by running:
|
|
40478
|
+
* // ```sh
|
|
40479
|
+
* // $ gcloud auth application-default login
|
|
40480
|
+
* // ```
|
|
40481
|
+
* // - Install the npm module by running:
|
|
40482
|
+
* // ```sh
|
|
40483
|
+
* // $ npm install googleapis
|
|
40484
|
+
* // ```
|
|
40485
|
+
*
|
|
40486
|
+
* const {google} = require('googleapis');
|
|
40487
|
+
* const discoveryengine = google.discoveryengine('v1beta');
|
|
40488
|
+
*
|
|
40489
|
+
* async function main() {
|
|
40490
|
+
* const auth = new google.auth.GoogleAuth({
|
|
40491
|
+
* // Scopes can be specified either as an array or as a single, space-delimited string.
|
|
40492
|
+
* scopes: [
|
|
40493
|
+
* 'https://www.googleapis.com/auth/cloud-platform',
|
|
40494
|
+
* 'https://www.googleapis.com/auth/discoveryengine.readwrite',
|
|
40495
|
+
* 'https://www.googleapis.com/auth/discoveryengine.serving.readwrite',
|
|
40496
|
+
* ],
|
|
40497
|
+
* });
|
|
40498
|
+
*
|
|
40499
|
+
* // Acquire an auth client, and bind it to all future calls
|
|
40500
|
+
* const authClient = await auth.getClient();
|
|
40501
|
+
* google.options({auth: authClient});
|
|
40502
|
+
*
|
|
40503
|
+
* // Do the magic
|
|
40504
|
+
* const res = await discoveryengine.projects.locations.licenseConfigs.list({
|
|
40505
|
+
* // Optional. The filter to apply to the list results. The supported fields are: * `subscription_tier` * `state` Examples: * `subscription_tier=SUBSCRIPTION_TIER_SEARCH,state=ACTIVE` - Lists all active search license configs. * `state=ACTIVE` - Lists all active license configs. The filter string should be a comma-separated list of field=value pairs.
|
|
40506
|
+
* filter: 'placeholder-value',
|
|
40507
|
+
* // Optional. Not supported.
|
|
40508
|
+
* pageSize: 'placeholder-value',
|
|
40509
|
+
* // Optional. Not supported.
|
|
40510
|
+
* pageToken: 'placeholder-value',
|
|
40511
|
+
* // Required. The parent branch resource name, such as `projects/{project\}/locations/{location\}`.
|
|
40512
|
+
* parent: 'projects/my-project/locations/my-location',
|
|
40513
|
+
* });
|
|
40514
|
+
* console.log(res.data);
|
|
40515
|
+
*
|
|
40516
|
+
* // Example response
|
|
40517
|
+
* // {
|
|
40518
|
+
* // "licenseConfigs": [],
|
|
40519
|
+
* // "nextPageToken": "my_nextPageToken"
|
|
40520
|
+
* // }
|
|
40521
|
+
* }
|
|
40522
|
+
*
|
|
40523
|
+
* main().catch(e => {
|
|
40524
|
+
* console.error(e);
|
|
40525
|
+
* throw e;
|
|
40526
|
+
* });
|
|
40527
|
+
*
|
|
40528
|
+
* ```
|
|
40529
|
+
*
|
|
40530
|
+
* @param params - Parameters for request
|
|
40531
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
40532
|
+
* @param callback - Optional callback that handles the response.
|
|
40533
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
40534
|
+
*/
|
|
40535
|
+
list(params: Params$Resource$Projects$Locations$Licenseconfigs$List, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
|
|
40536
|
+
list(params?: Params$Resource$Projects$Locations$Licenseconfigs$List, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$GoogleCloudDiscoveryengineV1betaListLicenseConfigsResponse>>;
|
|
40537
|
+
list(params: Params$Resource$Projects$Locations$Licenseconfigs$List, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
40538
|
+
list(params: Params$Resource$Projects$Locations$Licenseconfigs$List, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaListLicenseConfigsResponse>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaListLicenseConfigsResponse>): void;
|
|
40539
|
+
list(params: Params$Resource$Projects$Locations$Licenseconfigs$List, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaListLicenseConfigsResponse>): void;
|
|
40540
|
+
list(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaListLicenseConfigsResponse>): void;
|
|
39744
40541
|
/**
|
|
39745
40542
|
* Updates the LicenseConfig
|
|
39746
40543
|
* @example
|
|
@@ -39791,6 +40588,7 @@ export declare namespace discoveryengine_v1beta {
|
|
|
39791
40588
|
* // "endDate": {},
|
|
39792
40589
|
* // "freeTrial": false,
|
|
39793
40590
|
* // "geminiBundle": false,
|
|
40591
|
+
* // "lastUserUpdateTime": "my_lastUserUpdateTime",
|
|
39794
40592
|
* // "licenseCount": "my_licenseCount",
|
|
39795
40593
|
* // "name": "my_name",
|
|
39796
40594
|
* // "startDate": {},
|
|
@@ -39810,6 +40608,7 @@ export declare namespace discoveryengine_v1beta {
|
|
|
39810
40608
|
* // "endDate": {},
|
|
39811
40609
|
* // "freeTrial": false,
|
|
39812
40610
|
* // "geminiBundle": false,
|
|
40611
|
+
* // "lastUserUpdateTime": "my_lastUserUpdateTime",
|
|
39813
40612
|
* // "licenseCount": "my_licenseCount",
|
|
39814
40613
|
* // "name": "my_name",
|
|
39815
40614
|
* // "startDate": {},
|
|
@@ -39858,6 +40657,24 @@ export declare namespace discoveryengine_v1beta {
|
|
|
39858
40657
|
*/
|
|
39859
40658
|
name?: string;
|
|
39860
40659
|
}
|
|
40660
|
+
export interface Params$Resource$Projects$Locations$Licenseconfigs$List extends StandardParameters {
|
|
40661
|
+
/**
|
|
40662
|
+
* Optional. The filter to apply to the list results. The supported fields are: * `subscription_tier` * `state` Examples: * `subscription_tier=SUBSCRIPTION_TIER_SEARCH,state=ACTIVE` - Lists all active search license configs. * `state=ACTIVE` - Lists all active license configs. The filter string should be a comma-separated list of field=value pairs.
|
|
40663
|
+
*/
|
|
40664
|
+
filter?: string;
|
|
40665
|
+
/**
|
|
40666
|
+
* Optional. Not supported.
|
|
40667
|
+
*/
|
|
40668
|
+
pageSize?: number;
|
|
40669
|
+
/**
|
|
40670
|
+
* Optional. Not supported.
|
|
40671
|
+
*/
|
|
40672
|
+
pageToken?: string;
|
|
40673
|
+
/**
|
|
40674
|
+
* Required. The parent branch resource name, such as `projects/{project\}/locations/{location\}`.
|
|
40675
|
+
*/
|
|
40676
|
+
parent?: string;
|
|
40677
|
+
}
|
|
39861
40678
|
export interface Params$Resource$Projects$Locations$Licenseconfigs$Patch extends StandardParameters {
|
|
39862
40679
|
/**
|
|
39863
40680
|
* Immutable. Identifier. The fully qualified resource name of the license config. Format: `projects/{project\}/locations/{location\}/licenseConfigs/{license_config\}`
|
|
@@ -41449,6 +42266,7 @@ export declare namespace discoveryengine_v1beta {
|
|
|
41449
42266
|
* // "entity": "my_entity",
|
|
41450
42267
|
* // "eventTime": "my_eventTime",
|
|
41451
42268
|
* // "eventType": "my_eventType",
|
|
42269
|
+
* // "feedback": {},
|
|
41452
42270
|
* // "filter": "my_filter",
|
|
41453
42271
|
* // "mediaInfo": {},
|
|
41454
42272
|
* // "pageInfo": {},
|
|
@@ -41479,6 +42297,7 @@ export declare namespace discoveryengine_v1beta {
|
|
|
41479
42297
|
* // "entity": "my_entity",
|
|
41480
42298
|
* // "eventTime": "my_eventTime",
|
|
41481
42299
|
* // "eventType": "my_eventType",
|
|
42300
|
+
* // "feedback": {},
|
|
41482
42301
|
* // "filter": "my_filter",
|
|
41483
42302
|
* // "mediaInfo": {},
|
|
41484
42303
|
* // "pageInfo": {},
|
|
@@ -41943,7 +42762,7 @@ export declare namespace discoveryengine_v1beta {
|
|
|
41943
42762
|
* filter: 'placeholder-value',
|
|
41944
42763
|
* // Optional. The order in which the UserLicenses are listed. The value must be a comma-separated list of fields. Default sorting order is ascending. To specify descending order for a field, append a " desc" suffix. Redundant space characters in the syntax are insignificant. Supported fields (only `user_principal` is supported for now): * `user_principal` If not set, the default ordering is by `user_principal`. Examples: * `user_principal` to order by `user_principal` in ascending order. * `user_principal desc` to order by `user_principal` in descending order.
|
|
41945
42764
|
* orderBy: 'placeholder-value',
|
|
41946
|
-
* // Optional. Requested page size. Server may return fewer items than requested. If unspecified, defaults to
|
|
42765
|
+
* // Optional. Requested page size. Server may return fewer items than requested. If unspecified, defaults to 100. The maximum value is 1000; values above 1000 will be coerced to 1000. If this field is negative, an INVALID_ARGUMENT error is returned.
|
|
41947
42766
|
* pageSize: 'placeholder-value',
|
|
41948
42767
|
* // Optional. A page token, received from a previous `ListUserLicenses` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListUserLicenses` must match the call that provided the page token.
|
|
41949
42768
|
* pageToken: 'placeholder-value',
|
|
@@ -41989,7 +42808,7 @@ export declare namespace discoveryengine_v1beta {
|
|
|
41989
42808
|
*/
|
|
41990
42809
|
orderBy?: string;
|
|
41991
42810
|
/**
|
|
41992
|
-
* Optional. Requested page size. Server may return fewer items than requested. If unspecified, defaults to
|
|
42811
|
+
* Optional. Requested page size. Server may return fewer items than requested. If unspecified, defaults to 100. The maximum value is 1000; values above 1000 will be coerced to 1000. If this field is negative, an INVALID_ARGUMENT error is returned.
|
|
41993
42812
|
*/
|
|
41994
42813
|
pageSize?: number;
|
|
41995
42814
|
/**
|