This product(
bailian/2023-12-29) OpenAPI adopts ROA Signature style. See signature details in Description of the signature mechanism. We have packaged SDKs for common programming languages for developers. Developers can directly call the OpenAPI of this product by downloading the SDK without paying attention to the technical details. If the existing SDK cannot meet the usage requirements, you can connect through the signature mechanism. It will take about 5 working days. Therefore, it is recommended to join our DingTalk service group (78410016550) and sign under the guidance of experts. Before using the API, you need to prepare your identity account and access key (AccessKey) to effectively access the API through client tools (SDK, CLI, etc.). For details see getAccessKey.
Data Center
| API | Title | Description |
|---|---|---|
| AddFile | AddFile | Imports an unstructured document stored in the temporary storage space to Data Management. You cannot use the API to import structured documents. Use the console instead. |
| ApplyFileUploadLease | ApplyFileUploadLease | Applies for a document upload lease to upload a document. You cannot use the API to upload structured documents. Use the console instead. |
| DescribeFile | DescribeFile | Obtains the basic information of a document, including the document name, type, and status. |
Knowledge Index
| API | Title | Description |
|---|---|---|
| CreateIndex | CreateIndex | Creates an unstructured knowledge base and imports one or more parsed documents into the knowledge base. You cannot create a structured knowledge base by calling an API operation. Use the console instead. |
| GetIndexJobStatus | GetIndexJobStatus | Queries the current status of a specified knowledge base creation or add document job. |
| SubmitIndexJob | SubmitIndexJob | Submits a specified CreateIndex job to complete knowledge base creation. |
| SubmitIndexAddDocumentsJob | SubmitIndexAddDocumentsJob | Adds parsed documents to an unstructured knowledge base. You cannot use the API to add knowledge to structured knowledge bases, see the Usage notes section of this topic. |
| Retrieve | Retrieve | Queries information from a specified knowledge base. |
| ListIndexDocuments | ListIndexDocuments | Queries the details of one or more documents in a specified knowledge base. |
| ListChunks | ListChunks | For unstructured knowledge base, obtains the details of all chunks of a specified document; for structured knowledge base, obtains the details of all chunks. |
| ListIndices | ListIndices | Lists the details about the next or multiple knowledge bases in a specified workspace. |
| DeleteIndex | DeleteIndex | Deletes a specified knowledge base permanently. |
| DeleteIndexDocument | DeleteIndexDocument | Deletes one or more documents from a specified unstructured knowledge base permanently. You cannot use the API to delete structured documents, see the Usage notes section of this topic. |
Prompt Engineering
| API | Title | Description |
|---|---|---|
| GetPromptTemplate | GetPromptTemplate | Obtains a prompt template based on the template ID. |
| UpdatePromptTemplate | UpdatePromptTemplate | Updates a prompt template based on the template ID. |
| DeletePromptTemplate | DeletePromptTemplate | Deletes a prompt template based on the template ID. |
| ListPromptTemplates | ListPromptTemplates | Obtains a list of prompt templates. |
| ListPromptTemplates | ListPromptTemplates |