import * as pulumi from "@pulumi/pulumi"; import * as inputs from "../../types/input"; import * as outputs from "../../types/output"; /** * Creates a catalog item. * Auto-naming is currently not supported for this resource. */ export declare class CatalogItem extends pulumi.CustomResource { /** * Get an existing CatalogItem resource's state with the given name, ID, and optional extra * properties used to qualify the lookup. * * @param name The _unique_ name of the resulting resource. * @param id The _unique_ provider ID of the resource to lookup. * @param opts Optional settings to control the behavior of the CustomResource. */ static get(name: string, id: pulumi.Input, opts?: pulumi.CustomResourceOptions): CatalogItem; /** * Returns true if the given object is an instance of CatalogItem. This is designed to work even * when multiple copies of the Pulumi SDK have been loaded into the same process. */ static isInstance(obj: any): obj is CatalogItem; readonly catalogId: pulumi.Output; /** * Catalog item categories. This field is repeated for supporting one catalog item belonging to several parallel category hierarchies. For example, if a shoes product belongs to both ["Shoes & Accessories" -> "Shoes"] and ["Sports & Fitness" -> "Athletic Clothing" -> "Shoes"], it could be represented as: "categoryHierarchies": [ { "categories": ["Shoes & Accessories", "Shoes"]}, { "categories": ["Sports & Fitness", "Athletic Clothing", "Shoes"] } ] */ readonly categoryHierarchies: pulumi.Output; /** * Optional. Catalog item description. UTF-8 encoded string with a length limit of 5 KiB. */ readonly description: pulumi.Output; /** * Optional. Highly encouraged. Extra catalog item attributes to be included in the recommendation model. For example, for retail products, this could include the store name, vendor, style, color, etc. These are very strong signals for recommendation model, thus we highly recommend providing the item attributes here. */ readonly itemAttributes: pulumi.Output; /** * Optional. Variant group identifier for prediction results. UTF-8 encoded string with a length limit of 128 bytes. This field must be enabled before it can be used. [Learn more](/recommendations-ai/docs/catalog#item-group-id). */ readonly itemGroupId: pulumi.Output; /** * Optional. Deprecated. The model automatically detects the text language. Your catalog can include text in different languages, but duplicating catalog items to provide text in multiple languages can result in degraded model performance. * * @deprecated Optional. Deprecated. The model automatically detects the text language. Your catalog can include text in different languages, but duplicating catalog items to provide text in multiple languages can result in degraded model performance. */ readonly languageCode: pulumi.Output; readonly location: pulumi.Output; /** * Optional. Metadata specific to retail products. */ readonly productMetadata: pulumi.Output; readonly project: pulumi.Output; /** * Optional. Filtering tags associated with the catalog item. Each tag should be a UTF-8 encoded string with a length limit of 1 KiB. This tag can be used for filtering recommendation results by passing the tag as part of the predict request filter. */ readonly tags: pulumi.Output; /** * Catalog item title. UTF-8 encoded string with a length limit of 1 KiB. */ readonly title: pulumi.Output; /** * Create a CatalogItem resource with the given unique name, arguments, and options. * * @param name The _unique_ name of the resource. * @param args The arguments to use to populate this resource's properties. * @param opts A bag of options that control this resource's behavior. */ constructor(name: string, args: CatalogItemArgs, opts?: pulumi.CustomResourceOptions); } /** * The set of arguments for constructing a CatalogItem resource. */ export interface CatalogItemArgs { catalogId: pulumi.Input; /** * Catalog item categories. This field is repeated for supporting one catalog item belonging to several parallel category hierarchies. For example, if a shoes product belongs to both ["Shoes & Accessories" -> "Shoes"] and ["Sports & Fitness" -> "Athletic Clothing" -> "Shoes"], it could be represented as: "categoryHierarchies": [ { "categories": ["Shoes & Accessories", "Shoes"]}, { "categories": ["Sports & Fitness", "Athletic Clothing", "Shoes"] } ] */ categoryHierarchies: pulumi.Input[]>; /** * Optional. Catalog item description. UTF-8 encoded string with a length limit of 5 KiB. */ description?: pulumi.Input; /** * Catalog item identifier. UTF-8 encoded string with a length limit of 128 bytes. This id must be unique among all catalog items within the same catalog. It should also be used when logging user events in order for the user events to be joined with the Catalog. */ id: pulumi.Input; /** * Optional. Highly encouraged. Extra catalog item attributes to be included in the recommendation model. For example, for retail products, this could include the store name, vendor, style, color, etc. These are very strong signals for recommendation model, thus we highly recommend providing the item attributes here. */ itemAttributes?: pulumi.Input; /** * Optional. Variant group identifier for prediction results. UTF-8 encoded string with a length limit of 128 bytes. This field must be enabled before it can be used. [Learn more](/recommendations-ai/docs/catalog#item-group-id). */ itemGroupId?: pulumi.Input; /** * Optional. Deprecated. The model automatically detects the text language. Your catalog can include text in different languages, but duplicating catalog items to provide text in multiple languages can result in degraded model performance. * * @deprecated Optional. Deprecated. The model automatically detects the text language. Your catalog can include text in different languages, but duplicating catalog items to provide text in multiple languages can result in degraded model performance. */ languageCode?: pulumi.Input; location?: pulumi.Input; /** * Optional. Metadata specific to retail products. */ productMetadata?: pulumi.Input; project?: pulumi.Input; /** * Optional. Filtering tags associated with the catalog item. Each tag should be a UTF-8 encoded string with a length limit of 1 KiB. This tag can be used for filtering recommendation results by passing the tag as part of the predict request filter. */ tags?: pulumi.Input[]>; /** * Catalog item title. UTF-8 encoded string with a length limit of 1 KiB. */ title: pulumi.Input; }