import * as discoveryengine from "@distilled.cloud/gcp/discoveryengine_v1";
import { Unowned } from "alchemy/AdoptPolicy";
import { isResolved } from "alchemy/Diff";
import * as Provider from "alchemy/Provider";
import { Resource } from "alchemy/Resource";
import * as Data from "effect/Data";
import * as Effect from "effect/Effect";
import { GcpEnvironment } from "../Environment.ts";
import type { Providers } from "../Providers.ts";
import { parentBefore, parseResourceName, sameJson, toResourceId } from "./internal.ts";
export type CollectionsEnginesAssistantProps = {
/**
* Parent Engine resource name
* `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}`.
* Immutable — changing it replaces the assistant.
*/
engine: string;
/**
* Assistant id. If omitted, a unique RFC-1034 id is generated.
* Immutable — changing it replaces the assistant.
*/
assistantId?: string;
/**
* User-facing display name (max 128 characters).
*/
displayName?: string;
/**
* Configuration description.
*/
description?: string;
/**
* Web grounding type.
*/
webGroundingType?: discoveryengine.GoogleCloudDiscoveryengineV1AssistantWebGroundingTypeEnum;
/**
* When true, the default web-grounding toggle is off in the UI.
* @default false
*/
defaultWebGroundingToggleOff?: boolean;
/**
* Generation configuration (language, model, system instruction).
*/
generationConfig?: discoveryengine.GoogleCloudDiscoveryengineV1AssistantGenerationConfig;
/**
* Customer policy (banned phrases, Model Armor).
*/
customerPolicy?: discoveryengine.GoogleCloudDiscoveryengineV1AssistantCustomerPolicy;
};
export type CollectionsEnginesAssistant = Resource<
"GCP.DiscoveryEngine.CollectionsEnginesAssistant",
CollectionsEnginesAssistantProps,
{
/** Full resource name. */
name: string;
/** Assistant id (last path segment). */
assistantId: string;
/** Parent engine resource name. */
engine: string;
/** Project id. */
project: string;
/** Location id. */
location: string;
/** Collection id. */
collectionId: string;
/** User display name. */
displayName: string | undefined;
/** Description. */
description: string | undefined;
/** Web grounding type. */
webGroundingType: string | undefined;
/** Whether the default web-grounding toggle is off. */
defaultWebGroundingToggleOff: boolean;
/** RFC3339 creation timestamp. */
createTime: string | undefined;
/** RFC3339 last-update timestamp. */
updateTime: string | undefined;
},
never,
Providers
>;
/**
* A Discovery Engine Assistant attached to a collection Engine.
*
* Without labels, ownership rests on the deterministic id: `read` reports a
* resource it finds without prior state as unowned (adopt it with `--adopt`).
* Parent engine and assistant id are immutable; display name, description,
* grounding, and generation config update in place.
*
* ### Creating an Assistant
* **Example:** Assistant on a search engine
* ```typescript
* const engine = yield* GCP.DiscoveryEngine.CollectionsEngine("Search", {
* dataStoreIds: [store.dataStoreId],
* });
* const assistant = yield* GCP.DiscoveryEngine.CollectionsEnginesAssistant(
* "Help",
* {
* engine: engine.name,
* displayName: "docs helper",
* },
* );
* ```
*
* ### Updating an Assistant
* **Example:** Rename
* ```typescript
* // Same logical id as before; only the changed props differ.
* const assistant = yield* GCP.DiscoveryEngine.CollectionsEnginesAssistant(
* "Help",
* {
* engine: engine.name,
* displayName: "docs helper prod",
* },
* );
* ```
*
* @resource
* @category DiscoveryEngine
*/
export const CollectionsEnginesAssistant = Resource<CollectionsEnginesAssistant>(
"GCP.DiscoveryEngine.CollectionsEnginesAssistant",
);
export class CollectionsEnginesAssistantNotResolved extends Data.TaggedError(
"GCP.DiscoveryEngine.CollectionsEnginesAssistantNotResolved",
)<{
resourceName: string;
}> {}
const resourceName = (engine: string, assistantId: string) => `${engine}/assistants/${assistantId}`;
const getByName = (name: string) =>
discoveryengine
.getProjectsLocationsCollectionsEnginesAssistants({ name })
.pipe(Effect.catchTag("NotFound", () => Effect.undefined));
const toAttrs = (
assistant: discoveryengine.GoogleCloudDiscoveryengineV1Assistant,
project: string,
) => {
const name = assistant.name ?? "";
const parsed = parseResourceName(name, "assistants");
return {
name,
assistantId: parsed.id,
engine: parentBefore(name, "assistants"),
project: parsed.project || project,
location: parsed.location,
collectionId: parsed.collectionId,
displayName: assistant.displayName,
description: assistant.description,
webGroundingType: assistant.webGroundingType,
defaultWebGroundingToggleOff: assistant.defaultWebGroundingToggleOff === true,
createTime: assistant.createTime,
updateTime: assistant.updateTime,
};
};
export const CollectionsEnginesAssistantProvider = () =>
Provider.succeed(CollectionsEnginesAssistant, {
stables: ["name", "assistantId", "engine", "project", "location", "collectionId", "createTime"],
diff: Effect.fn(function* ({ news, olds, output }) {
if (!isResolved(news)) return undefined;
const previousEngine = olds?.engine ?? output?.engine;
const previousId = olds?.assistantId ?? output?.assistantId;
const nextId = news.assistantId ?? previousId;
if (
(previousEngine !== undefined && news.engine !== previousEngine) ||
(previousId !== undefined && nextId !== undefined && nextId !== previousId)
) {
return { action: "replace" as const, deleteFirst: false };
}
return undefined;
}),
read: Effect.fn(function* ({ id, olds, output }) {
const env = yield* GcpEnvironment.current;
const parent = olds?.engine ?? output?.engine;
const childId = yield* toResourceId(id, olds?.assistantId, output?.assistantId);
const name =
output?.name ?? (parent !== undefined ? resourceName(parent, childId) : undefined);
if (name === undefined) return undefined;
const existing = yield* getByName(name);
if (existing === undefined) return undefined;
const attrs = toAttrs(existing, env.project);
// No labels field: without prior state it may not be ours.
return output !== undefined ? attrs : Unowned(attrs);
}),
reconcile: Effect.fn(function* ({ id, news, output }) {
const env = yield* GcpEnvironment.current;
const assistantId = yield* toResourceId(id, news.assistantId, output?.assistantId);
const description = news.description;
const displayName = news.displayName ?? assistantId;
const fallbackName = output?.name ?? resourceName(news.engine, assistantId);
const groundingOff = news.defaultWebGroundingToggleOff === true;
let current = yield* getByName(fallbackName);
if (current === undefined) {
const created = yield* discoveryengine
.createProjectsLocationsCollectionsEnginesAssistants({
parent: news.engine,
assistantId,
body: {
displayName,
description,
webGroundingType: news.webGroundingType,
defaultWebGroundingToggleOff: groundingOff ? true : undefined,
generationConfig: news.generationConfig,
customerPolicy: news.customerPolicy,
},
})
.pipe(Effect.catchTag("Conflict", () => getByName(fallbackName)));
current = created ?? undefined;
}
if (current === undefined) {
return yield* new CollectionsEnginesAssistantNotResolved({
resourceName: fallbackName,
});
}
const name = current.name ?? fallbackName;
const displayNameChanged = (current.displayName ?? "") !== (displayName ?? "");
const descriptionChanged = (current.description ?? "") !== (description ?? "");
const groundingTypeChanged =
(current.webGroundingType ?? "") !== (news.webGroundingType ?? "");
const groundingOffChanged = (current.defaultWebGroundingToggleOff === true) !== groundingOff;
const generationChanged = !sameJson(current.generationConfig, news.generationConfig);
const policyChanged = !sameJson(current.customerPolicy, news.customerPolicy);
if (
displayNameChanged ||
descriptionChanged ||
groundingTypeChanged ||
groundingOffChanged ||
generationChanged ||
policyChanged
) {
current = yield* discoveryengine.patchProjectsLocationsCollectionsEnginesAssistants({
name,
updateMask: [
displayNameChanged ? "display_name" : undefined,
descriptionChanged ? "description" : undefined,
groundingTypeChanged ? "web_grounding_type" : undefined,
groundingOffChanged ? "default_web_grounding_toggle_off" : undefined,
generationChanged ? "generation_config" : undefined,
policyChanged ? "customer_policy" : undefined,
]
.filter((field): field is string => field !== undefined)
.join(","),
body: {
name,
displayName,
description,
webGroundingType: news.webGroundingType,
defaultWebGroundingToggleOff: groundingOff,
generationConfig: news.generationConfig,
customerPolicy: news.customerPolicy,
},
});
}
return toAttrs(current, env.project);
}),
delete: Effect.fn(function* ({ output }) {
const existing = yield* getByName(output.name);
if (existing === undefined) return;
yield* discoveryengine
.deleteProjectsLocationsCollectionsEnginesAssistants({
name: output.name,
})
.pipe(Effect.catchTag("NotFound", () => Effect.void));
}),
});