mirror of
https://github.com/langgenius/dify.git
synced 2026-09-24 23:22:26 +08:00
refactor(api): migrate console.datasets.rag_pipeline partially to BaseModel (#36649)
This commit is contained in:
@@ -6939,7 +6939,7 @@ Handle OAuth callback for trigger provider
|
||||
|
||||
| Code | Description |
|
||||
| ---- | ----------- |
|
||||
| 200 | Success |
|
||||
| 204 | Pipeline template deleted |
|
||||
|
||||
#### PATCH
|
||||
##### Parameters
|
||||
@@ -6947,12 +6947,13 @@ Handle OAuth callback for trigger provider
|
||||
| Name | Located in | Description | Required | Schema |
|
||||
| ---- | ---------- | ----------- | -------- | ------ |
|
||||
| template_id | path | | Yes | string |
|
||||
| payload | body | | Yes | [CustomizedPipelineTemplatePayload](#customizedpipelinetemplatepayload) |
|
||||
|
||||
##### Responses
|
||||
|
||||
| Code | Description |
|
||||
| ---- | ----------- |
|
||||
| 200 | Success |
|
||||
| 204 | Pipeline template updated |
|
||||
|
||||
#### POST
|
||||
##### Parameters
|
||||
@@ -6978,27 +6979,34 @@ Handle OAuth callback for trigger provider
|
||||
|
||||
##### Responses
|
||||
|
||||
| Code | Description |
|
||||
| ---- | ----------- |
|
||||
| 200 | Success |
|
||||
| Code | Description | Schema |
|
||||
| ---- | ----------- | ------ |
|
||||
| 201 | RAG pipeline dataset import started | [RagPipelineImportResponse](#ragpipelineimportresponse) |
|
||||
|
||||
### /rag/pipeline/empty-dataset
|
||||
|
||||
#### POST
|
||||
##### Responses
|
||||
|
||||
| Code | Description |
|
||||
| ---- | ----------- |
|
||||
| 200 | Success |
|
||||
| Code | Description | Schema |
|
||||
| ---- | ----------- | ------ |
|
||||
| 201 | RAG pipeline dataset created | [DatasetDetailResponse](#datasetdetailresponse) |
|
||||
|
||||
### /rag/pipeline/templates
|
||||
|
||||
#### GET
|
||||
##### Parameters
|
||||
|
||||
| Name | Located in | Description | Required | Schema |
|
||||
| ---- | ---------- | ----------- | -------- | ------ |
|
||||
| language | query | Template language | No | string |
|
||||
| type | query | Template source: built-in or customized | No | string |
|
||||
|
||||
##### Responses
|
||||
|
||||
| Code | Description |
|
||||
| ---- | ----------- |
|
||||
| 200 | Success |
|
||||
| Code | Description | Schema |
|
||||
| ---- | ----------- | ------ |
|
||||
| 200 | Pipeline templates | [PipelineTemplateListResponse](#pipelinetemplatelistresponse) |
|
||||
|
||||
### /rag/pipeline/templates/{template_id}
|
||||
|
||||
@@ -7008,12 +7016,13 @@ Handle OAuth callback for trigger provider
|
||||
| Name | Located in | Description | Required | Schema |
|
||||
| ---- | ---------- | ----------- | -------- | ------ |
|
||||
| template_id | path | | Yes | string |
|
||||
| type | query | Template source: built-in or customized | No | string |
|
||||
|
||||
##### Responses
|
||||
|
||||
| Code | Description |
|
||||
| ---- | ----------- |
|
||||
| 200 | Success |
|
||||
| Code | Description | Schema |
|
||||
| ---- | ----------- | ------ |
|
||||
| 200 | Pipeline template | [PipelineTemplateDetailResponse](#pipelinetemplatedetailresponse) |
|
||||
|
||||
### /rag/pipelines/datasource-plugins
|
||||
|
||||
@@ -7035,9 +7044,11 @@ Handle OAuth callback for trigger provider
|
||||
|
||||
##### Responses
|
||||
|
||||
| Code | Description |
|
||||
| ---- | ----------- |
|
||||
| 200 | Success |
|
||||
| Code | Description | Schema |
|
||||
| ---- | ----------- | ------ |
|
||||
| 200 | Import completed | [RagPipelineImportResponse](#ragpipelineimportresponse) |
|
||||
| 202 | Import pending confirmation | [RagPipelineImportResponse](#ragpipelineimportresponse) |
|
||||
| 400 | Import failed | [RagPipelineImportResponse](#ragpipelineimportresponse) |
|
||||
|
||||
### /rag/pipelines/imports/{import_id}/confirm
|
||||
|
||||
@@ -7050,9 +7061,10 @@ Handle OAuth callback for trigger provider
|
||||
|
||||
##### Responses
|
||||
|
||||
| Code | Description |
|
||||
| ---- | ----------- |
|
||||
| 200 | Success |
|
||||
| Code | Description | Schema |
|
||||
| ---- | ----------- | ------ |
|
||||
| 200 | Import confirmed | [RagPipelineImportResponse](#ragpipelineimportresponse) |
|
||||
| 400 | Import failed | [RagPipelineImportResponse](#ragpipelineimportresponse) |
|
||||
|
||||
### /rag/pipelines/imports/{pipeline_id}/check-dependencies
|
||||
|
||||
@@ -7065,9 +7077,9 @@ Handle OAuth callback for trigger provider
|
||||
|
||||
##### Responses
|
||||
|
||||
| Code | Description |
|
||||
| ---- | ----------- |
|
||||
| 200 | Success |
|
||||
| Code | Description | Schema |
|
||||
| ---- | ----------- | ------ |
|
||||
| 200 | Dependencies checked | [RagPipelineImportCheckDependenciesResponse](#ragpipelineimportcheckdependenciesresponse) |
|
||||
|
||||
### /rag/pipelines/recommended-plugins
|
||||
|
||||
@@ -7101,13 +7113,13 @@ Handle OAuth callback for trigger provider
|
||||
| Name | Located in | Description | Required | Schema |
|
||||
| ---- | ---------- | ----------- | -------- | ------ |
|
||||
| pipeline_id | path | | Yes | string |
|
||||
| payload | body | | Yes | [Payload](#payload) |
|
||||
| payload | body | | Yes | [CustomizedPipelineTemplatePayload](#customizedpipelinetemplatepayload) |
|
||||
|
||||
##### Responses
|
||||
|
||||
| Code | Description |
|
||||
| ---- | ----------- |
|
||||
| 200 | Success |
|
||||
| 204 | Pipeline template published |
|
||||
|
||||
### /rag/pipelines/{pipeline_id}/exports
|
||||
|
||||
@@ -7117,12 +7129,13 @@ Handle OAuth callback for trigger provider
|
||||
| Name | Located in | Description | Required | Schema |
|
||||
| ---- | ---------- | ----------- | -------- | ------ |
|
||||
| pipeline_id | path | | Yes | string |
|
||||
| include_secret | query | Whether to include secret values in the exported DSL | No | string |
|
||||
|
||||
##### Responses
|
||||
|
||||
| Code | Description |
|
||||
| ---- | ----------- |
|
||||
| 200 | Success |
|
||||
| Code | Description | Schema |
|
||||
| ---- | ----------- | ------ |
|
||||
| 200 | Pipeline exported | [SimpleDataResponse](#simpledataresponse) |
|
||||
|
||||
### /rag/pipelines/{pipeline_id}/workflow-runs
|
||||
|
||||
@@ -12429,6 +12442,14 @@ Condition detail
|
||||
| ---- | ---- | ----------- | -------- |
|
||||
| CredentialType | string | | |
|
||||
|
||||
#### CustomizedPipelineTemplatePayload
|
||||
|
||||
| Name | Type | Description | Required |
|
||||
| ---- | ---- | ----------- | -------- |
|
||||
| description | string | | No |
|
||||
| icon_info | object | | No |
|
||||
| name | string | | Yes |
|
||||
|
||||
#### DataSource
|
||||
|
||||
| Name | Type | Description | Required |
|
||||
@@ -13883,7 +13904,7 @@ Request payload for bulk downloading documents as a zip archive.
|
||||
|
||||
| Name | Type | Description | Required |
|
||||
| ---- | ---- | ----------- | -------- |
|
||||
| include_secret | string | | No |
|
||||
| include_secret | string | Whether to include secret values in the exported DSL | No |
|
||||
|
||||
#### IndexingEstimatePayload
|
||||
|
||||
@@ -14860,14 +14881,6 @@ Form input definition.
|
||||
| node_title | string | | Yes |
|
||||
| pause_type | [HumanInputPauseTypeResponse](#humaninputpausetyperesponse) | | Yes |
|
||||
|
||||
#### Payload
|
||||
|
||||
| Name | Type | Description | Required |
|
||||
| ---- | ---- | ----------- | -------- |
|
||||
| description | string | | No |
|
||||
| icon_info | object | | No |
|
||||
| name | string | | Yes |
|
||||
|
||||
#### PermissionEnum
|
||||
|
||||
Shared permission levels for resources (datasets, credentials, etc.)
|
||||
@@ -14876,6 +14889,51 @@ Shared permission levels for resources (datasets, credentials, etc.)
|
||||
| ---- | ---- | ----------- | -------- |
|
||||
| PermissionEnum | string | Shared permission levels for resources (datasets, credentials, etc.) | |
|
||||
|
||||
#### PipelineTemplateDetailQuery
|
||||
|
||||
| Name | Type | Description | Required |
|
||||
| ---- | ---- | ----------- | -------- |
|
||||
| type | string | Template source: built-in or customized | No |
|
||||
|
||||
#### PipelineTemplateDetailResponse
|
||||
|
||||
| Name | Type | Description | Required |
|
||||
| ---- | ---- | ----------- | -------- |
|
||||
| chunk_structure | string | | Yes |
|
||||
| created_by | string | | No |
|
||||
| description | string | | Yes |
|
||||
| export_data | string | | Yes |
|
||||
| graph | object | | Yes |
|
||||
| icon_info | object | | Yes |
|
||||
| id | string | | Yes |
|
||||
| name | string | | Yes |
|
||||
|
||||
#### PipelineTemplateItemResponse
|
||||
|
||||
| Name | Type | Description | Required |
|
||||
| ---- | ---- | ----------- | -------- |
|
||||
| chunk_structure | string | | Yes |
|
||||
| copyright | string | | No |
|
||||
| description | string | | Yes |
|
||||
| icon | object | | Yes |
|
||||
| id | string | | Yes |
|
||||
| name | string | | Yes |
|
||||
| position | integer | | Yes |
|
||||
| privacy_policy | string | | No |
|
||||
|
||||
#### PipelineTemplateListQuery
|
||||
|
||||
| Name | Type | Description | Required |
|
||||
| ---- | ---- | ----------- | -------- |
|
||||
| language | string | Template language | No |
|
||||
| type | string | Template source: built-in or customized | No |
|
||||
|
||||
#### PipelineTemplateListResponse
|
||||
|
||||
| Name | Type | Description | Required |
|
||||
| ---- | ---- | ----------- | -------- |
|
||||
| pipeline_templates | [ [PipelineTemplateItemResponse](#pipelinetemplateitemresponse) ] | | Yes |
|
||||
|
||||
#### PipelineVariableResponse
|
||||
|
||||
| Name | Type | Description | Required |
|
||||
@@ -15000,23 +15058,11 @@ Shared permission levels for resources (datasets, credentials, etc.)
|
||||
| ---- | ---- | ----------- | -------- |
|
||||
| yaml_content | string | | Yes |
|
||||
|
||||
#### RagPipelineImport
|
||||
#### RagPipelineImportCheckDependenciesResponse
|
||||
|
||||
| Name | Type | Description | Required |
|
||||
| ---- | ---- | ----------- | -------- |
|
||||
| current_dsl_version | string | | No |
|
||||
| dataset_id | string | | No |
|
||||
| error | string | | No |
|
||||
| id | string | | No |
|
||||
| imported_dsl_version | string | | No |
|
||||
| pipeline_id | string | | No |
|
||||
| status | string | | No |
|
||||
|
||||
#### RagPipelineImportCheckDependencies
|
||||
|
||||
| Name | Type | Description | Required |
|
||||
| ---- | ---- | ----------- | -------- |
|
||||
| leaked_dependencies | [ [RagPipelineLeakedDependency](#ragpipelineleakeddependency) ] | | No |
|
||||
| leaked_dependencies | [ [PluginDependency](#plugindependency) ] | | No |
|
||||
|
||||
#### RagPipelineImportPayload
|
||||
|
||||
@@ -15032,13 +15078,17 @@ Shared permission levels for resources (datasets, credentials, etc.)
|
||||
| yaml_content | string | | No |
|
||||
| yaml_url | string | | No |
|
||||
|
||||
#### RagPipelineLeakedDependency
|
||||
#### RagPipelineImportResponse
|
||||
|
||||
| Name | Type | Description | Required |
|
||||
| ---- | ---- | ----------- | -------- |
|
||||
| current_identifier | string | | No |
|
||||
| type | string | | No |
|
||||
| value | object | | No |
|
||||
| current_dsl_version | string | | Yes |
|
||||
| dataset_id | string | | No |
|
||||
| error | string | | No |
|
||||
| id | string | | Yes |
|
||||
| imported_dsl_version | string | | Yes |
|
||||
| pipeline_id | string | | No |
|
||||
| status | [ImportStatus](#importstatus) | | Yes |
|
||||
|
||||
#### RagPipelineRecommendedPluginQuery
|
||||
|
||||
|
||||
Reference in New Issue
Block a user