mirror of
https://github.com/langgenius/dify.git
synced 2026-10-29 18:07:39 +08:00
refactor(api): migrate console/service_api.dataset to BaseModel (#36480)
This commit is contained in:
chariri
@@ -4135,18 +4135,18 @@ Get list of datasets
|
||||
|
||||
| Name | Located in | Description | Required | Schema |
|
||||
| ---- | ---------- | ----------- | -------- | ------ |
|
||||
| ids | query | Filter by dataset IDs (list) | No | string |
|
||||
| include_all | query | Include all datasets (default: false) | No | string |
|
||||
| ids | query | Filter by dataset IDs | No | [ string ] |
|
||||
| include_all | query | Include all datasets | No | boolean |
|
||||
| keyword | query | Search keyword | No | string |
|
||||
| limit | query | Number of items per page (default: 20) | No | string |
|
||||
| page | query | Page number (default: 1) | No | string |
|
||||
| tag_ids | query | Filter by tag IDs (list) | No | string |
|
||||
| limit | query | Number of items per page | No | integer |
|
||||
| page | query | Page number | No | integer |
|
||||
| tag_ids | query | Filter by tag IDs | No | [ string ] |
|
||||
|
||||
##### Responses
|
||||
|
||||
| Code | Description |
|
||||
| ---- | ----------- |
|
||||
| 200 | Datasets retrieved successfully |
|
||||
| Code | Description | Schema |
|
||||
| ---- | ----------- | ------ |
|
||||
| 200 | Datasets retrieved successfully | [DatasetListResponse](#datasetlistresponse) |
|
||||
|
||||
#### POST
|
||||
##### Description
|
||||
@@ -4161,10 +4161,10 @@ Create a new dataset
|
||||
|
||||
##### Responses
|
||||
|
||||
| Code | Description |
|
||||
| ---- | ----------- |
|
||||
| 201 | Dataset created successfully |
|
||||
| 400 | Invalid request parameters |
|
||||
| Code | Description | Schema |
|
||||
| ---- | ----------- | ------ |
|
||||
| 201 | Dataset created successfully | [DatasetDetailResponse](#datasetdetailresponse) |
|
||||
| 400 | Invalid request parameters | |
|
||||
|
||||
### /datasets/api-base-info
|
||||
|
||||
@@ -4384,9 +4384,9 @@ Estimate dataset indexing cost
|
||||
|
||||
##### Responses
|
||||
|
||||
| Code | Description |
|
||||
| ---- | ----------- |
|
||||
| 200 | Indexing estimate calculated successfully |
|
||||
| Code | Description | Schema |
|
||||
| ---- | ----------- | ------ |
|
||||
| 200 | Indexing estimate calculated successfully | [IndexingEstimateResponse](#indexingestimateresponse) |
|
||||
|
||||
### /datasets/init
|
||||
|
||||
@@ -4467,9 +4467,9 @@ Get dataset retrieval settings
|
||||
|
||||
##### Responses
|
||||
|
||||
| Code | Description |
|
||||
| ---- | ----------- |
|
||||
| 200 | Retrieval settings retrieved successfully |
|
||||
| Code | Description | Schema |
|
||||
| ---- | ----------- | ------ |
|
||||
| 200 | Retrieval settings retrieved successfully | [RetrievalSettingResponse](#retrievalsettingresponse) |
|
||||
|
||||
### /datasets/retrieval-setting/{vector_type}
|
||||
|
||||
@@ -4486,9 +4486,9 @@ Get mock dataset retrieval settings by vector type
|
||||
|
||||
##### Responses
|
||||
|
||||
| Code | Description |
|
||||
| ---- | ----------- |
|
||||
| 200 | Mock retrieval settings retrieved successfully |
|
||||
| Code | Description | Schema |
|
||||
| ---- | ----------- | ------ |
|
||||
| 200 | Mock retrieval settings retrieved successfully | [RetrievalSettingResponse](#retrievalsettingresponse) |
|
||||
|
||||
### /datasets/{dataset_id}
|
||||
|
||||
@@ -4520,7 +4520,7 @@ Get dataset details
|
||||
|
||||
| Code | Description | Schema |
|
||||
| ---- | ----------- | ------ |
|
||||
| 200 | Dataset retrieved successfully | [DatasetDetail](#datasetdetail) |
|
||||
| 200 | Dataset retrieved successfully | [DatasetDetailWithPartialMembersResponse](#datasetdetailwithpartialmembersresponse) |
|
||||
| 403 | Permission denied | |
|
||||
| 404 | Dataset not found | |
|
||||
|
||||
@@ -4540,7 +4540,7 @@ Update dataset details
|
||||
|
||||
| Code | Description | Schema |
|
||||
| ---- | ----------- | ------ |
|
||||
| 200 | Dataset updated successfully | [DatasetDetail](#datasetdetail) |
|
||||
| 200 | Dataset updated successfully | [DatasetDetailWithPartialMembersResponse](#datasetdetailwithpartialmembersresponse) |
|
||||
| 403 | Permission denied | |
|
||||
| 404 | Dataset not found | |
|
||||
|
||||
@@ -4575,10 +4575,10 @@ Get dataset auto disable logs
|
||||
|
||||
##### Responses
|
||||
|
||||
| Code | Description |
|
||||
| ---- | ----------- |
|
||||
| 200 | Auto disable logs retrieved successfully |
|
||||
| 404 | Dataset not found |
|
||||
| Code | Description | Schema |
|
||||
| ---- | ----------- | ------ |
|
||||
| 200 | Auto disable logs retrieved successfully | [AutoDisableLogsResponse](#autodisablelogsresponse) |
|
||||
| 404 | Dataset not found | |
|
||||
|
||||
### /datasets/{dataset_id}/batch/{batch}/indexing-estimate
|
||||
|
||||
@@ -5263,10 +5263,10 @@ Get dataset error documents
|
||||
|
||||
##### Responses
|
||||
|
||||
| Code | Description |
|
||||
| ---- | ----------- |
|
||||
| 200 | Error documents retrieved successfully |
|
||||
| 404 | Dataset not found |
|
||||
| Code | Description | Schema |
|
||||
| ---- | ----------- | ------ |
|
||||
| 200 | Error documents retrieved successfully | [ErrorDocsResponse](#errordocsresponse) |
|
||||
| 404 | Dataset not found | |
|
||||
|
||||
### /datasets/{dataset_id}/external-hit-testing
|
||||
|
||||
@@ -5327,9 +5327,9 @@ Get dataset indexing status
|
||||
|
||||
##### Responses
|
||||
|
||||
| Code | Description |
|
||||
| ---- | ----------- |
|
||||
| 200 | Indexing status retrieved successfully |
|
||||
| Code | Description | Schema |
|
||||
| ---- | ----------- | ------ |
|
||||
| 200 | Indexing status retrieved successfully | [DocumentStatusListResponse](#documentstatuslistresponse) |
|
||||
|
||||
### /datasets/{dataset_id}/metadata
|
||||
|
||||
@@ -5437,11 +5437,11 @@ Get dataset permission user list
|
||||
|
||||
##### Responses
|
||||
|
||||
| Code | Description |
|
||||
| ---- | ----------- |
|
||||
| 200 | Permission users retrieved successfully |
|
||||
| 403 | Permission denied |
|
||||
| 404 | Dataset not found |
|
||||
| Code | Description | Schema |
|
||||
| ---- | ----------- | ------ |
|
||||
| 200 | Permission users retrieved successfully | [PartialMemberListResponse](#partialmemberlistresponse) |
|
||||
| 403 | Permission denied | |
|
||||
| 404 | Dataset not found | |
|
||||
|
||||
### /datasets/{dataset_id}/queries
|
||||
|
||||
@@ -5460,7 +5460,7 @@ Get dataset query history
|
||||
|
||||
| Code | Description | Schema |
|
||||
| ---- | ----------- | ------ |
|
||||
| 200 | Query history retrieved successfully | [DatasetQueryDetail](#datasetquerydetail) |
|
||||
| 200 | Query history retrieved successfully | [DatasetQueryListResponse](#datasetquerylistresponse) |
|
||||
|
||||
### /datasets/{dataset_id}/related-apps
|
||||
|
||||
@@ -5479,7 +5479,7 @@ Get applications related to dataset
|
||||
|
||||
| Code | Description | Schema |
|
||||
| ---- | ----------- | ------ |
|
||||
| 200 | Related apps retrieved successfully | [RelatedAppList](#relatedapplist) |
|
||||
| 200 | Related apps retrieved successfully | [RelatedAppListResponse](#relatedapplistresponse) |
|
||||
|
||||
### /datasets/{dataset_id}/retry
|
||||
|
||||
@@ -10863,19 +10863,6 @@ Enum class for api provider schema type.
|
||||
| use_icon_as_answer_icon | boolean | | No |
|
||||
| workflow | [WorkflowPartial](#workflowpartial) | | No |
|
||||
|
||||
#### AppDetailKernel
|
||||
|
||||
| Name | Type | Description | Required |
|
||||
| ---- | ---- | ----------- | -------- |
|
||||
| description | string | | No |
|
||||
| icon | string | | No |
|
||||
| icon_background | string | | No |
|
||||
| icon_type | string | | No |
|
||||
| icon_url | object | | No |
|
||||
| id | string | | No |
|
||||
| mode | string | | No |
|
||||
| name | string | | No |
|
||||
|
||||
#### AppDetailWithSite
|
||||
|
||||
| Name | Type | Description | Required |
|
||||
@@ -11081,6 +11068,13 @@ AppMCPServer Status Enum
|
||||
| ---- | ---- | ----------- | -------- |
|
||||
| text | string | Transcribed text from audio | Yes |
|
||||
|
||||
#### AutoDisableLogsResponse
|
||||
|
||||
| Name | Type | Description | Required |
|
||||
| ---- | ---- | ----------- | -------- |
|
||||
| count | integer | | Yes |
|
||||
| document_ids | [ string ] | | Yes |
|
||||
|
||||
#### AvatarUrlResponse
|
||||
|
||||
| Name | Type | Description | Required |
|
||||
@@ -11643,27 +11637,6 @@ Condition detail
|
||||
| dataset | [DatasetResponse](#datasetresponse) | | Yes |
|
||||
| documents | [ [DocumentResponse](#documentresponse) ] | | Yes |
|
||||
|
||||
#### DatasetBase
|
||||
|
||||
| Name | Type | Description | Required |
|
||||
| ---- | ---- | ----------- | -------- |
|
||||
| created_at | object | | No |
|
||||
| created_by | string | | No |
|
||||
| data_source_type | string | | No |
|
||||
| description | string | | No |
|
||||
| id | string | | No |
|
||||
| indexing_technique | string | | No |
|
||||
| name | string | | No |
|
||||
| permission | string | | No |
|
||||
|
||||
#### DatasetContent
|
||||
|
||||
| Name | Type | Description | Required |
|
||||
| ---- | ---- | ----------- | -------- |
|
||||
| content | string | | No |
|
||||
| content_type | string | | No |
|
||||
| file_info | [DatasetFileInfo](#datasetfileinfo) | | No |
|
||||
|
||||
#### DatasetCreatePayload
|
||||
|
||||
| Name | Type | Description | Required |
|
||||
@@ -11716,6 +11689,87 @@ Condition detail
|
||||
| updated_by | string | | No |
|
||||
| word_count | integer | | No |
|
||||
|
||||
#### DatasetDetailResponse
|
||||
|
||||
| Name | Type | Description | Required |
|
||||
| ---- | ---- | ----------- | -------- |
|
||||
| app_count | integer | | Yes |
|
||||
| author_name | string | | Yes |
|
||||
| built_in_field_enabled | boolean | | Yes |
|
||||
| chunk_structure | string | | Yes |
|
||||
| created_at | integer | | Yes |
|
||||
| created_by | string | | Yes |
|
||||
| data_source_type | string | | Yes |
|
||||
| description | string | | Yes |
|
||||
| doc_form | string | | Yes |
|
||||
| doc_metadata | [ [DatasetDocMetadataResponse](#datasetdocmetadataresponse) ] | | Yes |
|
||||
| document_count | integer | | Yes |
|
||||
| embedding_available | boolean | | No |
|
||||
| embedding_model | string | | Yes |
|
||||
| embedding_model_provider | string | | Yes |
|
||||
| enable_api | boolean | | Yes |
|
||||
| external_knowledge_info | [DatasetExternalKnowledgeInfoResponse](#datasetexternalknowledgeinforesponse) | | Yes |
|
||||
| external_retrieval_model | [DatasetExternalRetrievalModelResponse](#datasetexternalretrievalmodelresponse) | | Yes |
|
||||
| icon_info | [DatasetIconInfoResponse](#dataseticoninforesponse) | | Yes |
|
||||
| id | string | | Yes |
|
||||
| indexing_technique | string | | Yes |
|
||||
| is_multimodal | boolean | | Yes |
|
||||
| is_published | boolean | | Yes |
|
||||
| name | string | | Yes |
|
||||
| permission | string | | Yes |
|
||||
| pipeline_id | string | | Yes |
|
||||
| provider | string | | Yes |
|
||||
| retrieval_model_dict | [DatasetRetrievalModelResponse](#datasetretrievalmodelresponse) | | Yes |
|
||||
| runtime_mode | string | | Yes |
|
||||
| summary_index_setting | [DatasetSummaryIndexSettingResponse](#datasetsummaryindexsettingresponse) | | Yes |
|
||||
| tags | [ [DatasetTagResponse](#datasettagresponse) ] | | Yes |
|
||||
| total_available_documents | integer | | Yes |
|
||||
| total_documents | integer | | Yes |
|
||||
| updated_at | integer | | Yes |
|
||||
| updated_by | string | | Yes |
|
||||
| word_count | integer | | Yes |
|
||||
|
||||
#### DatasetDetailWithPartialMembersResponse
|
||||
|
||||
| Name | Type | Description | Required |
|
||||
| ---- | ---- | ----------- | -------- |
|
||||
| app_count | integer | | Yes |
|
||||
| author_name | string | | Yes |
|
||||
| built_in_field_enabled | boolean | | Yes |
|
||||
| chunk_structure | string | | Yes |
|
||||
| created_at | integer | | Yes |
|
||||
| created_by | string | | Yes |
|
||||
| data_source_type | string | | Yes |
|
||||
| description | string | | Yes |
|
||||
| doc_form | string | | Yes |
|
||||
| doc_metadata | [ [DatasetDocMetadataResponse](#datasetdocmetadataresponse) ] | | Yes |
|
||||
| document_count | integer | | Yes |
|
||||
| embedding_available | boolean | | No |
|
||||
| embedding_model | string | | Yes |
|
||||
| embedding_model_provider | string | | Yes |
|
||||
| enable_api | boolean | | Yes |
|
||||
| external_knowledge_info | [DatasetExternalKnowledgeInfoResponse](#datasetexternalknowledgeinforesponse) | | Yes |
|
||||
| external_retrieval_model | [DatasetExternalRetrievalModelResponse](#datasetexternalretrievalmodelresponse) | | Yes |
|
||||
| icon_info | [DatasetIconInfoResponse](#dataseticoninforesponse) | | Yes |
|
||||
| id | string | | Yes |
|
||||
| indexing_technique | string | | Yes |
|
||||
| is_multimodal | boolean | | Yes |
|
||||
| is_published | boolean | | Yes |
|
||||
| name | string | | Yes |
|
||||
| partial_member_list | [ string ] | | No |
|
||||
| permission | string | | Yes |
|
||||
| pipeline_id | string | | Yes |
|
||||
| provider | string | | Yes |
|
||||
| retrieval_model_dict | [DatasetRetrievalModelResponse](#datasetretrievalmodelresponse) | | Yes |
|
||||
| runtime_mode | string | | Yes |
|
||||
| summary_index_setting | [DatasetSummaryIndexSettingResponse](#datasetsummaryindexsettingresponse) | | Yes |
|
||||
| tags | [ [DatasetTagResponse](#datasettagresponse) ] | | Yes |
|
||||
| total_available_documents | integer | | Yes |
|
||||
| total_documents | integer | | Yes |
|
||||
| updated_at | integer | | Yes |
|
||||
| updated_by | string | | Yes |
|
||||
| word_count | integer | | Yes |
|
||||
|
||||
#### DatasetDocMetadata
|
||||
|
||||
| Name | Type | Description | Required |
|
||||
@@ -11724,16 +11778,30 @@ Condition detail
|
||||
| name | string | | No |
|
||||
| type | string | | No |
|
||||
|
||||
#### DatasetFileInfo
|
||||
#### DatasetDocMetadataResponse
|
||||
|
||||
| Name | Type | Description | Required |
|
||||
| ---- | ---- | ----------- | -------- |
|
||||
| extension | string | | No |
|
||||
| id | string | | No |
|
||||
| mime_type | string | | No |
|
||||
| name | string | | No |
|
||||
| size | integer | | No |
|
||||
| source_url | string | | No |
|
||||
| id | string | | Yes |
|
||||
| name | string | | Yes |
|
||||
| type | string | | Yes |
|
||||
|
||||
#### DatasetExternalKnowledgeInfoResponse
|
||||
|
||||
| Name | Type | Description | Required |
|
||||
| ---- | ---- | ----------- | -------- |
|
||||
| external_knowledge_api_endpoint | string | | Yes |
|
||||
| external_knowledge_api_id | string | | Yes |
|
||||
| external_knowledge_api_name | string | | Yes |
|
||||
| external_knowledge_id | string | | Yes |
|
||||
|
||||
#### DatasetExternalRetrievalModelResponse
|
||||
|
||||
| Name | Type | Description | Required |
|
||||
| ---- | ---- | ----------- | -------- |
|
||||
| score_threshold | number | | Yes |
|
||||
| score_threshold_enabled | boolean | | No |
|
||||
| top_k | integer | | Yes |
|
||||
|
||||
#### DatasetIconInfo
|
||||
|
||||
@@ -11744,12 +11812,78 @@ Condition detail
|
||||
| icon_type | string | | No |
|
||||
| icon_url | string | | No |
|
||||
|
||||
#### DatasetIconInfoResponse
|
||||
|
||||
| Name | Type | Description | Required |
|
||||
| ---- | ---- | ----------- | -------- |
|
||||
| icon | string | | Yes |
|
||||
| icon_background | string | | No |
|
||||
| icon_type | string | | Yes |
|
||||
| icon_url | string | | No |
|
||||
|
||||
#### DatasetKeywordSetting
|
||||
|
||||
| Name | Type | Description | Required |
|
||||
| ---- | ---- | ----------- | -------- |
|
||||
| keyword_weight | number | | No |
|
||||
|
||||
#### DatasetKeywordSettingResponse
|
||||
|
||||
| Name | Type | Description | Required |
|
||||
| ---- | ---- | ----------- | -------- |
|
||||
| keyword_weight | number | | Yes |
|
||||
|
||||
#### DatasetListItemResponse
|
||||
|
||||
| Name | Type | Description | Required |
|
||||
| ---- | ---- | ----------- | -------- |
|
||||
| app_count | integer | | Yes |
|
||||
| author_name | string | | Yes |
|
||||
| built_in_field_enabled | boolean | | Yes |
|
||||
| chunk_structure | string | | Yes |
|
||||
| created_at | integer | | Yes |
|
||||
| created_by | string | | Yes |
|
||||
| data_source_type | string | | Yes |
|
||||
| description | string | | Yes |
|
||||
| doc_form | string | | Yes |
|
||||
| doc_metadata | [ [DatasetDocMetadataResponse](#datasetdocmetadataresponse) ] | | Yes |
|
||||
| document_count | integer | | Yes |
|
||||
| embedding_available | boolean | | No |
|
||||
| embedding_model | string | | Yes |
|
||||
| embedding_model_provider | string | | Yes |
|
||||
| enable_api | boolean | | Yes |
|
||||
| external_knowledge_info | [DatasetExternalKnowledgeInfoResponse](#datasetexternalknowledgeinforesponse) | | Yes |
|
||||
| external_retrieval_model | [DatasetExternalRetrievalModelResponse](#datasetexternalretrievalmodelresponse) | | Yes |
|
||||
| icon_info | [DatasetIconInfoResponse](#dataseticoninforesponse) | | Yes |
|
||||
| id | string | | Yes |
|
||||
| indexing_technique | string | | Yes |
|
||||
| is_multimodal | boolean | | Yes |
|
||||
| is_published | boolean | | Yes |
|
||||
| name | string | | Yes |
|
||||
| partial_member_list | [ string ] | | Yes |
|
||||
| permission | string | | Yes |
|
||||
| pipeline_id | string | | Yes |
|
||||
| provider | string | | Yes |
|
||||
| retrieval_model_dict | [DatasetRetrievalModelResponse](#datasetretrievalmodelresponse) | | Yes |
|
||||
| runtime_mode | string | | Yes |
|
||||
| summary_index_setting | [DatasetSummaryIndexSettingResponse](#datasetsummaryindexsettingresponse) | | Yes |
|
||||
| tags | [ [DatasetTagResponse](#datasettagresponse) ] | | Yes |
|
||||
| total_available_documents | integer | | Yes |
|
||||
| total_documents | integer | | Yes |
|
||||
| updated_at | integer | | Yes |
|
||||
| updated_by | string | | Yes |
|
||||
| word_count | integer | | Yes |
|
||||
|
||||
#### DatasetListResponse
|
||||
|
||||
| Name | Type | Description | Required |
|
||||
| ---- | ---- | ----------- | -------- |
|
||||
| data | [ [DatasetListItemResponse](#datasetlistitemresponse) ] | | Yes |
|
||||
| has_more | boolean | | Yes |
|
||||
| limit | integer | | Yes |
|
||||
| page | integer | | Yes |
|
||||
| total | integer | | Yes |
|
||||
|
||||
#### DatasetMetadataBuiltInFieldResponse
|
||||
|
||||
| Name | Type | Description | Required |
|
||||
@@ -11793,17 +11927,46 @@ Condition detail
|
||||
| ---- | ---- | ----------- | -------- |
|
||||
| DatasetPermissionEnum | string | | |
|
||||
|
||||
#### DatasetQueryDetail
|
||||
#### DatasetQueryContentResponse
|
||||
|
||||
| Name | Type | Description | Required |
|
||||
| ---- | ---- | ----------- | -------- |
|
||||
| created_at | object | | No |
|
||||
| created_by | string | | No |
|
||||
| created_by_role | string | | No |
|
||||
| id | string | | No |
|
||||
| queries | [DatasetContent](#datasetcontent) | | No |
|
||||
| source | string | | No |
|
||||
| source_app_id | string | | No |
|
||||
| content | string | | Yes |
|
||||
| content_type | string | | Yes |
|
||||
| file_info | [DatasetQueryFileInfoResponse](#datasetqueryfileinforesponse) | | No |
|
||||
|
||||
#### DatasetQueryDetailResponse
|
||||
|
||||
| Name | Type | Description | Required |
|
||||
| ---- | ---- | ----------- | -------- |
|
||||
| created_at | integer | | Yes |
|
||||
| created_by | string | | Yes |
|
||||
| created_by_role | string | | Yes |
|
||||
| id | string | | Yes |
|
||||
| queries | [ [DatasetQueryContentResponse](#datasetquerycontentresponse) ] | | Yes |
|
||||
| source | string | | Yes |
|
||||
| source_app_id | string | | Yes |
|
||||
|
||||
#### DatasetQueryFileInfoResponse
|
||||
|
||||
| Name | Type | Description | Required |
|
||||
| ---- | ---- | ----------- | -------- |
|
||||
| extension | string | | Yes |
|
||||
| id | string | | Yes |
|
||||
| mime_type | string | | Yes |
|
||||
| name | string | | Yes |
|
||||
| size | integer | | Yes |
|
||||
| source_url | string | | Yes |
|
||||
|
||||
#### DatasetQueryListResponse
|
||||
|
||||
| Name | Type | Description | Required |
|
||||
| ---- | ---- | ----------- | -------- |
|
||||
| data | [ [DatasetQueryDetailResponse](#datasetquerydetailresponse) ] | | Yes |
|
||||
| has_more | boolean | | Yes |
|
||||
| limit | integer | | Yes |
|
||||
| page | integer | | Yes |
|
||||
| total | integer | | Yes |
|
||||
|
||||
#### DatasetRerankingModel
|
||||
|
||||
@@ -11812,6 +11975,13 @@ Condition detail
|
||||
| reranking_model_name | string | | No |
|
||||
| reranking_provider_name | string | | No |
|
||||
|
||||
#### DatasetRerankingModelResponse
|
||||
|
||||
| Name | Type | Description | Required |
|
||||
| ---- | ---- | ----------- | -------- |
|
||||
| reranking_model_name | string | | No |
|
||||
| reranking_provider_name | string | | No |
|
||||
|
||||
#### DatasetResponse
|
||||
|
||||
| Name | Type | Description | Required |
|
||||
@@ -11838,6 +12008,36 @@ Condition detail
|
||||
| top_k | integer | | No |
|
||||
| weights | [DatasetWeightedScore](#datasetweightedscore) | | No |
|
||||
|
||||
#### DatasetRetrievalModelResponse
|
||||
|
||||
| Name | Type | Description | Required |
|
||||
| ---- | ---- | ----------- | -------- |
|
||||
| reranking_enable | boolean | | Yes |
|
||||
| reranking_mode | string | | No |
|
||||
| reranking_model | [DatasetRerankingModelResponse](#datasetrerankingmodelresponse) | | Yes |
|
||||
| score_threshold | number | | No |
|
||||
| score_threshold_enabled | boolean | | Yes |
|
||||
| search_method | string | | Yes |
|
||||
| top_k | integer | | Yes |
|
||||
| weights | [DatasetWeightedScoreResponse](#datasetweightedscoreresponse) | | No |
|
||||
|
||||
#### DatasetSummaryIndexSettingResponse
|
||||
|
||||
| Name | Type | Description | Required |
|
||||
| ---- | ---- | ----------- | -------- |
|
||||
| enable | boolean | | No |
|
||||
| model_name | string | | No |
|
||||
| model_provider_name | string | | No |
|
||||
| summary_prompt | string | | No |
|
||||
|
||||
#### DatasetTagResponse
|
||||
|
||||
| Name | Type | Description | Required |
|
||||
| ---- | ---- | ----------- | -------- |
|
||||
| id | string | | Yes |
|
||||
| name | string | | Yes |
|
||||
| type | string | | Yes |
|
||||
|
||||
#### DatasetUpdatePayload
|
||||
|
||||
| Name | Type | Description | Required |
|
||||
@@ -11865,6 +12065,14 @@ Condition detail
|
||||
| embedding_provider_name | string | | No |
|
||||
| vector_weight | number | | No |
|
||||
|
||||
#### DatasetVectorSettingResponse
|
||||
|
||||
| Name | Type | Description | Required |
|
||||
| ---- | ---- | ----------- | -------- |
|
||||
| embedding_model_name | string | | Yes |
|
||||
| embedding_provider_name | string | | Yes |
|
||||
| vector_weight | number | | Yes |
|
||||
|
||||
#### DatasetWeightedScore
|
||||
|
||||
| Name | Type | Description | Required |
|
||||
@@ -11873,6 +12081,14 @@ Condition detail
|
||||
| vector_setting | [DatasetVectorSetting](#datasetvectorsetting) | | No |
|
||||
| weight_type | string | | No |
|
||||
|
||||
#### DatasetWeightedScoreResponse
|
||||
|
||||
| Name | Type | Description | Required |
|
||||
| ---- | ---- | ----------- | -------- |
|
||||
| keyword_setting | [DatasetKeywordSettingResponse](#datasetkeywordsettingresponse) | | Yes |
|
||||
| vector_setting | [DatasetVectorSettingResponse](#datasetvectorsettingresponse) | | Yes |
|
||||
| weight_type | string | | Yes |
|
||||
|
||||
#### DatasourceCredentialDeletePayload
|
||||
|
||||
| Name | Type | Description | Required |
|
||||
@@ -12066,6 +12282,29 @@ Request payload for bulk downloading documents as a zip archive.
|
||||
| ---- | ---- | ----------- | -------- |
|
||||
| document_ids | [ string ] | | Yes |
|
||||
|
||||
#### DocumentStatusListResponse
|
||||
|
||||
| Name | Type | Description | Required |
|
||||
| ---- | ---- | ----------- | -------- |
|
||||
| data | [ [DocumentStatusResponse](#documentstatusresponse) ] | | Yes |
|
||||
|
||||
#### DocumentStatusResponse
|
||||
|
||||
| Name | Type | Description | Required |
|
||||
| ---- | ---- | ----------- | -------- |
|
||||
| cleaning_completed_at | integer | | Yes |
|
||||
| completed_at | integer | | Yes |
|
||||
| completed_segments | integer | | No |
|
||||
| error | string | | Yes |
|
||||
| id | string | | Yes |
|
||||
| indexing_status | string | | Yes |
|
||||
| parsing_completed_at | integer | | Yes |
|
||||
| paused_at | integer | | Yes |
|
||||
| processing_started_at | integer | | Yes |
|
||||
| splitting_completed_at | integer | | Yes |
|
||||
| stopped_at | integer | | Yes |
|
||||
| total_segments | integer | | No |
|
||||
|
||||
#### DocumentWithSegmentsResponse
|
||||
|
||||
| Name | Type | Description | Required |
|
||||
@@ -12310,6 +12549,13 @@ Request payload for bulk downloading documents as a zip archive.
|
||||
| ---- | ---- | ----------- | -------- |
|
||||
| environment_variables | [ object ] | Environment variables for the draft workflow | Yes |
|
||||
|
||||
#### ErrorDocsResponse
|
||||
|
||||
| Name | Type | Description | Required |
|
||||
| ---- | ---- | ----------- | -------- |
|
||||
| data | [ [DocumentStatusResponse](#documentstatusresponse) ] | | Yes |
|
||||
| total | integer | | Yes |
|
||||
|
||||
#### ExecutionContentType
|
||||
|
||||
| Name | Type | Description | Required |
|
||||
@@ -12746,6 +12992,29 @@ Request payload for bulk downloading documents as a zip archive.
|
||||
| info_list | object | | Yes |
|
||||
| process_rule | object | | Yes |
|
||||
|
||||
#### IndexingEstimatePreviewItemResponse
|
||||
|
||||
| Name | Type | Description | Required |
|
||||
| ---- | ---- | ----------- | -------- |
|
||||
| child_chunks | [ string ] | | No |
|
||||
| content | string | | Yes |
|
||||
| summary | string | | No |
|
||||
|
||||
#### IndexingEstimateQaPreviewItemResponse
|
||||
|
||||
| Name | Type | Description | Required |
|
||||
| ---- | ---- | ----------- | -------- |
|
||||
| answer | string | | Yes |
|
||||
| question | string | | Yes |
|
||||
|
||||
#### IndexingEstimateResponse
|
||||
|
||||
| Name | Type | Description | Required |
|
||||
| ---- | ---- | ----------- | -------- |
|
||||
| preview | [ [IndexingEstimatePreviewItemResponse](#indexingestimatepreviewitemresponse) ] | | Yes |
|
||||
| qa_preview | [ [IndexingEstimateQaPreviewItemResponse](#indexingestimateqapreviewitemresponse) ] | | No |
|
||||
| total_segments | integer | | Yes |
|
||||
|
||||
#### InfoList
|
||||
|
||||
| Name | Type | Description | Required |
|
||||
@@ -13649,6 +13918,12 @@ Form input definition.
|
||||
| model | string | | Yes |
|
||||
| model_type | [ModelType](#modeltype) | | Yes |
|
||||
|
||||
#### PartialMemberListResponse
|
||||
|
||||
| Name | Type | Description | Required |
|
||||
| ---- | ---- | ----------- | -------- |
|
||||
| data | [ string ] | | Yes |
|
||||
|
||||
#### PartnerTenantsPayload
|
||||
|
||||
| Name | Type | Description | Required |
|
||||
@@ -13901,12 +14176,25 @@ Form input definition.
|
||||
| ---- | ---- | ----------- | -------- |
|
||||
| redirect_url | string | | Yes |
|
||||
|
||||
#### RelatedAppList
|
||||
#### RelatedAppListResponse
|
||||
|
||||
| Name | Type | Description | Required |
|
||||
| ---- | ---- | ----------- | -------- |
|
||||
| data | [ [AppDetailKernel](#appdetailkernel) ] | | No |
|
||||
| total | integer | | No |
|
||||
| data | [ [RelatedAppResponse](#relatedappresponse) ] | | Yes |
|
||||
| total | integer | | Yes |
|
||||
|
||||
#### RelatedAppResponse
|
||||
|
||||
| Name | Type | Description | Required |
|
||||
| ---- | ---- | ----------- | -------- |
|
||||
| description | string | | Yes |
|
||||
| icon | string | | Yes |
|
||||
| icon_background | string | | Yes |
|
||||
| icon_type | string | | Yes |
|
||||
| icon_url | string | | No |
|
||||
| id | string | | Yes |
|
||||
| mode | string | | Yes |
|
||||
| name | string | | Yes |
|
||||
|
||||
#### RemoteFileInfo
|
||||
|
||||
@@ -13954,6 +14242,12 @@ Form input definition.
|
||||
| top_k | integer | | Yes |
|
||||
| weights | [WeightModel](#weightmodel) | | No |
|
||||
|
||||
#### RetrievalSettingResponse
|
||||
|
||||
| Name | Type | Description | Required |
|
||||
| ---- | ---- | ----------- | -------- |
|
||||
| retrieval_method | [ string ] | | Yes |
|
||||
|
||||
#### RosterAgentCreatePayload
|
||||
|
||||
| Name | Type | Description | Required |
|
||||
|
||||
@@ -469,12 +469,22 @@ Resource for getting datasets
|
||||
|
||||
List all datasets
|
||||
|
||||
##### Parameters
|
||||
|
||||
| Name | Located in | Description | Required | Schema |
|
||||
| ---- | ---------- | ----------- | -------- | ------ |
|
||||
| include_all | query | Include all datasets | No | boolean |
|
||||
| keyword | query | Search keyword | No | string |
|
||||
| limit | query | Number of items per page | No | integer |
|
||||
| page | query | Page number | No | integer |
|
||||
| tag_ids | query | Filter by tag IDs | No | [ string ] |
|
||||
|
||||
##### Responses
|
||||
|
||||
| Code | Description |
|
||||
| ---- | ----------- |
|
||||
| 200 | Datasets retrieved successfully |
|
||||
| 401 | Unauthorized - invalid API token |
|
||||
| Code | Description | Schema |
|
||||
| ---- | ----------- | ------ |
|
||||
| 200 | Datasets retrieved successfully | [DatasetListResponse](#datasetlistresponse) |
|
||||
| 401 | Unauthorized - invalid API token | |
|
||||
|
||||
#### POST
|
||||
##### Summary
|
||||
@@ -493,11 +503,11 @@ Create a new dataset
|
||||
|
||||
##### Responses
|
||||
|
||||
| Code | Description |
|
||||
| ---- | ----------- |
|
||||
| 200 | Dataset created successfully |
|
||||
| 400 | Bad request - invalid parameters |
|
||||
| 401 | Unauthorized - invalid API token |
|
||||
| Code | Description | Schema |
|
||||
| ---- | ----------- | ------ |
|
||||
| 200 | Dataset created successfully | [DatasetDetailResponse](#datasetdetailresponse) |
|
||||
| 400 | Bad request - invalid parameters | |
|
||||
| 401 | Unauthorized - invalid API token | |
|
||||
|
||||
### /datasets/pipeline/file-upload
|
||||
|
||||
@@ -557,10 +567,10 @@ Get all knowledge type tags
|
||||
|
||||
##### Responses
|
||||
|
||||
| Code | Description |
|
||||
| ---- | ----------- |
|
||||
| 200 | Tags retrieved successfully |
|
||||
| 401 | Unauthorized - invalid API token |
|
||||
| Code | Description | Schema |
|
||||
| ---- | ----------- | ------ |
|
||||
| 200 | Tags retrieved successfully | [KnowledgeTagListResponse](#knowledgetaglistresponse) |
|
||||
| 401 | Unauthorized - invalid API token | |
|
||||
|
||||
#### PATCH
|
||||
##### Description
|
||||
@@ -575,11 +585,11 @@ Update a knowledge type tag
|
||||
|
||||
##### Responses
|
||||
|
||||
| Code | Description |
|
||||
| ---- | ----------- |
|
||||
| 200 | Tag updated successfully |
|
||||
| 401 | Unauthorized - invalid API token |
|
||||
| 403 | Forbidden - insufficient permissions |
|
||||
| Code | Description | Schema |
|
||||
| ---- | ----------- | ------ |
|
||||
| 200 | Tag updated successfully | [KnowledgeTagResponse](#knowledgetagresponse) |
|
||||
| 401 | Unauthorized - invalid API token | |
|
||||
| 403 | Forbidden - insufficient permissions | |
|
||||
|
||||
#### POST
|
||||
##### Summary
|
||||
@@ -598,11 +608,11 @@ Add a knowledge type tag
|
||||
|
||||
##### Responses
|
||||
|
||||
| Code | Description |
|
||||
| ---- | ----------- |
|
||||
| 200 | Tag created successfully |
|
||||
| 401 | Unauthorized - invalid API token |
|
||||
| 403 | Forbidden - insufficient permissions |
|
||||
| Code | Description | Schema |
|
||||
| ---- | ----------- | ------ |
|
||||
| 200 | Tag created successfully | [KnowledgeTagResponse](#knowledgetagresponse) |
|
||||
| 401 | Unauthorized - invalid API token | |
|
||||
| 403 | Forbidden - insufficient permissions | |
|
||||
|
||||
### /datasets/tags/binding
|
||||
|
||||
@@ -696,12 +706,12 @@ Get a specific dataset by ID
|
||||
|
||||
##### Responses
|
||||
|
||||
| Code | Description |
|
||||
| ---- | ----------- |
|
||||
| 200 | Dataset retrieved successfully |
|
||||
| 401 | Unauthorized - invalid API token |
|
||||
| 403 | Forbidden - insufficient permissions |
|
||||
| 404 | Dataset not found |
|
||||
| Code | Description | Schema |
|
||||
| ---- | ----------- | ------ |
|
||||
| 200 | Dataset retrieved successfully | [DatasetDetailWithPartialMembersResponse](#datasetdetailwithpartialmembersresponse) |
|
||||
| 401 | Unauthorized - invalid API token | |
|
||||
| 403 | Forbidden - insufficient permissions | |
|
||||
| 404 | Dataset not found | |
|
||||
|
||||
#### PATCH
|
||||
##### Description
|
||||
@@ -717,12 +727,12 @@ Update an existing dataset
|
||||
|
||||
##### Responses
|
||||
|
||||
| Code | Description |
|
||||
| ---- | ----------- |
|
||||
| 200 | Dataset updated successfully |
|
||||
| 401 | Unauthorized - invalid API token |
|
||||
| 403 | Forbidden - insufficient permissions |
|
||||
| 404 | Dataset not found |
|
||||
| Code | Description | Schema |
|
||||
| ---- | ----------- | ------ |
|
||||
| 200 | Dataset updated successfully | [DatasetDetailWithPartialMembersResponse](#datasetdetailwithpartialmembersresponse) |
|
||||
| 401 | Unauthorized - invalid API token | |
|
||||
| 403 | Forbidden - insufficient permissions | |
|
||||
| 404 | Dataset not found | |
|
||||
|
||||
### /datasets/{dataset_id}/document/create-by-file
|
||||
|
||||
@@ -1629,10 +1639,10 @@ Get tags bound to a specific dataset
|
||||
|
||||
##### Responses
|
||||
|
||||
| Code | Description |
|
||||
| ---- | ----------- |
|
||||
| 200 | Tags retrieved successfully |
|
||||
| 401 | Unauthorized - invalid API token |
|
||||
| Code | Description | Schema |
|
||||
| ---- | ----------- | ------ |
|
||||
| 200 | Tags retrieved successfully | [DatasetBoundTagListResponse](#datasetboundtaglistresponse) |
|
||||
| 401 | Unauthorized - invalid API token | |
|
||||
|
||||
### /end-users/{end_user_id}
|
||||
|
||||
@@ -2279,14 +2289,19 @@ Condition detail
|
||||
| limit | integer | Number of variables to return | No |
|
||||
| variable_name | string | Filter variables by name | No |
|
||||
|
||||
#### DataSetTag
|
||||
#### DatasetBoundTagListResponse
|
||||
|
||||
| Name | Type | Description | Required |
|
||||
| ---- | ---- | ----------- | -------- |
|
||||
| data | [ [DatasetBoundTagResponse](#datasetboundtagresponse) ] | | Yes |
|
||||
| total | integer | | Yes |
|
||||
|
||||
#### DatasetBoundTagResponse
|
||||
|
||||
| Name | Type | Description | Required |
|
||||
| ---- | ---- | ----------- | -------- |
|
||||
| binding_count | string | | No |
|
||||
| id | string | | Yes |
|
||||
| name | string | | Yes |
|
||||
| type | string | | Yes |
|
||||
|
||||
#### DatasetCreatePayload
|
||||
|
||||
@@ -2304,6 +2319,127 @@ Condition detail
|
||||
| retrieval_model | [RetrievalModel](#retrievalmodel) | | No |
|
||||
| summary_index_setting | object | | No |
|
||||
|
||||
#### DatasetDetailResponse
|
||||
|
||||
| Name | Type | Description | Required |
|
||||
| ---- | ---- | ----------- | -------- |
|
||||
| app_count | integer | | Yes |
|
||||
| author_name | string | | Yes |
|
||||
| built_in_field_enabled | boolean | | Yes |
|
||||
| chunk_structure | string | | Yes |
|
||||
| created_at | integer | | Yes |
|
||||
| created_by | string | | Yes |
|
||||
| data_source_type | string | | Yes |
|
||||
| description | string | | Yes |
|
||||
| doc_form | string | | Yes |
|
||||
| doc_metadata | [ [DatasetDocMetadataResponse](#datasetdocmetadataresponse) ] | | Yes |
|
||||
| document_count | integer | | Yes |
|
||||
| embedding_available | boolean | | No |
|
||||
| embedding_model | string | | Yes |
|
||||
| embedding_model_provider | string | | Yes |
|
||||
| enable_api | boolean | | Yes |
|
||||
| external_knowledge_info | [DatasetExternalKnowledgeInfoResponse](#datasetexternalknowledgeinforesponse) | | Yes |
|
||||
| external_retrieval_model | [DatasetExternalRetrievalModelResponse](#datasetexternalretrievalmodelresponse) | | Yes |
|
||||
| icon_info | [DatasetIconInfoResponse](#dataseticoninforesponse) | | Yes |
|
||||
| id | string | | Yes |
|
||||
| indexing_technique | string | | Yes |
|
||||
| is_multimodal | boolean | | Yes |
|
||||
| is_published | boolean | | Yes |
|
||||
| name | string | | Yes |
|
||||
| permission | string | | Yes |
|
||||
| pipeline_id | string | | Yes |
|
||||
| provider | string | | Yes |
|
||||
| retrieval_model_dict | [DatasetRetrievalModelResponse](#datasetretrievalmodelresponse) | | Yes |
|
||||
| runtime_mode | string | | Yes |
|
||||
| summary_index_setting | [DatasetSummaryIndexSettingResponse](#datasetsummaryindexsettingresponse) | | Yes |
|
||||
| tags | [ [DatasetTagResponse](#datasettagresponse) ] | | Yes |
|
||||
| total_available_documents | integer | | Yes |
|
||||
| total_documents | integer | | Yes |
|
||||
| updated_at | integer | | Yes |
|
||||
| updated_by | string | | Yes |
|
||||
| word_count | integer | | Yes |
|
||||
|
||||
#### DatasetDetailWithPartialMembersResponse
|
||||
|
||||
| Name | Type | Description | Required |
|
||||
| ---- | ---- | ----------- | -------- |
|
||||
| app_count | integer | | Yes |
|
||||
| author_name | string | | Yes |
|
||||
| built_in_field_enabled | boolean | | Yes |
|
||||
| chunk_structure | string | | Yes |
|
||||
| created_at | integer | | Yes |
|
||||
| created_by | string | | Yes |
|
||||
| data_source_type | string | | Yes |
|
||||
| description | string | | Yes |
|
||||
| doc_form | string | | Yes |
|
||||
| doc_metadata | [ [DatasetDocMetadataResponse](#datasetdocmetadataresponse) ] | | Yes |
|
||||
| document_count | integer | | Yes |
|
||||
| embedding_available | boolean | | No |
|
||||
| embedding_model | string | | Yes |
|
||||
| embedding_model_provider | string | | Yes |
|
||||
| enable_api | boolean | | Yes |
|
||||
| external_knowledge_info | [DatasetExternalKnowledgeInfoResponse](#datasetexternalknowledgeinforesponse) | | Yes |
|
||||
| external_retrieval_model | [DatasetExternalRetrievalModelResponse](#datasetexternalretrievalmodelresponse) | | Yes |
|
||||
| icon_info | [DatasetIconInfoResponse](#dataseticoninforesponse) | | Yes |
|
||||
| id | string | | Yes |
|
||||
| indexing_technique | string | | Yes |
|
||||
| is_multimodal | boolean | | Yes |
|
||||
| is_published | boolean | | Yes |
|
||||
| name | string | | Yes |
|
||||
| partial_member_list | [ string ] | | No |
|
||||
| permission | string | | Yes |
|
||||
| pipeline_id | string | | Yes |
|
||||
| provider | string | | Yes |
|
||||
| retrieval_model_dict | [DatasetRetrievalModelResponse](#datasetretrievalmodelresponse) | | Yes |
|
||||
| runtime_mode | string | | Yes |
|
||||
| summary_index_setting | [DatasetSummaryIndexSettingResponse](#datasetsummaryindexsettingresponse) | | Yes |
|
||||
| tags | [ [DatasetTagResponse](#datasettagresponse) ] | | Yes |
|
||||
| total_available_documents | integer | | Yes |
|
||||
| total_documents | integer | | Yes |
|
||||
| updated_at | integer | | Yes |
|
||||
| updated_by | string | | Yes |
|
||||
| word_count | integer | | Yes |
|
||||
|
||||
#### DatasetDocMetadataResponse
|
||||
|
||||
| Name | Type | Description | Required |
|
||||
| ---- | ---- | ----------- | -------- |
|
||||
| id | string | | Yes |
|
||||
| name | string | | Yes |
|
||||
| type | string | | Yes |
|
||||
|
||||
#### DatasetExternalKnowledgeInfoResponse
|
||||
|
||||
| Name | Type | Description | Required |
|
||||
| ---- | ---- | ----------- | -------- |
|
||||
| external_knowledge_api_endpoint | string | | Yes |
|
||||
| external_knowledge_api_id | string | | Yes |
|
||||
| external_knowledge_api_name | string | | Yes |
|
||||
| external_knowledge_id | string | | Yes |
|
||||
|
||||
#### DatasetExternalRetrievalModelResponse
|
||||
|
||||
| Name | Type | Description | Required |
|
||||
| ---- | ---- | ----------- | -------- |
|
||||
| score_threshold | number | | Yes |
|
||||
| score_threshold_enabled | boolean | | No |
|
||||
| top_k | integer | | Yes |
|
||||
|
||||
#### DatasetIconInfoResponse
|
||||
|
||||
| Name | Type | Description | Required |
|
||||
| ---- | ---- | ----------- | -------- |
|
||||
| icon | string | | Yes |
|
||||
| icon_background | string | | No |
|
||||
| icon_type | string | | Yes |
|
||||
| icon_url | string | | No |
|
||||
|
||||
#### DatasetKeywordSettingResponse
|
||||
|
||||
| Name | Type | Description | Required |
|
||||
| ---- | ---- | ----------- | -------- |
|
||||
| keyword_weight | number | | Yes |
|
||||
|
||||
#### DatasetListQuery
|
||||
|
||||
| Name | Type | Description | Required |
|
||||
@@ -2314,6 +2450,16 @@ Condition detail
|
||||
| page | integer | Page number | No |
|
||||
| tag_ids | [ string ] | Filter by tag IDs | No |
|
||||
|
||||
#### DatasetListResponse
|
||||
|
||||
| Name | Type | Description | Required |
|
||||
| ---- | ---- | ----------- | -------- |
|
||||
| data | [ [DatasetDetailResponse](#datasetdetailresponse) ] | | Yes |
|
||||
| has_more | boolean | | Yes |
|
||||
| limit | integer | | Yes |
|
||||
| page | integer | | Yes |
|
||||
| total | integer | | Yes |
|
||||
|
||||
#### DatasetMetadataActionResponse
|
||||
|
||||
| Name | Type | Description | Required |
|
||||
@@ -2363,6 +2509,43 @@ Condition detail
|
||||
| ---- | ---- | ----------- | -------- |
|
||||
| DatasetPermissionEnum | string | | |
|
||||
|
||||
#### DatasetRerankingModelResponse
|
||||
|
||||
| Name | Type | Description | Required |
|
||||
| ---- | ---- | ----------- | -------- |
|
||||
| reranking_model_name | string | | No |
|
||||
| reranking_provider_name | string | | No |
|
||||
|
||||
#### DatasetRetrievalModelResponse
|
||||
|
||||
| Name | Type | Description | Required |
|
||||
| ---- | ---- | ----------- | -------- |
|
||||
| reranking_enable | boolean | | Yes |
|
||||
| reranking_mode | string | | No |
|
||||
| reranking_model | [DatasetRerankingModelResponse](#datasetrerankingmodelresponse) | | Yes |
|
||||
| score_threshold | number | | No |
|
||||
| score_threshold_enabled | boolean | | Yes |
|
||||
| search_method | string | | Yes |
|
||||
| top_k | integer | | Yes |
|
||||
| weights | [DatasetWeightedScoreResponse](#datasetweightedscoreresponse) | | No |
|
||||
|
||||
#### DatasetSummaryIndexSettingResponse
|
||||
|
||||
| Name | Type | Description | Required |
|
||||
| ---- | ---- | ----------- | -------- |
|
||||
| enable | boolean | | No |
|
||||
| model_name | string | | No |
|
||||
| model_provider_name | string | | No |
|
||||
| summary_prompt | string | | No |
|
||||
|
||||
#### DatasetTagResponse
|
||||
|
||||
| Name | Type | Description | Required |
|
||||
| ---- | ---- | ----------- | -------- |
|
||||
| id | string | | Yes |
|
||||
| name | string | | Yes |
|
||||
| type | string | | Yes |
|
||||
|
||||
#### DatasetUpdatePayload
|
||||
|
||||
| Name | Type | Description | Required |
|
||||
@@ -2379,6 +2562,22 @@ Condition detail
|
||||
| permission | [DatasetPermissionEnum](#datasetpermissionenum) | | No |
|
||||
| retrieval_model | [RetrievalModel](#retrievalmodel) | | No |
|
||||
|
||||
#### DatasetVectorSettingResponse
|
||||
|
||||
| Name | Type | Description | Required |
|
||||
| ---- | ---- | ----------- | -------- |
|
||||
| embedding_model_name | string | | Yes |
|
||||
| embedding_provider_name | string | | Yes |
|
||||
| vector_weight | number | | Yes |
|
||||
|
||||
#### DatasetWeightedScoreResponse
|
||||
|
||||
| Name | Type | Description | Required |
|
||||
| ---- | ---- | ----------- | -------- |
|
||||
| keyword_setting | [DatasetKeywordSettingResponse](#datasetkeywordsettingresponse) | | Yes |
|
||||
| vector_setting | [DatasetVectorSettingResponse](#datasetvectorsettingresponse) | | Yes |
|
||||
| weight_type | string | | Yes |
|
||||
|
||||
#### DatasourceNodeRunPayload
|
||||
|
||||
| Name | Type | Description | Required |
|
||||
@@ -2522,6 +2721,21 @@ Note: The SQLAlchemy model defines an `is_anonymous` property for Flask-Login se
|
||||
| ---- | ---- | ----------- | -------- |
|
||||
| JsonValue | | | |
|
||||
|
||||
#### KnowledgeTagListResponse
|
||||
|
||||
| Name | Type | Description | Required |
|
||||
| ---- | ---- | ----------- | -------- |
|
||||
| KnowledgeTagListResponse | array | | |
|
||||
|
||||
#### KnowledgeTagResponse
|
||||
|
||||
| Name | Type | Description | Required |
|
||||
| ---- | ---- | ----------- | -------- |
|
||||
| binding_count | string | | No |
|
||||
| id | string | | Yes |
|
||||
| name | string | | Yes |
|
||||
| type | string | | Yes |
|
||||
|
||||
#### MessageFeedbackPayload
|
||||
|
||||
| Name | Type | Description | Required |
|
||||
|
||||
Reference in New Issue
Block a user