{"openapi":"3.1.0","info":{"title":"Apizie","version":"2.0.0","description":"One API key, one envelope, many public data sources."},"servers":[{"url":"https://zieapi.vercel.app"}],"security":[{"ApiKeyAuth":[]}],"paths":{"/v1/cloud:aliyun-milvusknowledgebase/add-documents":{"post":{"operationId":"cloud_aliyun_milvusknowledgebase_add_documents","summary":"Registers files that have been uploaded to knowledge base storage as knowledge base documents and…","description":"POST /api/v1/datasets/{datasetId}/documents/addDocuments","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["datasetId"],"properties":{"Dedup":{"type":"object","description":"The deduplication configuration"},"Documents":{"type":"array","description":"The list of documents"},"ImportType":{"type":"string","description":"The import type"},"KnowledgeBaseId":{"type":"string","description":"The knowledge base ID"},"MetaFields":{"type":"string","description":"The batch label configuration. The key must be a label field that is already defined in the knowledge base. The value supports string,…"},"StrategyId":{"type":"string","description":"The processing strategy ID"},"dingTalkConfiguration":{"type":"object","description":"Not supported. Ignore this parameter"},"parentId":{"type":"string","description":"Defaults to root when omitted"},"datasetId":{"type":"string","description":"The knowledge base ID"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-milvusknowledgebase/get-knowledge-base-pre-signed-url":{"post":{"operationId":"cloud_aliyun_milvusknowledgebase_get_knowledge_base_pre_signed_url","summary":"Generates an OSS pre-signed PUT URL pointing to the knowledge base dedicated storage for each file in…","description":"POST /api/v1/datasets/{datasetId}/getKnowledgeBasePreSignedUrl","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["datasetId"],"properties":{"Documents":{"type":"array","description":"The list of files to upload. You can specify 1 to 100 files"},"ExpiresIn":{"type":"integer","description":"The validity period of the pre-signed URL in seconds. Default value: `3600`"},"KnowledgeBaseId":{"type":"string","description":"The knowledge base ID. Either this parameter or datasetId must be specified. This parameter takes priority"},"datasetId":{"type":"string","description":"The knowledge base ID"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-milvusknowledgebase/search-knowledge-base":{"post":{"operationId":"cloud_aliyun_milvusknowledgebase_search_knowledge_base","summary":"Retrieves documents from a knowledge base","description":"POST /api/v1/knowledge-bases/{knowledgeBaseId}/search","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["knowledgeBaseId"],"properties":{"knowledgeBaseId":{"type":"string","description":"The knowledge base ID"},"documentIds":{"type":"array","description":"The list of document IDs"},"enableKnowledgeGraph":{"type":"string","description":"Specifies whether to enable the knowledge graph"},"image":{"type":"object","description":"The image retrieval input"},"pageNumber":{"type":"integer","description":"The page number"},"pageSize":{"type":"integer","description":"The number of entries per page"},"query":{"type":"string","description":"The retrieval query"},"rerankModelId":{"type":"integer","description":"The reranking model ID"},"rerankModelName":{"type":"string","description":"The name of a reranking model that the tenant has activated. If both rerankModelName and rerankModelId are specified, this parameter takes…"},"retrievalConfig":{"type":"object","description":"The retrieval configuration"},"tagFilter":{"type":"object","description":"The tag filter"},"version":{"type":"string","description":"The knowledge base version"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-milvusknowledgebase/version":{"post":{"operationId":"cloud_aliyun_milvusknowledgebase_version","summary":"version","description":"POST /","tags":["cloud"],"parameters":[],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}}},"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"x-api-key"}},"schemas":{"RunEnvelope":{"type":"object","required":["project","data","timestamp"],"properties":{"project":{"type":"string","example":"dev-tools:hash"},"data":{},"timestamp":{"type":"string","format":"date-time"}}},"ErrorEnvelope":{"type":"object","properties":{"content":{},"message":{"type":"string"},"errors":{"type":"array","items":{}},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}}}}}},"responses":{"Error":{"description":"Invalid key, plan gate, rate limit or upstream failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}}}}