Multimodal metadata management

Updated at:

DataWorks offers a unified multimodal metadata management solution to manage massive unstructured data—such as images, documents, and logs—scattered across OSS and NAS. This solution supports registration, preview, and keyword search. It also integrates with PAI to synchronize and enhance datasets, enabling advanced AI capabilities like tag filtering, natural language semantic search, and search by image. As a result, enterprises can break down data silos and improve data discoverability and availability across teams and tools.

Overview

In data-driven businesses, enterprises often have vast amounts of unstructured data, such as images, documents, and log files, stored in Object Storage Service (OSS) or Network Attached Storage (NAS). This data frequently remains in silos, making it difficult to discover, understand, and use.

The multimodal dataset management feature of DataWorks Data Map addresses this challenge, allowing you to register unstructured data as standard data assets and incorporate it into a unified enterprise data catalog. You can:

  • Centralized management: Register and manage files from OSS and NAS, and AI datasets processed by PAI.

  • Easy discovery: Quickly find the data you need using keyword search, tag filtering, and even natural language (semantic) search.

  • Streamlined access: Directly reference these datasets in DataWorks task nodes, such as Python, Shell, and PAI tasks, enabling a seamless data processing and AI modeling workflow.

Management modes

We offer two management modes for different data sources and use cases: basic mode and enhanced mode. The following table helps you choose the right mode.

Note: Both modes can coexist within the same DataWorks workspace. All data assets must belong to the same Alibaba Cloud primary account for unified discovery and management.

Management mode

Data characteristics

Target users

Core capabilities

Dependencies

Basic mode

Primarily raw files or semi-structured data stored in OSS or NAS.

Data warehousing or data engineering teams that use only DataWorks.

  • Dataset registration

  • Intelligent preview

  • Task attachment

  • Keyword search

DataWorks + OSS/NAS

Enhanced mode

AI datasets processed by PAI using smart tagging or vector indexing.

Algorithm or AI teams that use both DataWorks and PAI.

Includes all basic capabilities, plus:

  • Image: tag filtering, semantic search, and search by image.

  • Documents: semantic search.

DataWorks + PAI + OSS/NAS

Basic mode: Managing raw multimodal data

This mode is for teams that use DataWorks with MaxCompute for data processing. It focuses on raw, unstructured data used in Python, Notebook, and MaxFrame tasks. You can register OSS or NAS paths as datasets directly in DataWorks. The system then automatically collects basic metadata and provides an intelligent preview for supported formats like CSV, JSONL, and compressed archives. Once registered, you can search, view, and attach these datasets to task nodes like Python, Shell, and Notebook.

Typical data types include:

  • Semi-structured logs (JSONL, CSV).

  • Compressed archives (ZIP, GZIP) containing text files.

  • Raw multimedia files such as images, videos, and PDFs.

Enhanced mode: AI data asset collaboration

This mode is designed for teams that already use PAI and work with AI data assets through PAI-EAS or PAI-LangChain. When you complete a smart tagging or semantic indexing task for an image dataset in PAI's AI dataset management, or enable a vector index for a document knowledge base in PAI-LangChain, DataWorks automatically synchronizes the enhanced metadata to the data map. In DataWorks, you can then search for the dataset and perform advanced operations like tag filtering, natural language semantic search, and search by image, all without switching to the PAI console. Additionally, you can use this dataset as an input for related PAI-DLC node tasks within DataWorks.

Supported types of enhanced assets include:

  • PAI - AI Datasets: Image datasets with smart tagging or semantic indexing.

  • PAI - PAI-LangChain: Document knowledge bases with vector indexing configured (in public preview).

Metadata management capabilities

image

Capability

Basic mode

Enhanced mode

PAI AI dataset

PAI LangStudio knowledge base

Dataset keyword search

Supported

Supported

Supported

Basic metadata display

Supported

Supported

Supported

File list

Not supported

Supported

Supported

Content preview

Supported (for some formats)

Supported

(for images only)

Not supported

Filter files by tag

Not supported

Supported

