# Artificial Intelligence Recommendation

> Artificial Intelligence Recommendation (AIRec) is a personalized recommendation service exposing REST APIs for e-commerce product, content feed, and news article recommendations, with pre-built industry templates (E-commerce/Content/News) and two service types (You may also like / Related recommendations). Offers Industry Operation Edition and Algorithm Configuration Edition, SDKs for Java/Python/Go/PHP, subscription billing by users/items/QPS (USD 80 per 1M users, 50 per 1M items, 200/QPS/month) plus optional elastic QPS.

This documentation applies to the Alibaba Cloud international site. For China site documentation, please refer to https://help.aliyun.com/help/llms.txt

## AIRec-product-collection

- [AIRec-product-collection](https://www.alibabacloud.com/help/en/airec/airec.md): Artificial Intelligence Recommendation (AIRec) is a personalized recommendation service exposing REST APIs for e-commerce product, content, and news feeds, with pre-built industry templates, You-May-Also-Like and Related-Recommendation service types, Industry Operation and Algorithm Configuration editions, Go/Java/PHP/Python SDKs, subscription billing by users/items/QPS (USD 80/50/200 per million or per QPS/month) plus elastic QPS from USD 0.56/hour.
- [AIRec Product Overview](https://www.alibabacloud.com/help/en/airec/airec/product-overview.md): Directory of Alibaba Cloud AIRec (Artificial Intelligence Recommendation) product overview documentation, including What is AIRec, instance types, basic concepts, billing, and announcements. AIRec provides personalized recommendation services for e-commerce, content, news, video, and social scenarios via simple API calls.
- [What is AIRec](https://www.alibabacloud.com/help/en/airec/airec/product-overview/what-is-airec.md): Personalized recommendation service with templates for e-commerce, content, and news. Two modes: 'you may also like' (homepage) and related recommendations (detail page).
- [AIRec instance types](https://www.alibabacloud.com/help/en/airec/airec/product-overview/instance-types.md): Two editions: Industry Operation Edition (console-driven rules) and Algorithm Configuration Edition (custom ranking models). Comparison and upgrade path.
- [AIRec glossary](https://www.alibabacloud.com/help/en/airec/airec/product-overview/terms.md): Core concepts: customer/tenant, user, item, behavior, instance, scene. Two recommendation types. Integrated services: MaxCompute, DataWorks, Umeng SDK.
- [Billing](https://www.alibabacloud.com/help/en/airec/airec/product-overview/billing-2.md): Understand the billing methods for Alibaba Cloud AIRec, including key billable items and pricing models, to effectively forecast and optimize your costs.
- [Billing methods and pricing](https://www.alibabacloud.com/help/en/airec/airec/product-overview/billing-for-elastic-qps.md): Subscription: users (USD 80/M per 1M), items (USD 50/M per 1M), QPS (USD 200/M per unit). Elastic QPS hourly at USD 0.56-0.90/unit. 100K DAU ~ 10 QPS.
- [Instance renewal](https://www.alibabacloud.com/help/en/airec/airec/product-overview/instance-renewal.md): Manual and auto-renewal for subscription instances. Auto-renewal deduction starts 9 days before expiry. Trial edition not renewable, must upgrade to standard.
- [Expiration and overdue payment impacts](https://www.alibabacloud.com/help/en/airec/airec/product-overview/impacts-of-expiration-and-overdue-payments.md): Days 1-7: instance frozen, data retained, recoverable by renewal. Day 8: permanent release, all data deleted. Keep balance sufficient for elastic QPS.
- [Getting Started](https://www.alibabacloud.com/help/en/airec/airec/getting-started.md): Learn how to quickly launch your first personalized recommendation service with Alibaba Cloud AIRec through our step-by-step getting started guide.
- [AIRec video tutorial](https://www.alibabacloud.com/help/en/airec/airec/getting-started/tutorial.md): Step-by-step video walkthrough: start an instance (Quick Start or Historical Data mode), push data via SDK, create a scene, obtain recommendation results, and compare with real traffic.
- [Integration guide](https://www.alibabacloud.com/help/en/airec/airec/getting-started/get-started-with-airec.md): Four-step console wizard: upload data, configure policy (scenario + filtering rules), publish recommendation service, evaluate CTR and dwell-time metrics. Progress auto-saved between sessions.
- [Product Introduction](https://www.alibabacloud.com/help/en/airec/airec/getting-started/product-introduction.md): AIRec tackles cold-start and low-CTR challenges using collaborative filtering and deep learning CTR models. Understand its recommendation pipeline architecture, supported e-commerce and content scenarios, and real-time inference design.
- [Prepare data and services](https://www.alibabacloud.com/help/en/airec/airec/getting-started/preparations.md): Three prep steps: format data per industry spec, verify impression/click instrumentation, choose upload method (SDK-only or MaxCompute historical data).
- [Event tracking](https://www.alibabacloud.com/help/en/airec/airec/getting-started/use-event-tracking.md): Client-side vs server-side tracking. Covers exposure counting (visible + 1s minimum), click dedup, scene_id, tags, category_path, expire_time, and status fields.
- [Data specifications](https://www.alibabacloud.com/help/en/airec/airec/getting-started/data-specifications.md)
- [E-commerce data specifications](https://www.alibabacloud.com/help/en/airec/airec/getting-started/e-commerce-industry.md): Item, user, and behavior table schemas. Required fields: item_id, item_type, status, scene_id, pub_time. Behavior types: expose, click, buy, cart. MaxCompute DDL included.
- [News data specifications](https://www.alibabacloud.com/help/en/airec/airec/getting-started/news-industry.md): Item, user, and behavior table schemas for news. Key fields: author, channel, expire_time (timeliness-critical), duration (video). Behavior types: expose, click, like, share, stay, subscribe, dislike.
- [Content data specifications](https://www.alibabacloud.com/help/en/airec/airec/getting-started/content-industry.md): Item, user, behavior table schemas for articles, videos, audio, images. Key fields: duration (required for video), author, channel, content (5000 char max). MaxCompute DDL included.
- [Sample test data](https://www.alibabacloud.com/help/en/airec/airec/getting-started/sample-data.md): Downloadable CSV datasets for news, content, and e-commerce industries. Each includes behavior, item, and user tables for testing AIRec before production data is available.
- [User Guide](https://www.alibabacloud.com/help/en/airec/airec/user-guide.md): Use the `DescribeDBClusterStatus` API to query the status of AnalyticDB for MySQL clusters, with detailed request parameters and JSON response examples.
- [Access Product](https://www.alibabacloud.com/help/en/airec/airec/user-guide/access-product.md): Integrate your product catalog with AIRec by configuring item schema ingestion, calling PutItems to upload SKU data, and enabling GetRecommendation APIs — delivering personalized results from day one.
- [Start an instance](https://www.alibabacloud.com/help/en/airec/airec/user-guide/create-an-instance-and-upload-data.md)
- [Start instance with historical data](https://www.alibabacloud.com/help/en/airec/airec/user-guide/use-historical-data-to-start-an-instance.md): Import historical user/item/behavior data from MaxCompute to start an AIRec instance. Upload CSV via odpscmd Tunnel, select industry template, then push incremental data via server SDK.
- [Start instance with server SDKs](https://www.alibabacloud.com/help/en/airec/airec/user-guide/use-server-sdks-to-start-an-instance.md): Start an AIRec instance using server SDKs only (no MaxCompute). Upload baseline and incremental user/item/behavior data via SDK, select Quick Start mode, configure offline storage in your MaxCompute.
- [Push data and obtain results](https://www.alibabacloud.com/help/en/airec/airec/user-guide/push-data-and-obtain-recommendation-results.md)
- [Push data via PushDocument API](https://www.alibabacloud.com/help/en/airec/airec/user-guide/push-data.md): Stream real-time adds/updates/deletes to user, item, and behavior tables via PushDocument. Limits: 800 docs/request, 1 MB max.
- [Obtain recommendation results](https://www.alibabacloud.com/help/en/airec/airec/user-guide/obtain-recommendation-results.md): Retrieve personalized item recommendations for a given user. Returns ranked JSON results. Applies to Industry Operation Edition and Algorithm Configuration Edition instances.
- [Recommendation result field reference](https://www.alibabacloud.com/help/en/airec/airec/user-guide/details-of-returned-results.md): Response fields: RequestId, ItemId, ItemType, MatchInfo (algorithm identifier), TraceInfo (event tracking), Weight, Position.
- [Monitoring metrics and alert rules](https://www.alibabacloud.com/help/en/airec/airec/user-guide/view-the-monitoring-metrics-and-configure-alert-rules.md): Track QPS, API latency, push rates, and table usage ratios via Cloud Monitor. Configure alerts for throttling (>0 QPS), quota exhaustion (>90%), and behavioral data latency (>7200s).
- [Industry Operation Edition](https://www.alibabacloud.com/help/en/airec/airec/user-guide/industry-operation-edition.md)
- [Industry Operation Edition overview](https://www.alibabacloud.com/help/en/airec/airec/user-guide/overview-of-airec-industry-operation-edition.md): Pre-configured recommendation algorithms for e-commerce, news, and content industries. Fixed QPS of 5 (elastic up to 30).
- [Features in the AIRec console](https://www.alibabacloud.com/help/en/airec/airec/user-guide/features-in-the-console.md)
- [Instance quota and basic info](https://www.alibabacloud.com/help/en/airec/airec/user-guide/basic-information.md): View instance configuration and quota usage for user/item tables. QPS overage triggers throttling; table quota overage blocks all ADD/UPDATE SDK pushes.
- [Data sources configuration](https://www.alibabacloud.com/help/en/airec/airec/user-guide/data-sources.md): Configure boot data (historical via MaxCompute) and real-time data sources (Umeng SDK or server SDK). View data distribution statistics, run quality diagnostics, query push records, and manage.
- [Service management](https://www.alibabacloud.com/help/en/airec/airec/user-guide/management-of-services.md)
- [Data diagnostics](https://www.alibabacloud.com/help/en/airec/airec/user-guide/data-diagnostics.md): Automated scan for format errors, missed transfers, and duplicates. Reports list issues by priority (high/recommended/unnecessary). Auto-generated daily; manual scan available for custom time ranges.
- [Data query](https://www.alibabacloud.com/help/en/airec/airec/user-guide/data-query.md): Inspect push records (behavior/item/user messages) to verify uploads, and query current item or user attributes by item_id, item_type, user_id, or device_id.
- [Test recommendation service](https://www.alibabacloud.com/help/en/airec/airec/user-guide/test-on-recommendation-operations.md): Validate recommendations before going live via console Service Testing page (max 10 items) or server SDK (max 50 items).
- [Operation tools](https://www.alibabacloud.com/help/en/airec/airec/user-guide/recommendation-service-monitoring.md)
- [Recommendation policy configuration](https://www.alibabacloud.com/help/en/airec/airec/user-guide/recommendation-policies.md): Configure four policy types: deduplication (exposure/click filtering by time window), diversity (mixed ranking ratios, discretization), business metric definitions, and experience optimization.
- [Single-item operations](https://www.alibabacloud.com/help/en/airec/airec/user-guide/single-item-operations.md): Filter items by keyword, item_id:item_type, weight, status, category, store, or brand. Bulk actions: weight, cancel weighting, publish, unpublish, delete. Clear expired items in one click.
- [Effect analysis dashboard](https://www.alibabacloud.com/help/en/airec/airec/user-guide/business-effects.md): Monitor PV_CTR, UV_CTR, PV_CVR, UV_CVR, DAU, MAU, and per-user engagement depth. Four metric groups: business objectives, user popularity, overall traffic scale, and traffic CVR.
- [Manage pinned items](https://www.alibabacloud.com/help/en/airec/airec/user-guide/manage-pinned-items.md): Pin up to 10 items to the top of recommendation results for a scenario. Configure via console or SDK with strategy=fixedSlot parameter. Supports reordering, unpinning, and publishing changes.
- [Best Practices](https://www.alibabacloud.com/help/en/airec/airec/user-guide/industry-best-practices.md)
- [Configure news timeliness with pub_time and expire_time](https://www.alibabacloud.com/help/en/airec/airec/user-guide/ensure-the-timeliness-of-recommended-content-for-the-news-industry-through-publish-settings-and-scene-creation.md): Set pub_time (UNIX timestamp) and expire_time on items to control freshness. Articles auto-delist after expire_time.
- [Business performance reports](https://www.alibabacloud.com/help/en/airec/airec/user-guide/business-performance-reports.md): Compare AIRec (trace_id=Alibaba) vs self-developed system (trace_id=selfhold) metrics: PV_CTR, UV_CTR, PV_CVR, UV_CVR, DAU, MAU. Instance dashboard and per-scene reports with day/week comparison.
- [Algorithm Configuration Edition](https://www.alibabacloud.com/help/en/airec/airec/user-guide/algorithm-configuration-edition.md)
- [Algorithm Configuration Edition overview](https://www.alibabacloud.com/help/en/airec/airec/user-guide/overview-of-airec-algorithm-configuration-edition.md): Algorithm Configuration Edition supports custom recall, ranking, cold-start, and re-ranking models. Integrates DataWorks offline pipelines, MaxCompute storage, and PAI for model training and serving.
- [Industry algorithm models](https://www.alibabacloud.com/help/en/airec/airec/user-guide/industry-algorithm-models.md): Configurable recall algorithms: item-based collaborative filtering (traditional + Swing), content-based second-order transfer (by category/tag/channel/author/store/brand), popular item recall, and.
- [Features in the AIRec console](https://www.alibabacloud.com/help/en/airec/airec/user-guide/description-of-console-features.md)
- [Position policies](https://www.alibabacloud.com/help/en/airec/airec/user-guide/position-policy.md): Pin items to fixed feed positions via item pools. Set strategy=fixedSlot in the Recommend API. Filter by tags or item ID, max 20 positions, auto-fallback for expired items.
- [Experimental platform](https://www.alibabacloud.com/help/en/airec/airec/user-guide/online-experimental-platform.md)
- [Experiment parameter settings](https://www.alibabacloud.com/help/en/airec/airec/user-guide/experiment-parameter-settings.md): Create A/B experiments with traffic splitting by user ID or device ID (UTDID). Configure filtering/ranking algorithms per variant, allocate 10-20% traffic, max 20 experiments per scenario.
- [Experiment effect analysis](https://www.alibabacloud.com/help/en/airec/airec/user-guide/experiment-effect-analysis.md): View A/B experiment metrics: PV_CTR, UV_CTR, PV_CVR, UV_CVR, DAU/MAU, traffic CVR (favorite/review/cart), and per-user consumption. Compare variants to apply or stop experiments.
- [Best Practices](https://www.alibabacloud.com/help/en/airec/airec/user-guide/best-practices-for-algorithm-configuration-edition.md)
- [I2I algorithm real-time feedback](https://www.alibabacloud.com/help/en/airec/airec/user-guide/adjust-the-i2i-algorithm-policies-to-improve-user-experience-in-real-time-feedback.md): Configure I2I policies (subcategory convergence, parent category convergence, standard ItemCF) to update recommendations after interactions. Set category_path in item data, adjust operator priorities.
- [Item characteristic priority tuning](https://www.alibabacloud.com/help/en/airec/airec/user-guide/adjust-the-priorities-of-item-characteristics-to-meet-the-business-characteristics-of-industries.md): Boost store/brand/category/tag similarity using the content-based second-order transfer algorithm. Set shop_id in item data, adjust child-link or overall algorithm priority, verify via A/B test.
- [New item distribution policies](https://www.alibabacloud.com/help/en/airec/airec/user-guide/adjust-policies-of-new-items-to-efficiently-support-new-items.md): Control new item exposure via newRatio (default 2%, max 20%) and pub_time age window (default 7 days). Three policies: user preferences, global behavior popularity, latest publishing time.
- [Permission Management](https://www.alibabacloud.com/help/en/airec/airec/user-guide/permission-management.md): Configure permissions for Alibaba Cloud AIRec by granting access to RAM users via detailed step-by-step instructions and ready-to-use policy examples.
- [Grant RAM user permissions](https://www.alibabacloud.com/help/en/airec/airec/user-guide/ram-user-authorization.md): Create a RAM user, assign AIRec permission policies, and log on as the RAM user. Covers access mode selection, policy attachment, and AccessKey ID/secret retrieval.
- [Grant offline storage permissions to AIRec](https://www.alibabacloud.com/help/en/airec/airec/user-guide/grant-permissions-on-offline-storage-to-airec.md): Grant the ALIYUN$openias service account read/write access to your MaxCompute project and tables so AIRec can process offline data.
- [Best Practices](https://www.alibabacloud.com/help/en/airec/airec/use-cases.md): Use the `DescribeTableListByType` API to query tables by type in PolarDB-X 1.0, with detailed request parameters, response formats, and code examples provided.
- [Effect evaluation and policy adjustments of AIRec](https://www.alibabacloud.com/help/en/airec/airec/use-cases/effect-evaluation-and-policy-adjustments-of-airec.md): Evaluate recommendations via PV_CTR, UV_CTR, PV_CVR, UV_CVR metrics. A/B testing with traffic buckets compares AIRec vs custom policies. Optimize via policy config or algorithm tuning.
- [Create a scene with product selection rules](https://www.alibabacloud.com/help/en/airec/airec/use-cases/create-a-recommendation-scene-by-configuring-product-selection-rules.md): Filter items by type, category, and publish time to build per-scene item pools. Configure scene-level merchant diversity, category scattering, and item_type sorting ratios.
- [Instance operation rules for diversity](https://www.alibabacloud.com/help/en/airec/airec/use-cases/improve-the-diversity-of-recommendations-by-using-instance-operation-rules.md): Three rule types: blocking (suppress seen items by time window), scattering (prevent same category_path/shop_id/author consecutively), sorting (item_type ratio). Scene-level overrides instance-level.
- [Negative feedback configuration](https://www.alibabacloud.com/help/en/airec/airec/use-cases/improve-the-accuracy-of-recommendations-by-using-the-negative-feedback-feature.md): Report dislike signals via bhv_type="dislike" with three scopes: dislike_item (permanent block), dislike_class:key=value (block category/tag/shop), dislike_related (block similar items).
- [Configure fatigue rules](https://www.alibabacloud.com/help/en/airec/airec/use-cases/configure-fatigue-rules.md): Set time-window thresholds on exposure and click behaviors to prevent repeated recommendations. Three scenarios: high-volume, long-conversion, and one-off content. Fallback when pool < 3,000 items.
- [Recommendation filtering via SDK](https://www.alibabacloud.com/help/en/airec/airec/use-cases/use-the-recommendation-filtering-feature-to-customize-the-filtering-of-feed-streams.md): Add Base64-encoded JSON filter param to SDK requests. Conditions: contain/not_contain (tags), equal/not_equal (brand_id, city), category_match. Max 10 single-value rules per request.
- [Throttling for item promotion](https://www.alibabacloud.com/help/en/airec/airec/use-cases/use-the-throttling-feature-to-control-item-recommendations.md): Override default ranking to boost item exposure. Filter by category, author, keyword, or specific IDs. Set total exposure count or daily ratio per scene. States: Draft, Ready, Running, Ended.
- [Development Guide](https://www.alibabacloud.com/help/en/airec/airec/developer-reference.md): Create a tenant in ApsaraDB for OceanBase with a step-by-step process to configure its mode, character set, and resource allocation via the console.
- [Server SDK](https://www.alibabacloud.com/help/en/airec/airec/developer-reference/server-sdk.md): Integrate the Alibaba Cloud AIRec service with the official Server SDK. Follow our guide for step-by-step instructions, configurations, and code examples.
- [SDK for Go](https://www.alibabacloud.com/help/en/airec/airec/developer-reference/sdk-for-go.md): Push data and retrieve recommendations using alibaba-cloud-sdk-go. Code examples for bulk POST to /tables/{table}/actions/bulk and GET /actions/recommend with ReturnCount, UserId, SceneId params.
- [SDK for Java](https://www.alibabacloud.com/help/en/airec/airec/developer-reference/sdk-for-java.md): Install aliyun-java-sdk-airec via Maven (requires aliyun-java-sdk-core 4.2.2+). Code examples for DescribeInstance and push data operations. Supports J2SE 6.0+.
- [SDK for PHP](https://www.alibabacloud.com/help/en/airec/airec/developer-reference/sdk-for-php.md): Install alibabacloud/airec-20201126 via Composer. Code examples for CreateInstance, DescribeInstance, and RunInstance APIs. Requires PHP 5.6+. Supports both specialized and generic call methods.
- [SDK for Python](https://www.alibabacloud.com/help/en/airec/airec/developer-reference/sdk-for-python.md): Install alibabacloud_airec20201126 via pip. Code examples for CreateInstance, DescribeInstance, and RunInstance. Requires Python 3.7+. Supports async calls and both specialized and generic methods.
- [SDK initialization parameters](https://www.alibabacloud.com/help/en/airec/airec/developer-reference/description-of-parameters-for-initialization.md): Required params for AIRec SDK client init: accessKeyId, accessKeySecret, region (cn-hangzhou/cn-beijing), endpoint, instanceId, productCode (Airec), format (JSON only).
- [SDK changelog](https://www.alibabacloud.com/help/en/airec/airec/developer-reference/updates-for-sdks.md): Version history for Java, Python, Go, PHP, and C# SDKs. Latest: Java 2.2.0 (2022-12, throttling API), Python 2.0.1 (2021-03, API v2020-11-26). Breaking change at v2.0.0: lower camelCase params.
- [Data source management](https://www.alibabacloud.com/help/en/airec/airec/developer-reference/data-source-management.md): Understand how AIRec structures item catalogs, user profiles, and behavioral event signals into a unified data pipeline to drive recommendation accuracy. Covers supported ingestion modes, dataset schema design, and data freshness guarantees.
- [Grant RAM user access to AIRec](https://www.alibabacloud.com/help/en/airec/airec/developer-reference/authorize-a-ram-user-to-access-airec.md): Attach AliyunAIRecFullAccess or AliyunAIRecReadOnlyAccess system policies to a RAM user or role. Custom policies can scope access to specific instances using airec:InstanceId condition keys.
- [Upload full data to MaxCompute](https://www.alibabacloud.com/help/en/airec/airec/developer-reference/upload-full-data.md): Upload behavior, item, and user tables to MaxCompute using tunnel upload command. Supports E-commerce, News, and Content industry schemas.
- [Create a DataWorks data source](https://www.alibabacloud.com/help/en/airec/airec/developer-reference/create-a-data-source.md): Create a DataWorks workspace (Basic Mode, pay-as-you-go MaxCompute) as AIRec's full data source. Workspace name equals MaxCompute project name.
- [Data source overview](https://www.alibabacloud.com/help/en/airec/airec/developer-reference/overview.md): AIRec uses only MaxCompute as its data source. Covers key concepts: partitioned tables, projects, odpscmd client.
- [API Reference](https://www.alibabacloud.com/help/en/airec/airec/developer-reference/api-reference-1.md)
- [API overview](https://www.alibabacloud.com/help/en/airec/airec/developer-reference/api-airec-2020-11-26-overview.md): Full API list for AIRec (2020-11-26, ROA standard). Categories: Instance CRUD, External Data Sources, Data Set, Experiment, Flow Control, Recall Table, Ranking System, Ranking Model, Rules, Scene,.
- [API endpoints](https://www.alibabacloud.com/help/en/airec/airec/developer-reference/api-airec-2020-11-26-endpoint.md): Region-specific endpoints for AIRec API. Public: airec.{region}.aliyuncs.com; VPC: airec-vpc.{region}.aliyuncs.com.
- [RAM authorization reference](https://www.alibabacloud.com/help/en/airec/airec/developer-reference/api-airec-2020-11-26-ram.md): Policy elements for AIRec RAM (RamCode: airec). Actions table with access levels (read/write/list), ARN resource patterns (acs:airec:{region}:{account}:instance/{id}), and resource types: Instance,.
- [Access control authentication rules](https://www.alibabacloud.com/help/en/airec/airec/developer-reference/access-control.md): Authentication rules mapping each API operation to its required RAM Action and ARN resource path. Covers instance CRUD, dataset operations, diversify rules, push/recommend endpoints, and dashboard.
- [API catalog](https://www.alibabacloud.com/help/en/airec/airec/developer-reference/api-airec-2020-11-26-dir.md): Bastionhost service endpoints define the access points for API calls, enabling developers to correctly configure SDKs and tools across all global regions.
- [External Data Sources](https://www.alibabacloud.com/help/en/airec/airec/developer-reference/api-airec-2020-11-26-dir-external-data-sources.md)
- [CreateExtraDataSource](https://www.alibabacloud.com/help/en/airec/airec/developer-reference/api-airec-2020-11-26-createextradatasource.md): POST /v2/openapi/instances/{instanceId}/extra-data-sources. Creates a custom data source (UserCustomDataSource, ItemCustomDataSource, BehaviorCustomDataSource, or SampleCustomDataSource) for an AIRec.
- [DeleteExtraDataSource](https://www.alibabacloud.com/help/en/airec/airec/developer-reference/api-airec-2020-11-26-deleteextradatasource.md): DELETE /v2/openapi/instances/{instanceId}/extra-data-sources/{type}/{dataSourceId}. Removes a custom data source.
- [ListExtraDataSources](https://www.alibabacloud.com/help/en/airec/airec/developer-reference/api-airec-2020-11-26-listextradatasources.md): GET /v2/openapi/instances/{instanceId}/extra-data-sources. Lists feature and sample data sources. Optional filter by type: UserCustomDataSource, ItemCustomDataSource, or BehaviorCustomDataSource.
- [Data Set](https://www.alibabacloud.com/help/en/airec/airec/developer-reference/api-airec-2020-11-26-dir-data-set.md)
- [DeleteDataSet](https://www.alibabacloud.com/help/en/airec/airec/developer-reference/api-airec-2020-11-26-deletedataset.md): DELETE /v2/openapi/instances/{instanceId}/dataSets/{versionId}. Deletes a dataset of a specified version from an AIRec instance. Returns dataset state and timestamps.
- [AttachDataset](https://www.alibabacloud.com/help/en/airec/airec/developer-reference/api-airec-2020-11-26-attachdataset.md): POST /v2/openapi/instances/{instanceId}/dataSets/{versionId}/actions/current. Activates a specific dataset version to serve online recommendations. Required params: instanceId, versionId.
- [DescribeDataSetMessage](https://www.alibabacloud.com/help/en/airec/airec/developer-reference/api-airec-2020-11-26-describedatasetmessage.md): GET /v2/openapi/instances/{instanceId}/dataSets/{versionId}/messages. Returns data error diagnostics for a dataset version: errorLevel (warn/error), errorType, message text, and timestamp.
- [ListDataSet](https://www.alibabacloud.com/help/en/airec/airec/developer-reference/api-airec-2020-11-26-listdataset.md): Query all datasets for an AIRec instance. Returns versionId, state (Importing/Ready), and timestamps. GET /v2/openapi/instances/{instanceId}/dataSets
- [AIRec Experiment APIs](https://www.alibabacloud.com/help/en/airec/airec/developer-reference/api-airec-2020-11-26-dir-experiment.md): APIs for managing AIRec experiments: DeleteExperiment, EnableExperiment, UpdateExperimentConfig, UpdateExperimentStatus, DescribeBaseExperiment, DescribeExperiment, ListExperiments, CloneExperiment.
- [DeleteExperiment](https://www.alibabacloud.com/help/en/airec/airec/developer-reference/api-airec-2020-11-26-deleteexperiment.md): Delete an experiment by instanceId, sceneId, and experimentId. DELETE /v2/openapi/instances/{instanceId}/scenes/{sceneId}/experiments/{experimentId}. Returns boolean result.
- [EnableExperiment](https://www.alibabacloud.com/help/en/airec/airec/developer-reference/api-airec-2020-11-26-enableexperiment.md): Activate the experiment environment for a scene. POST /v2/openapi/instances/{instanceId}/scenes/{sceneId}/actions/enable-experiment. Requires instanceId and sceneId.
- [UpdateExperimentBasicInfo](https://www.alibabacloud.com/help/en/airec/airec/developer-reference/api-airec-2020-11-26-updateexperimentbasicinfo.md): Modify experiment name, description, and basic metadata. PUT /v2/openapi/instances/{instanceId}/scenes/{sceneId}/experiments/{experimentId}/basic
- [UpdateExperimentConfig](https://www.alibabacloud.com/help/en/airec/airec/developer-reference/api-airec-2020-11-26-updateexperimentconfig.md): Update algorithm configuration for an experiment. Modify recall (I2I, u2X2I, hot, new, embedding) and rank strategies. PUT .../experiments/{experimentId}/config
- [UpdateExperimentStatus](https://www.alibabacloud.com/help/en/airec/airec/developer-reference/api-airec-2020-11-26-updateexperimentstatus.md): Change experiment state (init/online/finish/offline). PUT .../experiments/{experimentId}/status. Returns updated experiment with algorithm configs and bucket assignments.
- [DescribeBaseExperiment](https://www.alibabacloud.com/help/en/airec/airec/developer-reference/api-airec-2020-11-26-describebaseexperiment.md): Retrieve the default (base) experiment for a scene, including algorithm configs (I2I, u2X2I, hot, new, embedding, rankservice), bucket assignments, and status.
- [DescribeExperiment](https://www.alibabacloud.com/help/en/airec/airec/developer-reference/api-airec-2020-11-26-describeexperiment.md): Query full details of a specific experiment by experimentId. Returns status, algorithm configs (RECALL/RANK categories, SYSTEM/CUSTOM types), and traffic buckets.
- [DescribeExperimentEnv](https://www.alibabacloud.com/help/en/airec/airec/developer-reference/api-airec-2020-11-26-describeexperimentenv.md): Query experiment environment settings for a scene: bucket count and traffic divide method (UID or IMEI). GET .../scenes/{sceneId}/experiment-env
- [DescribeExperimentEnvProgress](https://www.alibabacloud.com/help/en/airec/airec/developer-reference/api-airec-2020-11-26-describeexperimentenvprogress.md): Check experiment scenario activation progress. Returns status (NotOpen/Processing/Running) and progress (0-100). Poll until Running to confirm readiness.
- [ListExperiments](https://www.alibabacloud.com/help/en/airec/airec/developer-reference/api-airec-2020-11-26-listexperiments.md): List all experiments in a scene with basic info (name, status, buckets, onlineTime). No pagination. Status values: Init, Online, Finish, Offline.
- [CloneExperiment](https://www.alibabacloud.com/help/en/airec/airec/developer-reference/api-airec-2020-11-26-cloneexperiment.md): Duplicate an existing experiment with its algorithm configs. POST .../experiments/{experimentId}/actions/clone. Supports dryRun=true to validate without creating.
- [flow regulation](https://www.alibabacloud.com/help/en/airec/airec/developer-reference/api-airec-2020-11-26-dir-flow-regulation.md): Call the `DescribeSystemLog` API to programmatically query billing details for burstable clean bandwidth, with all required parameters and response examples.
- [ListFlowControlTaskReports](https://www.alibabacloud.com/help/en/airec/airec/developer-reference/api-airec-2020-11-26-listflowcontroltaskreports.md): Retrieve exposure reports for a traffic control task: CTR, PV, and invalid item percentage. Filter by startTime/endTime (UNIX seconds). Returns daily metric time series.
- [ListFlowControlTaskInvalidItems](https://www.alibabacloud.com/help/en/airec/airec/developer-reference/api-airec-2020-11-26-listflowcontroltaskinvaliditems.md): Check which items in a traffic control task are invalid. POST body contains item IDs to validate; returns invalidItems array with itemId and itemType.
- [ListFlowControlTaskItems](https://www.alibabacloud.com/help/en/airec/airec/developer-reference/api-airec-2020-11-26-listflowcontroltaskitems.md): Preview items in a traffic control task with pagination (max 500/page). Returns totalCount, validCount, and item details (author, itemType, weight, status, categoryPath).
- [CreateFlowControlTask](https://www.alibabacloud.com/help/en/airec/airec/developer-reference/api-airec-2020-11-26-createflowcontroltask.md): Create a traffic control (throttling) task. Supports dryRun mode. Returns taskId and initial DRAFT status. POST /v2/openapi/instances/{instanceId}/flowControlTasks
- [GetFlowControlTask](https://www.alibabacloud.com/help/en/airec/airec/developer-reference/api-airec-2020-11-26-getflowcontroltask.md): Get full details of a traffic control task: metadata (startTime, endTime, sceneIds), item selection rules (selectionParams), exposure target (EXPOSE_PERCENT or EXPOSE_COUNT), and status.
- [DeleteFlowControlTask](https://www.alibabacloud.com/help/en/airec/airec/developer-reference/api-airec-2020-11-26-deleteflowcontroltask.md): Delete a traffic control task by instanceId and taskId. DELETE /v2/openapi/instances/{instanceId}/flowControlTasks/{taskId}. Returns boolean result.
- [ListFlowControlTask](https://www.alibabacloud.com/help/en/airec/airec/developer-reference/api-airec-2020-11-26-listflowcontroltask.md): List traffic control tasks with optional status filter (DRAFT/READY/RUNNING/ENDED). Paginated (1-50/page). Returns task metadata, selection rules, and exposure targets.
- [ListFlowControlTaskItemReports](https://www.alibabacloud.com/help/en/airec/airec/developer-reference/api-airec-2020-11-26-listflowcontroltaskitemreports.md): Query per-item metrics for a traffic control task: top-exposure items or invalid items. Filter by time range (yesterDay/lastSevenDays/lastFifteenDays). Returns PV, CTR, click counts.
- [ListFlowControlTaskReference](https://www.alibabacloud.com/help/en/airec/airec/developer-reference/api-airec-2020-11-26-listflowcontroltaskreference.md): Query reference metrics for a traffic control task, including last7PvPercent, last7ScenePv, lastScenePv exposure stats. GET by instanceId and taskId.
- [ModifyFlowControlTask](https://www.alibabacloud.com/help/en/airec/airec/developer-reference/api-airec-2020-11-26-modifyflowcontroltask.md): Update a traffic control task's name, schedule (startTime/endTime), selectionParams, sceneIds, and exposure target (EXPOSE_PERCENT). PUT by instanceId and taskId.
- [StopFlowControlTask](https://www.alibabacloud.com/help/en/airec/airec/developer-reference/api-airec-2020-11-26-stopflowcontroltask.md): Stop a running traffic control task. PUT request with instanceId and taskId path params. Returns boolean result indicating success.
- [PublishFlowControlTask](https://www.alibabacloud.com/help/en/airec/airec/developer-reference/api-airec-2020-11-26-publishflowcontroltask.md): Activate a traffic control task so it takes effect on recommendations. PUT request with instanceId and taskId. Returns boolean result.
- [Recall Table](https://www.alibabacloud.com/help/en/airec/airec/developer-reference/api-airec-2020-11-26-dir-recall-table.md): Use the DescribeInstanceAttribute API to query all attributes of a Bastionhost instance, such as its InstanceStatus, ExpireTime, and network endpoints.
- [CreateFilteringAlgorithm](https://www.alibabacloud.com/help/en/airec/airec/developer-reference/api-airec-2020-11-26-createfilteringalgorithm.md): Create a filtering table from a MaxCompute (ODPS) source. Supports dryRun mode, CRON scheduling, and threshold settings for source data and index fluctuation.
- [DeleteFilteringAlgorithm](https://www.alibabacloud.com/help/en/airec/airec/developer-reference/api-airec-2020-11-26-deletefilteringalgorithm.md): Delete a filtering table and its related index. DELETE request with instanceId and algorithmId. Status transitions to Deleted.
- [ModifyFilteringAlgorithmMeta](https://www.alibabacloud.com/help/en/airec/airec/developer-reference/api-airec-2020-11-26-modifyfilteringalgorithmmeta.md): Update a filtering table's ODPS config: threshold settings, cron schedule, tableName, projectName. Must submit complete threshold config, not partial updates.
- [DescribeFilteringAlgorithm](https://www.alibabacloud.com/help/en/airec/airec/developer-reference/api-airec-2020-11-26-describefilteringalgorithm.md): Get configuration details of a specific filtering table by algorithmId: status, ODPS metadata, threshold settings, cron schedule, and extInfo separators.
- [ListFilteringAlgorithms](https://www.alibabacloud.com/help/en/airec/airec/developer-reference/api-airec-2020-11-26-listfilteringalgorithms.md): List all recall tables for an instance. Filter by status (Draft/Running/Offline/Deleted) or algorithmId. Supports pagination with page and size params.
- [OfflineFilteringAlgorithm](https://www.alibabacloud.com/help/en/airec/airec/developer-reference/api-airec-2020-11-26-offlinefilteringalgorithm.md): Take a filtering algorithm offline. POST request with instanceId and algorithmId. Status changes from Running to Offline; stops cron-scheduled index updates.
- [AIRec Ranking System APIs (Create/Deploy/Verify/Rollback)](https://www.alibabacloud.com/help/en/airec/airec/developer-reference/api-airec-2020-11-26-dir-sorting-system.md): AIRec ranking service APIs: CreateRankingSystem, ModifyRankingSystem, DeployRankingSystem, VerifyRankingSystem, RollbackRankingSystem, delete/list and history queries.
- [CreateRankingSystem](https://www.alibabacloud.com/help/en/airec/airec/developer-reference/api-airec-2020-11-26-createrankingsystem.md): Create a ranking service backed by EAS PredictEngine. POST with instanceId. Returns RankingSystem object with AutoDeploy, ModelTemplateId, and DeployStatus.
- [DeleteRankingSystem](https://www.alibabacloud.com/help/en/airec/airec/developer-reference/api-airec-2020-11-26-deleterankingsystem.md): Delete a ranking service by name. DELETE /v2/openapi/instances/{instanceId}/ranking-systems/{name}. Returns the deleted RankingSystem object.
- [ModifyRankingSystem](https://www.alibabacloud.com/help/en/airec/airec/developer-reference/api-airec-2020-11-26-modifyrankingsystem.md): Update a ranking service's configuration (AutoDeploy, PredictEngine, model settings). PUT by instanceId and service name. Returns modified RankingSystem.
- [GetRankingSystem](https://www.alibabacloud.com/help/en/airec/airec/developer-reference/api-airec-2020-11-26-getrankingsystem.md): Retrieve details of a ranking service by name: Meta (AutoDeploy, PredictEngine, ModelVersionName), ApplyStatus, DeployStatus, and SceneIdList.
- [GetRankingSystemHistory](https://www.alibabacloud.com/help/en/airec/airec/developer-reference/api-airec-2020-11-26-getrankingsystemhistory.md): Get a single operation record by operateId for a ranking service. Returns OperateType (CONF_CHANGE/DEPLOY_CHANGE), OperateTime, and PreviousOperateId.
- [ListRankingSystems](https://www.alibabacloud.com/help/en/airec/airec/developer-reference/api-airec-2020-11-26-listrankingsystems.md): List all ranking services for an instance. Filter by name or deployStatus (NOT_DEPLOYED/DEPLOY_SUCCESS). Supports pagination with page and size params.
- [ListRankingSystemHistories](https://www.alibabacloud.com/help/en/airec/airec/developer-reference/api-airec-2020-11-26-listrankingsystemhistories.md): List operation records for a ranking service. Filter by operateType (CONF_CHANGE/DEPLOY_CHANGE). Supports pagination. Returns RankingSystemHistory array.
- [DeployRankingSystem](https://www.alibabacloud.com/help/en/airec/airec/developer-reference/api-airec-2020-11-26-deployrankingsystem.md): Deploy or redeploy a ranking service after config changes. POST with body containing autoDeploy, autoDeployAuc, predictEngineType (EAS), and resourceId.
- [VerifyRankingSystem](https://www.alibabacloud.com/help/en/airec/airec/developer-reference/api-airec-2020-11-26-verifyrankingsystem.md): Test a ranking service with sample features. POST body accepts userFeatures and itemFeatures key-value strings. Returns prediction result as string.
- [RollbackRankingSystem](https://www.alibabacloud.com/help/en/airec/airec/developer-reference/api-airec-2020-11-26-rollbackrankingsystem.md): Roll back a ranking service to a previous version. POST body with operateId specifies which history record to revert to. Requires instanceId and service name.
- [Sort Model Template](https://www.alibabacloud.com/help/en/airec/airec/developer-reference/api-airec-2020-11-26-dir-sort-model-template.md)
- [CreateRankingModelTemplate API](https://www.alibabacloud.com/help/en/airec/airec/developer-reference/api-airec-2020-11-26-createrankingmodeltemplate.md): POST to create a ranking model template for an AIRec instance. Requires instanceId path param. Returns templateId, status, and meta (AutoRun, Type, DeployStatus).
- [DeleteRankingModelTemplate API](https://www.alibabacloud.com/help/en/airec/airec/developer-reference/api-airec-2020-11-26-deleterankingmodeltemplate.md): DELETE a ranking model template by instanceId and templateId. Returns the deleted template metadata including status and version count.
- [ModifyRankingModelTemplate API](https://www.alibabacloud.com/help/en/airec/airec/developer-reference/api-airec-2020-11-26-modifyrankingmodeltemplate.md): PUT to update a ranking model template. Requires instanceId and templateId path params plus a JSON body. RAM action: airec:ModifyRankingModelTemplate at instance level.
- [GetRankingModelTemplate API](https://www.alibabacloud.com/help/en/airec/airec/developer-reference/api-airec-2020-11-26-getrankingmodeltemplate.md): GET details of a specific ranking model template by instanceId and templateId. Returns RankingModelTemplate object. RAM action: airec:GetRankingModelTemplate.
- [RunRankingModelTemplate API](https://www.alibabacloud.com/help/en/airec/airec/developer-reference/api-airec-2020-11-26-runrankingmodeltemplate.md): POST to trigger training execution of a ranking model template. Requires instanceId and templateId. Starts model training and returns run result.
- [sorting model](https://www.alibabacloud.com/help/en/airec/airec/developer-reference/api-airec-2020-11-26-dir-sorting-model.md): Calculate the optimal broker count, disk size, and CPU for your EMR Kafka cluster with clear formulas based on peak traffic, replication, and retention.
- [CreateRankingModel API](https://www.alibabacloud.com/help/en/airec/airec/developer-reference/api-airec-2020-11-26-createrankingmodel.md): POST to create a ranking model. Requires instanceId. Supports dryRun=true for validation without creation. Returns rankingModelId and model metadata.
- [DeleteRankingModel API](https://www.alibabacloud.com/help/en/airec/airec/developer-reference/api-airec-2020-11-26-deleterankingmodel.md): DELETE a ranking model by instanceId and rankingModelId. RAM action: airec:DeleteRankingModel at instance level. Returns deleted model metadata.
- [DeleteRankingModelVersion API](https://www.alibabacloud.com/help/en/airec/airec/developer-reference/api-airec-2020-11-26-deleterankingmodelversion.md): DELETE a specific version of a ranking model by instanceId and versionId. Distinct from DeleteRankingModel which removes the entire model.
- [ModifyRankingModel API](https://www.alibabacloud.com/help/en/airec/airec/developer-reference/api-airec-2020-11-26-modifyrankingmodel.md): PUT to update ranking model metadata. Requires instanceId and rankingModelId. Response includes gmtModified timestamp and updated meta object.
- [ListRankingModels API](https://www.alibabacloud.com/help/en/airec/airec/developer-reference/api-airec-2020-11-26-listrankingmodels.md): GET paginated list of ranking models for an instance. Supports filtering by rankingModelId, page, and size (1-50). Returns array of model objects with metadata.
- [ListRankingModelTemplates API](https://www.alibabacloud.com/help/en/airec/airec/developer-reference/api-airec-2020-11-26-listrankingmodeltemplates.md): GET paginated list of ranking model templates sorted by creation time (descending). Params: instanceId, page, size (1-50). Returns RankingModelTemplate array.
- [GetRankingModelVersion API](https://www.alibabacloud.com/help/en/airec/airec/developer-reference/api-airec-2020-11-26-getrankingmodelversion.md): GET details of a ranking model version including training metrics (TrainAuc, TrainGauc, TrainLoss) and assessment metrics (AssessAuc, AssessGauc, AssessLoss).
- [ListRankingModelVersions API](https://www.alibabacloud.com/help/en/airec/airec/developer-reference/api-airec-2020-11-26-listrankingmodelversions.md): GET paginated list of versions for a ranking model. Filter by status: DRAFT, EFFECTIVE, PUBLISHING, INEFFECTIVE, FAILED. Requires instanceId and templateId.
- [DecribeRankingModel API](https://www.alibabacloud.com/help/en/airec/airec/developer-reference/api-airec-2020-11-26-decriberankingmodel.md): GET a single ranking model by instanceId and rankingModelId. Returns model metadata, creation time, and modification time. Distinct from ListRankingModels (single vs list).
- [CheckRankingModelReachable API](https://www.alibabacloud.com/help/en/airec/airec/developer-reference/api-airec-2020-11-26-checkrankingmodelreachable.md): GET to verify network connectivity of a deployed ranking model. Returns boolean result. Use before serving to confirm the model endpoint is accessible.
- [Rules](https://www.alibabacloud.com/help/en/airec/airec/developer-reference/api-airec-2020-11-26-dir-rules.md)
- [CreateRule API](https://www.alibabacloud.com/help/en/airec/airec/developer-reference/api-airec-2020-11-26-createrule.md): POST to create a recommendation rule (selection or operation type) for an AIRec instance. Returns ruleId and status. RAM action: airec:CreateRule.
- [ModifyRule API](https://www.alibabacloud.com/help/en/airec/airec/developer-reference/api-airec-2020-11-26-modifyrule.md): PUT to update a rule by instanceId and ruleId. Supports SelectionRule (item type filtering) and OperationRule (MIX, DIVERSIFY, EXPOSURE operations) via JSON body.
- [ListRules API](https://www.alibabacloud.com/help/en/airec/airec/developer-reference/api-airec-2020-11-26-listrules.md): GET paginated list of rules. Filter by sceneId (or "global"), ruleType (selection/operation), status (DRAFT/EFFECTIVE/PUBLISHING/INEFFECTIVE/FAILED), and time range.
- [DescribeRule API](https://www.alibabacloud.com/help/en/airec/airec/developer-reference/api-airec-2020-11-26-describerule.md): GET details of a single rule by instanceId, ruleId, sceneId, and ruleType. Returns rule status (DRAFT/EFFECTIVE/etc), creation and modification timestamps.
- [PublishRule API](https://www.alibabacloud.com/help/en/airec/airec/developer-reference/api-airec-2020-11-26-publishrule.md): PUT to publish a draft rule to make it effective. Requires instanceId, ruleId, ruleType (selection/operation), and sceneId. RAM action: airec:PublishRule.
- [Scene](https://www.alibabacloud.com/help/en/airec/airec/developer-reference/api-airec-2020-11-26-dir-scene.md)
- [CreateScene](https://www.alibabacloud.com/help/en/airec/airec/developer-reference/api-airec-2020-11-26-createscene.md): Create a recommendation scenario. Params: instanceId (required), dryRun (validates sceneId without creating). Returns sceneId, status (DRAFT/PUBLISHING/RUNNING/FAILED/FROZEN).
- [DeleteScene](https://www.alibabacloud.com/help/en/airec/airec/developer-reference/api-airec-2020-11-26-deletescene.md): Delete a recommendation scenario. Params: instanceId, sceneId (both required). Console Scenario Management is recommended over direct API calls.
- [ModifyScene](https://www.alibabacloud.com/help/en/airec/airec/developer-reference/api-airec-2020-11-26-modifyscene.md): Update a recommendation scenario via PUT request. Params: instanceId, sceneId (both required). Returns updated status (DRAFT/PUBLISHING/RUNNING/FAILED/FROZEN). RAM action: airec:ModifyScene.
- [DescribeScene](https://www.alibabacloud.com/help/en/airec/airec/developer-reference/api-airec-2020-11-26-describescene.md): Query details of a single recommendation scenario. GET request with instanceId and sceneId. Returns sceneId, status, gmtCreate, gmtModified. RAM action: airec:DescribeScene.
- [ListScenes](https://www.alibabacloud.com/help/en/airec/airec/developer-reference/api-airec-2020-11-26-listscenes.md): List all recommendation scenarios for an instance. Filter by status (DRAFT/PUBLISHING/RUNNING/FAILED/FROZEN) and sceneId. Supports pagination with page/size params (default 10, max 50).
- [Sample](https://www.alibabacloud.com/help/en/airec/airec/developer-reference/api-airec-2020-11-26-dir-sample.md): Configure a MaxCompute data source in OpenSearch with detailed steps, SQL commands for RAM permissions, and regex examples for daily partition-based data syncs.
- [CreateCustomSample](https://www.alibabacloud.com/help/en/airec/airec/developer-reference/api-airec-2020-11-26-createcustomsample.md): Create a custom training sample. POST /instances/{instanceId}/samples. Config includes LabelLogic (positive/negative behavior types, BhvTimeWindow), FeatureConfig, and WeightLogicList.
- [CreateSampleFormatConfig](https://www.alibabacloud.com/help/en/airec/airec/developer-reference/api-airec-2020-11-26-createsampleformatconfig.md): Define feature engineering config for a sample. POST /instances/{instanceId}/samples/{sampleId}/format-configs. Specify feature_type, embedding_dim, hash_bucket_size, and groups (user/item/combo).
- [DeleteSample](https://www.alibabacloud.com/help/en/airec/airec/developer-reference/api-airec-2020-11-26-deletesample.md): Delete a training sample. DELETE /v2/openapi/instances/{instanceId}/samples/{sampleId}. Returns the deleted Sample object with metadata (Status, Meta, SampleId).
- [ModifySample](https://www.alibabacloud.com/help/en/airec/airec/developer-reference/api-airec-2020-11-26-modifysample.md): Update a sample configuration. PUT /v2/openapi/instances/{instanceId}/samples/{sampleId}. Accepts JSON body to modify LabelLogic, FeatureConfig, WeightLogicList. RAM action: airec:ModifySample.
- [ListSamples](https://www.alibabacloud.com/help/en/airec/airec/developer-reference/api-airec-2020-11-26-listsamples.md): List all samples for an instance. GET request with optional sampleId filter and pagination (page, size). Returns array of Sample objects with Status, Meta (LabelLogic, FeatureConfig), and SampleId.
- [GetSample](https://www.alibabacloud.com/help/en/airec/airec/developer-reference/api-airec-2020-11-26-getsample.md): Retrieve a single sample. GET /instances/{instanceId}/samples/{sampleId}. Optional withExtendParmas=true returns LatestTaskStatus and SampleCount. RAM action: airec:GetSample.
- [CloneSample](https://www.alibabacloud.com/help/en/airec/airec/developer-reference/api-airec-2020-11-26-clonesample.md): Duplicate an existing sample. PUT /instances/{instanceId}/samples/{sampleId}/actions/clone. Returns a new Sample with a ClonedId referencing the original. RAM action: airec:CloneSample.
- [GenerateSample](https://www.alibabacloud.com/help/en/airec/airec/developer-reference/api-airec-2020-11-26-generatesample.md): Trigger sample generation for a cloned sample. PUT /instances/{instanceId}/samples/{sampleId}/actions/generate. Only works on samples created via CloneSample.
- [Other](https://www.alibabacloud.com/help/en/airec/airec/developer-reference/api-airec-2020-11-26-dir-other.md): Explore the OpenSearch analyzer system, covering its built-in text analyzers and custom creation methods, to precisely tailor indexing for optimal search relevance.
- [CreateCustomAnalysisTask](https://www.alibabacloud.com/help/en/airec/airec/developer-reference/api-airec-2020-11-26-createcustomanalysistask.md): Create a custom analysis task. POST /instances/{instanceId}/dashboard/custom-analysis-tasks. Param type (e.g. ITEM_CUSTOM for item-dimension analysis). Returns task ID.
- [AttachIndexVersion](https://www.alibabacloud.com/help/en/airec/airec/developer-reference/api-airec-2020-11-26-attachindexversion.md): Bring a filtering algorithm index version online. POST to /instances/{instanceId}/filtering-algorithms/{algorithmId}/index-versions/{versionId}/actions/attach. Returns TRUE/FALSE for switch success.
- [ModifyDataSource](https://www.alibabacloud.com/help/en/airec/airec/developer-reference/api-airec-2020-11-26-modifydatasource.md): Update a data source table config. PUT /instances/{instanceId}/dataSources/{tableName}. Supports MaxCompute (ODPS) and OSS sources. Returns meta with bucketName, projectName, tableName, partition.
- [ModifyFeatureTable](https://www.alibabacloud.com/help/en/airec/airec/developer-reference/api-airec-2020-11-26-modifyfeaturetable.md): Replace the feature list of a feature table. PUT /instances/{instanceId}/feature-tables/{type}/{featureTableId}. Type: UserFeatureTable or ItemFeatureTable.
- [ModifyItems](https://www.alibabacloud.com/help/en/airec/airec/developer-reference/api-airec-2020-11-26-modifyitems.md): Batch modify items in the recommendation item pool. POST /instances/{instanceId}/items. Returns boolean result (true=success). RAM action: airec:ModifyItems.
- [ModifyOfflineStorages](https://www.alibabacloud.com/help/en/airec/airec/developer-reference/api-airec-2020-11-26-modifyofflinestorages.md): Update offline storage config. POST /instances/{instanceId}/offlineStorages. All three tables must be modified simultaneously. Returns boolean. RAM action: airec:ModifyOfflineStorages.
- [StopDataSet](https://www.alibabacloud.com/help/en/airec/airec/developer-reference/api-airec-2020-11-26-stopdataset.md): Stop a specific dataset version. POST /instances/{instanceId}/dataSets/{versionId}/actions/stop. Returns dataset state (e.g. Importing), versionId, and timestamps. Use to halt an ongoing data import.
- [DescribeCustomAnalysisTask](https://www.alibabacloud.com/help/en/airec/airec/developer-reference/api-airec-2020-11-26-describecustomanalysistask.md): Query results of a custom analysis task by instanceId and taskId. Supports type parameter (e.g., ITEM_CUSTOM) to specify analysis category.
- [DescribeDefaultAlgorithms](https://www.alibabacloud.com/help/en/airec/airec/developer-reference/api-airec-2020-11-26-describedefaultalgorithms.md): Query default algorithm configurations for a scene. Returns algorithm keys (I2I, u2x2i, hot, new, embedding, mtorder, rankservice) with category RECALL or RANK and SYSTEM/CUSTOM type.
- [DescribeLatestTask](https://www.alibabacloud.com/help/en/airec/airec/developer-reference/api-airec-2020-11-26-describelatesttask.md): Retrieve the latest filtering algorithm build task status. Returns progress percentage, flowType (Auto/Manual/Rollback), versionId, costSeconds, and rollbackEnabled flag.
- [DescribeQuota](https://www.alibabacloud.com/help/en/airec/airec/developer-reference/api-airec-2020-11-26-describequota.md): Query instance resource quotas: itemCount, userCount (1M-10M range), qps (10-500), plus current usage via itemCountUsed, userCountUsed, and currentQps.
- [DescribeRegions](https://www.alibabacloud.com/help/en/airec/airec/developer-reference/api-airec-2020-11-26-describeregions.md): List available AIRec regions with regionId, endpoint, status (NotOpen/Processing/Running), and consoleUrl. Optional acceptLanguage param defaults to zh-cn.
- [DescribeSceneBucket](https://www.alibabacloud.com/help/en/airec/airec/developer-reference/api-airec-2020-11-26-describescenebucket.md): Query A/B test experiment bucket distribution for a scene. Returns total bucket num, inUse bucket numbers allocated to experiments, and bucket detail.
- [DescribeSceneThroughput](https://www.alibabacloud.com/help/en/airec/airec/developer-reference/api-airec-2020-11-26-describescenethroughput.md): Query traffic throughput (pvCount) for a recommendation scene by instanceId and sceneId. Use Scenario Management in the console for scene operations.
- [DescribeSyncReportDetail](https://www.alibabacloud.com/help/en/airec/airec/developer-reference/api-airec-2020-11-26-describesyncreportdetail.md): Query hourly real-time data sync quality reports. Filter by table type (behavior/item/user) and levelType (error/warn/info). Returns errorPercent, errorCount, and historyData per issue type.
- [DescribeSyncReportOutliers](https://www.alibabacloud.com/help/en/airec/airec/developer-reference/api-airec-2020-11-26-describesyncreportoutliers.md): Retrieve outlier samples from real-time sync reports. Key param filters: itemBhv, userBhv, bhvTypeBhv, traceIdBhv, traceInfoBhv, itemItem, userUser. Filter by type (behavior/item/user) and levelType.
- [DescribeUserMetrics](https://www.alibabacloud.com/help/en/airec/airec/developer-reference/api-airec-2020-11-26-describeusermetrics.md): Query user conversion metrics (pvCtr, uvCtr) over a time range. Returns per-scene dataPoints with val, startTime, and endTime for trend analysis.
- [GetExtraDataSource](https://www.alibabacloud.com/help/en/airec/airec/developer-reference/api-airec-2020-11-26-getextradatasource.md): Get details of an extra data source by type (UserCustomDataSource, ItemCustomDataSource, BehaviorCustomDataSource, SampleCustomDataSource) and dataSourceId.
- [ListDashboardDetails](https://www.alibabacloud.com/help/en/airec/airec/developer-reference/api-airec-2020-11-26-listdashboarddetails.md): Query detailed dashboard metrics by scene and trace. metricType: PV/UV counts, PV/UV conversion ratios, and dwell time (content scenarios). Filter by experimentIds and matchTypes (hot, emb, u2x2i).
- [ListDashboardDetailsFlows](https://www.alibabacloud.com/help/en/airec/airec/developer-reference/api-airec-2020-11-26-listdashboarddetailsflows.md): Query time-series traffic metric details (PV/UV counts, conversion ratios, dwell time) grouped by traceId and sceneId. Supports experimentIds filter for A/B test comparison.
- [ListDashboardMetrics](https://www.alibabacloud.com/help/en/airec/airec/developer-reference/api-airec-2020-11-26-listdashboardmetrics.md): Query aggregated dashboard metrics with optional metricView (USER or ITEM dimension) and metricQuery filter (e.g., dimension:ITEM_TYPE;behaviorType:expose).
- [ListDashboardMetricsFlows](https://www.alibabacloud.com/help/en/airec/airec/developer-reference/api-airec-2020-11-26-listdashboardmetricsflows.md): Query overall instance-level traffic flow metrics (PV/UV counts and conversion ratios) over a time range. Simpler than ListDashboardDetailsFlows with no scene/trace filtering.
- [ListFeatureTables](https://www.alibabacloud.com/help/en/airec/airec/developer-reference/api-airec-2020-11-26-listfeaturetables.md): List feature tables for an instance. Filter by type (ItemFeatureTable, UserFeatureTable), updateFrequency, or dataSourceId. Returns FeatureTable objects.
- [ListIndexVersions](https://www.alibabacloud.com/help/en/airec/airec/developer-reference/api-airec-2020-11-26-listindexversions.md): List index versions for a filtering algorithm (up to 10 entries, 3 switchable). Returns versionId, status (failed/online/offline), progress, builtTime, size, and rollbackEnabled flag.
- [ListInstanceTask](https://www.alibabacloud.com/help/en/airec/airec/developer-reference/api-airec-2020-11-26-listinstancetask.md): Query all async tasks for an instance. Returns totalProgress percentage and subProgressInfos with step name (e.g., DATA_IMPORT), type (DATA_PROCESS), finishedNum, and totalNum.
- [ListItems](https://www.alibabacloud.com/help/en/airec/airec/developer-reference/api-airec-2020-11-26-listitems.md): List items from an instance's item pool with pagination. Supports strategyUsed=true for pinned/fixed-position logic. Returns totalCount, instanceRecommendItem, sceneRecommendItem, and item details.
- [ListLogs](https://www.alibabacloud.com/help/en/airec/airec/developer-reference/api-airec-2020-11-26-listlogs.md): Query instance operation logs from the last 7 days. Filter with queryParams (key:value format, e.g., requestId:xxx;requestUri:xxx). Supports pagination with page and size (1-50).
- [ListMixCategories](https://www.alibabacloud.com/help/en/airec/airec/developer-reference/api-airec-2020-11-26-listmixcategories.md): Query content types supported in diversity rule configurations. No request parameters required. Returns category IDs used in mix rules.
- [ListOfflineStorages](https://www.alibabacloud.com/help/en/airec/airec/developer-reference/api-airec-2020-11-26-listofflinestorages.md): Query offline storage tables for an AIRec instance. Requires instanceId path parameter. Returns tableName and meta for each storage entry.
- [ListRuleConditions](https://www.alibabacloud.com/help/en/airec/airec/developer-reference/api-airec-2020-11-26-listruleconditions.md): Query item selection rule conditions for an instance. Returns selectType (e.g. QUERY_ITEM_TYPE), selectValue, and selectionOperation (e.g. QUERY_VALUE_IN).
- [ListRuleTasks](https://www.alibabacloud.com/help/en/airec/airec/developer-reference/api-airec-2020-11-26-listruletasks.md): Query rule task execution status for a scene. Requires instanceId and sceneId. Returns finishRate (percentage) and finishTime (UNIX timestamp).
- [ListSampleFormatConfigs](https://www.alibabacloud.com/help/en/airec/airec/developer-reference/api-airec-2020-11-26-listsampleformatconfigs.md): Retrieve sample format configurations for a specific sample. Requires instanceId and sampleId path parameters. Returns format config object.
- [ListSceneItems](https://www.alibabacloud.com/help/en/airec/airec/developer-reference/api-airec-2020-11-26-listsceneitems.md): Preview items in a recommendation scene. Filter by operationRuleId or selectionRuleId. Returns item counts (totalCount, sceneRecommendItem) and item details with pagination.
- [ListSceneParameters](https://www.alibabacloud.com/help/en/airec/airec/developer-reference/api-airec-2020-11-26-listsceneparameters.md): List all channels (traceId) and scenarios (sceneId) configured for an AIRec instance. Requires instanceId only.
- [ListUmengAppkeys](https://www.alibabacloud.com/help/en/airec/airec/developer-reference/api-airec-2020-11-26-listumengappkeys.md): Retrieve Umeng app keys linked to your account. No parameters required. Returns appkey, platform (Android/iOS), and app name for each entry.
- [ListUserClusters](https://www.alibabacloud.com/help/en/airec/airec/developer-reference/api-airec-2020-11-26-listuserclusters.md): List user clusters for an AIRec instance. Returns cluster name, status, metaType, gmtCreate/gmtModified timestamps, and X-Total-Count header.
- [QueryDataMessage](https://www.alibabacloud.com/help/en/airec/airec/developer-reference/api-airec-2020-11-26-querydatamessage.md): Query update messages in item/user/behavior tables within a time range. Filter by cmdType (update/delete/add), itemId, userId, bhvType, or messageSource. Supports pagination.
- [QueryDataMessageStatistics](https://www.alibabacloud.com/help/en/airec/airec/developer-reference/api-airec-2020-11-26-querydatamessagestatistics.md): Retrieve aggregated statistics for data update messages in item/user tables. Filter by time range, cmdType, bhvType, messageSource, or IMEI.
- [QueryExceptionHistory](https://www.alibabacloud.com/help/en/airec/airec/developer-reference/api-airec-2020-11-26-queryexceptionhistory.md): Query abnormal data history for item, behavior, or user segments within a time range. Requires instanceId, startTime, endTime, and type parameter.
- [QueryRawData](https://www.alibabacloud.com/help/en/airec/airec/developer-reference/api-airec-2020-11-26-queryrawdata.md): Retrieve raw data from item or user tables by primary key. Specify itemId/itemType for item table, or userId/userType for user table. Used for data verification.
- [QuerySingleAggregationReport](https://www.alibabacloud.com/help/en/airec/airec/developer-reference/api-airec-2020-11-26-querysingleaggregationreport.md): Run an aggregate query on a single sync report table. Data is not real-time. Requires instanceId only. Returns aggregated result object.
- [QuerySingleReport](https://www.alibabacloud.com/help/en/airec/airec/developer-reference/api-airec-2020-11-26-querysinglereport.md): Query a single table report by reportType. Valid types: typeItemValidScene, typeItemTag, typeItemTagScene, typeItemWeightScene, typeItemRawScene, typeItemExpireScene.
- [QuerySyncReportAggregation](https://www.alibabacloud.com/help/en/airec/airec/developer-reference/api-airec-2020-11-26-querysyncreportaggregation.md): Get aggregated overview of sync reports for a time range. Requires instanceId, startTime, and endTime (UNIX timestamps in seconds).
- [ListDataSource](https://www.alibabacloud.com/help/en/airec/airec/developer-reference/api-airec-2020-11-26-listdatasource.md): List data sources for an AIRec instance. Returns source type (ODPS supported), tableName, OSS bucket/path, MaxCompute project/partition, and timestamps.
- [InitComputingResource](https://www.alibabacloud.com/help/en/airec/airec/developer-reference/api-airec-2020-11-26-initcomputingresource.md): Initialize a computing resource (MAX_COMPUTE type) for an AIRec instance. Specify workspace name via the key parameter. PUT method.
- [PushDocument](https://www.alibabacloud.com/help/en/airec/airec/developer-reference/api-airec-2020-11-26-pushdocument.md): Bulk-push documents to a user, item, or behavior table in an AIRec instance. POST to /actions/bulk endpoint. Returns boolean result.
- [PushIntervention](https://www.alibabacloud.com/help/en/airec/airec/developer-reference/api-airec-2020-11-26-pushintervention.md): Push intervention data to an AIRec instance to override or adjust recommendation results. POST to /actions/intervene. Requires instanceId, returns boolean result.
- [RebuildIndex](https://www.alibabacloud.com/help/en/airec/airec/developer-reference/api-airec-2020-11-26-rebuildindex.md): Rebuild a filtering algorithm index. Requires instanceId and algorithmId path parameters. POST to /v2/openapi/instances/{instanceId}/filtering-algorithms/{algorithmId}/actions/rebuild.
- [Recommend](https://www.alibabacloud.com/help/en/airec/airec/developer-reference/api-airec-2020-11-26-recommend.md): Query personalized recommendation results for a user. Params: instanceId, userId, sceneId, returnCount (0-50), filter, items, strategy (fixedSlot for slot-based results). GET request.
- [RefreshFeatureTable](https://www.alibabacloud.com/help/en/airec/airec/developer-reference/api-airec-2020-11-26-refreshfeaturetable.md): Sync a feature table from its ODPS data source. Path params: instanceId, type (ItemFeatureTable or UserFeatureTable), featureTableId. Source table is treated as ground truth.
- [RunSampleFormatConfig](https://www.alibabacloud.com/help/en/airec/airec/developer-reference/api-airec-2020-11-26-runsampleformatconfig.md): Trigger sample formatting for a training sample. Params: instanceId, sampleId, mode (default: Latest). PUT to /v2/openapi/instances/{instanceId}/samples/{sampleId}/format-configs/actions/run.
- [UnLockIndexVersion](https://www.alibabacloud.com/help/en/airec/airec/developer-reference/api-airec-2020-11-26-unlockindexversion.md): Unlock a filtering algorithm index version. Requires instanceId and algorithmId. POST to /v2/openapi/instances/{instanceId}/filtering-algorithms/{algorithmId}/actions/unlock.
- [CreateDataDiagnoseTask](https://www.alibabacloud.com/help/en/airec/airec/developer-reference/api-airec-2020-11-26-createdatadiagnosetask.md): Create a data diagnostic task for an AIRec instance. Only param: instanceId. POST to /v2/openapi/instances/{instanceId}/data-diagnose-task. Returns boolean result.
- [CreateUmengToken](https://www.alibabacloud.com/help/en/airec/airec/developer-reference/api-airec-2020-11-26-createumengtoken.md): Create a Umeng authorization token for AIRec integration. Required param: code. POST to /v2/openapi/umeng/token.
- [GetLatestDataDiagnoseTaskStatus](https://www.alibabacloud.com/help/en/airec/airec/developer-reference/api-airec-2020-11-26-getlatestdatadiagnosetaskstatus.md): Get status of the latest data diagnostic task. Returns RUNNING, FAILURE, SUCCESS, or NOTASK. GET /v2/openapi/instances/{instanceId}/data-diagnose-task/status.
- [ListDataDiagnoseReports](https://www.alibabacloud.com/help/en/airec/airec/developer-reference/api-airec-2020-11-26-listdatadiagnosereports.md): List data diagnostic reports including manual, daily (cycle), and first-run types. Params: instanceId, optional taskCreateTime filter.
- [ListDataDiagnoseSampleDetails](https://www.alibabacloud.com/help/en/airec/airec/developer-reference/api-airec-2020-11-26-listdatadiagnosesampledetails.md): Retrieve sample-level details from a diagnostic report. Required params: instanceId, taskCreateTime (ms timestamp), startTime, endTime (UNIX seconds), taskSource (firstRun/manual/cycle), key.
- [Data structure](https://www.alibabacloud.com/help/en/airec/airec/developer-reference/api-airec-2020-11-26-struct-dir.md)
- [ExtraDataSource struct](https://www.alibabacloud.com/help/en/airec/airec/developer-reference/api-airec-2020-11-26-struct-extradatasource.md): Data structure for custom ODPS data sources. Fields: ProjectName, TableName, Type (ODPS only), UpdateFrequency, Status (Ready/Online/Failed). Supports User/Item/Behavior/Sample custom sources.
- [RankingModelVersion struct](https://www.alibabacloud.com/help/en/airec/airec/developer-reference/api-airec-2020-11-26-struct-rankingmodelversion.md): Model version training results. Fields: Status (TRAINING etc.), RunTime, TemplateName, TemplateId. Metrics: AssessAuc, AssessGauc, AssessLoss, TrainAuc, TrainGauc, TrainLoss.
- [RankingSystem struct](https://www.alibabacloud.com/help/en/airec/airec/developer-reference/api-airec-2020-11-26-struct-rankingsystem.md): Data structure returned by ranking system APIs. Contains fields: RankingSystemId, Status (Initializing/Importing/Running/Stopped), Meta (algorithm config), and table associations.
- [RankingSystemHistory struct](https://www.alibabacloud.com/help/en/airec/airec/developer-reference/api-airec-2020-11-26-struct-rankingsystemhistory.md): Data structure returned by ranking system APIs. Contains fields: RankingSystemId, Status (Initializing/Importing/Running/Stopped), Meta (algorithm config), and table associations.
- [Sample struct](https://www.alibabacloud.com/help/en/airec/airec/developer-reference/api-airec-2020-11-26-struct-sample.md): Training sample configuration. Status lifecycle: Unready/Ready/Generating/Success/Formatting/Formatted/Applied.
- [AIRec public error codes](https://www.alibabacloud.com/help/en/airec/airec/developer-reference/api-airec-2020-11-26-errorcodes.md): Service-specific error codes with HTTP status and messages. Includes InstanceNotExist (404), ValidationError (400), InternalServerError (500), quota errors, and data source validation failures.
- [AIRec API change records](https://www.alibabacloud.com/help/en/airec/airec/developer-reference/api-airec-2020-11-26-changeset.md): Changelog of AIRec API modifications by date. Example: 2023-03-31 DeleteExperiment description update. Links to per-API change history in OpenAPI Explorer.
- [AccessKey pair authentication](https://www.alibabacloud.com/help/en/airec/airec/developer-reference/accesskey-pair.md): AccessKey ID and secret for signing AIRec API requests. Create and manage pairs in RAM console Security Management page. Keep secret safe; delete and regenerate if leaked.
- [AIRec error code reference](https://www.alibabacloud.com/help/en/airec/airec/developer-reference/error-codes.md): Full error code table with HTTP status, message, and description. Covers validation (400), auth (401/403), not-found (404), size limits (413), and server errors (500/503).
- [Support](https://www.alibabacloud.com/help/en/airec/airec/support.md): Use the DetachUserENI API to detach an ENI from an AnalyticDB cluster, with detailed request parameters, response examples, and error code descriptions.
- [AIRec FAQ Directory](https://www.alibabacloud.com/help/en/airec/airec/support/faq.md): Index of AIRec FAQs covering preparation, data access integration, recommendation effectiveness testing, console issues, and quota limits for Alibaba Cloud Intelligent Recommendation.
- [Preparation FAQ](https://www.alibabacloud.com/help/en/airec/airec/support/faq-related-to-preparations.md): Difference between 'related recommendation' vs 'Recommendations for You', mixing industries, changing recommendation type after activation, user profile availability.
- [Data integration FAQ](https://www.alibabacloud.com/help/en/airec/airec/support/faq-related-to-data-access.md): Scene_id usage and recall, category_path for discretization, tag matching between user/item tables, feature fields, item_type mapping, traceInfo for A/B attribution.
- [Item validity and console FAQ](https://www.alibabacloud.com/help/en/airec/airec/support/faq-related-to-the-item-validity-and-airec-console.md): Listing takes up to 1 hour; removal is immediate. Exposure blocking: 31-day suppression window (requires real-time expose data). Result fields: traceId, itemId, position.
- [Quotas FAQ](https://www.alibabacloud.com/help/en/airec/airec/support/faq-related-to-quotas.md): QPS exceeded: overflow requests throttled. User/item exceeded: ADD/UPDATE blocked, DELETE works. Junior Edition: 1M users, 1M items, 2 QPS fixed.
- [Contact us](https://www.alibabacloud.com/help/en/airec/airec/support/contact-u.md): Support channels: pre-sales phone (4008013260), online chat, ticket submission, and Alibaba Cloud Developer Community for peer discussions.
- [Legal Resources](https://www.alibabacloud.com/help/en/airec/airec/support/legal-resources.md): Master the essential operations for functions in MaxCompute, from creating and deleting user-defined functions to viewing built-in ones, to enhance your data computation workflows.