googleapis
Version:
Google APIs Client Library for Node.js
1,121 lines • 2.2 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_v1beta {
export interface Options extends GlobalOptions {
version: 'v1beta';
}
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('v1beta');
* ```
*/
export class Discoveryengine {
context: APIRequestContext;
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;
}
/**
* 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;
}
/**
* 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;
}
/**
* 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;
}
/**
* The connector level alert config.
*/
export interface Schema$GoogleCloudDiscoveryengineV1alphaAlertPolicyConfig {
/**
* Optional. The enrollment states of each alert.
*/
alertEnrollments?: Schema$GoogleCloudDiscoveryengineV1alphaAlertPolicyConfigAlertEnrollment[];
/**
* Immutable. The fully qualified resource name of the AlertPolicy.
*/
alertPolicyName?: string | null;
}
/**
* The alert enrollment status.
*/
export interface Schema$GoogleCloudDiscoveryengineV1alphaAlertPolicyConfigAlertEnrollment {
/**
* Immutable. The id of an alert.
*/
alertId?: string | null;
/**
* Required. The enrollment status of a customer.
*/
enrollState?: string | null;
}
/**
* The resource level alert config. Used in: * UserLicense * EngineUserData The AlertPolicyConfig in data connector is of same usage. No easy way to migrate.
*/
export interface Schema$GoogleCloudDiscoveryengineV1alphaAlertPolicyResourceConfig {
/**
* Optional. The enrollment state of each alert.
*/
alertEnrollments?: Schema$GoogleCloudDiscoveryengineV1alphaAlertPolicyResourceConfigAlertEnrollment[];
/**
* Immutable. The fully qualified resource name of the AlertPolicy.
*/
alertPolicy?: string | null;
/**
* Optional. The contact details for each alert policy.
*/
contactDetails?: Schema$GoogleCloudDiscoveryengineV1alphaContactDetails[];
/**
* Optional. The language code used for notifications
*/
languageCode?: string | null;
}
/**
* The alert enrollment status.
*/
export interface Schema$GoogleCloudDiscoveryengineV1alphaAlertPolicyResourceConfigAlertEnrollment {
/**
* Immutable. The id of an alert.
*/
alertId?: string | null;
/**
* Required. The enrollment status of a customer.
*/
enrollState?: string | null;
/**
* Optional. Parameters used to instantiate a notification. Used for notifications that are triggered when registered. Not stored. * Gemini Business welcome emails. * Gemini Business user invitation emails.
*/
notificationParams?: {
[key: string]: string;
} | null;
}
/**
* Defines an answer.
*/
export interface Schema$GoogleCloudDiscoveryengineV1alphaAnswer {
/**
* Additional answer-skipped reasons. This provides the reason for ignored cases. If nothing is skipped, this field is not set.
*/
answerSkippedReasons?: string[] | null;
/**
* The textual answer.
*/
answerText?: string | null;
/**
* List of blob attachments in the answer.
*/
blobAttachments?: Schema$GoogleCloudDiscoveryengineV1alphaAnswerBlobAttachment[];
/**
* Citations.
*/
citations?: Schema$GoogleCloudDiscoveryengineV1alphaAnswerCitation[];
/**
* Output only. Answer completed timestamp.
*/
completeTime?: string | null;
/**
* Output only. Answer creation timestamp.
*/
createTime?: string | null;
/**
* A score in the range of [0, 1] describing how grounded the answer is by the reference chunks.
*/
groundingScore?: number | null;
/**
* Optional. Grounding supports.
*/
groundingSupports?: Schema$GoogleCloudDiscoveryengineV1alphaAnswerGroundingSupport[];
/**
* Immutable. Fully qualified name `projects/{project\}/locations/global/collections/{collection\}/engines/{engine\}/sessions/x/answers/x`
*/
name?: string | null;
/**
* Query understanding information.
*/
queryUnderstandingInfo?: Schema$GoogleCloudDiscoveryengineV1alphaAnswerQueryUnderstandingInfo;
/**
* References.
*/
references?: Schema$GoogleCloudDiscoveryengineV1alphaAnswerReference[];
/**
* Suggested related questions.
*/
relatedQuestions?: string[] | null;
/**
* Optional. Safety ratings.
*/
safetyRatings?: Schema$GoogleCloudDiscoveryengineV1alphaSafetyRating[];
/**
* The state of the answer generation.
*/
state?: string | null;
/**
* Answer generation steps.
*/
steps?: Schema$GoogleCloudDiscoveryengineV1alphaAnswerStep[];
}
/**
* Stores binarydata attached to text answer, e.g. image, video, audio, etc.
*/
export interface Schema$GoogleCloudDiscoveryengineV1alphaAnswerBlobAttachment {
/**
* Output only. The attribution type of the blob.
*/
attributionType?: string | null;
/**
* Output only. The mime type and data of the blob.
*/
data?: Schema$GoogleCloudDiscoveryengineV1alphaAnswerBlobAttachmentBlob;
}
/**
* The media type and data of the blob.
*/
export interface Schema$GoogleCloudDiscoveryengineV1alphaAnswerBlobAttachmentBlob {
/**
* Output only. Raw bytes.
*/
data?: string | null;
/**
* Output only. The media type (MIME type) of the generated or retrieved data.
*/
mimeType?: string | null;
}
/**
* Citation info for a segment.
*/
export interface Schema$GoogleCloudDiscoveryengineV1alphaAnswerCitation {
/**
* End of the attributed segment, exclusive. Measured in bytes (UTF-8 unicode). If there are multi-byte characters,such as non-ASCII characters, the index measurement is longer than the string length.
*/
endIndex?: string | null;
/**
* Citation sources for the attributed segment.
*/
sources?: Schema$GoogleCloudDiscoveryengineV1alphaAnswerCitationSource[];
/**
* Index indicates the start of the segment, measured in bytes (UTF-8 unicode). If there are multi-byte characters,such as non-ASCII characters, the index measurement is longer than the string length.
*/
startIndex?: string | null;
}
/**
* Citation source.
*/
export interface Schema$GoogleCloudDiscoveryengineV1alphaAnswerCitationSource {
/**
* ID of the citation source.
*/
referenceId?: string | null;
}
/**
* Grounding support for a claim in `answer_text`.
*/
export interface Schema$GoogleCloudDiscoveryengineV1alphaAnswerGroundingSupport {
/**
* Required. End of the claim, exclusive.
*/
endIndex?: string | null;
/**
* Indicates that this claim required grounding check. When the system decided this claim didn't require attribution/grounding check, this field is set to false. In that case, no grounding check was done for the claim and therefore `grounding_score`, `sources` is not returned.
*/
groundingCheckRequired?: boolean | null;
/**
* A score in the range of [0, 1] describing how grounded is a specific claim by the references. Higher value means that the claim is better supported by the reference chunks.
*/
groundingScore?: number | null;
/**
* Optional. Citation sources for the claim.
*/
sources?: Schema$GoogleCloudDiscoveryengineV1alphaAnswerCitationSource[];
/**
* Required. Index indicates the start of the claim, measured in bytes (UTF-8 unicode).
*/
startIndex?: string | null;
}
/**
* Query understanding information.
*/
export interface Schema$GoogleCloudDiscoveryengineV1alphaAnswerQueryUnderstandingInfo {
/**
* Query classification information.
*/
queryClassificationInfo?: Schema$GoogleCloudDiscoveryengineV1alphaAnswerQueryUnderstandingInfoQueryClassificationInfo[];
}
/**
* Query classification information.
*/
export interface Schema$GoogleCloudDiscoveryengineV1alphaAnswerQueryUnderstandingInfoQueryClassificationInfo {
/**
* Classification output.
*/
positive?: boolean | null;
/**
* Query classification type.
*/
type?: string | null;
}
/**
* Reference.
*/
export interface Schema$GoogleCloudDiscoveryengineV1alphaAnswerReference {
/**
* Chunk information.
*/
chunkInfo?: Schema$GoogleCloudDiscoveryengineV1alphaAnswerReferenceChunkInfo;
/**
* Structured document information.
*/
structuredDocumentInfo?: Schema$GoogleCloudDiscoveryengineV1alphaAnswerReferenceStructuredDocumentInfo;
/**
* Unstructured document information.
*/
unstructuredDocumentInfo?: Schema$GoogleCloudDiscoveryengineV1alphaAnswerReferenceUnstructuredDocumentInfo;
}
/**
* Chunk information.
*/
export interface Schema$GoogleCloudDiscoveryengineV1alphaAnswerReferenceChunkInfo {
/**
* Output only. Stores indexes of blobattachments linked to this chunk.
*/
blobAttachmentIndexes?: string[] | null;
/**
* Chunk resource name.
*/
chunk?: string | null;
/**
* Chunk textual content.
*/
content?: string | null;
/**
* Document metadata.
*/
documentMetadata?: Schema$GoogleCloudDiscoveryengineV1alphaAnswerReferenceChunkInfoDocumentMetadata;
/**
* The relevance of the chunk for a given query. Values range from 0.0 (completely irrelevant) to 1.0 (completely relevant). This value is for informational purpose only. It may change for the same query and chunk at any time due to a model retraining or change in implementation.
*/
relevanceScore?: number | null;
}
/**
* Document metadata.
*/
export interface Schema$GoogleCloudDiscoveryengineV1alphaAnswerReferenceChunkInfoDocumentMetadata {
/**
* Document resource name.
*/
document?: string | null;
/**
* Page identifier.
*/
pageIdentifier?: string | null;
/**
* The structured JSON metadata for the document. It is populated from the struct data from the Chunk in search result.
*/
structData?: {
[key: string]: any;
} | null;
/**
* Title.
*/
title?: string | null;
/**
* URI for the document.
*/
uri?: string | null;
}
/**
* Structured search information.
*/
export interface Schema$GoogleCloudDiscoveryengineV1alphaAnswerReferenceStructuredDocumentInfo {
/**
* Document resource name.
*/
document?: string | null;
/**
* Structured search data.
*/
structData?: {
[key: string]: any;
} | null;
/**
* Output only. The title of the document.
*/
title?: string | null;
/**
* Output only. The URI of the document.
*/
uri?: string | null;
}
/**
* Unstructured document information.
*/
export interface Schema$GoogleCloudDiscoveryengineV1alphaAnswerReferenceUnstructuredDocumentInfo {
/**
* List of cited chunk contents derived from document content.
*/
chunkContents?: Schema$GoogleCloudDiscoveryengineV1alphaAnswerReferenceUnstructuredDocumentInfoChunkContent[];
/**
* Document resource name.
*/
document?: string | null;
/**
* The structured JSON metadata for the document. It is populated from the struct data from the Chunk in search result.
*/
structData?: {
[key: string]: any;
} | null;
/**
* Title.
*/
title?: string | null;
/**
* URI for the document.
*/
uri?: string | null;
}
/**
* Chunk content.
*/
export interface Schema$GoogleCloudDiscoveryengineV1alphaAnswerReferenceUnstructuredDocumentInfoChunkContent {
/**
* Output only. Stores indexes of blobattachments linked to this chunk.
*/
blobAttachmentIndexes?: string[] | null;
/**
* Chunk textual content.
*/
content?: string | null;
/**
* Page identifier.
*/
pageIdentifier?: string | null;
/**
* The relevance of the chunk for a given query. Values range from 0.0 (completely irrelevant) to 1.0 (completely relevant). This value is for informational purpose only. It may change for the same query and chunk at any time due to a model retraining or change in implementation.
*/
relevanceScore?: number | null;
}
/**
* Step information.
*/
export interface Schema$GoogleCloudDiscoveryengineV1alphaAnswerStep {
/**
* Actions.
*/
actions?: Schema$GoogleCloudDiscoveryengineV1alphaAnswerStepAction[];
/**
* The description of the step.
*/
description?: string | null;
/**
* The state of the step.
*/
state?: string | null;
/**
* The thought of the step.
*/
thought?: string | null;
}
/**
* Action.
*/
export interface Schema$GoogleCloudDiscoveryengineV1alphaAnswerStepAction {
/**
* Observation.
*/
observation?: Schema$GoogleCloudDiscoveryengineV1alphaAnswerStepActionObservation;
/**
* Search action.
*/
searchAction?: Schema$GoogleCloudDiscoveryengineV1alphaAnswerStepActionSearchAction;
}
/**
* Observation.
*/
export interface Schema$GoogleCloudDiscoveryengineV1alphaAnswerStepActionObservation {
/**
* Search results observed by the search action, it can be snippets info or chunk info, depending on the citation type set by the user.
*/
searchResults?: Schema$GoogleCloudDiscoveryengineV1alphaAnswerStepActionObservationSearchResult[];
}
export interface Schema$GoogleCloudDiscoveryengineV1alphaAnswerStepActionObservationSearchResult {
/**
* If citation_type is CHUNK_LEVEL_CITATION and chunk mode is on, populate chunk info.
*/
chunkInfo?: Schema$GoogleCloudDiscoveryengineV1alphaAnswerStepActionObservationSearchResultChunkInfo[];
/**
* Document resource name.
*/
document?: string | null;
/**
* If citation_type is DOCUMENT_LEVEL_CITATION, populate document level snippets.
*/
snippetInfo?: Schema$GoogleCloudDiscoveryengineV1alphaAnswerStepActionObservationSearchResultSnippetInfo[];
/**
* Data representation. The structured JSON data for the document. It's populated from the struct data from the Document, or the Chunk in search result.
*/
structData?: {
[key: string]: any;
} | null;
/**
* Title.
*/
title?: string | null;
/**
* URI for the document.
*/
uri?: string | null;
}
/**
* Chunk information.
*/
export interface Schema$GoogleCloudDiscoveryengineV1alphaAnswerStepActionObservationSearchResultChunkInfo {
/**
* Chunk resource name.
*/
chunk?: string | null;
/**
* Chunk textual content.
*/
content?: string | null;
/**
* The relevance of the chunk for a given query. Values range from 0.0 (completely irrelevant) to 1.0 (completely relevant). This value is for informational purpose only. It may change for the same query and chunk at any time due to a model retraining or change in implementation.
*/
relevanceScore?: number | null;
}
/**
* Snippet information.
*/
export interface Schema$GoogleCloudDiscoveryengineV1alphaAnswerStepActionObservationSearchResultSnippetInfo {
/**
* Snippet content.
*/
snippet?: string | null;
/**
* Status of the snippet defined by the search team.
*/
snippetStatus?: string | null;
}
/**
* Search action.
*/
export interface Schema$GoogleCloudDiscoveryengineV1alphaAnswerStepActionSearchAction {
/**
* The query to search.
*/
query?: string | null;
}
/**
* AssistAnswer resource, main part of AssistResponse.
*/
export interface Schema$GoogleCloudDiscoveryengineV1alphaAssistAnswer {
/**
* Reasons for not answering the assist call.
*/
assistSkippedReasons?: string[] | null;
/**
* Optional. The field contains information about the various policy checks' results like the banned phrases or the Model Armor checks. This field is populated only if the assist call was skipped due to a policy violation.
*/
customerPolicyEnforcementResult?: Schema$GoogleCloudDiscoveryengineV1alphaAssistAnswerCustomerPolicyEnforcementResult;
/**
* Immutable. Identifier. Resource name of the `AssistAnswer`. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}/sessions/{session\}/assistAnswers/{assist_answer\}` This field must be a UTF-8 encoded string with a length limit of 1024 characters.
*/
name?: string | null;
/**
* Replies of the assistant.
*/
replies?: Schema$GoogleCloudDiscoveryengineV1alphaAssistAnswerReply[];
/**
* State of the answer generation.
*/
state?: string | null;
}
/**
* Customer policy enforcement results. Contains the results of the various policy checks, like the banned phrases or the Model Armor checks.
*/
export interface Schema$GoogleCloudDiscoveryengineV1alphaAssistAnswerCustomerPolicyEnforcementResult {
/**
* Customer policy enforcement results. Populated only if the assist call was skipped due to a policy violation. It contains results from those filters that blocked the processing of the query.
*/
policyResults?: Schema$GoogleCloudDiscoveryengineV1alphaAssistAnswerCustomerPolicyEnforcementResultPolicyEnforcementResult[];
/**
* Final verdict of the customer policy enforcement. If only one policy blocked the processing, the verdict is BLOCK.
*/
verdict?: string | null;
}
/**
* Customer policy enforcement result for the banned phrase policy.
*/
export interface Schema$GoogleCloudDiscoveryengineV1alphaAssistAnswerCustomerPolicyEnforcementResultBannedPhraseEnforcementResult {
/**
* The banned phrases that were found in the query or the answer.
*/
bannedPhrases?: string[] | null;
}
/**
* Customer policy enforcement result for the Model Armor policy.
*/
export interface Schema$GoogleCloudDiscoveryengineV1alphaAssistAnswerCustomerPolicyEnforcementResultModelArmorEnforcementResult {
/**
* The error returned by Model Armor if the policy enforcement failed for some reason.
*/
error?: Schema$GoogleRpcStatus;
/**
* The Model Armor violation that was found.
*/
modelArmorViolation?: string | null;
}
/**
* Customer policy enforcement result for a single policy type.
*/
export interface Schema$GoogleCloudDiscoveryengineV1alphaAssistAnswerCustomerPolicyEnforcementResultPolicyEnforcementResult {
/**
* The policy enforcement result for the banned phrase policy.
*/
bannedPhraseEnforcementResult?: Schema$GoogleCloudDiscoveryengineV1alphaAssistAnswerCustomerPolicyEnforcementResultBannedPhraseEnforcementResult;
/**
* The policy enforcement result for the Model Armor policy.
*/
modelArmorEnforcementResult?: Schema$GoogleCloudDiscoveryengineV1alphaAssistAnswerCustomerPolicyEnforcementResultModelArmorEnforcementResult;
}
/**
* One part of the multi-part response of the assist call.
*/
export interface Schema$GoogleCloudDiscoveryengineV1alphaAssistAnswerReply {
/**
* Possibly grounded response text or media from the assistant.
*/
groundedContent?: Schema$GoogleCloudDiscoveryengineV1alphaAssistantGroundedContent;
/**
* Output only. When set, uniquely identifies a reply within the `AssistAnswer` resource. During an AssistantService.StreamAssist call, multiple `Reply` messages with the same ID can occur within the response stream (across multiple StreamAssistResponse messages). These represent parts of a single `Reply` message in the final `AssistAnswer` resource.
*/
replyId?: string | null;
}
/**
* Multi-modal content.
*/
export interface Schema$GoogleCloudDiscoveryengineV1alphaAssistantContent {
/**
* Result of executing an ExecutableCode.
*/
codeEx