Not supported

Natural language retrieval

Not supported

Supported

Supported

Task node attachment

Supported (Python, Shell, and Notebook)

Supported

(PAI DLC node and PAI EAS service)

Not supported

Status

General Availability

General Availability

Public Beta

Scenario selection

Scenario

Recommended path

You use only DataWorks to manage raw files on OSS or NAS.

Refer to Use Case 1 to register datasets directly in DataWorks.

You use PAI to tag images and run AI training.

Refer to Use Case 2. After you complete enhancement tasks in PAI, discover and use the datasets in DataWorks.

You use PAI-LangStudio to build a RAG knowledge base.

Refer to Use Case 3. After you build a vector index in LangStudio, explore the knowledge base in DataWorks.

Scenario 1: Raw dataset management

This scenario is ideal for data engineers and data analysts who use DataWorks and OSS/NAS to centrally manage large volumes of raw files such as logs, documents, and images. If you do not use PAI for AI processing, use basic mode.

Unlocking the "black box" of unstructured data

Without leaving DataWorks or writing complex code, you can register, preview, search, and mount raw files on OSS/NAS to uniformly manage and govern them as standard data assets.

Example: The data black box bottleneck

In the process of building an enterprise data middle platform, large volumes of unstructured or semi-structured data are stored as raw files in object storage (OSS) or a network file system (NAS), for example:

  • Text record logs: JSONL format, stored in OSS and partitioned by day.

  • Procurement data: CSV, JSONL, or compressed archives (.gz/.zip) containing corresponding data rows collected by crawlers.

  • Business documents: TXT, PDF, Word, and Excel reports for subsequent NLP processing.

  • Raw images/videos: Surveillance snapshots and product images that have not yet entered an AI training pipeline.

This data is often automatically written to storage by ingestion systems or associated through external tables. Data engineers and algorithm engineers use compute tasks in DataWorks, such as MaxCompute MaxFrame and Python, for data cleansing and feature extraction. Teams need a lightweight, self-service method to register, preview, search, and reference these raw files in tasks.

Teams often face these pain points:

  • Lack of visibility into unstructured data: "What's actually in the OSS path oss://log-bucket/source-rule-doc-sets/2025/05/? Is it the raw rule document content?"

    Inspecting this data requires either manually recording the information or downloading the files.

  • High exploration costs: Manually downloading files or writing scripts to read them is inefficient and tedious.

  • Tasks coupled with paths: ETL scripts with hard-coded OSS paths are difficult to migrate or reuse.

  • Difficult data management: It is impossible to uniformly search, archive, or track the data lifecycle.

To this end, DataWorks and PAI jointly provide the dataset capability. This allows you to manage raw collections of multimodal files as if they were tables. You can also search for and view datasets in Data Map by using keyword search.

Supported data sources and formats

Basic mode supports registering multiple file formats stored in OSS and NAS and provides content preview capabilities for some of these formats.

Data Source

Format

Preview

Description

OSS

.csv, .json, .jsonl, .txt, .md.

Supported

Automatically parses and displays the first 10 rows of content in a table or text format.
CSV files must contain a header to correctly parse fields.































































































































OSS

.zip, .gz, .tar, and .tar.gz archives containing .jsonl files.

Conditionally supported

You can directly preview the content of the first recognizable text file (such as a .jsonl file) within a compressed archive without decompressing it.
Encrypted archives are not supported.































































































































OSS

Images (JPG/PNG, etc.), videos, Parquet, etc.

Not supported

/

NAS

All formats.

Procedure

image

This section demonstrates how to register a periodically updated dataset from OSS into Data Map and preview its contents.

Assume you have a dataset where a provider regularly publishes new batches of data by adding new subfolders to the same OSS path. Each subfolder contains a .zip archive, which in turn contains data files in .JSONL format. For example, a dataset for a smart tutoring application might be updated with new batches of Q&A data about "geography knowledge of different provinces and cities."

Prerequisites

  • You have an OSS bucket that contains data.

  • The operating account must have the Workspace Administrator or DataStudio role in the corresponding DataWorks workspace and have read permissions on the target OSS.

