Agent Settings
You can manage agents, skills, rules, knowledge bases, and repository indexes on the CodeArts Agent console. After these resources are created, they can be used on the CodeArts Agent client.
Agents
You can manage your custom agents on the Agents page, such as creating, editing, enabling, and deleting the agents. The agents can be synchronized and used on the CodeArts Agent client.
CodeArts Agent supports two types of agents: client-side agents (created on the client) and cloud-side agents (created on the console). When a user logs in to the CodeArts Agent client, the system will locally cache the cloud-side agents which are available to the user. Then, the client will update the cache every 24 hours to keep the agents in sync with the cloud.
| Creation Method | Scope of Application | Description |
|---|---|---|
| Local | Project | Effective only for the current project, distributed along with the repository, and stored locally. Storage directory: ./ .codeartsdoer/agents in the root directory of the project |
| User | Effective for all projects of the current user, and stored locally Local storage directory: %USERPROFILE%/.codeartsdoer/agents/ | |
| Cloud | Enterprise | Available to all enterprise users, created by enterprise administrators, and stored in the cloud. When a user logs in to the CodeArts Agent client, the system automatically caches the cloud agents accessible to the user to the local directory: %USERPROFILE%/.codeartsdoer/cache/enterprise/agents/. |
| Team | Restricted to designated teams, created by enterprise or team administrators, and stored in the cloud. When a user logs in to the CodeArts Agent client, the system automatically caches the cloud agents accessible to the user to the local directory: %USERPROFILE%/.codeartsdoer/cache/team/agents/. | |
| User | Available only to the creator and stored in the cloud. When a user logs in to the CodeArts Agent client, the system automatically caches the cloud agents accessible to the user to the local directory: %USERPROFILE%/.codeartsdoer/cache/user/agents/. |
- Log in to the CodeArts Agent console.
- In the navigation pane on the left, choose Agent Settings > Agents.
- Click Create Agent.
- Set agent parameters and click Create and Enable.
Table 2 Parameters for creating an agent Parameter
Description
Agent icon
The system provides various preset icons for agents. Click
on the icon to select a preferred style.Agent name
Name of the custom agent to be created.
Naming convention: 2 to 20 characters, consisting of letters, digits, underscores, and hyphens (-), and must start with a letter.
Agent type
Working mode of the agent, which affects its behavior logic and capability boundary.
- Primary/Sub-agent: It can be used as a sub-agent to be called by a primary agent or as a primary agent to call a sub-agent.
- Primary agent: It runs independently to process user requests and cannot be called by other agents.
- Sub-agent: It can be called by primary agents to perform specific tasks.
Description
A brief explanation of what the agent does to help users understand its functionality, with a maximum of 5,000 characters.
Applied to
Application scope of the custom agent, which cannot be modified after creation.
- Individual: Only the creator can use it.
- Team: It is available only to specified teams and can be created by enterprise administrators or team administrators.
- Enterprise: It is available to all enterprise members and can be created only by enterprise administrators.
Available team space
This parameter is displayed only when Applied To is set to Team.
It specifies the teams that can use the agent.
Enterprise administrators can view all teams but can select only one, while team administrators can only view and select the team they belong to.
Prompt
System instructions that define the role, tone, workflow, and rules/specifications of the agent.
Built-in tools
Built-in, out-of-the-box tools provided by the agent.
- Read: used to retrieve and view files.
- Edit: used to add, modify, or delete files.
- Terminal: used to run system commands in the command line environment.
- Preview: used to preview the generated frontend page in real time.
- Webfetch: used to capture and read web page content.
Skills
Skills associated with the agent to enable it to perform certain specialized tasks.
NOTE:CodeArts Agent has no hard limit on the number of associated skills, but it is recommended that the number not exceed 20 to ensure optimal user experience.
- View the created agent.
- Return to the Agent Management page. You can view the created agent in the agent list. Figure 1 Viewing the target agent on the Agents page
- On CodeArts IDE, open the settings page and click Agents. Then click
to manually refresh the page. After the refresh is complete, open the target tab (for example, User) to view the target agent. Figure 2 Viewing the target agent on the settings page
- In the input box on the chat page, click Agent. Verify that the target agent is displayed in the custom agent list.
If you create a sub-agent, it will not be displayed in the custom agent list.
- Return to the Agent Management page. You can view the created agent in the agent list.
Table 3 shows the operation permissions of different roles on managing cloud custom agents.
| Role | Enterprise Agent | Team Agent | User Agent (Operations Except Editing) | User Agent (Editing) |
|---|---|---|---|---|
| Enterprise administrators | All operations on all agents. | All operations on all agents. | All operations except editing on all agents. | Editing on agents created by themselves. |
| Team administrators | No operation permissions. | All operations on agents created by members of their own team. | All operations except editing on agents created by members of their own team. | Editing on agents created by themselves. |
| Members (of an enterprise or a team) | No operation permissions. | No operation permissions. | All operations except editing on agents created by themselves. | Editing on agents created by themselves. |
| Operation | Procedure |
|---|---|
| Enabling or disabling a cloud custom agent |
|
| Editing a cloud custom agent |
|
| Copying a cloud custom agent | When you need to reuse mature configurations, iterate multiple versions in parallel, share team templates, or isolate tasks, you can achieve this by copying agents.
|
| Deleting a cloud custom agent |
|
Skills & Rules
You can manage your skills and rules on the Skills & Rules page, such as creating, editing, enabling, and deleting skills and rules. The skills and rules can be synchronized and used on the CodeArts Agent client.
- There are two types of skills: client-side skills (created on the client) and cloud-side skills (created on the console). Meanwhile, these skills are classified into enterprise-level, team-level, project-level, and user-level skills.
Table 5 Classification of custom skills Creation Method
Scope of Application
Description
Local
Project
Applied to the current project and stored in a local path
Storage directory: ./.codeartsdoer/skills/ in the root directory of the project
User
Effective for all projects of the current user, and stored locally
Local storage directory: %USERPROFILE%/.codeartsdoer/skills
Cloud
Enterprise
Skills unified across the enterprise, available to all members, created by the enterprise administrator, and stored in the cloud.
Team
Skills unified across the team, available to specific teams, created by the enterprise administrator or team administrator, and stored in the cloud.
User
Available only to the user and stored in the cloud.
If skills with the same name exist, the skill invocation priority is as follows: cloud enterprise skills > cloud team skills > local project skills > local user skills > cloud user skills > built-in system skills.
- There are two types of rules: client-side rules (created on the client) and cloud-side rules (created on the console). Meanwhile, these rules are classified into enterprise-level, team-level, project-level, and user-level rules. The cloud-side user-level rules can be created on the console and client. For details, see Creating Cloud-Side Rules in IDE.
Table 6 Rule types Creation Method
Scope of Application
Applicable To
Storage Directory
Description
Local
Project
Current project
./.codeartsdoer/rule in the project root directory
Effective only for the current project, distributed along with the repository, and stored locally.
User
All projects of the current user
%USERPROFILE%/.codeartsdoer/rule
Effective for all projects of the current user, formulated based on personal habits or preferences, and stored locally.
Cloud
Enterprise
All enterprise members
-
Rules unified across the enterprise, available to all members, created by the enterprise administrator, and stored in the cloud.
Team
All members of a specified team
-
Rules unified across the team, available to specific teams, created by the enterprise administrator or team administrator, and stored in the cloud.
User
Self only
-
Rules formulated based on personal habits or preferences, available only to the members themselves, and stored in the cloud.
If rules with the same name exist, the rule invocation priority is as follows: cloud enterprise rules > cloud team rules > local project rules > local user rules > cloud user rules.
To create an enterprise skill, a team skill, or user skill on the cloud, perform the following steps: Before creating a cloud skill, ensure that you have purchased CodeArts Agent basic or professional edition.
- Log in to the CodeArts Agent console.
- In the navigation pane on the left, choose Agent Settings > Skills and Rules. The skill and rule lists are displayed.
- On the Skills tab, click Add Skill in the upper right corner. The Add Skill dialog box is displayed.
- Right-click in the blue box area and upload the target skill ZIP file from the local. Alternatively, drag and drop the local skill ZIP file to the blue box area and click OK.
- The skill ZIP file must conform to the required directory structure; otherwise, the import may fail. For example, the root directory of each skill folder must contain a SKILL.md file, which must include the skill name, description, and other details in YAML format.
- Only one ZIP file can be uploaded at a time. The file can contain multiple skill folders, and the total file size cannot exceed 5 MB.
Figure 3 Creating a skill
- Set parameters for creating a cloud skill as instructed in Table 7. Figure 4 Creating a cloud skill
Table 7 Cloud skill parameters Parameter
Description
Change
If you need to re-upload a skill ZIP file, click Change and re-upload it as instructed in 4.
Applied To
- Private: available only to yourself and will not be shared with other users.
- Team: available to specified teams and can be created by enterprise administrators or team administrators.
- Enterprise: available to all members of the entire enterprise, and can only be created by enterprise administrators.
Teams
This parameter is displayed only when Applied To is set to Team.
Select a team from the drop-down list. If no team has been created, create one first.
Enterprise administrators can view and select all teams, while team administrators can only view and select the team they belong to.
Tag
(Optional) Several types of tags have been preset in CodeArts Agent. Select tags from the drop-down list as required.
- Click Confirm and Enable to complete the skill creation.
On the Skills tab, view the created skill. To immediately view the created cloud skill on the client, go to the corresponding skill tab (Enterprise/Team/User) under Skills and Rules on the client, and click
or choose 
> Update in the skills area. Then the cloud skill is synchronized to the client. - The CodeArts Agent client automatically synchronizes cloud skills every 24 hours.
- The CodeArts Agent client synchronizes only enabled skills.
Table 8 shows the operation permissions of different roles on managing cloud skills.
| Role | Enterprise Skill | Team Skill | User Skill (Operations Except Editing) | User Skill (Editing) |
|---|---|---|---|---|
| Enterprise administrators | All operations on all skills. | All operations on all skills. | All operations except editing on all skills. | Editing on skills created by themselves. |
| Team administrators | The following operations can be performed:
| All operations on skills created by members of their own team. | All operations except editing on skills created by members of their own team. | Editing on skills created by themselves. |
| Team members | The following operations can be performed:
| The following operations can be performed on skills created by members of their own team:
| All operations except editing on skills created by themselves. | Editing on skills created by themselves. |
| Enterprise members | The following operations can be performed:
| No operation permissions. | All operations except editing on skills created by themselves. | Editing on skills created by themselves. |
| Operation | Procedure |
|---|---|
| Viewing cloud skill details |
|
| Editing cloud skills |
|
| Deleting a cloud skill |
CAUTION: Deleting a skill will affect the agents using it. Deleted skills cannot be recovered. Exercise caution when performing this operation. |
| Enabling or disabling a cloud skill | Use either of the following methods to enable or disable a cloud skill:
Only enabled skills can be synchronized to the CodeArts Agent client. |
| Adding a cloud skill to favorites or removing it | On the CodeArts Agent console, choose Skills & Rules, click the Skills tab, and click Favorite or Unfavorite next to the target skill. View the favorites on the Favorites tab. |
| Batch deleting cloud skills |
|
| Batch enabling or disabling cloud skills | Use either of the following methods to batch enable or disable cloud skills:
Only enabled skills can be synchronized to the CodeArts Agent client. |
| Batch adding cloud skills to favorites or removing them | On the CodeArts Agent console, choose Skills & Rules, and click the Skills tab. Select the target skills and choose More > Batch Favorite or More > Batch Unfavorite in the upper right corner. View the favorites on the Favorites tab. |
To create an enterprise rule, a team rule, or user rule on the cloud, perform the following steps:
- Log in to the CodeArts Agent console.
- In the navigation pane on the left, choose Agent Settings > Skills and Rules. The skill and rule lists are displayed.
- On the Rules tab, click Add Rule in the upper right corner. The Add Rule dialog box is displayed.
- Set the parameters based on Table 10. Figure 5 Creating a cloud rule
Table 10 Cloud rule parameters Parameter
Description
Name
Name of the rule to be created.
Naming rules: Enter 1 to 64 characters. Only letters, digits, underscores (_), hyphens (-), and periods (.) are allowed.
Content
Customize one or more rules. The value can contain a maximum of 50,000 characters.
Example: requiring the system to always respond using Python.
Application Scope
Application scope of a rule, that is, where the rule takes effect.
- Auto Apply: The rule applies to all chats by default and is automatically identified by the system.
- Manual Call: The rule does not take effect automatically. To use the rule, on the chat panel, enter # in the input box or click
and choose Add Context. Then click Rules and select a rule from the list.
Applied To
- User: available only to enterprise members themselves.
- Team: available to all members in a specified team, and can be created by enterprise administrators or team administrators.
- Enterprise: available to all members of the entire enterprise, and can only be created by enterprise administrators.
Teams
This parameter is displayed only when Applied To is set to Team.
Select a team from the drop-down list. If no team has been created, create one first.
Enterprise administrators can view and select all teams, while team administrators can only view and select the team they belong to.
Tag
(Optional) Several types of tags have been preset in CodeArts Agent. Select tags from the drop-down list as required.
Brief Description
(Optional) Description of the rule. Enter up to 1,024 characters.
- Click Confirm and Enable to complete the rule creation.
On the Rules tab, view the created rule. To immediately view the created cloud rule on the client, go to the corresponding rule tab (Enterprise/Team/User) under Skills and Rules on the client, and click
in the rules area. Then the cloud rule is synchronized to the client. - The CodeArts Agent client automatically synchronizes cloud rules every 24 hours.
- The CodeArts Agent client synchronizes only enabled rules.
Table 11 shows the operation permissions of different roles on managing cloud rules.
| Role | Enterprise Rule | Team Rule | User Rule (Operations Except Editing) | User Rule (Editing) |
|---|---|---|---|---|
| Enterprise administrators | All operations on all rules. | All operations on all rules. | All operations except editing on all rules. | Editing on rules created by themselves. |
| Team administrators | The following operations can be performed:
| All operations on rules created by members of their own team (including the team administrator). | All operations except editing on rules created by members of their own team (including the team administrator). | Editing on rules created by themselves. |
| Team members | The following operations can be performed:
| The following operations can be performed on rules created by members of their own team (including the team administrator):
| All operations except editing on rules created by themselves. | Editing on rules created by themselves. |
| Enterprise members | The following operations can be performed:
| No operation permissions. | All operations except editing on rules created by themselves. | Editing on rules created by themselves. |
| Operation | Procedure |
|---|---|
| Editing a cloud rule |
|
| Deleting a cloud rule |
CAUTION: Deleting a rule will affect the agents using it. Deleted rules cannot be recovered. Exercise caution when performing this operation. |
| Enabling or disabling a cloud rule | On the CodeArts Agent console, choose Skills & Rules, click the Rules tab, and click Only enabled rules can be synchronized to the CodeArts Agent client. |
| Adding a cloud rule to favorites or removing it | On the CodeArts Agent console, choose Skills & Rules, click the Rules tab, and click Favorite or Unfavorite next to the target rule. View the favorites on the Favorites tab. |
| Batch deleting cloud rules |
CAUTION: Deleting a rule will affect the agents using it. Deleted rules cannot be recovered. Exercise caution when performing this operation. |
| Batch enabling or disabling cloud rules | On the CodeArts Agent console, choose Skills & Rules, and click the Rules tab. Select the target rules and click Batch Enable or choose More > Batch Disable in the upper right corner. Only enabled rules can be synchronized to the CodeArts Agent client. |
| Batch adding cloud rules to favorites or removing them | On the CodeArts Agent console, choose Skills & Rules, and click the Rules tab. Select the target rules and choose More > Batch Favorite or More > Batch Unfavorite in the upper right corner. View the favorites on the Favorites tab. |
| Modifying the application scope of cloud enterprise rules or team rules | On the settings page of CodeArts Agent IDE, choose Skills and Rules > Enterprise > Rules or Skills and Rules > Team > Rules. Locate the target rule and click the switch next to it.
|
| Batch modifying the application scope of cloud enterprise rules or team rules |
|
Knowledge Space
You can upload enterprise internal documents and technical materials to the Knowledge Space page for unified management. The knowledge can serve as contextual reference to improve the accuracy of the agent's responses. Knowledge spaces can only be created and managed on the console, and only accounts with seats enabled can perform related operations.
- Create a knowledge space.
A knowledge space is used to manage multiple knowledge bases in one place. Before creating a knowledge base, you need to create a knowledge space.
- On the Knowledge page, click Create Space and set parameters by referring to Table 13. Figure 6 Creating a knowledge space
- Click OK.
In the knowledge space list, you can view the created one.
- On the Knowledge page, click Create Space and set parameters by referring to Table 13.
- Create a knowledge base.
Create a knowledge base within a knowledge space and specify its type and source. This ensures a clear information structure and easy retrieval.
- Select your desired knowledge space from the list to view its detailed information.
- Click Create Knowledge Base in the upper right corner.
- Configure basic information by referring to Table 14. Figure 7 Creating a knowledge base
Table 14 Basic parameters of a knowledge base Parameter
Description
Name
Indicates the name of the knowledge base to be created.
Naming rules: The name cannot start with an underscore (_) and can contain a maximum of 32 characters, including letters, digits, underscores (_), and hyphens (-).
Knowledge Type
Indicates the knowledge base type. You can select Unstructured or Structured.
- Unstructured: Data does not have a fixed format.
- Structured: Data has fixed formats, fields, and structures.
Data Source
Indicates the data source of the knowledge base. You can select Local file or Code.- When Knowledge Type is set to Unstructured, the following data sources are supported:
- Local file: The code base mainly contains textual content, such as articles, reports, and books. Supported formats include TXT, DOCX, PDF, MD, CSV, XLS, and XLSX.
- Code: Only ZIP packages containing Java, Python, C, C++, or Vue code files are supported.
- When Knowledge Type is set to Structured, only local JSON files are supported.
Knowledge Description
(Optional) Indicates the description of the knowledge base content. A maximum of 300 characters are allowed. A detailed description helps guide the agent to call and utilize the knowledge base more accurately.
- Click Next and complete the content import configuration by referring to Table 15.
Table 15 Content import configuration parameters Parameter
Description
Embedding Model
Select an embedding model to vectorize the uploaded files/code. The following models are available.
- bge-m3: a multilingual 1024-dimensional text embedding model that supports hybrid retrieval (dense, sparse, and multi-vector representation). It supports a maximum text length of 8,192 tokens, making it ideal for complex, multilingual scenarios.
- m3e-base: a general-purpose 768-dimensional embedding model for Chinese and English text, suitable for most basic semantic understanding and retrieval tasks.
- bge-large-zh-v1.5: a Chinese-specific model optimized for tasks such as retrieval, classification, clustering, and semantic matching.
- paraphrase-multilingual-MiniLM-L12-v2: a 364-dimensional multilingual embedding model that excels in text similarity calculations, ideal for speed-sensitive scenarios.
- VESO-v1.3: a specific model deeply optimized for code, delivering outstanding performance in code vectorization and search tasks.
Splitter
This parameter is displayed when Knowledge Type is set to Unstructured and Data Source is set to Local file.
The way your content is split depends on the splitter you choose. Different languages can use different splitters for optimal results.
- By paragraph: Content is split by double line breaks (\n\n) or paragraph structure.
- By line: Content is split by single line breaks (\n).
- By sentence (for English): Content is split by sentence boundaries.
- By character: Content is split into individual characters (including whitespace characters).
Chunk Length
This parameter is displayed when Knowledge Type is set to Unstructured and Data Source is set to Local file.
Range: 50 to 1,200 characters. Default value: 1,000 characters.
Chunk Overlap
This parameter is displayed when Knowledge Type is set to Unstructured and Data Source is set to Local file.
Overlap between sequential chunks. Valid range: 0 ≤ Overlap length ≤ Chunk length – 1. Default value is 0.
Child Splitter
This parameter is displayed when Knowledge Type is set to Unstructured and Data Source is set to Local file.
Applied when a chunk exceeds the maximum allowed length. Currently, the following child splitters are supported:
- By character: Content is split into individual characters (including whitespace characters).
- By sentence (for English): Content is split by sentence boundaries.
- By word (for English): Content is split by whitespace characters.
Index Fields
This parameter is displayed when Knowledge Type is set to Structured.
Enter the JSON keys to be used as index fields during retrieval. Up to 20 fields are supported, separated by English commas (,).
Filter Fields
This parameter is displayed when Knowledge Type is set to Structured.
Enter the JSON keys to be used as filter criteria during retrieval. Up to 2 fields are supported, separated by English commas (,).
Indexed Field
This parameter is displayed when Data Source is set to Code.
Select indexed fields to specify which data fields the system needs to build indexes for in advance. During retrieval, the agent will perform keyword matching only against these indexed fields.
For example, if function body is selected as an indexed field, the agent will prioritize matching keywords within the function body section of the code when a user enters a search query.
Use Sliding Window
This parameter is displayed when Data Source is set to Code.
Once enabled, complex functions are segmented into chunks to improve search accuracy.
- Click OK.
In the knowledge base list, you can view the created one.
- Import files.
After creating a knowledge base, you can upload various local documents to it. Once uploaded, the system automatically cleans the data and builds indexes, ensuring that your imported content can be quickly retrieved and called, achieving instant knowledge accumulation.
- Click the name of your desired knowledge base in the list to view its detailed information.
- Click Import File in the upper right corner.
- Select target code files or other files from the local and click OK to return to the knowledge base page. Figure 8 Uploading code files or other files
You can upload code files or other files based on your required knowledge type. The maximum size for a single file or compressed package is 20 MB, and the maximum capacity for a single knowledge base is 50 MB.
Table 16 Description for file importing Knowledge Type
Data Source
Description
Unstructured
Local files
TXT, DOCX, PDF, MD, CSV, XLS, and XLSX files are supported.
Code
Only ZIP packages containing Java, Python, C, C++, or Vue code files are supported.
Structured
Local files
Only JSON files are supported.
- View the import result.
When Ingestion Status changes from Uploading to Ingested, the file import is successful.
Table 17 shows the operation permissions of different roles on managing knowledge bases.
| Role | Enterprise Knowledge Base | Team Knowledge Base | User Knowledge Base |
|---|---|---|---|
| Enterprise administrators | All operations on all knowledge bases. | All operations on the knowledge bases of the team which the enterprise administrator belongs to. | All operations on the knowledge bases created by themselves. |
| Team administrators | The following operations can be performed:
| All operations on knowledge bases created by members of their own team (including the team administrator). | All operations on the knowledge bases created by themselves. |
| Team members | The following operations can be performed:
| The following operations can be performed on knowledge bases created by members of their own team (including the team administrator):
| All operations on the knowledge bases created by themselves. |
| Enterprise members | The following operations can be performed:
| No operation permissions. | All operations on the knowledge bases created by themselves. |
| Operation | Procedure |
|---|---|
| Editing a knowledge space | On the knowledge space page, click |
| Deleting a knowledge space | Before deleting a knowledge space, you must clear all knowledge bases in the space.
|
| Testing the hit rate of a knowledge base | The hit rate test is designed to run search queries against the knowledge base to verify the accuracy and relevance of retrieval results.
|
| Deleting a knowledge base | When content is severely outdated and holds no retention value, or contains critical errors where correction is too costly or impossible, follow the steps below to delete the knowledge base.
|
| Batch deleting knowledge bases | Deleting knowledge bases one by one manually is inefficient; you can batch delete knowledge bases through the following steps:
|
| Viewing operation history on knowledge bases |
|
| Re-importing a file | If file upload fails, check your network connection or file format, and click Reimport to try again.
|
| Deleting a file | When dealing with a small number of files, deleting them one by one is more intuitive and flexible, making it easier to locate and clear specific content.
|
| Batch deleting files | Deleting many files one by one manually is inefficient; you can also batch delete files using the following steps. This is ideal for scenarios such as knowledge base restructuring, version iterations, and deduplication, helping you keep your knowledge base organized.
|
Repository Index
Repository Index helps you quickly search and retrieve relevant information within your codebase, supporting both client-side indexes and cloud-side indexes. Client-side indexes are built on the CodeArts Agent client, and cloud-side indexes are built on the CodeArts Agent console. Only accounts with enabled seats can create and delete the cloud indexes.
| Dimension | Local User Index | Cloud Index |
|---|---|---|
| Used by | Current user |
|
| Repository type | Unlimited | Git and GitHub repositories are supported. |
If your account has been assigned a seat, you can create cloud repository indexes. If not, you cannot create them.
- Log in to the CodeArts Agent console.
- In the navigation pane on the left, choose Agent Settings > Repository Index.
- Click Create Index.
- Set basic index information by referring to Table 20 and click Next.
Table 20 Repository index parameters Parameter
Description
Visible To
Visible scope of the repository index.
- User: available only to members themselves.
- Team: available only to team members and created by the enterprise administrator, team administrator, or team members.
- Enterprise: available to all enterprise members and created by the enterprise administrator, team administrator, enterprise members, or team members.
Teams
This parameter is displayed only when Visible To is set to Team.
Select a team from the drop-down list; only the teams which the current account belongs to are displayed.
Code Source
Source of the code repository that you want to index.
- Git: a general Git repository.
- GitHub: a GitHub repository, which can be a public repository or an authorized private repository.
Authorization Method
Method to authorize the system to access your code source.
- Authorize by Service: Select a service endpoint from the drop-down list. The endpoint corresponds to the connection information of the GitHub or Git repository.
If no service endpoint has been created, click Add to create one by referring to Table 21.
- Authorize by Personal Token: Authorize access requests using an access token generated from your personal account.
Default Branch
This parameter is displayed only when Code Source is set to Git.
Enter the branch name of a Git repository. The branch name can contain a maximum of 200 characters.
Figure 9 Creating a service endpoint
Table 21 Service endpoint parameters Parameter
Description
Connection Name
Name of the custom repository to be connected.
Naming rules: The name can contain letters, digits, underscores (_), and hyphens (-), but cannot start with an underscore.
Git URL
This parameter is displayed only when Code Source is set to Git.
HTTPS access address of the Git repository
User Name
This parameter is displayed only when Code Source is set to Git.
User name for HTTPS authentication of the Git repository.
Password or Access Token
This parameter is displayed only when Code Source is set to Git.
Password or access token for HTTPS authentication of the Git repository.
Access Token
This parameter is displayed only when Code Source is set to Github.
Access token for HTTPS authentication of the GitHub repository.
- Select the repository and language, and click OK to finish creating the index.
On the repository index page, view the newly created repository index. When its status changes from parsing to parsing completed, the repository index has been successfully parsed.
- Return to the CodeArts Agent IDE client and open the Git, Repo, or GitHub repository project. CodeArts Agent automatically downloads team repository indexes from the cloud.
After the team repository indexes are successfully downloaded, the progress displayed on the page reaches 100%.
If the number of files in the repository is greater than 50,000, click Create Index to manually build the repository index.
- (Optional) Use the index in the intelligent Q&A mode.
To use the index in the intelligent Q&A mode, first ensure that the indexing process is completed. Then, at the bottom of the input box on the chat panel, click
to search for indexes. When the icon changes to 
, the index function is enabled.
Table 22 shows the operation permissions of different roles to delete repository indexes.
| Role | Enterprise-Level Repository Index | Team-Level Repository Index | User-Level Repository Index |
|---|---|---|---|
| Enterprise administrator | All repository indexes | All repository indexes of the administrator's team | All repository indexes created by the user |
| Team administrator | All repository indexes created by the user | All repository indexes created by team administrator and members of the team managed by the team administrator | All repository indexes created by the user |
| Team member | All repository indexes created by the user | All repository indexes created by the user | All repository indexes created by the user |
| Enterprise member | All repository indexes created by the user | No operation permissions. | All repository indexes created by the user |
| Operation | Procedure |
|---|---|
| Delete a specified repository index. | When there are only several indexes, you can delete them one by one.
|
| Delete the repository indexes in a batch. | If there are many indexes, you can delete them in batches.
|
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot
