googleapis
Version:
Google APIs Client Library for Node.js
1,010 lines • 2.8 MB
TypeScript
import { OAuth2Client, JWT, Compute, UserRefreshClient, BaseExternalAccountClient, GaxiosResponseWithHTTP2, GoogleConfigurable, MethodOptions, StreamMethodOptions, GlobalOptions, GoogleAuth, BodyResponseCallback, APIRequestContext } from 'googleapis-common';
import { Readable } from 'stream';
export declare namespace discoveryengine_v1alpha {
export interface Options extends GlobalOptions {
version: 'v1alpha';
}
interface StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient | BaseExternalAccountClient | GoogleAuth;
/**
* V1 error format.
*/
'$.xgafv'?: string;
/**
* OAuth access token.
*/
access_token?: string;
/**
* Data format for response.
*/
alt?: string;
/**
* JSONP
*/
callback?: string;
/**
* Selector specifying which fields to include in a partial response.
*/
fields?: string;
/**
* API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
*/
key?: string;
/**
* OAuth 2.0 token for the current user.
*/
oauth_token?: string;
/**
* Returns response with indentations and line breaks.
*/
prettyPrint?: boolean;
/**
* Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
*/
quotaUser?: string;
/**
* Legacy upload protocol for media (e.g. "media", "multipart").
*/
uploadType?: string;
/**
* Upload protocol for media (e.g. "raw", "multipart").
*/
upload_protocol?: string;
}
/**
* Discovery Engine API
*
* Discovery Engine API.
*
* @example
* ```js
* const {google} = require('googleapis');
* const discoveryengine = google.discoveryengine('v1alpha');
* ```
*/
export class Discoveryengine {
context: APIRequestContext;
billingAccounts: Resource$Billingaccounts;
projects: Resource$Projects;
constructor(options: GlobalOptions, google?: GoogleConfigurable);
}
/**
* `Distribution` contains summary statistics for a population of values. It optionally contains a histogram representing the distribution of those values across a set of buckets. The summary statistics are the count, mean, sum of the squared deviation from the mean, the minimum, and the maximum of the set of population of values. The histogram is based on a sequence of buckets and gives a count of values that fall into each bucket. The boundaries of the buckets are given either explicitly or by formulas for buckets of fixed or exponentially increasing widths. Although it is not forbidden, it is generally a bad idea to include non-finite values (infinities or NaNs) in the population of values, as this will render the `mean` and `sum_of_squared_deviation` fields meaningless.
*/
export interface Schema$GoogleApiDistribution {
/**
* The number of values in each bucket of the histogram, as described in `bucket_options`. If the distribution does not have a histogram, then omit this field. If there is a histogram, then the sum of the values in `bucket_counts` must equal the value in the `count` field of the distribution. If present, `bucket_counts` should contain N values, where N is the number of buckets specified in `bucket_options`. If you supply fewer than N values, the remaining values are assumed to be 0. The order of the values in `bucket_counts` follows the bucket numbering schemes described for the three bucket types. The first value must be the count for the underflow bucket (number 0). The next N-2 values are the counts for the finite buckets (number 1 through N-2). The N'th value in `bucket_counts` is the count for the overflow bucket (number N-1).
*/
bucketCounts?: string[] | null;
/**
* Defines the histogram bucket boundaries. If the distribution does not contain a histogram, then omit this field.
*/
bucketOptions?: Schema$GoogleApiDistributionBucketOptions;
/**
* The number of values in the population. Must be non-negative. This value must equal the sum of the values in `bucket_counts` if a histogram is provided.
*/
count?: string | null;
/**
* Must be in increasing order of `value` field.
*/
exemplars?: Schema$GoogleApiDistributionExemplar[];
/**
* The arithmetic mean of the values in the population. If `count` is zero then this field must be zero.
*/
mean?: number | null;
/**
* If specified, contains the range of the population values. The field must not be present if the `count` is zero.
*/
range?: Schema$GoogleApiDistributionRange;
/**
* The sum of squared deviations from the mean of the values in the population. For values x_i this is: Sum[i=1..n]((x_i - mean)^2) Knuth, "The Art of Computer Programming", Vol. 2, page 232, 3rd edition describes Welford's method for accumulating this sum in one pass. If `count` is zero then this field must be zero.
*/
sumOfSquaredDeviation?: number | null;
}
/**
* `BucketOptions` describes the bucket boundaries used to create a histogram for the distribution. The buckets can be in a linear sequence, an exponential sequence, or each bucket can be specified explicitly. `BucketOptions` does not include the number of values in each bucket. A bucket has an inclusive lower bound and exclusive upper bound for the values that are counted for that bucket. The upper bound of a bucket must be strictly greater than the lower bound. The sequence of N buckets for a distribution consists of an underflow bucket (number 0), zero or more finite buckets (number 1 through N - 2) and an overflow bucket (number N - 1). The buckets are contiguous: the lower bound of bucket i (i \> 0) is the same as the upper bound of bucket i - 1. The buckets span the whole range of finite values: lower bound of the underflow bucket is -infinity and the upper bound of the overflow bucket is +infinity. The finite buckets are so-called because both bounds are finite.
*/
export interface Schema$GoogleApiDistributionBucketOptions {
/**
* The explicit buckets.
*/
explicitBuckets?: Schema$GoogleApiDistributionBucketOptionsExplicit;
/**
* The exponential buckets.
*/
exponentialBuckets?: Schema$GoogleApiDistributionBucketOptionsExponential;
/**
* The linear bucket.
*/
linearBuckets?: Schema$GoogleApiDistributionBucketOptionsLinear;
}
/**
* Specifies a set of buckets with arbitrary widths. There are `size(bounds) + 1` (= N) buckets. Bucket `i` has the following boundaries: Upper bound (0 <= i < N-1): bounds[i] Lower bound (1 <= i < N); bounds[i - 1] The `bounds` field must contain at least one element. If `bounds` has only one element, then there are no finite buckets, and that single element is the common boundary of the overflow and underflow buckets.
*/
export interface Schema$GoogleApiDistributionBucketOptionsExplicit {
/**
* The values must be monotonically increasing.
*/
bounds?: number[] | null;
}
/**
* Specifies an exponential sequence of buckets that have a width that is proportional to the value of the lower bound. Each bucket represents a constant relative uncertainty on a specific value in the bucket. There are `num_finite_buckets + 2` (= N) buckets. Bucket `i` has the following boundaries: Upper bound (0 <= i < N-1): scale * (growth_factor ^ i). Lower bound (1 <= i < N): scale * (growth_factor ^ (i - 1)).
*/
export interface Schema$GoogleApiDistributionBucketOptionsExponential {
/**
* Must be greater than 1.
*/
growthFactor?: number | null;
/**
* Must be greater than 0.
*/
numFiniteBuckets?: number | null;
/**
* Must be greater than 0.
*/
scale?: number | null;
}
/**
* Specifies a linear sequence of buckets that all have the same width (except overflow and underflow). Each bucket represents a constant absolute uncertainty on the specific value in the bucket. There are `num_finite_buckets + 2` (= N) buckets. Bucket `i` has the following boundaries: Upper bound (0 <= i < N-1): offset + (width * i). Lower bound (1 <= i < N): offset + (width * (i - 1)).
*/
export interface Schema$GoogleApiDistributionBucketOptionsLinear {
/**
* Must be greater than 0.
*/
numFiniteBuckets?: number | null;
/**
* Lower bound of the first bucket.
*/
offset?: number | null;
/**
* Must be greater than 0.
*/
width?: number | null;
}
/**
* Exemplars are example points that may be used to annotate aggregated distribution values. They are metadata that gives information about a particular value added to a Distribution bucket, such as a trace ID that was active when a value was added. They may contain further information, such as a example values and timestamps, origin, etc.
*/
export interface Schema$GoogleApiDistributionExemplar {
/**
* Contextual information about the example value. Examples are: Trace: type.googleapis.com/google.monitoring.v3.SpanContext Literal string: type.googleapis.com/google.protobuf.StringValue Labels dropped during aggregation: type.googleapis.com/google.monitoring.v3.DroppedLabels There may be only a single attachment of any given message type in a single exemplar, and this is enforced by the system.
*/
attachments?: Array<{
[key: string]: any;
}> | null;
/**
* The observation (sampling) time of the above value.
*/
timestamp?: string | null;
/**
* Value of the exemplar point. This value determines to which bucket the exemplar belongs.
*/
value?: number | null;
}
/**
* The range of the population values.
*/
export interface Schema$GoogleApiDistributionRange {
/**
* The maximum of the population values.
*/
max?: number | null;
/**
* The minimum of the population values.
*/
min?: number | null;
}
/**
* Message that represents an arbitrary HTTP body. It should only be used for payload formats that can't be represented as JSON, such as raw binary or an HTML page. This message can be used both in streaming and non-streaming API methods in the request as well as the response. It can be used as a top-level request field, which is convenient if one wants to extract parameters from either the URL or HTTP template into the request fields and also want access to the raw HTTP body. Example: message GetResourceRequest { // A unique request id. string request_id = 1; // The raw HTTP body is bound to this field. google.api.HttpBody http_body = 2; \} service ResourceService { rpc GetResource(GetResourceRequest) returns (google.api.HttpBody); rpc UpdateResource(google.api.HttpBody) returns (google.protobuf.Empty); \} Example with streaming methods: service CaldavService { rpc GetCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); rpc UpdateCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); \} Use of this type only changes how the request and response bodies are handled, all other features will continue to work unchanged.
*/
export interface Schema$GoogleApiHttpBody {
/**
* The HTTP Content-Type header value specifying the content type of the body.
*/
contentType?: string | null;
/**
* The HTTP request/response body as raw binary.
*/
data?: string | null;
/**
* Application specific response metadata. Must be set in the first response for streaming APIs.
*/
extensions?: Array<{
[key: string]: any;
}> | null;
}
/**
* A specific metric, identified by specifying values for all of the labels of a `MetricDescriptor`.
*/
export interface Schema$GoogleApiMetric {
/**
* The set of label values that uniquely identify this metric. All labels listed in the `MetricDescriptor` must be assigned values.
*/
labels?: {
[key: string]: string;
} | null;
/**
* An existing metric type, see google.api.MetricDescriptor. For example, `custom.googleapis.com/invoice/paid/amount`.
*/
type?: string | null;
}
/**
* An object representing a resource that can be used for monitoring, logging, billing, or other purposes. Examples include virtual machine instances, databases, and storage devices such as disks. The `type` field identifies a MonitoredResourceDescriptor object that describes the resource's schema. Information in the `labels` field identifies the actual resource and its attributes according to the schema. For example, a particular Compute Engine VM instance could be represented by the following object, because the MonitoredResourceDescriptor for `"gce_instance"` has labels `"project_id"`, `"instance_id"` and `"zone"`: { "type": "gce_instance", "labels": { "project_id": "my-project", "instance_id": "12345678901234", "zone": "us-central1-a" \}\}
*/
export interface Schema$GoogleApiMonitoredResource {
/**
* Required. Values for all of the labels listed in the associated monitored resource descriptor. For example, Compute Engine VM instances use the labels `"project_id"`, `"instance_id"`, and `"zone"`.
*/
labels?: {
[key: string]: string;
} | null;
/**
* Required. The monitored resource type. This field must match the `type` field of a MonitoredResourceDescriptor object. For example, the type of a Compute Engine VM instance is `gce_instance`. Some descriptors include the service name in the type; for example, the type of a Datastream stream is `datastream.googleapis.com/Stream`.
*/
type?: string | null;
}
/**
* Auxiliary metadata for a MonitoredResource object. MonitoredResource objects contain the minimum set of information to uniquely identify a monitored resource instance. There is some other useful auxiliary metadata. Monitoring and Logging use an ingestion pipeline to extract metadata for cloud resources of all types, and store the metadata in this message.
*/
export interface Schema$GoogleApiMonitoredResourceMetadata {
/**
* Output only. Values for predefined system metadata labels. System labels are a kind of metadata extracted by Google, including "machine_image", "vpc", "subnet_id", "security_group", "name", etc. System label values can be only strings, Boolean values, or a list of strings. For example: { "name": "my-test-instance", "security_group": ["a", "b", "c"], "spot_instance": false \}
*/
systemLabels?: {
[key: string]: any;
} | null;
/**
* Output only. A map of user-defined metadata labels.
*/
userLabels?: {
[key: string]: string;
} | null;
}
/**
* The error payload that is populated on LRO sync APIs, including the following: * `google.cloud.discoveryengine.v1main.DataConnectorService.SetUpDataConnector` * `google.cloud.discoveryengine.v1main.DataConnectorService.StartConnectorRun`
*/
export interface Schema$GoogleCloudDiscoveryengineLoggingConnectorRunErrorContext {
/**
* The full resource name of the Connector Run. Format: `projects/x/locations/x/collections/x/dataConnector/connectorRuns/x`. The `connector_run_id` is system-generated.
*/
connectorRun?: string | null;
/**
* The full resource name of the DataConnector. Format: `projects/x/locations/x/collections/x/dataConnector`.
*/
dataConnector?: string | null;
/**
* The time when the connector run ended.
*/
endTime?: string | null;
/**
* The entity to sync for the connector run.
*/
entity?: string | null;
/**
* The operation resource name of the LRO to sync the connector.
*/
operation?: string | null;
/**
* The time when the connector run started.
*/
startTime?: string | null;
/**
* The type of sync run. Can be one of the following: * `FULL` * `INCREMENTAL`
*/
syncType?: string | null;
}
/**
* A description of the context in which an error occurred.
*/
export interface Schema$GoogleCloudDiscoveryengineLoggingErrorContext {
/**
* The HTTP request which was processed when the error was triggered.
*/
httpRequest?: Schema$GoogleCloudDiscoveryengineLoggingHttpRequestContext;
/**
* The location in the source code where the decision was made to report the error, usually the place where it was logged.
*/
reportLocation?: Schema$GoogleCloudDiscoveryengineLoggingSourceLocation;
}
/**
* An error log which is reported to the Error Reporting system.
*/
export interface Schema$GoogleCloudDiscoveryengineLoggingErrorLog {
/**
* The error payload that is populated on LRO connector sync APIs.
*/
connectorRunPayload?: Schema$GoogleCloudDiscoveryengineLoggingConnectorRunErrorContext;
/**
* A description of the context in which the error occurred.
*/
context?: Schema$GoogleCloudDiscoveryengineLoggingErrorContext;
/**
* The error payload that is populated on LRO import APIs.
*/
importPayload?: Schema$GoogleCloudDiscoveryengineLoggingImportErrorContext;
/**
* A message describing the error.
*/
message?: string | null;
/**
* The API request payload, represented as a protocol buffer. Most API request types are supported—for example: * `type.googleapis.com/google.cloud.discoveryengine.v1alpha.DocumentService.CreateDocumentRequest` * `type.googleapis.com/google.cloud.discoveryengine.v1alpha.UserEventService.WriteUserEventRequest`
*/
requestPayload?: {
[key: string]: any;
} | null;
/**
* The API response payload, represented as a protocol buffer. This is used to log some "soft errors", where the response is valid but we consider there are some quality issues like unjoined events. The following API responses are supported, and no PII is included: * `google.cloud.discoveryengine.v1alpha.RecommendationService.Recommend` * `google.cloud.discoveryengine.v1alpha.UserEventService.WriteUserEvent` * `google.cloud.discoveryengine.v1alpha.UserEventService.CollectUserEvent`
*/
responsePayload?: {
[key: string]: any;
} | null;
/**
* The service context in which this error has occurred.
*/
serviceContext?: Schema$GoogleCloudDiscoveryengineLoggingServiceContext;
/**
* The RPC status associated with the error log.
*/
status?: Schema$GoogleRpcStatus;
}
/**
* HTTP request data that is related to a reported error.
*/
export interface Schema$GoogleCloudDiscoveryengineLoggingHttpRequestContext {
/**
* The HTTP response status code for the request.
*/
responseStatusCode?: number | null;
}
/**
* The error payload that is populated on LRO import APIs, including the following: * `google.cloud.discoveryengine.v1alpha.DocumentService.ImportDocuments` * `google.cloud.discoveryengine.v1alpha.UserEventService.ImportUserEvents`
*/
export interface Schema$GoogleCloudDiscoveryengineLoggingImportErrorContext {
/**
* The detailed content which caused the error on importing a document.
*/
document?: string | null;
/**
* Google Cloud Storage file path of the import source. Can be set for batch operation error.
*/
gcsPath?: string | null;
/**
* Line number of the content in file. Should be empty for permission or batch operation error.
*/
lineNumber?: string | null;
/**
* The operation resource name of the LRO.
*/
operation?: string | null;
/**
* The detailed content which caused the error on importing a user event.
*/
userEvent?: string | null;
}
/**
* Describes a running service that sends errors.
*/
export interface Schema$GoogleCloudDiscoveryengineLoggingServiceContext {
/**
* An identifier of the service—for example, `discoveryengine.googleapis.com`.
*/
service?: string | null;
}
/**
* Indicates a location in the source code of the service for which errors are reported.
*/
export interface Schema$GoogleCloudDiscoveryengineLoggingSourceLocation {
/**
* Human-readable name of a function or method—for example, `google.cloud.discoveryengine.v1alpha.RecommendationService.Recommend`.
*/
functionName?: string | null;
}
/**
* Access Control Configuration.
*/
export interface Schema$GoogleCloudDiscoveryengineV1AclConfig {
/**
* Identity provider config.
*/
idpConfig?: Schema$GoogleCloudDiscoveryengineV1IdpConfig;
/**
* Immutable. The full resource name of the acl configuration. Format: `projects/{project\}/locations/{location\}/aclConfig`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.
*/
name?: string | null;
}
/**
* Informations to support actions on the connector.
*/
export interface Schema$GoogleCloudDiscoveryengineV1ActionConfig {
/**
* Optional. Action parameters in structured json format.
*/
actionParams?: {
[key: string]: any;
} | null;
/**
* Output only. The connector contains the necessary parameters and is configured to support actions.
*/
isActionConfigured?: boolean | null;
/**
* Optional. Action parameters in json string format.
*/
jsonActionParams?: string | null;
/**
* Optional. The Service Directory resource name (projects/x/locations/x/namespaces/x/services/x) representing a VPC network endpoint used to connect to the data source's `instance_uri`, defined in DataConnector.params. Required when VPC Service Controls are enabled.
*/
serviceName?: string | null;
/**
* Optional. Whether to use static secrets for the connector. If true, the secrets provided in the action_params will be ignored.
*/
useStaticSecrets?: boolean | null;
}
/**
* Configuration data for advance site search.
*/
export interface Schema$GoogleCloudDiscoveryengineV1AdvancedSiteSearchConfig {
/**
* If set true, automatic refresh is disabled for the DataStore.
*/
disableAutomaticRefresh?: boolean | null;
/**
* If set true, initial indexing is disabled for the DataStore.
*/
disableInitialIndex?: boolean | null;
}
/**
* The connector level alert config.
*/
export interface Schema$GoogleCloudDiscoveryengineV1AlertPolicyConfig {
/**
* Optional. The enrollment states of each alert.
*/
alertEnrollments?: Schema$GoogleCloudDiscoveryengineV1AlertPolicyConfigAlertEnrollment[];
/**
* Immutable. The fully qualified resource name of the AlertPolicy.
*/
alertPolicyName?: string | null;
}
/**
* The alert enrollment status.
*/
export interface Schema$GoogleCloudDiscoveryengineV1AlertPolicyConfigAlertEnrollment {
/**
* Immutable. The id of an alert.
*/
alertId?: string | null;
/**
* Required. The enrollment status of a customer.
*/
enrollState?: string | null;
}
/**
* Stored definition of an agent that uses A2A.
*/
export interface Schema$GoogleCloudDiscoveryengineV1alphaA2AAgentDefinition {
/**
* Optional. Configuration specific to agents that are deployed from Cloud Marketplace.
*/
cloudMarketplaceConfig?: Schema$GoogleCloudDiscoveryengineV1alphaA2AAgentDefinitionCloudMarketplaceConfig;
/**
* Optional. The agent card is a JSON string.
*/
jsonAgentCard?: string | null;
}
/**
* Configuration specific to agents that are deployed from Cloud Marketplace.
*/
export interface Schema$GoogleCloudDiscoveryengineV1alphaA2AAgentDefinitionCloudMarketplaceConfig {
/**
* Required. The Marketplace Entitlement this agent is associated with. Format: `projects/{project\}/entitlements/{entitlement\}`.
*/
entitlement?: string | null;
/**
* Output only. The Marketplace Order this agent belongs to. Format: `billingAccounts/{billing_account\}/orders/{order\}`
*/
order?: string | null;
}
/**
* Access Control Configuration.
*/
export interface Schema$GoogleCloudDiscoveryengineV1alphaAclConfig {
/**
* Identity provider config.
*/
idpConfig?: Schema$GoogleCloudDiscoveryengineV1alphaIdpConfig;
/**
* Immutable. The full resource name of the acl configuration. Format: `projects/{project\}/locations/{location\}/aclConfig`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.
*/
name?: string | null;
}
/**
* Request message for the DataConnectorService.AcquireAccessToken method.
*/
export interface Schema$GoogleCloudDiscoveryengineV1alphaAcquireAccessTokenRequest {
}
/**
* Response message for the DataConnectorService.AcquireAccessToken method.
*/
export interface Schema$GoogleCloudDiscoveryengineV1alphaAcquireAccessTokenResponse {
/**
* The created access token.
*/
accessToken?: string | null;
/**
* Info about the stored refresh token used to create the access token.
*/
refreshTokenInfo?: Schema$GoogleCloudDiscoveryengineV1alphaRefreshTokenInfo;
}
/**
* Informations to support actions on the connector.
*/
export interface Schema$GoogleCloudDiscoveryengineV1alphaActionConfig {
/**
* Optional. Action parameters in structured json format.
*/
actionParams?: {
[key: string]: any;
} | null;
/**
* Output only. The connector contains the necessary parameters and is configured to support actions.
*/
isActionConfigured?: boolean | null;
/**
* Optional. Action parameters in json string format.
*/
jsonActionParams?: string | null;
/**
* Optional. The Service Directory resource name (projects/x/locations/x/namespaces/x/services/x) representing a VPC network endpoint used to connect to the data source's `instance_uri`, defined in DataConnector.params. Required when VPC Service Controls are enabled.
*/
serviceName?: string | null;
/**
* Optional. Whether to use static secrets for the connector. If true, the secrets provided in the action_params will be ignored.
*/
useStaticSecrets?: boolean | null;
}
/**
* Request for DataStoreService.AddPatientFilter method.
*/
export interface Schema$GoogleCloudDiscoveryengineV1alphaAddPatientFilterRequest {
/**
* Required. Full resource name of DataStore, such as `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}`. If the caller does not have permission to access the DataStore, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the requested DataStore does not exist, a NOT_FOUND error is returned. If the requested DataStore already has a patient filter, an ALREADY_EXISTS error will be returned.
*/
dataStore?: string | null;
/**
* Required. Names of the Group resources to use as a basis for the patient filter, in format `projects/{project_id\}/locations/{location_id\}/datasets/{dataset_id\}/fhirStores/{fhir_store_id\}/fhir/Group/{group_id\}`. if the caller does not have permission to access the FHIR store, regardless of whether it exists, PERMISSION_DENIED error is returned. If the discovery engine service account does not have permission to access the FHIR store, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the group is not found at the location, a RESOURCE_NOT_FOUND error will be returned. The filter group must be a FHIR resource name of type Group, and the filter will be constructed from the direct members of the group which are Patient resources.
*/
filterGroups?: string[] | null;
}
/**
* Stores the definition of an agent that uses ADK and is deployed to Agent Engine (formerly known as Reasoning Engine).
*/
export interface Schema$GoogleCloudDiscoveryengineV1alphaAdkAgentDefinition {
/**
* Optional. The reasoning engine that the agent is connected to.
*/
provisionedReasoningEngine?: Schema$GoogleCloudDiscoveryengineV1alphaAdkAgentDefinitionProvisionedReasoningEngine;
}
/**
* Keeps track of the reasoning engine that the agent is connected to. This message is not intended to keep track of agent's lifecycle. Instead it is only used to define parameters to connect to the agent that is already deployed to a reasoning engine.
*/
export interface Schema$GoogleCloudDiscoveryengineV1alphaAdkAgentDefinitionProvisionedReasoningEngine {
/**
* Required. The reasoning engine that the agent is connected to. Format: `projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}`
*/
reasoningEngine?: string | null;
}
/**
* Request message for CompletionService.AdvancedCompleteQuery method. .
*/
export interface Schema$GoogleCloudDiscoveryengineV1alphaAdvancedCompleteQueryRequest {
/**
* Optional. Specification to boost suggestions matching the condition.
*/
boostSpec?: Schema$GoogleCloudDiscoveryengineV1alphaAdvancedCompleteQueryRequestBoostSpec;
/**
* Optional. Experiment ids for this request.
*/
experimentIds?: string[] | null;
/**
* Indicates if tail suggestions should be returned if there are no suggestions that match the full query. Even if set to true, if there are suggestions that match the full query, those are returned and no tail suggestions are returned.
*/
includeTailSuggestions?: boolean | null;
/**
* Required. The typeahead input used to fetch suggestions. Maximum length is 128 characters. The query can not be empty for most of the suggestion types. If it is empty, an `INVALID_ARGUMENT` error is returned. The exception is when the suggestion_types contains only the type `RECENT_SEARCH`, the query can be an empty string. The is called "zero prefix" feature, which returns user's recently searched queries given the empty query.
*/
query?: string | null;
/**
* Specifies the autocomplete query model, which only applies to the QUERY SuggestionType. This overrides any model specified in the Configuration \> Autocomplete section of the Cloud console. Currently supported values: * `document` - Using suggestions generated from user-imported documents. * `search-history` - Using suggestions generated from the past history of SearchService.Search API calls. Do not use it when there is no traffic for Search API. * `user-event` - Using suggestions generated from user-imported search events. * `document-completable` - Using suggestions taken directly from user-imported document fields marked as completable. Default values: * `document` is the default model for regular dataStores. * `search-history` is the default model for site search dataStores.
*/
queryModel?: string | null;
/**
* Optional. Suggestion types to return. If empty or unspecified, query suggestions are returned. Only one suggestion type is supported at the moment.
*/
suggestionTypes?: string[] | null;
/**
* Optional. Specification of each suggestion type.
*/
suggestionTypeSpecs?: Schema$GoogleCloudDiscoveryengineV1alphaAdvancedCompleteQueryRequestSuggestionTypeSpec[];
/**
* Optional. Information about the end user. This should be the same identifier information as UserEvent.user_info and SearchRequest.user_info.
*/
userInfo?: Schema$GoogleCloudDiscoveryengineV1alphaUserInfo;
/**
* Optional. A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor logs in or out of the website. This field should NOT have a fixed value such as `unknown_visitor`. This should be the same identifier as UserEvent.user_pseudo_id and SearchRequest.user_pseudo_id. The field must be a UTF-8 encoded string with a length limit of 128
*/
userPseudoId?: string | null;
}
/**
* Specification to boost suggestions based on the condition of the suggestion.
*/
export interface Schema$GoogleCloudDiscoveryengineV1alphaAdvancedCompleteQueryRequestBoostSpec {
/**
* Condition boost specifications. If a suggestion matches multiple conditions in the specifications, boost values from these specifications are all applied and combined in a non-linear way. Maximum number of specifications is 20. Note: Currently only support language condition boost.
*/
conditionBoostSpecs?: Schema$GoogleCloudDiscoveryengineV1alphaAdvancedCompleteQueryRequestBoostSpecConditionBoostSpec[];
}
/**
* Boost applies to suggestions which match a condition.
*/
export interface Schema$GoogleCloudDiscoveryengineV1alphaAdvancedCompleteQueryRequestBoostSpecConditionBoostSpec {
/**
* Strength of the boost, which should be in [-1, 1]. Negative boost means demotion. Default is 0.0. Setting to 1.0 gives the suggestions a big promotion. However, it does not necessarily mean that the top result will be a boosted suggestion. Setting to -1.0 gives the suggestions a big demotion. However, other suggestions that are relevant might still be shown. Setting to 0.0 means no boost applied. The boosting condition is ignored.
*/
boost?: number | null;
/**
* An expression which specifies a boost condition. The syntax is the same as [filter expression syntax](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata#filter-expression-syntax). Currently, the only supported condition is a list of BCP-47 lang codes. Example: * To boost suggestions in languages `en` or `fr`: `(lang_code: ANY("en", "fr"))`
*/
condition?: string | null;
}
/**
* Specification of each suggestion type.
*/
export interface Schema$GoogleCloudDiscoveryengineV1alphaAdvancedCompleteQueryRequestSuggestionTypeSpec {
/**
* Optional. Maximum number of suggestions to return for each suggestion type.
*/
maxSuggestions?: number | null;
/**
* Optional. Suggestion type.
*/
suggestionType?: string | null;
}
/**
* Response message for CompletionService.AdvancedCompleteQuery method.
*/
export interface Schema$GoogleCloudDiscoveryengineV1alphaAdvancedCompleteQueryResponse {
/**
* Results of the matched content suggestions. The result list is ordered and the first result is the top suggestion.
*/
contentSuggestions?: Schema$GoogleCloudDiscoveryengineV1alphaAdvancedCompleteQueryResponseContentSuggestion[];
/**
* Results of the matched people suggestions. The result list is ordered and the first result is the top suggestion.
*/
peopleSuggestions?: Schema$GoogleCloudDiscoveryengineV1alphaAdvancedCompleteQueryResponsePersonSuggestion[];
/**
* Results of the matched query suggestions. The result list is ordered and the first result is a top suggestion.
*/
querySuggestions?: Schema$GoogleCloudDiscoveryengineV1alphaAdvancedCompleteQueryResponseQuerySuggestion[];
/**
* Results of the matched "recent search" suggestions. The result list is ordered and the first result is the top suggestion.
*/
recentSearchSuggestions?: Schema$GoogleCloudDiscoveryengineV1alphaAdvancedCompleteQueryResponseRecentSearchSuggestion[];
/**
* True if the returned suggestions are all tail suggestions. For tail matching to be triggered, include_tail_suggestions in the request must be true and there must be no suggestions that match the full query.
*/
tailMatchTriggered?: boolean | null;
}
/**
* Suggestions as content.
*/
export interface Schema$GoogleCloudDiscoveryengineV1alphaAdvancedCompleteQueryResponseContentSuggestion {
/**
* The type of the content suggestion.
*/
contentType?: string | null;
/**
* The name of the dataStore that this suggestion belongs to.
*/
dataStore?: string | null;
/**
* The destination uri of the content suggestion.
*/
destinationUri?: string | null;
/**
* The document data snippet in the suggestion. Only a subset of fields will be populated.
*/
document?: Schema$GoogleCloudDiscoveryengineV1alphaDocument;
/**
* The icon uri of the content suggestion.
*/
iconUri?: string | null;
/**
* The score of each suggestion. The score is in the range of [0, 1].
*/
score?: number | null;
/**
* The suggestion for the query.
*/
suggestion?: string | null;
}
/**
* Suggestions as people.
*/
export interface Schema$GoogleCloudDiscoveryengineV1alphaAdvancedCompleteQueryResponsePersonSuggestion {
/**
* The name of the dataStore that this suggestion belongs to.
*/
dataStore?: string | null;
/**
* The destination uri of the person suggestion.
*/
destinationUri?: string | null;
/**
* The photo uri of the person suggestion.
*/
displayPhotoUri?: string | null;
/**
* The document data snippet in the suggestion. Only a subset of fields is populated.
*/
document?: Schema$GoogleCloudDiscoveryengineV1alphaDocument;
/**
* The type of the person.
*/
personType?: string | null;
/**
* The score of each suggestion. The score is in the range of [0, 1].
*/
score?: number | null;
/**
* The suggestion for the query.
*/
suggestion?: string | null;
}
/**
* Suggestions as search queries.
*/
export interface Schema$GoogleCloudDiscoveryengineV1alphaAdvancedCompleteQueryResponseQuerySuggestion {
/**
* The unique document field paths that serve as the source of this suggestion if it was generated from completable fields. This field is only populated for the document-completable model.
*/
completableFieldPaths?: string[] | null;
/**
* The name of the dataStore that this suggestion belongs to.
*/
dataStore?: string[] | null;
/**
* The score of each suggestion. The score is in the range of [0, 1].
*/
score?: number | null;
/**
* The suggestion for the query.
*/
suggestion?: string | null;
}
/**
* Suggestions from recent search history.
*/
export interface Schema$GoogleCloudDiscoveryengineV1alphaAdvancedCompleteQueryResponseRecentSearchSuggestion {
/**
* The time when this recent rearch happened.
*/
recentSearchTime?: string | null;
/**
* The score of each suggestion. The score is in the range of [0, 1].
*/
score?: number | null;
/**
* The suggestion for the query.
*/
suggestion?: string | null;
}
/**
* Configuration data for advance site search.
*/
export interface Schema$GoogleCloudDiscoveryengineV1alphaAdvancedSiteSearchConfig {
/**
* If set true, automatic refresh is disabled for the DataStore.
*/
disableAutomaticRefresh?: boolean | null;
/**
* If set true, initial indexing is disabled for the DataStore.
*/
disableInitialIndex?: boolean | null;
}
/**
* Performs a predefined, specific task.
*/
export interface Schema$GoogleCloudDiscoveryengineV1alphaAgent {
/**
* Optional. The behavior of the agent is defined as an A2A agent.
*/
a2aAgentDefinition?: Schema$GoogleCloudDiscoveryengineV1alphaA2AAgentDefinition;
/**
* Optional. The behavior of the agent is defined as an ADK agent.
*/
adkAgentDefinition?: Schema$GoogleCloudDiscoveryengineV1alphaAdkAgentDefinition;
/**
* Optional. The authorizations that are required by the agent.
*/
authorizationConfig?: Schema$GoogleCloudDiscoveryengineV1alphaAuthorizationConfig;
/**
* Output only. Timestamp when this Agent was created.
*/
createTime?: string | null;
/**
* Optional. The custom placeholder text that appears in the text box before the user enters any text.
*/
customPlaceholderText?: string | null;
/**
* Output only. The reason why the agent deployment failed. Only set if the state is DEPLOYMENT_FAILED.
*/
deploymentFailureReason?: string | null;
/**
* Required. Human-readable description of the agent. This might be used by an LLM to automatically select an agent to respond to a user query.
*/
description?: string | null;
/**
* Optional. The behavior of the agent is defined as a Dialogflow agent.
*/
dialogflowAgentDefinition?: Schema$GoogleCloudDiscoveryengineV1alphaDialogflowAgentDefinition;
/**
* Required. Display name of the agent. This might be used by an LLM to automatically select an agent to respond to a user query.
*/
displayName?: string | null;
/**
* Optional. The icon that represents the agent on the UI.
*/
icon?: Schema$GoogleCloudDiscoveryengineV1alphaAgentImage;
/**
* Optional. The code of the language of the text in the description, display_name and starter_prompts fields.
*/
languageCode?: string | null;
/**
* Optional. The behavior of the Google managed agent.
*/
managedAgentDefinition?: Schema$GoogleCloudDiscoveryengineV1alphaManagedAgentDefinition;
/**
* Identifier. Resource name of the agent. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}/assistants/{assistant\}/agents/{agent\}`
*/
name?: string | null;
/**
* Output only. The reason why the agent was rejected. Only set if the state is PRIVATE, and got there via rejection.
*/
rejectionReason?: string | null;
/**
* Optional. The sharing config of the agent.
*/
sharingConfig?: Schema$GoogleCloudDiscoveryengineV1alphaAgentSharingConfig;
/**
* Optional. The starter prompt suggestions to show the user on the landing page of the agent.
*/
starterPrompts?: Schema$GoogleCloudDiscoveryengineV1alphaAgentStarterPrompt[];
/**
* Output only. The lifecycle state of the agent.
*/
state?: string | null;
/**
* Output only. The reason why the agent was suspended. Only set if the state is SUSPENDED.
*/
suspensionReason?: string | null;
/**
* Output only. Timestamp when this Agent was most recently updated.
*/
updateTime?: string | null;
}
/**
* Describes a file used internally by an agent as a context on each invocation.
*/
export interface Schema$GoogleCloudDiscoveryengineV1alphaAgentFile {
/**
* Required. The name of the file.
*/
fileName?: string | null;
/**
* Immutable. The content type of the file.
*/
mimeType?: string | null;
/**
* Identifier. The resource name of the file. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}/assistants/{assistant\}/agents/{agent\}/files/{file\}`
*/
name?: string | null;
}
/**
* Represents an image.
*/
export interface Schema$GoogleCloudDiscoveryengineV1alphaAgentImage {
/**
* Base64-encoded image file contents.
*/
content?: string | null;
/**
* Image URI.
*/
uri?: string | null;
}
/**
* Sharing related configuration.
*/
export interface Schema$GoogleCloudDiscoveryengineV1alphaAgentSharingConfig {
/**
* Optional. The sharing scope of the agent.
*/
scope?: string | null;
}
/**
* The starter prompt suggestion to show the user on the landing page of the agent.
*/
export interface Schema$GoogleCloudDiscoveryengineV1alphaAgentStarterPrompt {
/**
* Required. The text of the starter prompt.
*/
text?: string | null;
}
/**
* The data for displaying an Agent.
*/
export interface Schema$GoogleCloudDiscoveryengineV1alphaAgentView {
/**
* Immutable. The origin of the Agent.
*/
agentOrigin?: string | null;
/**
* Output only. The sharing state of the agent.
*/
agentSharingState?: string | null;
/**
* Output only. The type of the agent.
*/
agentType?: string | null;
/**
* The custom placeholder text that appears in the text box before the user enters any text.
*/
customPlaceholderText?: string | null;
/**
* The reason why the agent deployment failed. Only set if the state is DEPLOYMENT_FAILED.
*/
deploymentFailureReason?: string | null;
/**
* Required. Human-readable description of the agent. This might be used by an LLM to automatically select an agent to respond to a user query and to generate the first version of the steps for the agent that can be modified by the user. The language of this is either Agent.language_code, or ListAvailableAgentViewsRequest.language_code if translations are enabled.
*/
description?: string | null;
/**
* Required. Display name of the agent. The language of this is either Agent.language_code, or ListAvailableAgentViewsRequest.language_code if translations are enabled.
*/
displayName?: string | null;
/**
* Optional. The icon that represents the agent on the UI.
*/
icon?: Schema$GoogleCloudDiscoveryengineV1alphaAgentImage;
/**
* Resource name of the agent. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}/assistants/{assistant\}/agents/{agent\}`
*/
name?: string | null;
/**
* The reason why the agent was rejected. Only set if the state is PRIVATE, and got there via rejection.
*/
rejectionReason?: string | null;
/**
* Output only. The state of the Agent.
*/
state?: string | null;
/**
* Optional. The suggested prompts for the agent, to be shown on the agent landing page.
*/
suggestedPrompts?: Schema$GoogleCloudDiscoveryengineV1alphaAgentViewSuggestedPrompt[];
/**
* The reason why the agent was suspended. Only set if the state is SUSPENDED.
*/
suspensionReason?: string | null;
/**
* Output only. The timestamp when the agent was last updated.
*/
updateTime?: string | null;
/**
* Optional. Per-user annotations of the current caller for the agent.
*/
userAnnotations?: Schema$GoogleCloudDiscoveryengineV1alphaUserAnnotations;
/**
* The permi