Step 1: Register a dataset

  1. In the DataWorks console, click Go to Data Map.

  2. In the left-side navigation pane, click the image icon and navigate to Data Map > Data Catalog.

  3. In the directory tree on the left, click DataSet, select the target workspace, and click Create Dataset on the workspace details page.

  4. In the dialog box, enter the following information to register the dataset.

    Parameter

    Description

    Example

    Name

    A clear, business-friendly name.

    2025-Gaokao-Corpus-TrainingSet

    Storage Type

    Your file storage service.

    For this example, select OSS.

    Content Type

    Helps the system better parse and preview the data.

    Text.

    If you are unsure, select Common.

    Description

    Describe the data content, purpose, source, and other relevant details.

    Raw corpus of college entrance exam questions for a smart tutoring application, updated daily.

    OSS Path

    The path to the file or folder. Click the folder icon on the right to select an OSS path.

    Note

    Best practices for OSS path design:

    • Isolate by business domain or region: /gaokao/math/, /iot/sensor/.

    • Partition folders by year or date: /gaokao/math/2025/.

    • The folder path used to register the dataset should be a prefix path, such as /gaokao/2025/.

    • Avoid oversized directories: We recommend fewer than 100,000 files per path.

    /Demo/gaokao/train/

    Default Mount Path

    Select the default mount path for the data. This path will be used by DataWorks task nodes that require mounted files, such as Python and Shell tasks.

    /mnt/data/gaokao/train

    A blue banner at the top of the form indicates that after the dataset is created, users with the data development role have read and write permissions by default. The system automatically populates the workspace and owner fields. On the right are two tabs: Dataset Configuration and Version Configuration. The Basic Information section on the Dataset Configuration tab is expanded by default.

For more detailed instructions, see Manage datasets.

Step 2: Search and preview

  1. On the Data Map page, click the top search bar, select Dataset as the type, and enter a keyword in the search box (for example, the dataset name Gaokao, description content corpus, or path fragment gaokao).

  2. Find your dataset in the search results and click it to go to the details page.

  3. The details page shows the following:

    • Basic Information: Metadata such as the owner, storage path, and creation time.

    • Data Preview: By default, data is displayed as a Smart Table. If the file format is supported, the system automatically displays a preview of the file's content. Double-click a field to view its details. You can also switch to the Raw Text mode.

      For information about data formats supported for preview, see Overview of metadata management capabilities.

    • Data lineage: View which task nodes use this dataset.

Step 3: Use dataset in tasks

Use the dataset as an input to decouple code from physical storage paths.

  1. In DataStudio, create or open a Python, Shell, or Notebook node.

  2. In the Scheduling > Scheduling Policy > Dataset section on the right side of the node configuration, click + Add to add a dataset to mount.

  3. Click Dataset and select the dataset you registered in Step 1 from the list that appears.

  4. In your code, you can access the data path by using system-injected environment variables. For more information, see Using datasets.

    Important

    At runtime, DataWorks mounts the dataset path to the task's local file system (read-only), so you do not need to worry about storage replication or security. Access is still controlled by the native permissions of OSS or NAS.

For more detailed instructions, see Use datasets.

FAQ

  • Q: Why can't I preview my data?

    • Preview not supported: The file format (such as Parquet or video) might not support preview. This is expected behavior. You can go to the OSS console to view the file list.

    • File read failure: Check whether your account has read permissions for the OSS path, or if the compressed file is encrypted.

    • Blank preview: The first file in the specified path may be empty or corrupted.

  • Q: Can a single dataset version correspond to multiple OSS paths?

    • No. A dataset version can correspond to only one root path.

  • Q: Can I register the same OSS path to multiple datasets?

    • This is not recommended, as it can interfere with subsequent data lineage analysis.

  • Q: Can the previewed content be exported?

    • You cannot export content directly from the preview interface. However, you can mount the dataset to a Notebook node and then write code to read and export the data.

Use case 2: AI-enhanced image datasets

This use case is designed for teams that use both DataWorks and PAI, particularly for AI applications that require advanced search and filtering of large-scale image collections, such as autonomous driving, industrial quality inspection, and content moderation.

Enable intelligent image search in DataWorks

This solution integrates the AI processing capabilities of PAI with the metadata management features of DataWorks. This allows data analysts, algorithm engineers, and even product managers to interact with image data more intelligently within DataWorks:

  • Filter images by business tags: For example, you can filter for all images where the "weather is rainy" and which "contain pedestrians."

  • Search for images using natural language: For example, you can find relevant images by entering "a red car is crossing a crosswalk."

Capability overview

The capabilities in this use case depend entirely on the successful execution of enhancement tasks in PAI.

PAI enhancement task

Unlocked capability

Successful intelligent tagging task

Tag filtering: Provides a tag filtering panel that supports logical combinations such as "include" and "exclude."

Successful semantic index task

Semantic search and search by image: Provides a natural language search box and a search-by-image feature, with adjustable parameters like TopK and similarity.

Both tasks succeed

Combined search: Allows combining tags and semantic queries (using an AND relationship) for more precise searches.

Example: Autonomous driving data provisioning

An autonomous driving company has built its data and algorithm pipeline using DataWorks and PAI. In PAI, the algorithm team uses the Qwen-VL model to automatically apply business tags like "weather," "lighting," and "vehicle type" to millions of traffic images. They also use the GME model to build a vector index.

Now, the data team and product managers want to quickly filter for "daytime, sunny images that include pedestrians crossing the street" in DataWorks to select a new dataset for training and validating a new model.

Create intelligent tagging and semantic index in PAI

To enable tag filtering and semantic search for your image datasets in DataWorks Data Map, you must first complete several setup steps in PAI.

For complete, detailed instructions, see Manage and use multimodal data.

Prerequisite

Description

Dataset Type

Must be an Advanced PAI dataset. Basic datasets do not support these capabilities.

Content Type

We recommend selecting Common or Image. The actual content must include Image (supported formats: jpg, jpeg, png, gif, bmp, tiff, and webp).

Region support

Available only in specified regions, including China (Hangzhou), China (Shanghai), China (Shenzhen), China (Ulanqab), China (Beijing), China (Guangzhou), and Singapore.

Enhancement task

Complete at least one of the following:

  • An intelligent tagging task to generate tags.

  • A semantic index task to generate vectors.

Vector storage

This example uses Milvus (version 2.4 or later). You must create an instance and configure a connection.

1. Create an Advanced image dataset

Goal: Create a container to store your image data and its enhanced metadata.

  1. Create the dataset

    • Path: Go to the PAI console. In the list of workspaces, select the one that has the same name as your DataWorks workspace, and then navigate to AI asset management > Dataset.

    • Click Create Dataset and fill in the following key parameters:

      • Type: Ensure that you select Advanced.

      • Content Type: Select Image.

      • OSS Path: Specify the OSS directory where your raw images are stored.

    • Give the dataset a meaningful name (for example, autonomous_driving_image_dataset_test) and click OK.

      Important

      This name is used as the dataset name in DataWorks.

  2. Initialize metadata

    • Path: Return to the dataset list and go to the details page of the dataset you just created.

    • On the Version Details > Metadata tab, click Update Now.

    • PAI starts a background task to scan all image files in your OSS path and collects basic metadata. Wait for the task to complete.

2. Enable tag filtering

Goal: Use a large model to automatically generate business tags for your images.

  1. Create an intelligent tagging model connection: To allow PAI tasks to access external large model services, you must create a connection.

    • Path: Go to AI asset management > Connect.

      • Click the Model Service tab and click Create Connection.

      • Select Model Studio Large Model Service and enter your API key.

        image

  2. Define the tag schema

    • Path: Go to AI asset management > Dataset and open the Intelligent Tag Definition tab.

    • Click Create Intelligent Tag Definition to configure your tagging rules.

      • Guiding Prompt: Give the model a role and context, for example: "You are an experienced traffic scene analyst..."

      • Tag Definition: Use JSON format to define your tags and their descriptions. For example:

        {
          "speed_bump": "Typically yellow and black striped, a raised bar across the road used to slow down vehicles.",
          "non_motor_vehicle": "Includes bicycles, e-bikes, wheelchairs, etc."
        }
  3. Run the intelligent tagging task

    • Path: Go to AI asset management > Tasks > Dataset Tasks.

    • Select the dataset you created in Step 1, and then click Create Node > Intelligent Tagging.

      image

    • Configure the following parameters:

      • Intelligent Tagging Model Connection: Select the Model Studio model connection you created.

      • Intelligent Tagging Model: Select Qwen-VL Max or Qwen-VL Plus.

      • Intelligent Tag Definition: Select the tag definition you just created.

      • Tagging Mode: For the initial tagging job, select Full.

    • Click OK to start the task.

3. Enable semantic search

Goal: Generate vector features for your images and store them in a database for semantic search or search by image.

  1. Create a semantic index model connection

    • Go to AI asset management > Connect and open the Model Service tab.

    • Click Create Connection, select General Multimodal Embedding Model Service, and link it to your deployed GME EAS service.

      If you have not deployed an EAS service, go to the console home page, navigate to Quick Start > Model Gallery, and deploy the service.

      image

  2. Create a vector database connection

    • Go to AI asset management > Connect > Database.

    • Click Create Connection, select your database type (such as Milvus), and enter the instance's URI, token, and database name.

      For a guide on how to fill in these fields, see 2.3 Create a vector database connection.
  3. Configure the index

    • Path: Return to the dataset details page and find the Index Configuration section.

    • Click Edit and configure the information.

      image

      • Index Model Connection: Select the GME model service connection you created.

      • Index Database Connection: Select the vector database connection you created.

      • Index Database Table: Enter the name of the table or collection in your vector database used for storing vectors (for example, traffic_image_embeddings).

  4. Run the semantic index task

    • Path: Go to AI asset management > Tasks and open the Dataset Tasks tab.

    • Select the OSS dataset you created and click Create Node > Semantic Indexing.

      image

    • Select the Dataset Version to process and click OK to start the task.

Important

After the status of the intelligent tagging and semantic index tasks in PAI changes to Succeeded., the index search or tag search options will appear for the corresponding dataset in DataWorks Data Map after a short delay.

Use enhanced datasets in DataWorks

Note

After you create and process a dataset in PAI, DataWorks Data Map automatically synchronizes its metadata. No additional registration is required in DataWorks; you can start using the dataset directly.

1. Discover the dataset

First, find your dataset in DataWorks.

  1. In the DataWorks console, go to Go to Data Map. In the left-side navigation pane, click the image icon to go to the search page.

  2. In the search bar at the top, enter keywords related to your dataset. You can search in several ways:

    • By name: For example, enter autonomous driving.

    • By description: For example, enter traffic or image.

    • By path: For example, enter a part of the OSS path, such as traffic_images.

  3. The system displays all matching datasets in real time. You can:

    • Sort: Sort the results by Correlation or Update Time.

    • Switch views: Switch between Gallery and List modes. Hover over an item to quickly preview its basic information.

    • Refine results: Use the filter panel on the left to narrow your results by data source, workspace, and other criteria.

2. Explore dataset details

Once you find your target dataset, click it to open its details page.

  • View core properties
    On the details page, you can see the dataset's Name, Description, Owner, Last Updated, and other metadata. The Dataset Version list allows you to trace and view the detailed configuration of different versions, such as the storage Path and Default Mount Path.































































































































  • Read usage instructions
    If the dataset owner has provided detailed usage instructions, you can find user manuals, field dictionaries, sample code, or compliance statements here to help you better understand and use the data.































































































































3. Interact with data

This is the core step for using the PAI-enhanced capabilities. On the dataset details page, switch to the View Data tab.

Important

If no enhancement task has been run, DataWorks displays only basic metadata (name, path, and file list). No tags or semantic search will be available.

Basic filtering

This is a basic capability available for all image datasets. You can filter files by their metadata.

  • Example: Filter for all images where File last modified time > 2025-05-01.

Multi-dimensional tag filtering
Important

This feature is available only after the intelligent tagging task in PAI completes successfully.

You can pinpoint images by combining tags, much like using filters on an e-commerce website.

  • Example: Filter for images that Include any tag: Motor Vehicle and Exclude the following tags: Crosswalk.

Semantic search and search by image
Important

This feature is available only after the semantic index task in PAI completes successfully.

You can directly search for the data you want using natural language or by uploading an image.

  • Natural language search
    In the search bar at the top, enter a description of the scene you are looking for.































































































































    • Example: Enter "red car driving on the road".

    • The system returns a list of the most relevant images based on vector similarity.

  • View single image details
    Click any image from the search results to view a larger version and all the tags automatically generated by PAI.































































































































  • Search by image
    Click the image icon next to the search bar to upload a local image or specify an OSS image. The system automatically finds the most similar images in the dataset.































































































































FAQ

  • Q1: Why can’t I find my PAI dataset in DataWorks?

    • Possible cause: The dataset and your DataWorks workspace belong to different Alibaba Cloud primary accounts. The system does not support cross-tenant data synchronization.

    • Solution: Ensure that the PAI dataset and the DataWorks workspace are in the same primary account.

  • Q2: Why is the "tag filtering" feature missing from my dataset details page?

    • Possible cause: This can happen if the intelligent tagging task in PAI has not completed successfully or is still running. The corresponding features in DataWorks are enabled only after the PAI task succeeds.

    • Solution:

      1. Go to the PAI console and check the run status of the corresponding intelligent tagging task to ensure it is marked as Succeeded..

      2. If the task failed, check the PAI task logs to troubleshoot any errors with the Qwen-VL model call.

  • Q3: Why does semantic search (or search by image) return no results?

    • Possible cause: The PAI service cannot access your vector database (such as Milvus). This is usually due to a network connectivity issue or an incorrect allowlist configuration.

    • Solution:

      1. First, go to the PAI console and confirm that the "semantic index" task has run successfully.

      2. Then, configure the access allowlist for your Milvus instance using the network configuration and allowlist configuration.

Use case 3: AI-enhanced document knowledge base (PAI LangStudio)(Public Beta)

This use case is for users who have built a document knowledge base (such as enterprise policies, technical manuals, or compliance documents) in PAI LangStudio. By integrating the knowledge base with DataWorks Data Map, you can incorporate these valuable unstructured knowledge assets into a unified enterprise data catalog and provide them with powerful semantic search capabilities.

Core value: Make knowledge discoverable and understandable

This feature solves this problem. Its core values include:

  • Unified discovery: Unifies the management and search of scattered document knowledge bases, structured data, and image data within DataWorks Data Map.

  • Accurate retrieval: Ask questions in natural language, such as "What are the approval processes for cross-border data transfers?" The system understands your intent and pinpoints the exact passages that contain the answer from large document collections.

  • Support for RAG applications: Provides a high-quality, searchable data foundation for building smarter RAG (Retrieval-Augmented Generation) applications, such as enterprise Q&A bots.

Example: Find key clauses in compliance documents

A financial institution's risk management team faces a challenge: they have a huge internal knowledge base that consists of hundreds of data governance and compliance documents in PDF format. When they need to find a specific clause, such as "specific approval requirements for cross-border data transfer," traditional keyword searches are ineffective and often return a large number of irrelevant documents, requiring significant manual review.

By using PAI LangStudio to build a vector index for these documents and integrating it with DataWorks Data Map, team members can now enter natural language questions directly in DataWorks. The system can understand the semantics of the questions and return the original regulatory clauses that contain the answers, improving information retrieval efficiency.

Step 1: Prepare the knowledge base in PAI LangStudio

Important

All operations in this section are performed in the PAI LangStudio console. DataWorks only synchronizes and displays the processing results from PAI. The semantic search capability depends entirely on the successful completion of the following steps.

Prerequisites

Before you begin, ensure that the following conditions are met:

Condition

Description

Account consistency

You must use the same Alibaba Cloud account for both PAI LangStudio and DataWorks.

Knowledge base type

The knowledge base must be of the Document type. Supported formats include .pdf, .docx, .txt, .md, and .html.

Region support

Your region must be supported by PAI LangStudio, such as China (Hangzhou), China (Shanghai), and China (Beijing).

Vector index status

A vector index must have been successfully built for the knowledge base, and its status must be "Ready".

Key operations

  1. Create a document knowledge base

    • Path: Go to LangStudio, select a workspace, and then select the Knowledge Base tab.

    • Click Create Knowledge Base and configure the following core parameters:

      • Knowledge Base Name: Enter a name for your knowledge base, for example, data_governance_kb.

      • Knowledge Base Type: Select Documents.

      • Data Source OSS Path: Specify an OSS directory to store your source documents.

      • Vector Database Type: Select Milvus.

    • After the knowledge base is created, click Upload on the details page to upload your documents (such as PDF and Word files) to the data source.

      Recommended document naming convention: {domain}_{topic}_v{version}, for example, finance_compliance_v2.

      image

  2. Build a vector index

    • Path: Go to the details page of the knowledge base that you just created.

    • In the upper-right corner of the page, click Update Index. The system starts a background task that automatically performs the following actions:

      Important

      To automatically process newly added documents, you need to configure a scheduled trigger to rebuild the vector index in LangStudio.

      1. Document parsing and chunking: Splits long documents into semantically complete text chunks.

      2. Vectorization (Embedding): Calls the built-in embedding model to convert each text chunk into a numerical vector.

      3. Storage and indexing: Stores the generated vectors in your selected vector database (Milvus) and creates an index.

    • Wait for the task to complete until the File Status changes to "Indexed" or the task status in Operation Records shows "Succeeded".

Important

When the vector index status of the knowledge base in PAI LangStudio shows "Ready", DataWorks Data Map automatically synchronizes this asset and enables semantic search for it.

Step 2: Use knowledge base in DataWorks

After completing the preparation in PAI, team members can retrieve knowledge efficiently in DataWorks.

  1. Search for the knowledge base asset

    • Path: Go to DataWorks > Data Map > Search.

    • Search by the knowledge base name (for example, governance) or by keywords in its description to find your knowledge base asset in the results.

  2. Perform a semantic search

    • Go to the knowledge base details page and switch to the View Data tab.

    • In the Search Box at the top, enter your question in natural language.

      Example: What do the data quality regulations cover?

    • The system returns the most relevant document passages in real time and highlights the matching content. Each passage shows its source file name and page number, so you can quickly locate the original document.

  3. Use and trace back

    • You can quickly find answers in the returned document passages.

    • If you need to view the full context, you can find and read the entire document in the original knowledge base by using its source file name.

FAQ

  • Q: Why can't I find my PAI LangStudio knowledge base in DataWorks?

    • Reason 1: PAI and DataWorks are not under the same Alibaba Cloud primary account.

    • Cause 2: The knowledge base type is not "Document" (for example, it is "Image" or "Structured Data").

    • Solution: Check and ensure that both prerequisites are met.

  • Q: Why is the semantic search box missing from my knowledge base details page?

    • Cause: The vector index for the knowledge base has not been built successfully or is still in progress.

    • Solution: Return to PAI LangStudio and check whether the Update Index task has completed successfully and the status is "Ready".

  • Q: What should I do if semantic search returns inaccurate or irrelevant results?

    • Cause: This is usually related to the document chunking strategy. If chunks are too small, they may lose semantic context. If chunks are too large, they may include too much unrelated content.

    • Solution: Return to PAI LangStudio. In the knowledge base configuration, adjust the Text Chunk Size and Overlap Size, and then update the index again. This is an iterative process that requires you to tune the settings based on the characteristics of your documents.