diff --git a/.changeset/gentle-cobras-drum.md b/.changeset/gentle-cobras-drum.md new file mode 100644 index 0000000..59d3ec0 --- /dev/null +++ b/.changeset/gentle-cobras-drum.md @@ -0,0 +1,5 @@ +--- +'openapi-ts-request': patch +--- + +perf: support desc line break #306 diff --git a/.changeset/green-chicken-glow.md b/.changeset/green-chicken-glow.md new file mode 100644 index 0000000..0f1ce73 --- /dev/null +++ b/.changeset/green-chicken-glow.md @@ -0,0 +1,5 @@ +--- +'openapi-ts-request': patch +--- + +fix: fix duplicate type reference error #601 diff --git a/src/generator/serviceGenarator.ts b/src/generator/serviceGenarator.ts index 27a3f5b..55122c4 100644 --- a/src/generator/serviceGenarator.ts +++ b/src/generator/serviceGenarator.ts @@ -106,6 +106,8 @@ export default class ServiceGenerator { protected interfaceTPConfigs: ITypeItem[] = []; // 记录每个类型被哪些模块使用（用于拆分类型文件） protected typeModuleMap: Map> = new Map(); + // 从原始 schema key 到最终类型名称的映射（用于处理重名情况） + protected schemaKeyToTypeNameMap: Map = new Map(); constructor(config: GenerateServiceProps, openAPIData: OpenAPIObject) { this.config = { @@ -268,10 +270,16 @@ export default class ServiceGenerator { const reactQueryMode = this.config.reactQueryMode; const reactQueryFileName = displayReactQueryFileName(reactQueryMode); + // 先处理重复的 typeName，建立类型名称映射（在生成 service controller 之前） + this.interfaceTPConfigs = this.getInterfaceTPConfigs(); + this.schemaKeyToTypeNameMap = handleDuplicateTypeNames( + this.interfaceTPConfigs + ); + if (!isOnlyGenTypeScriptType) { const prettierError = []; - // 生成 service controller 文件 + // 生成 service controller 文件（此时类型名称映射已经建立） this.getServiceTPConfigs().forEach((tp) => { const { list, ...restTp } = tp; const payload: Omit & @@ -335,10 +343,6 @@ export default class ServiceGenerator { } } - // 处理重复的 typeName - this.interfaceTPConfigs = this.getInterfaceTPConfigs(); - handleDuplicateTypeNames(this.interfaceTPConfigs); - // 生成 ts 类型声明 if (!isGenJavaScript) { if (this.config.isSplitTypesByModule) { @@ -414,7 +418,10 @@ export default class ServiceGenerator { } ); } else { - // 传统方式：所有类型在一个文件 + // 在生成文件前，对 interfaceTPConfigs 进行排序（因为 getServiceTPConfigs 可能添加了新类型） + this.interfaceTPConfigs.sort((a, b) => + a.typeName.localeCompare(b.typeName) + ); this.genFileFromTemplate( `${interfaceFileName}.ts`, TypescriptFileType.interface, @@ -745,6 +752,7 @@ export default class ServiceGenerator { : '', enumLabelType: isEnum ? (result.enumLabelType as string) : '', description: result.description as string, + originalSchemaKey: schemaKey, // 保存原始 schema key，用于处理重名后的类型映射 }); // 记录 schema 类型归属 @@ -771,7 +779,8 @@ export default class ServiceGenerator { } }); - return lastTypes?.sort((a, b) => a.typeName.localeCompare(b.typeName)); // typeName排序 + return lastTypes; + // return lastTypes?.sort((a, b) => a.typeName.localeCompare(b.typeName)); // typeName排序 } private getServiceTPConfigs() { @@ -963,32 +972,46 @@ export default class ServiceGenerator { }; return { + // 如果 functionName 和 summary 相同，则不显示 summary + ...(() => { + const rawDesc = + functionName === newApi.summary + ? newApi.description || '' + : [ + newApi.summary, + newApi.description, + (newApi.responses?.default as ResponseObject) + ?.description + ? `返回值: ${(newApi.responses?.default as ResponseObject).description}` + : '', + ] + .filter((s) => s) + .join(' '); + const hasLineBreak = lineBreakReg.test(rawDesc); + // 格式化描述文本，让描述支持换行 + const desc = hasLineBreak + ? '\n * ' + rawDesc.split('\n').join('\n * ') + '\n *' + : rawDesc; + // 如果描述有换行，pathInComment 结尾加换行使 */ 单独一行 + const pathInComment = hasLineBreak + ? formattedPath.replace(/\*/g, '*') + '\n' + : formattedPath.replace(/\*/g, '*'); + const originApifoxRunLink = newApi?.['x-run-in-apifox']; + const apifoxRunLink = + hasLineBreak && originApifoxRunLink + ? ' * ' + originApifoxRunLink + '\n' + : originApifoxRunLink; + return { desc, pathInComment, apifoxRunLink }; + })(), ...newApi, functionName: this.config.isCamelCase ? camelCase(functionName) : functionName, typeName: this.getFunctionParamsTypeName(newApi), path: getPrefixPath(), - pathInComment: formattedPath.replace(/\*/g, '*'), - apifoxRunLink: newApi?.['x-run-in-apifox'], hasPathVariables: formattedPath.includes('{'), hasApiPrefix: !!this.config.apiPrefix, method: newApi.method, - // 如果 functionName 和 summary 相同，则不显示 summary - desc: - functionName === newApi.summary - ? (newApi.description || '').replace(lineBreakReg, '') - : [ - newApi.summary, - newApi.description, - (newApi.responses?.default as ResponseObject) - ?.description - ? `返回值: ${(newApi.responses?.default as ResponseObject).description}` - : '', - ] - .filter((s) => s) - .join(' ') - .replace(lineBreakReg, ''), hasHeader: !!params?.header || !!body?.mediaType, params: finalParams, hasParams: Boolean(keys(finalParams).length), @@ -1196,13 +1219,21 @@ export default class ServiceGenerator { private getType(schemaObject: ISchemaObject, namespace?: string) { const customTypeHookFunc = this.config.hook?.customType; const schemas = this.openAPIData.components?.schemas; + const schemaKeyToTypeNameMap = this.schemaKeyToTypeNameMap; if (customTypeHookFunc) { + // 为自定义 hook 提供支持映射的 originGetType + const originGetTypeWithMapping = ( + schema: ISchemaObject, + ns?: string, + s?: typeof schemas + ) => getDefaultType(schema, ns, s, schemaKeyToTypeNameMap); + const type = customTypeHookFunc({ schemaObject, namespace, schemas, - originGetType: getDefaultType, + originGetType: originGetTypeWithMapping, }); if (typeof type === 'string') { @@ -1210,7 +1241,12 @@ export default class ServiceGenerator { } } - return getDefaultType(schemaObject, namespace, schemas); + return getDefaultType( + schemaObject, + namespace, + schemas, + schemaKeyToTypeNameMap + ); } private getFunctionParamsTypeName(data: APIDataType) { @@ -1684,6 +1720,15 @@ export default class ServiceGenerator { // 处理公共类型的依赖：如果公共类型依赖某个模块类型，将该类型也移到公共类型 Helper.moveCommonTypeDependenciesToCommon({ moduleTypes, commonTypes }); + // 对每个模块的类型列表进行排序 + moduleTypes.forEach((types) => { + types.sort((a, b) => a.typeName.localeCompare(b.typeName)); + }); + + // 对公共类型和枚举类型进行排序 + commonTypes.sort((a, b) => a.typeName.localeCompare(b.typeName)); + enumTypes.sort((a, b) => a.typeName.localeCompare(b.typeName)); + return { moduleTypes, commonTypes, enumTypes }; } } diff --git a/src/generator/serviceGeneratorHelper.ts b/src/generator/serviceGeneratorHelper.ts index b0161ce..2a41ee4 100644 --- a/src/generator/serviceGeneratorHelper.ts +++ b/src/generator/serviceGeneratorHelper.ts @@ -116,7 +116,7 @@ export function resolveEnumObject(params: { const getActualType = (type: typeof schemaObject.type): string => { if (Array.isArray(type)) { // 如果是数组，返回第一个非 null 类型 - return type.find((t) => t !== 'null') || 'string'; + return (type.find((t) => t !== 'null') as string | undefined) || 'string'; } return type; }; @@ -187,11 +187,17 @@ export function resolveEnumObject(params: { } } + // 格式化描述文本，让描述支持换行 + const formattedDescription = + schemaObject.description && lineBreakReg.test(schemaObject.description) + ? '\n * ' + schemaObject.description.split('\n').join('\n * ') + '\n' + : schemaObject.description; + return { isEnum: true, type: Array.isArray(enumArray) ? enumStr : 'string', enumLabelType: enumLabelTypeStr, - description: schemaObject.description, + description: formattedDescription, }; } @@ -241,8 +247,11 @@ export function getProps(params: { // 获取描述信息，如果是 $ref 引用，尝试获取引用对象的描述 let desc = [schema.title, schema.description] .filter((item) => item) - .join(' ') - .replace(lineBreakReg, ''); + .join(' '); + // 格式化描述文本，让描述支持换行 + desc = lineBreakReg.test(desc) + ? '\n * ' + desc.split('\n').join('\n * ') + '\n' + : desc; // 如果是 $ref 引用，尝试获取引用对象的描述 if (isReferenceObject(schema) && openAPIData) { @@ -251,10 +260,13 @@ export function getProps(params: { refName ] as SchemaObject; if (refSchema) { - const refDesc = [refSchema.title, refSchema.description] + let refDesc = [refSchema.title, refSchema.description] .filter((item) => item) - .join(' ') - .replace(lineBreakReg, ''); + .join(' '); + // 格式化描述文本，让描述支持换行 + refDesc = lineBreakReg.test(refDesc) + ? '\n * ' + refDesc.split('\n').join('\n * ') + '\n' + : refDesc; if (refDesc) { desc = desc + refDesc; } @@ -348,7 +360,9 @@ export function resolveRefObject(params: { // 处理 OpenAPI 3.1 的 type 数组情况 if (Array.isArray(schemaObj.type)) { // 如果是数组，使用第一个非 null 类型 - resolvedType = schemaObj.type.find((t) => t !== 'null') || 'string'; + resolvedType = + (schemaObj.type.find((t) => t !== 'null') as string | undefined) || + 'string'; } else { resolvedType = schemaObj.type; } @@ -420,7 +434,7 @@ export function getResponsesType(params: { // 生成带注释的类型定义 return formattedDescription - ? ` /**\n * ${formattedDescription}\n */\n ${statusCode}: ${lastType};` + ? ` /**\n * ${formattedDescription}\n */\n ${statusCode}: ${lastType};` : ` ${statusCode}: ${lastType};`; } ); diff --git a/src/generator/type.ts b/src/generator/type.ts index 21f6ba2..da03e26 100644 --- a/src/generator/type.ts +++ b/src/generator/type.ts @@ -38,6 +38,8 @@ export interface ITypeItem { description?: string; /** 类型所属的模块名称（用于拆分类型文件） */ belongsToModules?: Set; + /** 原始的 schema key（用于处理重名后的类型映射） */ + originalSchemaKey?: string; } export type ICustomSchemaObject = SchemaObject & { isAllowed?: boolean }; diff --git a/src/generator/util.ts b/src/generator/util.ts index f0bc9c5..55348a5 100644 --- a/src/generator/util.ts +++ b/src/generator/util.ts @@ -114,6 +114,30 @@ export function getRefName(refObject: ReferenceObject | string) { return resolveTypeName(getLastRefName(refObject.$ref)); } +/** + * 获取引用类型名称，支持类型名称映射 + * @param refObject 引用对象 + * @param schemaKeyToTypeNameMap 从原始 schema key 到最终类型名称的映射（处理重名情况） + * @returns 最终的类型名称 + */ +export function getRefNameWithMapping( + refObject: ReferenceObject | string, + schemaKeyToTypeNameMap?: Map +) { + if (!isReferenceObject(refObject)) { + return refObject; + } + + const schemaKey = getLastRefName(refObject.$ref); + // 如果存在映射，使用映射后的类型名称 + if (schemaKeyToTypeNameMap?.has(schemaKey)) { + return schemaKeyToTypeNameMap.get(schemaKey); + } + + // 否则使用默认的类型名称解析 + return resolveTypeName(schemaKey); +} + export function getLastRefName(refPath: string = '') { const refPaths = refPath.split('/'); @@ -125,7 +149,8 @@ export function getLastRefName(refPath: string = '') { export function getDefaultType( schemaObject?: ISchemaObject | string, namespace: string = '', - schemas?: ComponentsObject['schemas'] + schemas?: ComponentsObject['schemas'], + schemaKeyToTypeNameMap?: Map ): string { if (isUndefined(schemaObject) || isNull(schemaObject)) { return 'unknown'; @@ -136,8 +161,9 @@ export function getDefaultType( } if (isReferenceObject(schemaObject)) { - // return getRefName(schemaObject); - return [namespace, getRefName(schemaObject)].filter((s) => s).join('.'); + // 使用映射获取正确的类型名称（处理重名情况） + const refName = getRefNameWithMapping(schemaObject, schemaKeyToTypeNameMap); + return [namespace, refName].filter((s) => s).join('.'); } let type = schemaObject?.type; @@ -196,14 +222,24 @@ export function getDefaultType( if (Array.isArray(items)) { const arrayItemType = items .map((subType: Dictionary) => - getDefaultType((subType.schema || subType) as SchemaObject, namespace) + getDefaultType( + (subType.schema || subType) as SchemaObject, + namespace, + schemas, + schemaKeyToTypeNameMap + ) ) .toString(); return `[${arrayItemType}]`; } - const arrayType = getDefaultType(items, namespace); + const arrayType = getDefaultType( + items, + namespace, + schemas, + schemaKeyToTypeNameMap + ); return arrayType.includes(' | ') ? `(${arrayType})[]` : `${arrayType}[]`; } @@ -224,13 +260,17 @@ export function getDefaultType( if (schemaObject.oneOf && schemaObject.oneOf.length) { return schemaObject.oneOf - .map((item) => getDefaultType(item, namespace)) + .map((item) => + getDefaultType(item, namespace, schemas, schemaKeyToTypeNameMap) + ) .join(' | '); } if (schemaObject.anyOf?.length) { return schemaObject.anyOf - .map((item) => getDefaultType(item, namespace)) + .map((item) => + getDefaultType(item, namespace, schemas, schemaKeyToTypeNameMap) + ) .join(' | '); } @@ -241,12 +281,16 @@ export function getDefaultType( const schemaKey = getLastRefName(item.$ref); if ((schemas?.[schemaKey] as SchemaObject)?.enum) { - // return `I${getDefaultType(item, namespace)}`; - return getDefaultType(item, namespace); + return getDefaultType( + item, + namespace, + schemas, + schemaKeyToTypeNameMap + ); } } - return getDefaultType(item, namespace); + return getDefaultType(item, namespace, schemas, schemaKeyToTypeNameMap); }); return `(${allofList.join(' & ')})`; @@ -257,7 +301,8 @@ export function getDefaultType( const type = getDefaultType( schemaObject.additionalProperties, namespace, - schemas + schemas, + schemaKeyToTypeNameMap ); return `Record`; @@ -296,7 +341,9 @@ export function getDefaultType( return ` ${property.description ? `/** ${property.description} */\n` : ''}'${key}'${required ? '' : '?'}: ${getDefaultType( property, - namespace + namespace, + schemas, + schemaKeyToTypeNameMap )}; `; }) .join('')}}`; @@ -333,9 +380,12 @@ function findDuplicateTypeNames(arr: string[]) { export function handleDuplicateTypeNames( interfaceTPConfigs: Array< - Pick + Pick > -) { +): Map { + // 创建从原始 schema key 到最终类型名称的映射 + const schemaKeyToTypeNameMap = new Map(); + const duplicateTypeNames = findDuplicateTypeNames( map(interfaceTPConfigs, (item) => item.typeName) ); @@ -358,6 +408,18 @@ export function handleDuplicateTypeNames( }); }); } + + // 建立映射关系（在处理重名之后） + forEach(interfaceTPConfigs, (interfaceTP) => { + if (interfaceTP.originalSchemaKey) { + schemaKeyToTypeNameMap.set( + interfaceTP.originalSchemaKey, + interfaceTP.typeName + ); + } + }); + + return schemaKeyToTypeNameMap; } // 检测所有path重复区域（prefix） diff --git "a/test/__snapshots__/common/\346\265\213\350\257\225 _COMPUTER SCIENCE_ \350\277\231\344\270\200\347\261\273\347\232\204\346\236\232\344\270\276\345\200\274\345\234\250\347\224\237\346\210\220\347\232\204\347\261\273\345\236\213\344\270\255\344\270\215\346\212\245\351\224\231.snap" "b/test/__snapshots__/common/\346\265\213\350\257\225 _COMPUTER SCIENCE_ \350\277\231\344\270\200\347\261\273\347\232\204\346\236\232\344\270\276\345\200\274\345\234\250\347\224\237\346\210\220\347\232\204\347\261\273\345\236\213\344\270\255\344\270\215\346\212\245\351\224\231.snap" index 58cdfbb..6688528 100644 --- "a/test/__snapshots__/common/\346\265\213\350\257\225 _COMPUTER SCIENCE_ \350\277\231\344\270\200\347\261\273\347\232\204\346\236\232\344\270\276\345\200\274\345\234\250\347\224\237\346\210\220\347\232\204\347\261\273\345\236\213\344\270\255\344\270\215\346\212\245\351\224\231.snap" +++ "b/test/__snapshots__/common/\346\265\213\350\257\225 _COMPUTER SCIENCE_ \350\277\231\344\270\200\347\261\273\347\232\204\346\236\232\344\270\276\345\200\274\345\234\250\347\224\237\346\210\220\347\232\204\347\261\273\345\236\213\344\270\255\344\270\215\346\212\245\351\224\231.snap" @@ -26,7 +26,14 @@ import request from 'axios'; import * as API from './types'; -/** Returns a student object GET /hello */ +/** + * Returns a student object + * name: string + * age: integer + * gender: string + * major: Major + * GET /hello + */ export function helloUsingGet({ options, }: { @@ -51,10 +58,21 @@ export type IGenderEnum = keyof typeof GenderEnum; export type HelloUsingGetResponses = { /** * A student object + * name: string + * age: integer + * gender: string + * major: Major */ 200: Student; }; +/** + * Major enum + * COMPUTER SCIENCE: Computer Science + * MATHEMATICS: Mathematics + * PHYSICS: Physics + * LITERATURE: Literature + */ export enum Major { 'COMPUTER SCIENCE' = 'COMPUTER SCIENCE', 'MATHEMATICS' = 'MATHEMATICS', @@ -68,5 +86,12 @@ export type Student = { name: string; age: number; gender: 'MALE' | 'FEMALE' | 'OTHER'; + /** + * Major enum + * COMPUTER SCIENCE: Computer Science + * MATHEMATICS: Mathematics + * PHYSICS: Physics + * LITERATURE: Literature + */ major: Major; }; diff --git "a/test/__snapshots__/common/\346\265\213\350\257\225\346\214\211\346\250\241\345\235\227\346\213\206\345\210\206\347\261\273\345\236\213\346\226\207\344\273\266.snap" "b/test/__snapshots__/common/\346\265\213\350\257\225\346\214\211\346\250\241\345\235\227\346\213\206\345\210\206\347\261\273\345\236\213\346\226\207\344\273\266.snap" index ae6ec05..bd8ff93 100644 --- "a/test/__snapshots__/common/\346\265\213\350\257\225\346\214\211\346\250\241\345\235\227\346\213\206\345\210\206\347\261\273\345\236\213\346\226\207\344\273\266.snap" +++ "b/test/__snapshots__/common/\346\265\213\350\257\225\346\214\211\346\250\241\345\235\227\346\213\206\345\210\206\347\261\273\345\236\213\346\226\207\344\273\266.snap" @@ -3294,7 +3294,10 @@ export type ChatMessageReq = { export type QuestionRecommendReq = { conversation_id?: string; - /** Query string `json:"query"`Answer string `json:"answer"` */ + /** + * Query string `json:"query"` + * Answer string `json:"answer"` + */ user?: string; }; @@ -3489,12 +3492,28 @@ export type AppDetail = { workspaceID?: string; }; +export type AppModelConfigPromptPrefix = { + background?: string; + role?: string; + switchRecommendedQuestion?: boolean; +}; + export type AppModelConfigs = { configs?: ModelConfigsMap; prePrompt?: string; providerId?: string; }; +export type AppRecommendedContext = { + appID?: string; + appRecommendedContextID?: string; + context?: string; + createdAt?: string; + description?: string; + name?: string; + updatedAt?: string; +}; + export type AppRecommendedContext2 = { context?: string; description?: string; @@ -3868,22 +3887,6 @@ export type WxExtra = { encodingAESKey?: string; token?: string; }; - -export type AppModelConfigPromptPrefix = { - background?: string; - role?: string; - switchRecommendedQuestion?: boolean; -}; - -export type AppRecommendedContext = { - appID?: string; - appRecommendedContextID?: string; - context?: string; - createdAt?: string; - description?: string; - name?: string; - updatedAt?: string; -}; /* eslint-disable */ // @ts-ignore import { queryOptions, useMutation } from '@tanstack/react-query'; @@ -5581,7 +5584,7 @@ export function v1ApiAppAppIdRecommendedContextUsingPost({ }: { // 叠加生成的Param类型 (非body参数openapi默认没有生成对象) params: API.V1ApiAppAppIdRecommendedContextUsingPostParams; - body: API.AppRecommendedContext; + body: API.AppRecommendedContext2; options?: { [key: string]: unknown }; }) { const { appID: param0, ...queryParams } = params; diff --git "a/test/__snapshots__/common/\346\265\213\350\257\225\346\217\217\350\277\260\344\277\241\346\201\257\346\224\257\346\214\201\346\215\242\350\241\214.snap" "b/test/__snapshots__/common/\346\265\213\350\257\225\346\217\217\350\277\260\344\277\241\346\201\257\346\224\257\346\214\201\346\215\242\350\241\214.snap" new file mode 100644 index 0000000..6688528 --- /dev/null +++ "b/test/__snapshots__/common/\346\265\213\350\257\225\346\217\217\350\277\260\344\277\241\346\201\257\346\224\257\346\214\201\346\215\242\350\241\214.snap" @@ -0,0 +1,97 @@ +/* eslint-disable */ +// @ts-ignore +import * as API from './types'; + +export function displayGenderEnum(field: API.GenderEnum) { + return { MALE: 'MALE', FEMALE: 'FEMALE', OTHER: 'OTHER' }[field]; +} + +export function displayMajorEnum(field: API.Major) { + return { + 'COMPUTER SCIENCE': 'COMPUTER SCIENCE', + MATHEMATICS: 'MATHEMATICS', + PHYSICS: 'PHYSICS', + LITERATURE: 'LITERATURE', + }[field]; +} +/* eslint-disable */ +// @ts-ignore +export * from './types'; +export * from './displayEnumLabel'; + +export * from './student'; +/* eslint-disable */ +// @ts-ignore +import request from 'axios'; + +import * as API from './types'; + +/** + * Returns a student object + * name: string + * age: integer + * gender: string + * major: Major + * GET /hello + */ +export function helloUsingGet({ + options, +}: { + options?: { [key: string]: unknown }; +}) { + return request('/hello', { + method: 'GET', + ...(options || {}), + }); +} +/* eslint-disable */ +// @ts-ignore + +export enum GenderEnum { + 'MALE' = 'MALE', + 'FEMALE' = 'FEMALE', + 'OTHER' = 'OTHER', +} + +export type IGenderEnum = keyof typeof GenderEnum; + +export type HelloUsingGetResponses = { + /** + * A student object + * name: string + * age: integer + * gender: string + * major: Major + */ + 200: Student; +}; + +/** + * Major enum + * COMPUTER SCIENCE: Computer Science + * MATHEMATICS: Mathematics + * PHYSICS: Physics + * LITERATURE: Literature + */ +export enum Major { + 'COMPUTER SCIENCE' = 'COMPUTER SCIENCE', + 'MATHEMATICS' = 'MATHEMATICS', + 'PHYSICS' = 'PHYSICS', + 'LITERATURE' = 'LITERATURE', +} + +export type IMajor = keyof typeof Major; + +export type Student = { + name: string; + age: number; + gender: 'MALE' | 'FEMALE' | 'OTHER'; + /** + * Major enum + * COMPUTER SCIENCE: Computer Science + * MATHEMATICS: Mathematics + * PHYSICS: Physics + * LITERATURE: Literature + */ + major: Major; +}; diff --git "a/test/__snapshots__/common/\346\265\213\350\257\225\346\224\257\346\214\201 apifox x-apifox-enum.snap" "b/test/__snapshots__/common/\346\265\213\350\257\225\346\224\257\346\214\201 apifox x-apifox-enum.snap" index e1faf07..e90c69d 100644 --- "a/test/__snapshots__/common/\346\265\213\350\257\225\346\224\257\346\214\201 apifox x-apifox-enum.snap" +++ "b/test/__snapshots__/common/\346\265\213\350\257\225\346\224\257\346\214\201 apifox x-apifox-enum.snap" @@ -299,11 +299,18 @@ export type RspMsgItem = { From_Account?: string; /** 是否是空洞消息，当消息被删除或者消息过期后，MsgBody 为空，该字段为1，撤回的消息，该字段为2 */ IsPlaceMsg?: number; - /** 消息内容，详情请参见 消息内容 MsgBody 说明isSystemMsg == 1 消息类型 ObjectisSystemMsg == 0 消息类型 Array */ + /** + * 消息内容，详情请参见 消息内容 MsgBody 说明 + * isSystemMsg == 1 消息类型 Object + * isSystemMsg == 0 消息类型 Array + */ MsgBody?: Object; /** 字段为 1 时表示系统消息 */ IsSystemMsg?: number; - /** 消息的优先级，用于消息去重，有客户端发消息时填写，如果没有填，服务端会自动生成，1表示 High 优先级消息，2表示 Normal 优先级消息，3表示 Low 优先级消息，4表示 Lowest 优先级消息 */ + /** + * 消息的优先级，用于消息去重，有客户端发消息时填写，如果没有填，服务端会自动生成， + * 1表示 High 优先级消息，2表示 Normal 优先级消息，3表示 Low 优先级消息，4表示 Lowest 优先级消息 + */ MsgPriority?: number; /** 消息随机数，用于标记该条消息，数据范围 [0,4294967295] */ MsgRandom?: number; diff --git "a/test/__snapshots__/common/\346\265\213\350\257\225\347\224\237\346\210\220 JSON Schemas.snap" "b/test/__snapshots__/common/\346\265\213\350\257\225\347\224\237\346\210\220 JSON Schemas.snap" index 60774fe..16230f9 100644 --- "a/test/__snapshots__/common/\346\265\213\350\257\225\347\224\237\346\210\220 JSON Schemas.snap" +++ "b/test/__snapshots__/common/\346\265\213\350\257\225\347\224\237\346\210\220 JSON Schemas.snap" @@ -1682,7 +1682,7 @@ export function v1ApiAppAppIdRecommendedContextUsingPost({ }: { // 叠加生成的Param类型 (非body参数openapi默认没有生成对象) params: API.V1ApiAppAppIdRecommendedContextUsingPostParams; - body: API.AppRecommendedContext; + body: API.AppRecommendedContext2; options?: { [key: string]: unknown }; }) { const { appID: param0, ...queryParams } = params; @@ -4700,7 +4700,10 @@ export type QueryTokenResp = { export type QuestionRecommendReq = { conversation_id?: string; - /** Query string `json:"query"`Answer string `json:"answer"` */ + /** + * Query string `json:"query"` + * Answer string `json:"answer"` + */ user?: string; }; diff --git "a/test/__snapshots__/common/\346\265\213\350\257\225\347\224\237\346\210\220 isSupportParseEnumDesc \350\256\276\347\275\256\344\270\272true.snap" "b/test/__snapshots__/common/\346\265\213\350\257\225\347\224\237\346\210\220 isSupportParseEnumDesc \350\256\276\347\275\256\344\270\272true.snap" index 4e5e76d..3beae13 100644 --- "a/test/__snapshots__/common/\346\265\213\350\257\225\347\224\237\346\210\220 isSupportParseEnumDesc \350\256\276\347\275\256\344\270\272true.snap" +++ "b/test/__snapshots__/common/\346\265\213\350\257\225\347\224\237\346\210\220 isSupportParseEnumDesc \350\256\276\347\275\256\344\270\272true.snap" @@ -4,7 +4,27 @@ import request from 'axios'; import * as API from './types'; -/** 获取access_token > **为了安全考虑，开发者请勿将access_token返回给前端，需要开发者保存在后台，所有访问企业微信api的请求由后台发起**获取access_token是调用企业微信API接口的第一步，相当于创建了一个登录凭证，其它的业务API接口，都需要依赖于access_token来鉴权调用者身份。因此开发者，在使用业务接口前，要明确access_token的颁发来源，使用正确的access_token。**权限说明：**每个应用有独立的secret，获取到的access_token只能本应用使用，所以每个应用的access_token应该分开来获取。**注意事项：**开发者需要缓存access_token，用于后续接口的调用（注意：不能频繁调用gettoken接口，否则会受到频率拦截）。当access_token失效或过期时，需要重新获取。access_token的有效期通过返回的expires_in来传达，正常情况下为7200秒（2小时），有效期内重复获取返回相同结果，过期后获取会返回新的access_token。由于企业微信每个应用的access_token是彼此独立的，所以进行缓存时需要区分应用来进行存储。access_token至少保留512字节的存储空间。企业微信可能会出于运营需要，提前使access_token失效，开发者应实现access_token失效时重新获取的逻辑。 GET /cgi-bin/gettoken https://app.apifox.com/web/project/6276513/apis/api-288122020-run */ +/** + * 获取access_token > **为了安全考虑，开发者请勿将access_token返回给前端，需要开发者保存在后台，所有访问企业微信api的请求由后台发起** + * + * 获取access_token是调用企业微信API接口的第一步，相当于创建了一个登录凭证，其它的业务API接口，都需要依赖于access_token来鉴权调用者身份。 + * 因此开发者，在使用业务接口前，要明确access_token的颁发来源，使用正确的access_token。 + * + * + * **权限说明：** + * 每个应用有独立的secret，获取到的access_token只能本应用使用，所以每个应用的access_token应该分开来获取。 + * + * + * **注意事项：** + * 开发者需要缓存access_token，用于后续接口的调用（注意：不能频繁调用gettoken接口，否则会受到频率拦截）。当access_token失效或过期时，需要重新获取。 + * + * access_token的有效期通过返回的expires_in来传达，正常情况下为7200秒（2小时），有效期内重复获取返回相同结果，过期后获取会返回新的access_token。 + * 由于企业微信每个应用的access_token是彼此独立的，所以进行缓存时需要区分应用来进行存储。 + * access_token至少保留512字节的存储空间。 + * 企业微信可能会出于运营需要，提前使access_token失效，开发者应实现access_token失效时重新获取的逻辑。 + * GET /cgi-bin/gettoken + * https://app.apifox.com/web/project/6276513/apis/api-288122020-run + */ export function cgiBinGettokenUsingGet({ params, body, diff --git "a/test/__snapshots__/common/\346\265\213\350\257\225\347\224\237\346\210\220 react-query \347\232\204 vue \346\250\241\345\274\217.snap" "b/test/__snapshots__/common/\346\265\213\350\257\225\347\224\237\346\210\220 react-query \347\232\204 vue \346\250\241\345\274\217.snap" index 5f9c093..f69cb79 100644 --- "a/test/__snapshots__/common/\346\265\213\350\257\225\347\224\237\346\210\220 react-query \347\232\204 vue \346\250\241\345\274\217.snap" +++ "b/test/__snapshots__/common/\346\265\213\350\257\225\347\224\237\346\210\220 react-query \347\232\204 vue \346\250\241\345\274\217.snap" @@ -3181,7 +3181,7 @@ export function v1ApiAppAppIdRecommendedContextUsingPost({ }: { // 叠加生成的Param类型 (非body参数openapi默认没有生成对象) params: API.V1ApiAppAppIdRecommendedContextUsingPostParams; - body: API.AppRecommendedContext; + body: API.AppRecommendedContext2; options?: { [key: string]: unknown }; }) { const { appID: param0, ...queryParams } = params; @@ -4135,7 +4135,10 @@ export type QueryTokenResp = { export type QuestionRecommendReq = { conversation_id?: string; - /** Query string `json:"query"`Answer string `json:"answer"` */ + /** + * Query string `json:"query"` + * Answer string `json:"answer"` + */ user?: string; }; diff --git "a/test/__snapshots__/common/\346\265\213\350\257\225\347\224\237\346\210\220 react-query.snap" "b/test/__snapshots__/common/\346\265\213\350\257\225\347\224\237\346\210\220 react-query.snap" index a7d742c..3679ebe 100644 --- "a/test/__snapshots__/common/\346\265\213\350\257\225\347\224\237\346\210\220 react-query.snap" +++ "b/test/__snapshots__/common/\346\265\213\350\257\225\347\224\237\346\210\220 react-query.snap" @@ -3225,7 +3225,7 @@ export function v1ApiAppAppIdRecommendedContextUsingPost({ }: { // 叠加生成的Param类型 (非body参数openapi默认没有生成对象) params: API.V1ApiAppAppIdRecommendedContextUsingPostParams; - body: API.AppRecommendedContext; + body: API.AppRecommendedContext2; options?: { [key: string]: unknown }; }) { const { appID: param0, ...queryParams } = params; @@ -4135,7 +4135,10 @@ export type QueryTokenResp = { export type QuestionRecommendReq = { conversation_id?: string; - /** Query string `json:"query"`Answer string `json:"answer"` */ + /** + * Query string `json:"query"` + * Answer string `json:"answer"` + */ user?: string; }; diff --git "a/test/__snapshots__/common/\346\265\213\350\257\225\347\224\237\346\210\220 response type comments.snap" "b/test/__snapshots__/common/\346\265\213\350\257\225\347\224\237\346\210\220 response type comments.snap" index 4e5e76d..3beae13 100644 --- "a/test/__snapshots__/common/\346\265\213\350\257\225\347\224\237\346\210\220 response type comments.snap" +++ "b/test/__snapshots__/common/\346\265\213\350\257\225\347\224\237\346\210\220 response type comments.snap" @@ -4,7 +4,27 @@ import request from 'axios'; import * as API from './types'; -/** 获取access_token > **为了安全考虑，开发者请勿将access_token返回给前端，需要开发者保存在后台，所有访问企业微信api的请求由后台发起**获取access_token是调用企业微信API接口的第一步，相当于创建了一个登录凭证，其它的业务API接口，都需要依赖于access_token来鉴权调用者身份。因此开发者，在使用业务接口前，要明确access_token的颁发来源，使用正确的access_token。**权限说明：**每个应用有独立的secret，获取到的access_token只能本应用使用，所以每个应用的access_token应该分开来获取。**注意事项：**开发者需要缓存access_token，用于后续接口的调用（注意：不能频繁调用gettoken接口，否则会受到频率拦截）。当access_token失效或过期时，需要重新获取。access_token的有效期通过返回的expires_in来传达，正常情况下为7200秒（2小时），有效期内重复获取返回相同结果，过期后获取会返回新的access_token。由于企业微信每个应用的access_token是彼此独立的，所以进行缓存时需要区分应用来进行存储。access_token至少保留512字节的存储空间。企业微信可能会出于运营需要，提前使access_token失效，开发者应实现access_token失效时重新获取的逻辑。 GET /cgi-bin/gettoken https://app.apifox.com/web/project/6276513/apis/api-288122020-run */ +/** + * 获取access_token > **为了安全考虑，开发者请勿将access_token返回给前端，需要开发者保存在后台，所有访问企业微信api的请求由后台发起** + * + * 获取access_token是调用企业微信API接口的第一步，相当于创建了一个登录凭证，其它的业务API接口，都需要依赖于access_token来鉴权调用者身份。 + * 因此开发者，在使用业务接口前，要明确access_token的颁发来源，使用正确的access_token。 + * + * + * **权限说明：** + * 每个应用有独立的secret，获取到的access_token只能本应用使用，所以每个应用的access_token应该分开来获取。 + * + * + * **注意事项：** + * 开发者需要缓存access_token，用于后续接口的调用（注意：不能频繁调用gettoken接口，否则会受到频率拦截）。当access_token失效或过期时，需要重新获取。 + * + * access_token的有效期通过返回的expires_in来传达，正常情况下为7200秒（2小时），有效期内重复获取返回相同结果，过期后获取会返回新的access_token。 + * 由于企业微信每个应用的access_token是彼此独立的，所以进行缓存时需要区分应用来进行存储。 + * access_token至少保留512字节的存储空间。 + * 企业微信可能会出于运营需要，提前使access_token失效，开发者应实现access_token失效时重新获取的逻辑。 + * GET /cgi-bin/gettoken + * https://app.apifox.com/web/project/6276513/apis/api-288122020-run + */ export function cgiBinGettokenUsingGet({ params, body, diff --git "a/test/__snapshots__/common/\346\265\213\350\257\225\347\224\237\346\210\220\345\214\277\345\220\215response =_ \345\205\267\345\220\215response.snap" "b/test/__snapshots__/common/\346\265\213\350\257\225\347\224\237\346\210\220\345\214\277\345\220\215response =_ \345\205\267\345\220\215response.snap" index 4e5e76d..3beae13 100644 --- "a/test/__snapshots__/common/\346\265\213\350\257\225\347\224\237\346\210\220\345\214\277\345\220\215response =_ \345\205\267\345\220\215response.snap" +++ "b/test/__snapshots__/common/\346\265\213\350\257\225\347\224\237\346\210\220\345\214\277\345\220\215response =_ \345\205\267\345\220\215response.snap" @@ -4,7 +4,27 @@ import request from 'axios'; import * as API from './types'; -/** 获取access_token > **为了安全考虑，开发者请勿将access_token返回给前端，需要开发者保存在后台，所有访问企业微信api的请求由后台发起**获取access_token是调用企业微信API接口的第一步，相当于创建了一个登录凭证，其它的业务API接口，都需要依赖于access_token来鉴权调用者身份。因此开发者，在使用业务接口前，要明确access_token的颁发来源，使用正确的access_token。**权限说明：**每个应用有独立的secret，获取到的access_token只能本应用使用，所以每个应用的access_token应该分开来获取。**注意事项：**开发者需要缓存access_token，用于后续接口的调用（注意：不能频繁调用gettoken接口，否则会受到频率拦截）。当access_token失效或过期时，需要重新获取。access_token的有效期通过返回的expires_in来传达，正常情况下为7200秒（2小时），有效期内重复获取返回相同结果，过期后获取会返回新的access_token。由于企业微信每个应用的access_token是彼此独立的，所以进行缓存时需要区分应用来进行存储。access_token至少保留512字节的存储空间。企业微信可能会出于运营需要，提前使access_token失效，开发者应实现access_token失效时重新获取的逻辑。 GET /cgi-bin/gettoken https://app.apifox.com/web/project/6276513/apis/api-288122020-run */ +/** + * 获取access_token > **为了安全考虑，开发者请勿将access_token返回给前端，需要开发者保存在后台，所有访问企业微信api的请求由后台发起** + * + * 获取access_token是调用企业微信API接口的第一步，相当于创建了一个登录凭证，其它的业务API接口，都需要依赖于access_token来鉴权调用者身份。 + * 因此开发者，在使用业务接口前，要明确access_token的颁发来源，使用正确的access_token。 + * + * + * **权限说明：** + * 每个应用有独立的secret，获取到的access_token只能本应用使用，所以每个应用的access_token应该分开来获取。 + * + * + * **注意事项：** + * 开发者需要缓存access_token，用于后续接口的调用（注意：不能频繁调用gettoken接口，否则会受到频率拦截）。当access_token失效或过期时，需要重新获取。 + * + * access_token的有效期通过返回的expires_in来传达，正常情况下为7200秒（2小时），有效期内重复获取返回相同结果，过期后获取会返回新的access_token。 + * 由于企业微信每个应用的access_token是彼此独立的，所以进行缓存时需要区分应用来进行存储。 + * access_token至少保留512字节的存储空间。 + * 企业微信可能会出于运营需要，提前使access_token失效，开发者应实现access_token失效时重新获取的逻辑。 + * GET /cgi-bin/gettoken + * https://app.apifox.com/web/project/6276513/apis/api-288122020-run + */ export function cgiBinGettokenUsingGet({ params, body, diff --git "a/test/__snapshots__/common/\347\224\237\346\210\220\346\236\232\344\270\276\347\277\273\350\257\221, \347\224\237\346\210\220 type \347\277\273\350\257\221.snap" "b/test/__snapshots__/common/\347\224\237\346\210\220\346\236\232\344\270\276\347\277\273\350\257\221, \347\224\237\346\210\220 type \347\277\273\350\257\221.snap" index 1171b23..d7967bb 100644 --- "a/test/__snapshots__/common/\347\224\237\346\210\220\346\236\232\344\270\276\347\277\273\350\257\221, \347\224\237\346\210\220 type \347\277\273\350\257\221.snap" +++ "b/test/__snapshots__/common/\347\224\237\346\210\220\346\236\232\344\270\276\347\277\273\350\257\221, \347\224\237\346\210\220 type \347\277\273\350\257\221.snap" @@ -1319,1846 +1319,2626 @@ export function displayWorkspaceRoleEnum(field: API.WorkspaceRole) { // @ts-ignore import * as API from './types'; -export function displayAddAppkeyReq(field: keyof API.AddAppkeyReq) { - return { - appid: 'appid', - appkey: 'appkey', - appsecret: 'appsecret', - encodingAESKey: 'encodingAESKey', - token: 'token', - type: 'wjl,dingding,feishu,wxa,wx', - }[field]; -} -export function displayApiToken(field: keyof API.ApiToken) { - return { - apiTokenID: 'apiTokenID', - appID: 'appID', - createdAt: 'createdAt', - token: 'token', - updatedAt: 'updatedAt', - }[field]; -} -export function displayApiTokenDataList(field: keyof API.ApiTokenDataList) { - return { - data: 'data', - total: 'total', - }[field]; -} -export function displayApp(field: keyof API.App) { - return { - appID: 'appID', - appImage: 'appImage', - appStatus: 'appStatus', - appType: '应用类型', - createdAt: 'createdAt', - description: 'description', - groupID: 'groupID', - guidance: '开场提问引导', - name: 'name', - operator: 'operator', - priority: '应用优先级', - prologue: 'prologue', - recommendSwitch: 'recommendSwitch', - templateStatus: '是否模版', - updatedAt: 'updatedAt', - workspaceID: 'workspaceID', - }[field]; -} + export function displayAddAppkeyReq(field: keyof API.AddAppkeyReq) { + return ( + { + appid: 'appid', + appkey: 'appkey', + appsecret: 'appsecret', + encodingAESKey: 'encodingAESKey', + token: 'token', + type: 'wjl,dingding,feishu,wxa,wx', + }[field] + + ) + } + + + export function displayApiToken(field: keyof API.ApiToken) { + return ( + { + apiTokenID: 'apiTokenID', + appID: 'appID', + createdAt: 'createdAt', + token: 'token', + updatedAt: 'updatedAt', + }[field] + + ) + } + + + export function displayApiTokenDataList(field: keyof API.ApiTokenDataList) { + return ( + { + data: 'data', + total: 'total', + }[field] + + ) + } + + + export function displayApp(field: keyof API.App) { + return ( + { + appID: 'appID', + appImage: 'appImage', + appStatus: 'appStatus', + appType: '应用类型', + createdAt: 'createdAt', + description: 'description', + groupID: 'groupID', + guidance: '开场提问引导', + name: 'name', + operator: 'operator', + priority: '应用优先级', + prologue: 'prologue', + recommendSwitch: 'recommendSwitch', + templateStatus: '是否模版', + updatedAt: 'updatedAt', + workspaceID: 'workspaceID', + }[field] + + ) + } + + + export function displayAppDataset(field: keyof API.AppDataset) { + return ( + { + description: '描述', + llmDesc: 'llm描述', + name: '知识库名', + }[field] + + ) + } + + + export function displayAppDatasetConfig(field: keyof API.AppDatasetConfig) { + return ( + { + appDatasetConfigID: 'appDatasetConfigID', + appID: 'appID', + createdAt: 'createdAt', + minScore: 'minScore', + searchSource: 'searchSource', + timeoutSecond: 'timeoutSecond', + topK: 'topK', + updatedAt: 'updatedAt', + }[field] + + ) + } + + + export function displayAppDatasetConfigs(field: keyof API.AppDatasetConfigs) { + return ( + { + minScore: '最低分数', + searchSource: '知识库源，默认 warehouse', + timeoutSecond: '知识库查询超时时间', + topK: '知识库条数', + }[field] + + ) + } + + + export function displayAppDatasets(field: keyof API.AppDatasets) { + return ( + { + appCount: 'appCount', + author: 'author', + datasetID: 'datasetID', + datasetName: 'datasetName', + docCount: 'docCount', + state: 'state', + }[field] + + ) + } + + + export function displayAppDetail(field: keyof API.AppDetail) { + return ( + { + AnswerTokensCount: '消耗输出token', + appDatasetConfig: 'appDatasetConfig', + appDatasets: '数据集Id列表', + appGroupID: 'appGroupID', + appID: 'appID', + appImage: '应用头像', + appName: '应用名', + appPrePrompt: 'PrePrompt', + appPromptPrefix: 'appPromptPrefix', + appProvider: '模型', + appProviderID: 'AppDatasetSource database2.AppDatasetSourceInfo `json:"appDatasetSource"`', + appProviderName: '模型名', + appRecommendedContext: '推荐内容', + appStatus: 'appStatus', + appToken: '应用token列表', + configs: 'configs', + conversationCount: '会话总数', + createAt: 'createAt', + description: '应用描述', + guidance: '开场提问引导', + h5RandomPath: 'H5随机分享路径', + historyLimit: 'historyLimit', + messagesCount: '消息总数', + pcRandomPath: 'PC随机分享路径', + prologue: '开场白', + queryTokensCount: '消耗输入token', + switchRecommendedQuestion: 'switchRecommendedQuestion', + templateStatus: 'templateStatus', + totalTokens: '消耗总token', + workspaceID: 'workspaceID', + }[field] + + ) + } + + + export function displayAppMessagesCount(field: keyof API.AppMessagesCount) { + return ( + { + total: 'total', + }[field] + + ) + } + + + export function displayAppModelConfigPromptPrefix(field: keyof API.AppModelConfigPromptPrefix) { + return ( + { + background: 'background', + role: 'role', + switchRecommendedQuestion: 'switchRecommendedQuestion', + }[field] + + ) + } + + + export function displayAppModelConfigs(field: keyof API.AppModelConfigs) { + return ( + { + configs: 'configs', + prePrompt: 'prePrompt', + providerId: 'providerId', + }[field] + + ) + } + + + export function displayAppRecommendedContext(field: keyof API.AppRecommendedContext) { + return ( + { + appID: 'appID', + appRecommendedContextID: 'appRecommendedContextID', + context: 'context', + createdAt: 'createdAt', + description: 'description', + name: 'name', + updatedAt: 'updatedAt', + }[field] + + ) + } + + + export function displayAppRecommendedContext2(field: keyof API.AppRecommendedContext2) { + return ( + { + context: 'context', + description: 'description', + id: 'id', + name: 'name', + }[field] + + ) + } + + + export function displayAppRecommendedContext3(field: keyof API.AppRecommendedContext3) { + return ( + { + context: 'context', + description: 'description', + id: 'id', + name: 'name', + }[field] + + ) + } + + + export function displayAppRecommendedContextResp(field: keyof API.AppRecommendedContextResp) { + return ( + { + questions: 'questions', + recommendSwitch: 'recommendSwitch', + }[field] + + ) + } + + + export function displayAppResp(field: keyof API.AppResp) { + return ( + { + appGroupID: 'appGroupID', + appGroupName: 'appGroupName', + appImage: 'appImage', + appStatus: 'appStatus', + createAt: 'createAt', + datasetCount: 'datasetCount', + description: 'description', + h5: 'h5', + id: 'id', + name: 'name', + pc: 'pc', + workspaceID: 'workspaceID', + }[field] + + ) + } + + + export function displayAppWithPermission(field: keyof API.AppWithPermission) { + return ( + { + appID: 'appID', + appImage: 'appImage', + appStatus: 'appStatus', + appType: '应用类型', + createdAt: 'createdAt', + description: 'description', + groupID: 'groupID', + guidance: '开场提问引导', + isAppAdmin: 'isAppAdmin', + name: 'name', + operator: 'operator', + priority: '应用优先级', + prologue: 'prologue', + recommendSwitch: 'recommendSwitch', + templateStatus: '是否模版', + updatedAt: 'updatedAt', + workspaceID: 'workspaceID', + }[field] + + ) + } + + + export function displayAttentionDataCountResp(field: keyof API.AttentionDataCountResp) { + return ( + { + total: 'total', + }[field] + + ) + } + + + export function displayAttentionUser(field: keyof API.AttentionUser) { + return ( + { + email: 'email', + isAttentionUser: 'isAttentionUser', + phone: 'phone', + userID: 'userID', + userName: 'userName', + }[field] + + ) + } + + + export function displayAttentionUserResp(field: keyof API.AttentionUserResp) { + return ( + { + email: 'email', + lastMessageTime: 'lastMessageTime', + phone: 'phone', + userID: 'userID', + userName: 'userName', + }[field] + + ) + } + + + export function displayAuthAuthorizeUsingGetParams(field: keyof API.AuthAuthorizeUsingGetParams) { + return ( + { + redirect_uri: '业务回调地址', + state: '保持请求和回调的状态，授权成功后会回传该参数', + }[field] + + ) + } + + + + + export function displayAuthExchangeUsingGetParams(field: keyof API.AuthExchangeUsingGetParams) { + return ( + { + code: 'code', + redirect_uri: '业务回调地址', + }[field] + + ) + } + + + + + + + + + export function displayChat(field: keyof API.Chat) { + return ( + { + conversation_id: 'conversation_id', + inputs: 'inputs', + isIgnore: 'isIgnore', + query: 'query', + response_mode: 'response_mode', + user: 'user', + }[field] + + ) + } + + + export function displayChatMessageReq(field: keyof API.ChatMessageReq) { + return ( + { + prompt: 'prompt', + query: 'query', + }[field] + + ) + } + + + export function displayConversationLogsResp(field: keyof API.ConversationLogsResp) { + return ( + { + AnswerTokensCount: '消耗输出token', + appID: 'appID', + conversationID: 'conversationID', + conversationName: 'conversationName', + createdAt: 'createdAt', + messagesCount: 'messagesCount', + queryTokensCount: '消耗输入token', + totalTokens: '消耗总token', + userID: 'userID', + userInfo: 'userInfo', + }[field] + + ) + } + + + export function displayConversationMsg(field: keyof API.ConversationMsg) { + return ( + { + conversationId: 'conversationId', + createAt: 'createAt', + name: 'name', + userId: 'userId', + }[field] + + ) + } + + + export function displayConversationResp(field: keyof API.ConversationResp) { + return ( + { + AnswerTokensCount: '消耗输出token', + appID: 'appID', + appName: 'appName', + conversationID: 'conversationID', + conversationName: 'conversationName', + createdAt: 'createdAt', + lastMessagesTime: 'lastMessagesTime', + messagesCount: 'messagesCount', + queryTokensCount: '消耗输入token', + totalTokens: '消耗总token', + userID: 'userID', + userInfo: 'userInfo', + }[field] + + ) + } + + + export function displayCopyAppReq(field: keyof API.CopyAppReq) { + return ( + { + appID: 'appID', + workspaceID: 'workspaceID', + }[field] + + ) + } + + + export function displayCreateApiTokenRESP(field: keyof API.CreateApiTokenRESP) { + return ( + { + token: 'token', + }[field] + + ) + } + + + export function displayCreateAppReq(field: keyof API.CreateAppReq) { + return ( + { + description: 'description', + guidance: 'guidance', + name: 'name', + prologue: 'prologue', + }[field] + + ) + } + + + export function displayCreateAppReqV2(field: keyof API.CreateAppReqV2) { + return ( + { + appDescription: 'appDescription', + appGroupID: 'appGroupID', + appGuidance: '提示查询', + appImage: 'appImage', + appName: 'appName', + appPrologue: '开场白', + historyLimit: 'historyLimit', + modelConfigs: 'modelConfigs', + prePrompt: 'prePrompt', + providerId: 'providerId', + }[field] + + ) + } + + + export function displayCreateAttentionReq(field: keyof API.CreateAttentionReq) { + return ( + { + followeeUserIDList: 'followeeUserIDList', + iamID: 'iamID', + }[field] + + ) + } + + + + + export function displayCreateSharePathRESP(field: keyof API.CreateSharePathRESP) { + return ( + { + path: 'path', + }[field] + + ) + } + + + export function displayData(field: keyof API.Data) { + return ( + { + appkey: 'appkey', + appsecret: 'appsecret', + state: '0-未开启，1-开启', + url: 'url', + wxExtra: 'wxExtra', + }[field] + + ) + } + + + export function displayDatasetData(field: keyof API.DatasetData) { + return ( + { + author: 'author', + description: 'description', + docCount: 'docCount', + document_count: 'document_count', + id: 'id', + name: 'name', + permission: 'permission', + state: 'state', + uuid: 'uuid', + word_count: 'word_count', + }[field] + + ) + } + + + export function displayDeleteAttentionReq(field: keyof API.DeleteAttentionReq) { + return ( + { + followeeUserIDList: 'followeeUserIDList', + iamID: 'iamID', + }[field] + + ) + } + + + + + export function displayDeleteMemberBody(field: keyof API.DeleteMemberBody) { + return ( + { + userID: '用户id', + }[field] + + ) + } + + + export function displayDeleteResp(field: keyof API.DeleteResp) { + return ( + { + msg: 'msg', + }[field] + + ) + } + + + + + export function displayErrorResp(field: keyof API.ErrorResp) { + return ( + { + msg: 'msg', + type: 'type', + }[field] + + ) + } + + + export function displayExchangeTokenRESP(field: keyof API.ExchangeTokenRESP) { + return ( + { + access_token: '访问令牌', + expires_in: '访问令牌过期时间', + refresh_expires_in: '刷新令牌过期时间', + refresh_token: '刷新令牌', + token_type: '令牌类型', + }[field] + + ) + } + + + export function displayFeedback(field: keyof API.Feedback) { + return ( + { + comment: '评论', + conversation_id: 'conversation_id', + createdAt: 'createdAt', + message_id: 'message_id', + rating: 'like/unlike', + score: '打分', + updatedAt: 'updatedAt', + }[field] + + ) + } + + + export function displayFeedbacksReqBody(field: keyof API.FeedbacksReqBody) { + return ( + { + comment: '评论', + conversation_id: 'conversation_id', + rating: 'like/unlike', + score: '分数1-10', + }[field] + + ) + } + + + export function displayFilestreamResp(field: keyof API.FilestreamResp) { + return ( + { + conversation_id: 'conversation_id', + }[field] + + ) + } + + + export function displayGetApiTokenByRandomPathRESP(field: keyof API.GetApiTokenByRandomPathRESP) { + return ( + { + apiTokenID: 'apiTokenID', + appID: 'appID', + appName: 'appName', + createdAt: 'createdAt', + recommendedContext: 'recommendedContext', + switchRecommendedContext: 'switchRecommendedContext', + switchRecommendedQuestion: 'switchRecommendedQuestion', + token: 'token', + updatedAt: 'updatedAt', + }[field] + + ) + } + + + export function displayGetAppKeyReq(field: keyof API.GetAppKeyReq) { + return ( + { + appid: 'appid', + type: 'wjl,dingding,feishu,wxa,wx', + }[field] + + ) + } + + + export function displayGetAttentionDataCountReq(field: keyof API.GetAttentionDataCountReq) { + return ( + { + appIDList: 'appIDList', + iamID: 'iamID', + userID: 'userID', + }[field] + + ) + } + + + export function displayGetImagePreSignedUrlResp(field: keyof API.GetImagePreSignedUrlResp) { + return ( + { + appImage: 'appImage', + preSignedPutUrl: 'preSignedPutUrl', + }[field] + + ) + } + + + export function displayGuidances(field: keyof API.Guidances) { + return ( + { + items: 'items', + }[field] + + ) + } + + + export function displayHistoryInfo(field: keyof API.HistoryInfo) { + return ( + { + Rating: 'like/unlike', + answer: 'answer', + answerToken: 'answerToken', + comment: '评论', + createAt: 'createAt', + format: 'format', + messageId: 'messageId', + query: 'query', + queryToken: 'queryToken', + score: '打分', + totalToken: 'totalToken', + }[field] + + ) + } + + + export function displayIAMUserInfo(field: keyof API.IAMUserInfo) { + return ( + { + createdTime: '创建时间', + email: 'Cid string `json:"cid"`', + id: '用户id', + idpId: 'idpId', + isAdmin: '是否iam管理员', + isAppAdmin: 'isAppAdmin', + isRkUser: '是否罗克佳华人员', + isSuperUser: '是否超级管理员', + isSystemAdmin: 'isSystemAdmin', + lastTime: 'Deleted int32 `json:"deleted"` // 逻辑删除', + loginName: '登录名', + msgType: '消息类型', + phone: '电话', + rkUserCard: '罗克佳华用户账号', + sign: '个性签名', + status: '状态：1可用；0未激活；-1禁用', + updatedTime: '修改时间', + useType: '用户类型', + userName: '用户名', + wechatAppId: 'wechatAppId', + wechatSwitch: 'wechatSwitch', + wechatgzhSwitch: 'wechatgzhSwitch', + }[field] + + ) + } + + + export function displayListAllAttentionUser(field: keyof API.ListAllAttentionUser) { + return ( + { + data: 'data', + total: 'total', + }[field] + + ) + } + + + export function displayListAppDatasetConfigResp(field: keyof API.ListAppDatasetConfigResp) { + return ( + { + data: 'data', + total: 'total', + }[field] + + ) + } + + + export function displayListAppDatasets(field: keyof API.ListAppDatasets) { + return ( + { + Data: 'Data', + total: 'total', + }[field] + + ) + } + + + export function displayListAppResp(field: keyof API.ListAppResp) { + return ( + { + data: 'data', + total: 'total', + }[field] + + ) + } + + + export function displayListAttentionConversationReq(field: keyof API.ListAttentionConversationReq) { + return ( + { + appIDList: 'appIDList', + iamID: 'iamID', + offset: 'offset', + size: 'size', + userID: 'userID', + }[field] + + ) + } + + + export function displayListAttentionUserResp(field: keyof API.ListAttentionUserResp) { + return ( + { + data: 'data', + total: 'total', + }[field] + + ) + } + + + export function displayListConversationLogsResp(field: keyof API.ListConversationLogsResp) { + return ( + { + data: 'data', + total: 'total', + }[field] + + ) + } + + + export function displayListConversationResp(field: keyof API.ListConversationResp) { + return ( + { + data: 'data', + total: 'total', + }[field] + + ) + } + + + export function displayListDatasetsResp(field: keyof API.ListDatasetsResp) { + return ( + { + data: 'data', + has_more: 'has_more', + offset: 'offset', + size: 'size', + total: 'total', + }[field] + + ) + } + + + export function displayListFeedbacksResp(field: keyof API.ListFeedbacksResp) { + return ( + { + data: 'data', + total: 'total', + }[field] + + ) + } + + + export function displayListMemberRESP(field: keyof API.ListMemberRESP) { + return ( + { + data: 'data', + total: 'total', + }[field] + + ) + } + + + export function displayListProviderResp(field: keyof API.ListProviderResp) { + return ( + { + data: 'data', + total: 'total', + }[field] + + ) + } + + + export function displayListUserWithAppRESP(field: keyof API.ListUserWithAppRESP) { + return ( + { + data: 'data', + total: 'total', + }[field] + + ) + } + + + export function displayListWorkspaceGroup(field: keyof API.ListWorkspaceGroup) { + return ( + { + data: 'data', + }[field] + + ) + } + + + export function displayListWorkspacePermissions(field: keyof API.ListWorkspacePermissions) { + return ( + { + data: 'data', + total: 'total', + }[field] + + ) + } + + + + + export function displayMemberBody(field: keyof API.MemberBody) { + return ( + { + role: '角色(system_admin-系统管理员;system_user-系统管普通用户;app_admin-应用管理员;app_user-应用普通用户)', + userID: '用户id', + }[field] + + ) + } + + + export function displayMemberWithRoleData(field: keyof API.MemberWithRoleData) { + return ( + { + appRole: '应用角色', + createdAt: 'createdAt', + email: 'email', + idpID: 'idpID', + isAppAdmin: '是否是app管理员', + isSystemAdmin: '是否是系统管理员', + operator: 'operator', + phone: 'phone', + role: '角色(系统管理员、系统普通用户)', + updatedAt: 'updatedAt', + userID: 'iam 用户id', + userName: 'userName', + }[field] + + ) + } + + + export function displayMessagesCountResp(field: keyof API.MessagesCountResp) { + return ( + { + messagesCount: '请求消耗token', + time: 'time', + }[field] + + ) + } + + + export function displayMessagesTokenResp(field: keyof API.MessagesTokenResp) { + return ( + { + answerToken: '回答消耗token', + queryToken: '请求消耗token', + time: 'time', + totalToken: 'totalToken', + }[field] + + ) + } + + + export function displayModelConfigsMap(field: keyof API.ModelConfigsMap) { + return ( + { + model_type: '模型(ERNIE-Bot-4;ERNIE-Bot;ERNIE-Bot-turbo;gpt-3.5-turbo-16k;gpt-4-1106-preview)', + penalty_score: '通过对已生成的token增加惩罚，减少重复生成的现象。取值范围：[1.0, 2.0]', + temperature: '较高的数值会使输出更加随机，而较低的数值会使其更加集中和确定。默认0.95，范围 (0, 1.0]', + tools_call: 'tools call', + top_p: '影响输出文本的多样性，取值越大，生成文本的多样性越强。取值范围 [0, 1.0]', + }[field] + + ) + } + + + export function displayModelConfigsMap2(field: keyof API.ModelConfigsMap2) { + return ( + { + model_type: '模型(ERNIE-Bot-4;ERNIE-Bot;ERNIE-Bot-turbo;gpt-3.5-turbo-16k;gpt-4-1106-preview)', + penalty_score: '通过对已生成的token增加惩罚，减少重复生成的现象。取值范围：[1.0, 2.0]', + temperature: '较高的数值会使输出更加随机，而较低的数值会使其更加集中和确定。默认0.95，范围 (0, 1.0]', + tools_call: 'tools_call', + top_p: '影响输出文本的多样性，取值越大，生成文本的多样性越强。取值范围 [0, 1.0]', + }[field] + + ) + } + + + export function displayProviderResp(field: keyof API.ProviderResp) { + return ( + { + name: '名字', + providerID: 'providerID', + subType: 'subType', + type: '类型', + }[field] + + ) + } + + + export function displayQueryTokenResp(field: keyof API.QueryTokenResp) { + return ( + { + AnswerTokensCount: '消耗输出token', + queryTokensCount: '消耗输入token', + totalTokens: '消耗总token', + }[field] + + ) + } + + + export function displayQuestionRecommendReq(field: keyof API.QuestionRecommendReq) { + return ( + { + conversation_id: 'conversation_id', + user: ' + * Query string `json:"query"` + * Answer string `json:"answer"` +', + }[field] + + ) + } + + + export function displayRecommendQuestionAndContext(field: keyof API.RecommendQuestionAndContext) { + return ( + { + contexts: 'contexts', + questions: 'questions', + }[field] + + ) + } + + + export function displayRefreshTokenBody(field: keyof API.RefreshTokenBody) { + return ( + { + refreshToken: 'refreshToken', + }[field] + + ) + } + + + export function displayReleaseDiscoverReq(field: keyof API.ReleaseDiscoverReq) { + return ( + { + alterAppID: 'alterAppID', + appType: '应用类型', + templateStatus: '是否作为模版 TRUE:作为模版；FALSE:不作为', + }[field] + + ) + } + + + export function displayResponseData(field: keyof API.ResponseData) { + return ( + { + answer: 'answer', + conversation_id: 'conversation_id', + created_at: 'created_at', + event: 'event', + id: 'id', + trace_id: 'trace_id', + }[field] + + ) + } + + + export function displayResponseRecommendData(field: keyof API.ResponseRecommendData) { + return ( + { + answer: 'answer', + conversation_id: 'conversation_id', + created_at: 'created_at', + event: 'event', + id: 'id', + trace_id: 'trace_id', + }[field] + + ) + } + + + export function displaySpeechToTextResp(field: keyof API.SpeechToTextResp) { + return ( + { + text: '转化的结果', + }[field] + + ) + } + + + export function displayTextToSpeechReq(field: keyof API.TextToSpeechReq) { + return ( + { + text: '需要转的文字', + }[field] + + ) + } + + + export function displayUpdateAppGroup(field: keyof API.UpdateAppGroup) { + return ( + { + appGroupID: 'appGroupID', + }[field] + + ) + } + + + export function displayUpdateAppKeyStateReq(field: keyof API.UpdateAppKeyStateReq) { + return ( + { + appid: 'appid', + state: '0-关闭，1-启动', + type: 'wjl,dingding,feishu', + }[field] + + ) + } + + + export function displayUpdateAppReq(field: keyof API.UpdateAppReq) { + return ( + { + appDescription: 'appDescription', + appGroupID: 'appGroupID', + appImage: 'appImage', + appName: 'appName', + }[field] + + ) + } + + + export function displayUpdateAppReqV2(field: keyof API.UpdateAppReqV2) { + return ( + { + appGroupID: 'appGroupID', + appGuidance: '提示查询', + appPrologue: '开场白', + appRecommendedContexts: '推荐内容', + historyLimit: 'historyLimit', + modelConfigs: 'modelConfigs', + prePrompt: 'prePrompt', + providerId: 'providerId', + recommendSwitch: 'recommendSwitch', + }[field] + + ) + } + + + export function displayUpdateAppStatusReq(field: keyof API.UpdateAppStatusReq) { + return ( + { + appStatus: 'PUBLIC:公开；PRIVATE:私有', + }[field] + + ) + } + + + export function displayUpdateUserRoleBody(field: keyof API.UpdateUserRoleBody) { + return ( + { + role: '角色(system_admin-系统管理员;system_user-系统管普通用户;app_admin-应用管理员;app_user-应用普通用户)', + userID: '用户id', + }[field] + + ) + } + + + export function displayUser(field: keyof API.User) { + return ( + { + createdAt: 'createdAt', + email: 'email', + idpID: 'idpID', + operator: 'operator', + phone: 'phone', + role: '角色(系统管理员、系统普通用户)', + updatedAt: 'updatedAt', + userID: 'iam 用户id', + userName: 'userName', + }[field] + + ) + } + + + export function displayUserWithAppData(field: keyof API.UserWithAppData) { + return ( + { + appWithPermissionList: 'appWithPermissionList', + createdAt: 'createdAt', + email: 'email', + idpID: 'idpID', + isSystemAdmin: 'isSystemAdmin', + operator: 'operator', + phone: 'phone', + role: '角色(系统管理员、系统普通用户)', + updatedAt: 'updatedAt', + userID: 'iam 用户id', + userName: 'userName', + }[field] + + ) + } + + + export function displayV1ApiAppAppIdApiTokenUsingGetParams(field: keyof API.V1ApiAppAppIdApiTokenUsingGetParams) { + return ( + { + appID: '应用id', + size: '每页大小', + offset: '分页', + }[field] + + ) + } + + + + + export function displayV1ApiAppAppIdApiTokenUsingPostParams(field: keyof API.V1ApiAppAppIdApiTokenUsingPostParams) { + return ( + { + appID: '应用id', + }[field] + + ) + } + + + -export function displayAppDataset(field: keyof API.AppDataset) { - return { - description: '描述', - llmDesc: 'llm描述', - name: '知识库名', - }[field]; -} + export function displayV1ApiAppAppIdDatasetConfigsUsingDeleteParams(field: keyof API.V1ApiAppAppIdDatasetConfigsUsingDeleteParams) { + return ( + { + appID: '应用id', + appDatasetConfigID: '应用知识库配置id', + }[field] + + ) + } -export function displayAppDatasetConfig(field: keyof API.AppDatasetConfig) { - return { - appDatasetConfigID: 'appDatasetConfigID', - appID: 'appID', - createdAt: 'createdAt', - minScore: 'minScore', - searchSource: 'searchSource', - timeoutSecond: 'timeoutSecond', - topK: 'topK', - updatedAt: 'updatedAt', - }[field]; -} -export function displayAppDatasetConfigs(field: keyof API.AppDatasetConfigs) { - return { - minScore: '最低分数', - searchSource: '知识库源，默认 warehouse', - timeoutSecond: '知识库查询超时时间', - topK: '知识库条数', - }[field]; -} -export function displayAppDatasets(field: keyof API.AppDatasets) { - return { - appCount: 'appCount', - author: 'author', - datasetID: 'datasetID', - datasetName: 'datasetName', - docCount: 'docCount', - state: 'state', - }[field]; -} -export function displayAppDetail(field: keyof API.AppDetail) { - return { - AnswerTokensCount: '消耗输出token', - appDatasetConfig: 'appDatasetConfig', - appDatasets: '数据集Id列表', - appGroupID: 'appGroupID', - appID: 'appID', - appImage: '应用头像', - appName: '应用名', - appPrePrompt: 'PrePrompt', - appPromptPrefix: 'appPromptPrefix', - appProvider: '模型', - appProviderID: - 'AppDatasetSource database2.AppDatasetSourceInfo `json:"appDatasetSource"`', - appProviderName: '模型名', - appRecommendedContext: '推荐内容', - appStatus: 'appStatus', - appToken: '应用token列表', - configs: 'configs', - conversationCount: '会话总数', - createAt: 'createAt', - description: '应用描述', - guidance: '开场提问引导', - h5RandomPath: 'H5随机分享路径', - historyLimit: 'historyLimit', - messagesCount: '消息总数', - pcRandomPath: 'PC随机分享路径', - prologue: '开场白', - queryTokensCount: '消耗输入token', - switchRecommendedQuestion: 'switchRecommendedQuestion', - templateStatus: 'templateStatus', - totalTokens: '消耗总token', - workspaceID: 'workspaceID', - }[field]; -} + export function displayV1ApiAppAppIdDatasetConfigsUsingGetParams(field: keyof API.V1ApiAppAppIdDatasetConfigsUsingGetParams) { + return ( + { + appID: '应用id', + }[field] + + ) + } -export function displayAppMessagesCount(field: keyof API.AppMessagesCount) { - return { - total: 'total', - }[field]; -} -export function displayAppModelConfigPromptPrefix( - field: keyof API.AppModelConfigPromptPrefix -) { - return { - background: 'background', - role: 'role', - switchRecommendedQuestion: 'switchRecommendedQuestion', - }[field]; -} -export function displayAppModelConfigs(field: keyof API.AppModelConfigs) { - return { - configs: 'configs', - prePrompt: 'prePrompt', - providerId: 'providerId', - }[field]; -} -export function displayAppRecommendedContext( - field: keyof API.AppRecommendedContext -) { - return { - appID: 'appID', - appRecommendedContextID: 'appRecommendedContextID', - context: 'context', - createdAt: 'createdAt', - description: 'description', - name: 'name', - updatedAt: 'updatedAt', - }[field]; -} + export function displayV1ApiAppAppIdDatasetConfigsUsingPostParams(field: keyof API.V1ApiAppAppIdDatasetConfigsUsingPostParams) { + return ( + { + appID: '应用id', + }[field] + + ) + } -export function displayAppRecommendedContext2( - field: keyof API.AppRecommendedContext2 -) { - return { - context: 'context', - description: 'description', - id: 'id', - name: 'name', - }[field]; -} -export function displayAppRecommendedContext3( - field: keyof API.AppRecommendedContext3 -) { - return { - context: 'context', - description: 'description', - id: 'id', - name: 'name', - }[field]; -} -export function displayAppRecommendedContextResp( - field: keyof API.AppRecommendedContextResp -) { - return { - questions: 'questions', - recommendSwitch: 'recommendSwitch', - }[field]; -} -export function displayAppResp(field: keyof API.AppResp) { - return { - appGroupID: 'appGroupID', - appGroupName: 'appGroupName', - appImage: 'appImage', - appStatus: 'appStatus', - createAt: 'createAt', - datasetCount: 'datasetCount', - description: 'description', - h5: 'h5', - id: 'id', - name: 'name', - pc: 'pc', - workspaceID: 'workspaceID', - }[field]; -} + export function displayV1ApiAppAppIdDatasetConfigsUsingPutParams(field: keyof API.V1ApiAppAppIdDatasetConfigsUsingPutParams) { + return ( + { + appID: '应用id', + }[field] + + ) + } -export function displayAppWithPermission(field: keyof API.AppWithPermission) { - return { - appID: 'appID', - appImage: 'appImage', - appStatus: 'appStatus', - appType: '应用类型', - createdAt: 'createdAt', - description: 'description', - groupID: 'groupID', - guidance: '开场提问引导', - isAppAdmin: 'isAppAdmin', - name: 'name', - operator: 'operator', - priority: '应用优先级', - prologue: 'prologue', - recommendSwitch: 'recommendSwitch', - templateStatus: '是否模版', - updatedAt: 'updatedAt', - workspaceID: 'workspaceID', - }[field]; -} -export function displayAttentionDataCountResp( - field: keyof API.AttentionDataCountResp -) { - return { - total: 'total', - }[field]; -} -export function displayAttentionUser(field: keyof API.AttentionUser) { - return { - email: 'email', - isAttentionUser: 'isAttentionUser', - phone: 'phone', - userID: 'userID', - userName: 'userName', - }[field]; -} -export function displayAttentionUserResp(field: keyof API.AttentionUserResp) { - return { - email: 'email', - lastMessageTime: 'lastMessageTime', - phone: 'phone', - userID: 'userID', - userName: 'userName', - }[field]; -} + export function displayV1ApiAppAppIdDatasetsListUsingGetParams(field: keyof API.V1ApiAppAppIdDatasetsListUsingGetParams) { + return ( + { + appID: '应用id', + size: 'size', + offset: 'offset', + }[field] + + ) + } + + + + + export function displayV1ApiAppAppIdDatasetsUsingDeleteParams(field: keyof API.V1ApiAppAppIdDatasetsUsingDeleteParams) { + return ( + { + appID: '应用id', + datasetID: '数据集id', + }[field] + + ) + } + + + + + + + export function displayV1ApiAppAppIdDatasetsUsingPostParams(field: keyof API.V1ApiAppAppIdDatasetsUsingPostParams) { + return ( + { + appID: '应用id', + }[field] + + ) + } + + + + + export function displayV1ApiAppAppIdDetailsUsingGetParams(field: keyof API.V1ApiAppAppIdDetailsUsingGetParams) { + return ( + { + appID: '应用id', + }[field] + + ) + } + + + + + export function displayV1ApiAppAppIdHourlyMessagesUsingGetParams(field: keyof API.V1ApiAppAppIdHourlyMessagesUsingGetParams) { + return ( + { + appID: '应用id', + starTimestamp: '开始时间，秒级时间戳', + endTimestamp: '结束时间，秒级时间戳', + }[field] + + ) + } + + + + + export function displayV1ApiAppAppIdHourlyTokenUsingGetParams(field: keyof API.V1ApiAppAppIdHourlyTokenUsingGetParams) { + return ( + { + appID: '应用id', + starTimestamp: '开始时间，秒级时间戳', + endTimestamp: '结束时间，秒级时间戳', + }[field] + + ) + } + + + + + export function displayV1ApiAppAppIdLogsConversationIdMessagesUsingGetParams(field: keyof API.V1ApiAppAppIdLogsConversationIdMessagesUsingGetParams) { + return ( + { + appID: '应用id', + conversationID: '会话id', + }[field] + + ) + } + + + + + export function displayV1ApiAppAppIdLogsUsingGetParams(field: keyof API.V1ApiAppAppIdLogsUsingGetParams) { + return ( + { + appID: '应用id', + conversationID: '会话id', + endTimestamp: '结束时间', + pageOffset: '页数1开始', + pageSize: '每页数量', + providerID: '模型id', + starTimestamp: '开始时间', + userID: '用户id', + }[field] + + ) + } + + + + + export function displayV1ApiAppAppIdMemberRoleUsingPutParams(field: keyof API.V1ApiAppAppIdMemberRoleUsingPutParams) { + return ( + { + appID: '应用id', + }[field] + + ) + } + + + + + export function displayV1ApiAppAppIdMemberUsingDeleteParams(field: keyof API.V1ApiAppAppIdMemberUsingDeleteParams) { + return ( + { + appID: '应用id', + }[field] + + ) + } + + + + + export function displayV1ApiAppAppIdMemberUsingGetParams(field: keyof API.V1ApiAppAppIdMemberUsingGetParams) { + return ( + { + appID: '应用id', + size: '每页大小', + offset: '分页', + }[field] + + ) + } + + + + + export function displayV1ApiAppAppIdMemberUsingPostParams(field: keyof API.V1ApiAppAppIdMemberUsingPostParams) { + return ( + { + appID: '应用id', + }[field] + + ) + } + + + + + export function displayV1ApiAppAppIdMessagesUsingGetParams(field: keyof API.V1ApiAppAppIdMessagesUsingGetParams) { + return ( + { + appID: '应用id', + starTimestamp: '开始时间，秒级时间戳', + endTimestamp: '结束时间，秒级时间戳', + }[field] + + ) + } + + + + + export function displayV1ApiAppAppIdModelConfigsUsingPostParams(field: keyof API.V1ApiAppAppIdModelConfigsUsingPostParams) { + return ( + { + appID: '应用id', + }[field] + + ) + } + + + + + export function displayV1ApiAppAppIdModelConfigsUsingPutParams(field: keyof API.V1ApiAppAppIdModelConfigsUsingPutParams) { + return ( + { + appID: '应用id', + }[field] + + ) + } + + + + + export function displayV1ApiAppAppIdModelPromptUsingPostParams(field: keyof API.V1ApiAppAppIdModelPromptUsingPostParams) { + return ( + { + appID: '应用id', + }[field] + + ) + } + + + + + export function displayV1ApiAppAppIdOpenApiDeleteUsingDeleteParams(field: keyof API.V1ApiAppAppIdOpenApiDeleteUsingDeleteParams) { + return ( + { + appID: '应用id', + }[field] + + ) + } + + + + + export function displayV1ApiAppAppIdPluginUsingPutParams(field: keyof API.V1ApiAppAppIdPluginUsingPutParams) { + return ( + { + appID: '应用id', + }[field] + + ) + } + + + + + export function displayV1ApiAppAppIdRecommendedContextUsingGetParams(field: keyof API.V1ApiAppAppIdRecommendedContextUsingGetParams) { + return ( + { + appID: '应用id', + }[field] + + ) + } + + + + + export function displayV1ApiAppAppIdRecommendedContextUsingPostParams(field: keyof API.V1ApiAppAppIdRecommendedContextUsingPostParams) { + return ( + { + appID: '应用id', + }[field] + + ) + } + + + + + export function displayV1ApiAppAppIdShareUsingPutParams(field: keyof API.V1ApiAppAppIdShareUsingPutParams) { + return ( + { + appID: '应用id', + isH5: '是否h5', + }[field] + + ) + } + + + + + export function displayV1ApiAppAppIdTokenUsingGetParams(field: keyof API.V1ApiAppAppIdTokenUsingGetParams) { + return ( + { + appID: '应用id', + starTimestamp: '开始时间，秒级时间戳', + endTimestamp: '结束时间，秒级时间戳', + }[field] + + ) + } + + + + + export function displayV1ApiAppAppIdUpdateStatusUsingPutParams(field: keyof API.V1ApiAppAppIdUpdateStatusUsingPutParams) { + return ( + { + appID: '应用id', + }[field] + + ) + } + + + + + export function displayV1ApiAppAppIdUpdateUsingPutParams(field: keyof API.V1ApiAppAppIdUpdateUsingPutParams) { + return ( + { + appID: '应用id', + }[field] + + ) + } + + + + + export function displayV1ApiAppH5ShareApiTokenUsingGetParams(field: keyof API.V1ApiAppH5ShareApiTokenUsingGetParams) { + return ( + { + randomPath: '分享的随机path', + }[field] + + ) + } + + + + + export function displayV1ApiAppIdCostUsingPostParams(field: keyof API.V1ApiAppIdCostUsingPostParams) { + return ( + { + appID: '应用id', + conversationID: '会话id', + endTimestamp: '结束时间', + pageOffset: '页数1开始', + pageSize: '每页数量', + providerID: '模型id', + starTimestamp: '开始时间', + userID: '用户id', + }[field] + + ) + } + + + + + + + + + export function displayV1ApiAppListPrivateUsingGetParams(field: keyof API.V1ApiAppListPrivateUsingGetParams) { + return ( + { + onlyConversations: '是否只查看会话过的应用', + }[field] + + ) + } + + + + + export function displayV1ApiAppListPublicUsingGetParams(field: keyof API.V1ApiAppListPublicUsingGetParams) { + return ( + { + onlyConversations: '是否只查看会话过的应用', + }[field] + + ) + } + + + + + + + export function displayV1ApiAppShareApiTokenUsingGetParams(field: keyof API.V1ApiAppShareApiTokenUsingGetParams) { + return ( + { + randomPath: '分享的随机path', + }[field] + + ) + } + + + + + + + export function displayV1ApiAttentionAppListUsingGetParams(field: keyof API.V1ApiAttentionAppListUsingGetParams) { + return ( + { + iamID: 'IAM用户id', + }[field] + + ) + } + + + + + + + + + + + export function displayV1ApiAttentionMessagesHistoryUsingGetParams(field: keyof API.V1ApiAttentionMessagesHistoryUsingGetParams) { + return ( + { + iamID: 'IAM ID', + appID: '应用id', + conversationID: '会话id', + }[field] + + ) + } + + + + + export function displayV1ApiAttentionUserAllUsingGetParams(field: keyof API.V1ApiAttentionUserAllUsingGetParams) { + return ( + { + iamID: '登陆用户IAMID', + isAttention: '用户id', + nameOrPhone: '名字或电话，模糊匹配', + offset: 'offset', + phone: '电话号码', + size: 'size', + userID: '用户id', + userName: '用户名字用于搜索', + }[field] + + ) + } + + + + + + + export function displayV1ApiAttentionUserListUsingPostParams(field: keyof API.V1ApiAttentionUserListUsingPostParams) { + return ( + { + iamID: 'IAM ID', + size: '默认10', + offset: '默认0', + }[field] + + ) + } + + + + + + + + + + + + + + + export function displayV1ApiConversationsConversationIdHistoryUsingDeleteParams(field: keyof API.V1ApiConversationsConversationIdHistoryUsingDeleteParams) { + return ( + { + conversation_id: '会话id', + message_id: '聊天信息id', + }[field] + + ) + } + + + + + export function displayV1ApiConversationsConversationIdHistoryUsingGetParams(field: keyof API.V1ApiConversationsConversationIdHistoryUsingGetParams) { + return ( + { + conversation_id: '会话id', + }[field] + + ) + } + + + + + export function displayV1ApiConversationsUsingDeleteParams(field: keyof API.V1ApiConversationsUsingDeleteParams) { + return ( + { + conversation_id: '会话id', + }[field] + + ) + } + + + + + export function displayV1ApiConversationsUsingGetParams(field: keyof API.V1ApiConversationsUsingGetParams) { + return ( + { + user_id: '用户id,空值不返回', + }[field] + + ) + } + + + + + export function displayV1ApiFeedbacksMessageIdUsingDeleteParams(field: keyof API.V1ApiFeedbacksMessageIdUsingDeleteParams) { + return ( + { + message_id: '消息id', + conversation_id: '会话id', + }[field] + + ) + } + + + + + export function displayV1ApiFeedbacksMessageIdUsingPostParams(field: keyof API.V1ApiFeedbacksMessageIdUsingPostParams) { + return ( + { + message_id: '消息id', + }[field] + + ) + } + + + + + export function displayV1ApiFeedbacksUsingGetParams(field: keyof API.V1ApiFeedbacksUsingGetParams) { + return ( + { + conversation_ID: 'conversation_ID', + message_ID: 'message_ID', + pageOffset: '页数1开始', + pageSize: '每页数量', + }[field] + + ) + } + + + + + + + export function displayV1ApiFileUsingPostParams(field: keyof API.V1ApiFileUsingPostParams) { + return ( + { + conversation_id: '会话id', + user_id: 'user id', + }[field] + + ) + } + + + + + export function displayV1ApiIamAccountUsingGetParams(field: keyof API.V1ApiIamAccountUsingGetParams) { + return ( + { + openId: 'openId', + }[field] + + ) + } + + + + + export function displayV1ApiProviderListUsingGetParams(field: keyof API.V1ApiProviderListUsingGetParams) { + return ( + { + size: 'size', + offset: 'offset', + }[field] + + ) + } + + + + + export function displayV1ApiRobotWorkspaceIdAppkeyStateUsingPostParams(field: keyof API.V1ApiRobotWorkspaceIdAppkeyStateUsingPostParams) { + return ( + { + workspaceID: '空间ID', + }[field] + + ) + } + + + + + export function displayV1ApiRobotWorkspaceIdAppkeyUsingDeleteParams(field: keyof API.V1ApiRobotWorkspaceIdAppkeyUsingDeleteParams) { + return ( + { + workspaceID: '空间ID', + }[field] + + ) + } + + + + + export function displayV1ApiRobotWorkspaceIdAppkeyUsingGetParams(field: keyof API.V1ApiRobotWorkspaceIdAppkeyUsingGetParams) { + return ( + { + workspaceID: '空间ID', + appid: 'appid', + type: 'wjl,dingding,feishu,wxa,wx', + }[field] + + ) + } + + + + + export function displayV1ApiRobotWorkspaceIdAppkeyUsingPostParams(field: keyof API.V1ApiRobotWorkspaceIdAppkeyUsingPostParams) { + return ( + { + workspaceID: '空间ID', + }[field] + + ) + } + + + + + + + + + + + export function displayV1ApiUserInfoUsingGetParams(field: keyof API.V1ApiUserInfoUsingGetParams) { + return ( + { + appID: '应用id', + }[field] + + ) + } + -export function displayAuthAuthorizeUsingGetParams( - field: keyof API.AuthAuthorizeUsingGetParams -) { - return { - redirect_uri: '业务回调地址', - state: '保持请求和回调的状态，授权成功后会回传该参数', - }[field]; -} -export function displayAuthExchangeUsingGetParams( - field: keyof API.AuthExchangeUsingGetParams -) { - return { - code: 'code', - redirect_uri: '业务回调地址', - }[field]; -} -export function displayChat(field: keyof API.Chat) { - return { - conversation_id: 'conversation_id', - inputs: 'inputs', - isIgnore: 'isIgnore', - query: 'query', - response_mode: 'response_mode', - user: 'user', - }[field]; -} -export function displayChatMessageReq(field: keyof API.ChatMessageReq) { - return { - prompt: 'prompt', - query: 'query', - }[field]; -} -export function displayConversationLogsResp( - field: keyof API.ConversationLogsResp -) { - return { - AnswerTokensCount: '消耗输出token', - appID: 'appID', - conversationID: 'conversationID', - conversationName: 'conversationName', - createdAt: 'createdAt', - messagesCount: 'messagesCount', - queryTokensCount: '消耗输入token', - totalTokens: '消耗总token', - userID: 'userID', - userInfo: 'userInfo', - }[field]; -} + export function displayV1ApiUserUsingGetParams(field: keyof API.V1ApiUserUsingGetParams) { + return ( + { + offset: 'offset', + phone: '电话号码', + size: 'size', + userID: '用户id', + userName: '用户名字用于搜索', + }[field] + + ) + } -export function displayConversationMsg(field: keyof API.ConversationMsg) { - return { - conversationId: 'conversationId', - createAt: 'createAt', - name: 'name', - userId: 'userId', - }[field]; -} -export function displayConversationResp(field: keyof API.ConversationResp) { - return { - AnswerTokensCount: '消耗输出token', - appID: 'appID', - appName: 'appName', - conversationID: 'conversationID', - conversationName: 'conversationName', - createdAt: 'createdAt', - lastMessagesTime: 'lastMessagesTime', - messagesCount: 'messagesCount', - queryTokensCount: '消耗输入token', - totalTokens: '消耗总token', - userID: 'userID', - userInfo: 'userInfo', - }[field]; -} -export function displayCopyAppReq(field: keyof API.CopyAppReq) { - return { - appID: 'appID', - workspaceID: 'workspaceID', - }[field]; -} -export function displayCreateApiTokenRESP(field: keyof API.CreateApiTokenRESP) { - return { - token: 'token', - }[field]; -} + export function displayV2ApiAppAppIdDetailsUsingGetParams(field: keyof API.V2ApiAppAppIdDetailsUsingGetParams) { + return ( + { + appID: '应用id', + }[field] + + ) + } -export function displayCreateAppReq(field: keyof API.CreateAppReq) { - return { - description: 'description', - guidance: 'guidance', - name: 'name', - prologue: 'prologue', - }[field]; -} -export function displayCreateAppReqV2(field: keyof API.CreateAppReqV2) { - return { - appDescription: 'appDescription', - appGroupID: 'appGroupID', - appGuidance: '提示查询', - appImage: 'appImage', - appName: 'appName', - appPrologue: '开场白', - historyLimit: 'historyLimit', - modelConfigs: 'modelConfigs', - prePrompt: 'prePrompt', - providerId: 'providerId', - }[field]; -} -export function displayCreateAttentionReq(field: keyof API.CreateAttentionReq) { - return { - followeeUserIDList: 'followeeUserIDList', - iamID: 'iamID', - }[field]; -} -export function displayCreateSharePathRESP( - field: keyof API.CreateSharePathRESP -) { - return { - path: 'path', - }[field]; -} + export function displayV2ApiAppAppIdUpdateUsingPostParams(field: keyof API.V2ApiAppAppIdUpdateUsingPostParams) { + return ( + { + appID: '应用id', + }[field] + + ) + } -export function displayData(field: keyof API.Data) { - return { - appkey: 'appkey', - appsecret: 'appsecret', - state: '0-未开启，1-开启', - url: 'url', - wxExtra: 'wxExtra', - }[field]; -} -export function displayDatasetData(field: keyof API.DatasetData) { - return { - author: 'author', - description: 'description', - docCount: 'docCount', - document_count: 'document_count', - id: 'id', - name: 'name', - permission: 'permission', - state: 'state', - uuid: 'uuid', - word_count: 'word_count', - }[field]; -} -export function displayDeleteAttentionReq(field: keyof API.DeleteAttentionReq) { - return { - followeeUserIDList: 'followeeUserIDList', - iamID: 'iamID', - }[field]; -} -export function displayDeleteMemberBody(field: keyof API.DeleteMemberBody) { - return { - userID: '用户id', - }[field]; -} + export function displayV2ApiAppListUsingGetParams(field: keyof API.V2ApiAppListUsingGetParams) { + return ( + { + onlyConversations: '是否只查看会话过的应用', + }[field] + + ) + } -export function displayDeleteResp(field: keyof API.DeleteResp) { - return { - msg: 'msg', - }[field]; -} -export function displayErrorResp(field: keyof API.ErrorResp) { - return { - msg: 'msg', - type: 'type', - }[field]; -} -export function displayExchangeTokenRESP(field: keyof API.ExchangeTokenRESP) { - return { - access_token: '访问令牌', - expires_in: '访问令牌过期时间', - refresh_expires_in: '刷新令牌过期时间', - refresh_token: '刷新令牌', - token_type: '令牌类型', - }[field]; -} -export function displayFeedback(field: keyof API.Feedback) { - return { - comment: '评论', - conversation_id: 'conversation_id', - createdAt: 'createdAt', - message_id: 'message_id', - rating: 'like/unlike', - score: '打分', - updatedAt: 'updatedAt', - }[field]; -} + export function displayV2ApiAppShareApiTokenUsingGetParams(field: keyof API.V2ApiAppShareApiTokenUsingGetParams) { + return ( + { + randomPath: '分享的随机path', + }[field] + + ) + } -export function displayFeedbacksReqBody(field: keyof API.FeedbacksReqBody) { - return { - comment: '评论', - conversation_id: 'conversation_id', - rating: 'like/unlike', - score: '分数1-10', - }[field]; -} -export function displayFilestreamResp(field: keyof API.FilestreamResp) { - return { - conversation_id: 'conversation_id', - }[field]; -} -export function displayGetApiTokenByRandomPathRESP( - field: keyof API.GetApiTokenByRandomPathRESP -) { - return { - apiTokenID: 'apiTokenID', - appID: 'appID', - appName: 'appName', - createdAt: 'createdAt', - recommendedContext: 'recommendedContext', - switchRecommendedContext: 'switchRecommendedContext', - switchRecommendedQuestion: 'switchRecommendedQuestion', - token: 'token', - updatedAt: 'updatedAt', - }[field]; -} -export function displayGetAppKeyReq(field: keyof API.GetAppKeyReq) { - return { - appid: 'appid', - type: 'wjl,dingding,feishu,wxa,wx', - }[field]; -} -export function displayGetAttentionDataCountReq( - field: keyof API.GetAttentionDataCountReq -) { - return { - appIDList: 'appIDList', - iamID: 'iamID', - userID: 'userID', - }[field]; -} -export function displayGetImagePreSignedUrlResp( - field: keyof API.GetImagePreSignedUrlResp -) { - return { - appImage: 'appImage', - preSignedPutUrl: 'preSignedPutUrl', - }[field]; -} + export function displayV2ApiChatMessagesMessagesCountUsingGetParams(field: keyof API.V2ApiChatMessagesMessagesCountUsingGetParams) { + return ( + { + isPerPerson: '是否查询人均,默认false', + starTimestamp: '开始时间，秒级时间戳', + endTimestamp: '结束时间，秒级时间戳', + }[field] + + ) + } -export function displayGuidances(field: keyof API.Guidances) { - return { - items: 'items', - }[field]; -} -export function displayHistoryInfo(field: keyof API.HistoryInfo) { - return { - Rating: 'like/unlike', - answer: 'answer', - answerToken: 'answerToken', - comment: '评论', - createAt: 'createAt', - format: 'format', - messageId: 'messageId', - query: 'query', - queryToken: 'queryToken', - score: '打分', - totalToken: 'totalToken', - }[field]; -} -export function displayIAMUserInfo(field: keyof API.IAMUserInfo) { - return { - createdTime: '创建时间', - email: 'Cid string `json:"cid"`', - id: '用户id', - idpId: 'idpId', - isAdmin: '是否iam管理员', - isAppAdmin: 'isAppAdmin', - isRkUser: '是否罗克佳华人员', - isSuperUser: '是否超级管理员', - isSystemAdmin: 'isSystemAdmin', - lastTime: 'Deleted int32 `json:"deleted"` // 逻辑删除', - loginName: '登录名', - msgType: '消息类型', - phone: '电话', - rkUserCard: '罗克佳华用户账号', - sign: '个性签名', - status: '状态：1可用；0未激活；-1禁用', - updatedTime: '修改时间', - useType: '用户类型', - userName: '用户名', - wechatAppId: 'wechatAppId', - wechatSwitch: 'wechatSwitch', - wechatgzhSwitch: 'wechatgzhSwitch', - }[field]; -} -export function displayListAllAttentionUser( - field: keyof API.ListAllAttentionUser -) { - return { - data: 'data', - total: 'total', - }[field]; -} -export function displayListAppDatasetConfigResp( - field: keyof API.ListAppDatasetConfigResp -) { - return { - data: 'data', - total: 'total', - }[field]; -} -export function displayListAppDatasets(field: keyof API.ListAppDatasets) { - return { - Data: 'Data', - total: 'total', - }[field]; -} -export function displayListAppResp(field: keyof API.ListAppResp) { - return { - data: 'data', - total: 'total', - }[field]; -} -export function displayListAttentionConversationReq( - field: keyof API.ListAttentionConversationReq -) { - return { - appIDList: 'appIDList', - iamID: 'iamID', - offset: 'offset', - size: 'size', - userID: 'userID', - }[field]; -} -export function displayListAttentionUserResp( - field: keyof API.ListAttentionUserResp -) { - return { - data: 'data', - total: 'total', - }[field]; -} -export function displayListConversationLogsResp( - field: keyof API.ListConversationLogsResp -) { - return { - data: 'data', - total: 'total', - }[field]; -} + export function displayV2ApiFileUsingPostParams(field: keyof API.V2ApiFileUsingPostParams) { + return ( + { + conversation_id: '会话id', + user_id: 'user id', + }[field] + + ) + } -export function displayListConversationResp( - field: keyof API.ListConversationResp -) { - return { - data: 'data', - total: 'total', - }[field]; -} -export function displayListDatasetsResp(field: keyof API.ListDatasetsResp) { - return { - data: 'data', - has_more: 'has_more', - offset: 'offset', - size: 'size', - total: 'total', - }[field]; -} -export function displayListFeedbacksResp(field: keyof API.ListFeedbacksResp) { - return { - data: 'data', - total: 'total', - }[field]; -} -export function displayListMemberRESP(field: keyof API.ListMemberRESP) { - return { - data: 'data', - total: 'total', - }[field]; -} -export function displayListProviderResp(field: keyof API.ListProviderResp) { - return { - data: 'data', - total: 'total', - }[field]; -} -export function displayListUserWithAppRESP( - field: keyof API.ListUserWithAppRESP -) { - return { - data: 'data', - total: 'total', - }[field]; -} + export function displayV2ApiWorkspacesDefaultUsingPostParams(field: keyof API.V2ApiWorkspacesDefaultUsingPostParams) { + return ( + { + workspaceID: '空间ID', + }[field] + + ) + } -export function displayListWorkspaceGroup(field: keyof API.ListWorkspaceGroup) { - return { - data: 'data', - }[field]; -} -export function displayListWorkspacePermissions( - field: keyof API.ListWorkspacePermissions -) { - return { - data: 'data', - total: 'total', - }[field]; -} -export function displayMemberBody(field: keyof API.MemberBody) { - return { - role: '角色(system_admin-系统管理员;system_user-系统管普通用户;app_admin-应用管理员;app_user-应用普通用户)', - userID: '用户id', - }[field]; -} -export function displayMemberWithRoleData(field: keyof API.MemberWithRoleData) { - return { - appRole: '应用角色', - createdAt: 'createdAt', - email: 'email', - idpID: 'idpID', - isAppAdmin: '是否是app管理员', - isSystemAdmin: '是否是系统管理员', - operator: 'operator', - phone: 'phone', - role: '角色(系统管理员、系统普通用户)', - updatedAt: 'updatedAt', - userID: 'iam 用户id', - userName: 'userName', - }[field]; -} + export function displayV2ApiWorkspacesRecommendedMessageIdDetailsUsingGetParams(field: keyof API.V2ApiWorkspacesRecommendedMessageIdDetailsUsingGetParams) { + return ( + { + messageId: '消息id', + }[field] + + ) + } -export function displayMessagesCountResp(field: keyof API.MessagesCountResp) { - return { - messagesCount: '请求消耗token', - time: 'time', - }[field]; -} -export function displayMessagesTokenResp(field: keyof API.MessagesTokenResp) { - return { - answerToken: '回答消耗token', - queryToken: '请求消耗token', - time: 'time', - totalToken: 'totalToken', - }[field]; -} -export function displayModelConfigsMap(field: keyof API.ModelConfigsMap) { - return { - model_type: - '模型(ERNIE-Bot-4;ERNIE-Bot;ERNIE-Bot-turbo;gpt-3.5-turbo-16k;gpt-4-1106-preview)', - penalty_score: - '通过对已生成的token增加惩罚，减少重复生成的现象。取值范围：[1.0, 2.0]', - temperature: - '较高的数值会使输出更加随机，而较低的数值会使其更加集中和确定。默认0.95，范围 (0, 1.0]', - tools_call: 'tools call', - top_p: - '影响输出文本的多样性，取值越大，生成文本的多样性越强。取值范围 [0, 1.0]', - }[field]; -} -export function displayModelConfigsMap2(field: keyof API.ModelConfigsMap2) { - return { - model_type: - '模型(ERNIE-Bot-4;ERNIE-Bot;ERNIE-Bot-turbo;gpt-3.5-turbo-16k;gpt-4-1106-preview)', - penalty_score: - '通过对已生成的token增加惩罚，减少重复生成的现象。取值范围：[1.0, 2.0]', - temperature: - '较高的数值会使输出更加随机，而较低的数值会使其更加集中和确定。默认0.95，范围 (0, 1.0]', - tools_call: 'tools_call', - top_p: - '影响输出文本的多样性，取值越大，生成文本的多样性越强。取值范围 [0, 1.0]', - }[field]; -} -export function displayProviderResp(field: keyof API.ProviderResp) { - return { - name: '名字', - providerID: 'providerID', - subType: 'subType', - type: '类型', - }[field]; -} -export function displayQueryTokenResp(field: keyof API.QueryTokenResp) { - return { - AnswerTokensCount: '消耗输出token', - queryTokensCount: '消耗输入token', - totalTokens: '消耗总token', - }[field]; -} -export function displayQuestionRecommendReq( - field: keyof API.QuestionRecommendReq -) { - return { - conversation_id: 'conversation_id', - user: 'Query string `json:"query"`Answer string `json:"answer"`', - }[field]; -} -export function displayRecommendQuestionAndContext( - field: keyof API.RecommendQuestionAndContext -) { - return { - contexts: 'contexts', - questions: 'questions', - }[field]; -} -export function displayRefreshTokenBody(field: keyof API.RefreshTokenBody) { - return { - refreshToken: 'refreshToken', - }[field]; -} -export function displayReleaseDiscoverReq(field: keyof API.ReleaseDiscoverReq) { - return { - alterAppID: 'alterAppID', - appType: '应用类型', - templateStatus: '是否作为模版 TRUE:作为模版；FALSE:不作为', - }[field]; -} + export function displayV2ApiWorkspacesWorkspaceIdAppAppIdDatasetsJoinUsingPostParams(field: keyof API.V2ApiWorkspacesWorkspaceIdAppAppIdDatasetsJoinUsingPostParams) { + return ( + { + workspaceID: '空间ID', + appID: '应用id', + }[field] + + ) + } -export function displayResponseData(field: keyof API.ResponseData) { - return { - answer: 'answer', - conversation_id: 'conversation_id', - created_at: 'created_at', - event: 'event', - id: 'id', - trace_id: 'trace_id', - }[field]; -} -export function displayResponseRecommendData( - field: keyof API.ResponseRecommendData -) { - return { - answer: 'answer', - conversation_id: 'conversation_id', - created_at: 'created_at', - event: 'event', - id: 'id', - trace_id: 'trace_id', - }[field]; -} -export function displaySpeechToTextResp(field: keyof API.SpeechToTextResp) { - return { - text: '转化的结果', - }[field]; -} -export function displayTextToSpeechReq(field: keyof API.TextToSpeechReq) { - return { - text: '需要转的文字', - }[field]; -} + export function displayV2ApiWorkspacesWorkspaceIdAppAppIdDatasetsUsingDeleteParams(field: keyof API.V2ApiWorkspacesWorkspaceIdAppAppIdDatasetsUsingDeleteParams) { + return ( + { + appID: '应用id', + workspaceID: '空间ID', + datasetID: '数据集id', + }[field] + + ) + } -export function displayUpdateAppGroup(field: keyof API.UpdateAppGroup) { - return { - appGroupID: 'appGroupID', - }[field]; -} -export function displayUpdateAppKeyStateReq( - field: keyof API.UpdateAppKeyStateReq -) { - return { - appid: 'appid', - state: '0-关闭，1-启动', - type: 'wjl,dingding,feishu', - }[field]; -} -export function displayUpdateAppReq(field: keyof API.UpdateAppReq) { - return { - appDescription: 'appDescription', - appGroupID: 'appGroupID', - appImage: 'appImage', - appName: 'appName', - }[field]; -} -export function displayUpdateAppReqV2(field: keyof API.UpdateAppReqV2) { - return { - appGroupID: 'appGroupID', - appGuidance: '提示查询', - appPrologue: '开场白', - appRecommendedContexts: '推荐内容', - historyLimit: 'historyLimit', - modelConfigs: 'modelConfigs', - prePrompt: 'prePrompt', - providerId: 'providerId', - recommendSwitch: 'recommendSwitch', - }[field]; -} + export function displayV2ApiWorkspacesWorkspaceIdAppAppIdDetailsUsingGetParams(field: keyof API.V2ApiWorkspacesWorkspaceIdAppAppIdDetailsUsingGetParams) { + return ( + { + workspaceID: '空间ID', + appID: '应用id', + }[field] + + ) + } -export function displayUpdateAppStatusReq(field: keyof API.UpdateAppStatusReq) { - return { - appStatus: 'PUBLIC:公开；PRIVATE:私有', - }[field]; -} -export function displayUpdateUserRoleBody(field: keyof API.UpdateUserRoleBody) { - return { - role: '角色(system_admin-系统管理员;system_user-系统管普通用户;app_admin-应用管理员;app_user-应用普通用户)', - userID: '用户id', - }[field]; -} -export function displayUser(field: keyof API.User) { - return { - createdAt: 'createdAt', - email: 'email', - idpID: 'idpID', - operator: 'operator', - phone: 'phone', - role: '角色(系统管理员、系统普通用户)', - updatedAt: 'updatedAt', - userID: 'iam 用户id', - userName: 'userName', - }[field]; -} -export function displayUserWithAppData(field: keyof API.UserWithAppData) { - return { - appWithPermissionList: 'appWithPermissionList', - createdAt: 'createdAt', - email: 'email', - idpID: 'idpID', - isSystemAdmin: 'isSystemAdmin', - operator: 'operator', - phone: 'phone', - role: '角色(系统管理员、系统普通用户)', - updatedAt: 'updatedAt', - userID: 'iam 用户id', - userName: 'userName', - }[field]; -} + export function displayV2ApiWorkspacesWorkspaceIdAppAppIdHourlyMessagesUsingGetParams(field: keyof API.V2ApiWorkspacesWorkspaceIdAppAppIdHourlyMessagesUsingGetParams) { + return ( + { + workspaceID: '空间ID', + appID: '应用id', + starTimestamp: '开始时间，秒级时间戳', + endTimestamp: '结束时间，秒级时间戳', + }[field] + + ) + } -export function displayV1ApiAppAppIdApiTokenUsingGetParams( - field: keyof API.V1ApiAppAppIdApiTokenUsingGetParams -) { - return { - appID: '应用id', - size: '每页大小', - offset: '分页', - }[field]; -} -export function displayV1ApiAppAppIdApiTokenUsingPostParams( - field: keyof API.V1ApiAppAppIdApiTokenUsingPostParams -) { - return { - appID: '应用id', - }[field]; -} -export function displayV1ApiAppAppIdDatasetConfigsUsingDeleteParams( - field: keyof API.V1ApiAppAppIdDatasetConfigsUsingDeleteParams -) { - return { - appID: '应用id', - appDatasetConfigID: '应用知识库配置id', - }[field]; -} -export function displayV1ApiAppAppIdDatasetConfigsUsingGetParams( - field: keyof API.V1ApiAppAppIdDatasetConfigsUsingGetParams -) { - return { - appID: '应用id', - }[field]; -} + export function displayV2ApiWorkspacesWorkspaceIdAppAppIdHourlyTokenUsingGetParams(field: keyof API.V2ApiWorkspacesWorkspaceIdAppAppIdHourlyTokenUsingGetParams) { + return ( + { + workspaceID: '空间ID', + appID: '应用id', + starTimestamp: '开始时间，秒级时间戳', + endTimestamp: '结束时间，秒级时间戳', + }[field] + + ) + } -export function displayV1ApiAppAppIdDatasetConfigsUsingPostParams( - field: keyof API.V1ApiAppAppIdDatasetConfigsUsingPostParams -) { - return { - appID: '应用id', - }[field]; -} -export function displayV1ApiAppAppIdDatasetConfigsUsingPutParams( - field: keyof API.V1ApiAppAppIdDatasetConfigsUsingPutParams -) { - return { - appID: '应用id', - }[field]; -} -export function displayV1ApiAppAppIdDatasetsListUsingGetParams( - field: keyof API.V1ApiAppAppIdDatasetsListUsingGetParams -) { - return { - appID: '应用id', - size: 'size', - offset: 'offset', - }[field]; -} -export function displayV1ApiAppAppIdDatasetsUsingDeleteParams( - field: keyof API.V1ApiAppAppIdDatasetsUsingDeleteParams -) { - return { - appID: '应用id', - datasetID: '数据集id', - }[field]; -} + export function displayV2ApiWorkspacesWorkspaceIdAppAppIdLogsUsingGetParams(field: keyof API.V2ApiWorkspacesWorkspaceIdAppAppIdLogsUsingGetParams) { + return ( + { + appID: '应用id', + workspaceID: '空间ID', + conversationID: '会话id', + endTimestamp: '结束时间', + pageOffset: '页数1开始', + pageSize: '每页数量', + providerID: '模型id', + starTimestamp: '开始时间', + userID: '用户id', + }[field] + + ) + } -export function displayV1ApiAppAppIdDatasetsUsingPostParams( - field: keyof API.V1ApiAppAppIdDatasetsUsingPostParams -) { - return { - appID: '应用id', - }[field]; -} -export function displayV1ApiAppAppIdDetailsUsingGetParams( - field: keyof API.V1ApiAppAppIdDetailsUsingGetParams -) { - return { - appID: '应用id', - }[field]; -} -export function displayV1ApiAppAppIdHourlyMessagesUsingGetParams( - field: keyof API.V1ApiAppAppIdHourlyMessagesUsingGetParams -) { - return { - appID: '应用id', - starTimestamp: '开始时间，秒级时间戳', - endTimestamp: '结束时间，秒级时间戳', - }[field]; -} -export function displayV1ApiAppAppIdHourlyTokenUsingGetParams( - field: keyof API.V1ApiAppAppIdHourlyTokenUsingGetParams -) { - return { - appID: '应用id', - starTimestamp: '开始时间，秒级时间戳', - endTimestamp: '结束时间，秒级时间戳', - }[field]; -} + export function displayV2ApiWorkspacesWorkspaceIdAppAppIdMessagesUsingGetParams(field: keyof API.V2ApiWorkspacesWorkspaceIdAppAppIdMessagesUsingGetParams) { + return ( + { + workspaceID: '空间ID', + appID: '应用id', + starTimestamp: '开始时间，秒级时间戳', + endTimestamp: '结束时间，秒级时间戳', + }[field] + + ) + } -export function displayV1ApiAppAppIdLogsConversationIdMessagesUsingGetParams( - field: keyof API.V1ApiAppAppIdLogsConversationIdMessagesUsingGetParams -) { - return { - appID: '应用id', - conversationID: '会话id', - }[field]; -} -export function displayV1ApiAppAppIdLogsUsingGetParams( - field: keyof API.V1ApiAppAppIdLogsUsingGetParams -) { - return { - appID: '应用id', - conversationID: '会话id', - endTimestamp: '结束时间', - pageOffset: '页数1开始', - pageSize: '每页数量', - providerID: '模型id', - starTimestamp: '开始时间', - userID: '用户id', - }[field]; -} -export function displayV1ApiAppAppIdMemberRoleUsingPutParams( - field: keyof API.V1ApiAppAppIdMemberRoleUsingPutParams -) { - return { - appID: '应用id', - }[field]; -} -export function displayV1ApiAppAppIdMemberUsingDeleteParams( - field: keyof API.V1ApiAppAppIdMemberUsingDeleteParams -) { - return { - appID: '应用id', - }[field]; -} + export function displayV2ApiWorkspacesWorkspaceIdAppAppIdModelConfigsUsingPutParams(field: keyof API.V2ApiWorkspacesWorkspaceIdAppAppIdModelConfigsUsingPutParams) { + return ( + { + appID: '应用id', + workspaceID: '空间ID', + }[field] + + ) + } + -export function displayV1ApiAppAppIdMemberUsingGetParams( - field: keyof API.V1ApiAppAppIdMemberUsingGetParams -) { - return { - appID: '应用id', - size: '每页大小', - offset: '分页', - }[field]; -} -export function displayV1ApiAppAppIdMemberUsingPostParams( - field: keyof API.V1ApiAppAppIdMemberUsingPostParams -) { - return { - appID: '应用id', - }[field]; -} -export function displayV1ApiAppAppIdMessagesUsingGetParams( - field: keyof API.V1ApiAppAppIdMessagesUsingGetParams -) { - return { - appID: '应用id', - starTimestamp: '开始时间，秒级时间戳', - endTimestamp: '结束时间，秒级时间戳', - }[field]; -} + export function displayV2ApiWorkspacesWorkspaceIdAppAppIdPluginUsingGetParams(field: keyof API.V2ApiWorkspacesWorkspaceIdAppAppIdPluginUsingGetParams) { + return ( + { + appID: '应用id', + workspaceID: '空间ID', + }[field] + + ) + } -export function displayV1ApiAppAppIdModelConfigsUsingPostParams( - field: keyof API.V1ApiAppAppIdModelConfigsUsingPostParams -) { - return { - appID: '应用id', - }[field]; -} -export function displayV1ApiAppAppIdModelConfigsUsingPutParams( - field: keyof API.V1ApiAppAppIdModelConfigsUsingPutParams -) { - return { - appID: '应用id', - }[field]; -} -export function displayV1ApiAppAppIdModelPromptUsingPostParams( - field: keyof API.V1ApiAppAppIdModelPromptUsingPostParams -) { - return { - appID: '应用id', - }[field]; -} -export function displayV1ApiAppAppIdOpenApiDeleteUsingDeleteParams( - field: keyof API.V1ApiAppAppIdOpenApiDeleteUsingDeleteParams -) { - return { - appID: '应用id', - }[field]; -} + export function displayV2ApiWorkspacesWorkspaceIdAppAppIdTokenUsingGetParams(field: keyof API.V2ApiWorkspacesWorkspaceIdAppAppIdTokenUsingGetParams) { + return ( + { + appID: '应用id', + starTimestamp: '开始时间，秒级时间戳', + endTimestamp: '结束时间，秒级时间戳', + }[field] + + ) + } -export function displayV1ApiAppAppIdPluginUsingPutParams( - field: keyof API.V1ApiAppAppIdPluginUsingPutParams -) { - return { - appID: '应用id', - }[field]; -} -export function displayV1ApiAppAppIdRecommendedContextUsingGetParams( - field: keyof API.V1ApiAppAppIdRecommendedContextUsingGetParams -) { - return { - appID: '应用id', - }[field]; -} -export function displayV1ApiAppAppIdRecommendedContextUsingPostParams( - field: keyof API.V1ApiAppAppIdRecommendedContextUsingPostParams -) { - return { - appID: '应用id', - }[field]; -} -export function displayV1ApiAppAppIdShareUsingPutParams( - field: keyof API.V1ApiAppAppIdShareUsingPutParams -) { - return { - appID: '应用id', - isH5: '是否h5', - }[field]; -} + export function displayV2ApiWorkspacesWorkspaceIdAppAppIdUpdateStatusUsingPutParams(field: keyof API.V2ApiWorkspacesWorkspaceIdAppAppIdUpdateStatusUsingPutParams) { + return ( + { + workspaceID: '空间ID', + appID: '应用id', + }[field] + + ) + } -export function displayV1ApiAppAppIdTokenUsingGetParams( - field: keyof API.V1ApiAppAppIdTokenUsingGetParams -) { - return { - appID: '应用id', - starTimestamp: '开始时间，秒级时间戳', - endTimestamp: '结束时间，秒级时间戳', - }[field]; -} -export function displayV1ApiAppAppIdUpdateStatusUsingPutParams( - field: keyof API.V1ApiAppAppIdUpdateStatusUsingPutParams -) { - return { - appID: '应用id', - }[field]; -} -export function displayV1ApiAppAppIdUpdateUsingPutParams( - field: keyof API.V1ApiAppAppIdUpdateUsingPutParams -) { - return { - appID: '应用id', - }[field]; -} -export function displayV1ApiAppH5ShareApiTokenUsingGetParams( - field: keyof API.V1ApiAppH5ShareApiTokenUsingGetParams -) { - return { - randomPath: '分享的随机path', - }[field]; -} + export function displayV2ApiWorkspacesWorkspaceIdAppAppIdUsingPostParams(field: keyof API.V2ApiWorkspacesWorkspaceIdAppAppIdUsingPostParams) { + return ( + { + workspaceID: '空间ID', + appID: '应用id', + }[field] + + ) + } -export function displayV1ApiAppIdCostUsingPostParams( - field: keyof API.V1ApiAppIdCostUsingPostParams -) { - return { - appID: '应用id', - conversationID: '会话id', - endTimestamp: '结束时间', - pageOffset: '页数1开始', - pageSize: '每页数量', - providerID: '模型id', - starTimestamp: '开始时间', - userID: '用户id', - }[field]; -} -export function displayV1ApiAppListPrivateUsingGetParams( - field: keyof API.V1ApiAppListPrivateUsingGetParams -) { - return { - onlyConversations: '是否只查看会话过的应用', - }[field]; -} -export function displayV1ApiAppListPublicUsingGetParams( - field: keyof API.V1ApiAppListPublicUsingGetParams -) { - return { - onlyConversations: '是否只查看会话过的应用', - }[field]; -} -export function displayV1ApiAppShareApiTokenUsingGetParams( - field: keyof API.V1ApiAppShareApiTokenUsingGetParams -) { - return { - randomPath: '分享的随机path', - }[field]; -} + export function displayV2ApiWorkspacesWorkspaceIdAppsAppIdBaseUsingPostParams(field: keyof API.V2ApiWorkspacesWorkspaceIdAppsAppIdBaseUsingPostParams) { + return ( + { + appID: '应用id', + workspaceID: '空间ID', + }[field] + + ) + } -export function displayV1ApiAttentionAppListUsingGetParams( - field: keyof API.V1ApiAttentionAppListUsingGetParams -) { - return { - iamID: 'IAM用户id', - }[field]; -} -export function displayV1ApiAttentionMessagesHistoryUsingGetParams( - field: keyof API.V1ApiAttentionMessagesHistoryUsingGetParams -) { - return { - iamID: 'IAM ID', - appID: '应用id', - conversationID: '会话id', - }[field]; -} -export function displayV1ApiAttentionUserAllUsingGetParams( - field: keyof API.V1ApiAttentionUserAllUsingGetParams -) { - return { - iamID: '登陆用户IAMID', - isAttention: '用户id', - nameOrPhone: '名字或电话，模糊匹配', - offset: 'offset', - phone: '电话号码', - size: 'size', - userID: '用户id', - userName: '用户名字用于搜索', - }[field]; -} -export function displayV1ApiAttentionUserListUsingPostParams( - field: keyof API.V1ApiAttentionUserListUsingPostParams -) { - return { - iamID: 'IAM ID', - size: '默认10', - offset: '默认0', - }[field]; -} + export function displayV2ApiWorkspacesWorkspaceIdAppsAppIdGroupUsingPostParams(field: keyof API.V2ApiWorkspacesWorkspaceIdAppsAppIdGroupUsingPostParams) { + return ( + { + appID: '应用id', + workspaceID: '空间ID', + }[field] + + ) + } -export function displayV1ApiConversationsConversationIdHistoryUsingDeleteParams( - field: keyof API.V1ApiConversationsConversationIdHistoryUsingDeleteParams -) { - return { - conversation_id: '会话id', - message_id: '聊天信息id', - }[field]; -} -export function displayV1ApiConversationsConversationIdHistoryUsingGetParams( - field: keyof API.V1ApiConversationsConversationIdHistoryUsingGetParams -) { - return { - conversation_id: '会话id', - }[field]; -} -export function displayV1ApiConversationsUsingDeleteParams( - field: keyof API.V1ApiConversationsUsingDeleteParams -) { - return { - conversation_id: '会话id', - }[field]; -} -export function displayV1ApiConversationsUsingGetParams( - field: keyof API.V1ApiConversationsUsingGetParams -) { - return { - user_id: '用户id,空值不返回', - }[field]; -} + export function displayV2ApiWorkspacesWorkspaceIdAppsAppIdUsingDeleteParams(field: keyof API.V2ApiWorkspacesWorkspaceIdAppsAppIdUsingDeleteParams) { + return ( + { + appID: '应用id', + workspaceID: '空间ID', + }[field] + + ) + } -export function displayV1ApiFeedbacksMessageIdUsingDeleteParams( - field: keyof API.V1ApiFeedbacksMessageIdUsingDeleteParams -) { - return { - message_id: '消息id', - conversation_id: '会话id', - }[field]; -} -export function displayV1ApiFeedbacksMessageIdUsingPostParams( - field: keyof API.V1ApiFeedbacksMessageIdUsingPostParams -) { - return { - message_id: '消息id', - }[field]; -} -export function displayV1ApiFeedbacksUsingGetParams( - field: keyof API.V1ApiFeedbacksUsingGetParams -) { - return { - conversation_ID: 'conversation_ID', - message_ID: 'message_ID', - pageOffset: '页数1开始', - pageSize: '每页数量', - }[field]; -} -export function displayV1ApiFileUsingPostParams( - field: keyof API.V1ApiFileUsingPostParams -) { - return { - conversation_id: '会话id', - user_id: 'user id', - }[field]; -} + export function displayV2ApiWorkspacesWorkspaceIdAppsUsingGetParams(field: keyof API.V2ApiWorkspacesWorkspaceIdAppsUsingGetParams) { + return ( + { + workspaceID: '空间ID', + onlyConversations: '是否只查看会话过的应用', + appName: '应用名，模糊查询', + }[field] + + ) + } -export function displayV1ApiIamAccountUsingGetParams( - field: keyof API.V1ApiIamAccountUsingGetParams -) { - return { - openId: 'openId', - }[field]; -} -export function displayV1ApiProviderListUsingGetParams( - field: keyof API.V1ApiProviderListUsingGetParams -) { - return { - size: 'size', - offset: 'offset', - }[field]; -} -export function displayV1ApiRobotWorkspaceIdAppkeyStateUsingPostParams( - field: keyof API.V1ApiRobotWorkspaceIdAppkeyStateUsingPostParams -) { - return { - workspaceID: '空间ID', - }[field]; -} -export function displayV1ApiRobotWorkspaceIdAppkeyUsingDeleteParams( - field: keyof API.V1ApiRobotWorkspaceIdAppkeyUsingDeleteParams -) { - return { - workspaceID: '空间ID', - }[field]; -} + export function displayV2ApiWorkspacesWorkspaceIdAppsUsingPostParams(field: keyof API.V2ApiWorkspacesWorkspaceIdAppsUsingPostParams) { + return ( + { + workspaceID: '空间ID', + }[field] + + ) + } -export function displayV1ApiRobotWorkspaceIdAppkeyUsingGetParams( - field: keyof API.V1ApiRobotWorkspaceIdAppkeyUsingGetParams -) { - return { - workspaceID: '空间ID', - appid: 'appid', - type: 'wjl,dingding,feishu,wxa,wx', - }[field]; -} -export function displayV1ApiRobotWorkspaceIdAppkeyUsingPostParams( - field: keyof API.V1ApiRobotWorkspaceIdAppkeyUsingPostParams -) { - return { - workspaceID: '空间ID', - }[field]; -} -export function displayV1ApiUserInfoUsingGetParams( - field: keyof API.V1ApiUserInfoUsingGetParams -) { - return { - appID: '应用id', - }[field]; -} -export function displayV1ApiUserUsingGetParams( - field: keyof API.V1ApiUserUsingGetParams -) { - return { - offset: 'offset', - phone: '电话号码', - size: 'size', - userID: '用户id', - userName: '用户名字用于搜索', - }[field]; -} + export function displayV2ApiWorkspacesWorkspaceIdDatasetsUsingGetParams(field: keyof API.V2ApiWorkspacesWorkspaceIdDatasetsUsingGetParams) { + return ( + { + workspaceID: '空间ID', + }[field] + + ) + } -export function displayV2ApiAppAppIdDetailsUsingGetParams( - field: keyof API.V2ApiAppAppIdDetailsUsingGetParams -) { - return { - appID: '应用id', - }[field]; -} -export function displayV2ApiAppAppIdUpdateUsingPostParams( - field: keyof API.V2ApiAppAppIdUpdateUsingPostParams -) { - return { - appID: '应用id', - }[field]; -} -export function displayV2ApiAppListUsingGetParams( - field: keyof API.V2ApiAppListUsingGetParams -) { - return { - onlyConversations: '是否只查看会话过的应用', - }[field]; -} -export function displayV2ApiAppShareApiTokenUsingGetParams( - field: keyof API.V2ApiAppShareApiTokenUsingGetParams -) { - return { - randomPath: '分享的随机path', - }[field]; -} + export function displayV2ApiWorkspacesWorkspaceIdDatasetsUsingPostParams(field: keyof API.V2ApiWorkspacesWorkspaceIdDatasetsUsingPostParams) { + return ( + { + workspaceID: '空间ID', + }[field] + + ) + } -export function displayV2ApiChatMessagesMessagesCountUsingGetParams( - field: keyof API.V2ApiChatMessagesMessagesCountUsingGetParams -) { - return { - isPerPerson: '是否查询人均,默认false', - starTimestamp: '开始时间，秒级时间戳', - endTimestamp: '结束时间，秒级时间戳', - }[field]; -} -export function displayV2ApiFileUsingPostParams( - field: keyof API.V2ApiFileUsingPostParams -) { - return { - conversation_id: '会话id', - user_id: 'user id', - }[field]; -} -export function displayV2ApiWorkspacesDefaultUsingPostParams( - field: keyof API.V2ApiWorkspacesDefaultUsingPostParams -) { - return { - workspaceID: '空间ID', - }[field]; -} -export function displayV2ApiWorkspacesRecommendedMessageIdDetailsUsingGetParams( - field: keyof API.V2ApiWorkspacesRecommendedMessageIdDetailsUsingGetParams -) { - return { - messageId: '消息id', - }[field]; -} + export function displayV2ApiWorkspacesWorkspaceIdGroupsUsingGetParams(field: keyof API.V2ApiWorkspacesWorkspaceIdGroupsUsingGetParams) { + return ( + { + workspaceID: '空间ID', + }[field] + + ) + } -export function displayV2ApiWorkspacesWorkspaceIdAppAppIdDatasetsJoinUsingPostParams( - field: keyof API.V2ApiWorkspacesWorkspaceIdAppAppIdDatasetsJoinUsingPostParams -) { - return { - workspaceID: '空间ID', - appID: '应用id', - }[field]; -} -export function displayV2ApiWorkspacesWorkspaceIdAppAppIdDatasetsUsingDeleteParams( - field: keyof API.V2ApiWorkspacesWorkspaceIdAppAppIdDatasetsUsingDeleteParams -) { - return { - appID: '应用id', - workspaceID: '空间ID', - datasetID: '数据集id', - }[field]; -} -export function displayV2ApiWorkspacesWorkspaceIdAppAppIdDetailsUsingGetParams( - field: keyof API.V2ApiWorkspacesWorkspaceIdAppAppIdDetailsUsingGetParams -) { - return { - workspaceID: '空间ID', - appID: '应用id', - }[field]; -} -export function displayV2ApiWorkspacesWorkspaceIdAppAppIdHourlyMessagesUsingGetParams( - field: keyof API.V2ApiWorkspacesWorkspaceIdAppAppIdHourlyMessagesUsingGetParams -) { - return { - workspaceID: '空间ID', - appID: '应用id', - starTimestamp: '开始时间，秒级时间戳', - endTimestamp: '结束时间，秒级时间戳', - }[field]; -} + export function displayV2ApiWorkspacesWorkspaceIdGroupsUsingPostParams(field: keyof API.V2ApiWorkspacesWorkspaceIdGroupsUsingPostParams) { + return ( + { + workspaceID: '空间ID', + }[field] + + ) + } -export function displayV2ApiWorkspacesWorkspaceIdAppAppIdHourlyTokenUsingGetParams( - field: keyof API.V2ApiWorkspacesWorkspaceIdAppAppIdHourlyTokenUsingGetParams -) { - return { - workspaceID: '空间ID', - appID: '应用id', - starTimestamp: '开始时间，秒级时间戳', - endTimestamp: '结束时间，秒级时间戳', - }[field]; -} -export function displayV2ApiWorkspacesWorkspaceIdAppAppIdLogsUsingGetParams( - field: keyof API.V2ApiWorkspacesWorkspaceIdAppAppIdLogsUsingGetParams -) { - return { - appID: '应用id', - workspaceID: '空间ID', - conversationID: '会话id', - endTimestamp: '结束时间', - pageOffset: '页数1开始', - pageSize: '每页数量', - providerID: '模型id', - starTimestamp: '开始时间', - userID: '用户id', - }[field]; -} -export function displayV2ApiWorkspacesWorkspaceIdAppAppIdMessagesUsingGetParams( - field: keyof API.V2ApiWorkspacesWorkspaceIdAppAppIdMessagesUsingGetParams -) { - return { - workspaceID: '空间ID', - appID: '应用id', - starTimestamp: '开始时间，秒级时间戳', - endTimestamp: '结束时间，秒级时间戳', - }[field]; -} -export function displayV2ApiWorkspacesWorkspaceIdAppAppIdModelConfigsUsingPutParams( - field: keyof API.V2ApiWorkspacesWorkspaceIdAppAppIdModelConfigsUsingPutParams -) { - return { - appID: '应用id', - workspaceID: '空间ID', - }[field]; -} + export function displayV2ApiWorkspacesWorkspaceIdGroupsWorkspaceGroupIdUsingDeleteParams(field: keyof API.V2ApiWorkspacesWorkspaceIdGroupsWorkspaceGroupIdUsingDeleteParams) { + return ( + { + workspaceID: '空间ID', + workspaceGroupID: '分组ID', + }[field] + + ) + } -export function displayV2ApiWorkspacesWorkspaceIdAppAppIdPluginUsingGetParams( - field: keyof API.V2ApiWorkspacesWorkspaceIdAppAppIdPluginUsingGetParams -) { - return { - appID: '应用id', - workspaceID: '空间ID', - }[field]; -} -export function displayV2ApiWorkspacesWorkspaceIdAppAppIdTokenUsingGetParams( - field: keyof API.V2ApiWorkspacesWorkspaceIdAppAppIdTokenUsingGetParams -) { - return { - appID: '应用id', - starTimestamp: '开始时间，秒级时间戳', - endTimestamp: '结束时间，秒级时间戳', - }[field]; -} -export function displayV2ApiWorkspacesWorkspaceIdAppAppIdUpdateStatusUsingPutParams( - field: keyof API.V2ApiWorkspacesWorkspaceIdAppAppIdUpdateStatusUsingPutParams -) { - return { - workspaceID: '空间ID', - appID: '应用id', - }[field]; -} -export function displayV2ApiWorkspacesWorkspaceIdAppAppIdUsingPostParams( - field: keyof API.V2ApiWorkspacesWorkspaceIdAppAppIdUsingPostParams -) { - return { - workspaceID: '空间ID', - appID: '应用id', - }[field]; -} + export function displayV2ApiWorkspacesWorkspaceIdGroupsWorkspaceGroupIdUsingPostParams(field: keyof API.V2ApiWorkspacesWorkspaceIdGroupsWorkspaceGroupIdUsingPostParams) { + return ( + { + workspaceID: '空间ID', + workspaceGroupID: '分组ID', + }[field] + + ) + } -export function displayV2ApiWorkspacesWorkspaceIdAppsAppIdBaseUsingPostParams( - field: keyof API.V2ApiWorkspacesWorkspaceIdAppsAppIdBaseUsingPostParams -) { - return { - appID: '应用id', - workspaceID: '空间ID', - }[field]; -} -export function displayV2ApiWorkspacesWorkspaceIdAppsAppIdGroupUsingPostParams( - field: keyof API.V2ApiWorkspacesWorkspaceIdAppsAppIdGroupUsingPostParams -) { - return { - appID: '应用id', - workspaceID: '空间ID', - }[field]; -} -export function displayV2ApiWorkspacesWorkspaceIdAppsAppIdUsingDeleteParams( - field: keyof API.V2ApiWorkspacesWorkspaceIdAppsAppIdUsingDeleteParams -) { - return { - appID: '应用id', - workspaceID: '空间ID', - }[field]; -} -export function displayV2ApiWorkspacesWorkspaceIdAppsUsingGetParams( - field: keyof API.V2ApiWorkspacesWorkspaceIdAppsUsingGetParams -) { - return { - workspaceID: '空间ID', - onlyConversations: '是否只查看会话过的应用', - appName: '应用名，模糊查询', - }[field]; -} + export function displayV2ApiWorkspacesWorkspaceIdPermissionsUsingGetParams(field: keyof API.V2ApiWorkspacesWorkspaceIdPermissionsUsingGetParams) { + return ( + { + workspaceID: '空间ID', + }[field] + + ) + } -export function displayV2ApiWorkspacesWorkspaceIdAppsUsingPostParams( - field: keyof API.V2ApiWorkspacesWorkspaceIdAppsUsingPostParams -) { - return { - workspaceID: '空间ID', - }[field]; -} -export function displayV2ApiWorkspacesWorkspaceIdDatasetsUsingGetParams( - field: keyof API.V2ApiWorkspacesWorkspaceIdDatasetsUsingGetParams -) { - return { - workspaceID: '空间ID', - }[field]; -} -export function displayV2ApiWorkspacesWorkspaceIdDatasetsUsingPostParams( - field: keyof API.V2ApiWorkspacesWorkspaceIdDatasetsUsingPostParams -) { - return { - workspaceID: '空间ID', - }[field]; -} -export function displayV2ApiWorkspacesWorkspaceIdGroupsUsingGetParams( - field: keyof API.V2ApiWorkspacesWorkspaceIdGroupsUsingGetParams -) { - return { - workspaceID: '空间ID', - }[field]; -} + export function displayV2ApiWorkspacesWorkspaceIdUsersUsingGetParams(field: keyof API.V2ApiWorkspacesWorkspaceIdUsersUsingGetParams) { + return ( + { + workspaceID: '空间ID', + }[field] + + ) + } -export function displayV2ApiWorkspacesWorkspaceIdGroupsUsingPostParams( - field: keyof API.V2ApiWorkspacesWorkspaceIdGroupsUsingPostParams -) { - return { - workspaceID: '空间ID', - }[field]; -} -export function displayV2ApiWorkspacesWorkspaceIdGroupsWorkspaceGroupIdUsingDeleteParams( - field: keyof API.V2ApiWorkspacesWorkspaceIdGroupsWorkspaceGroupIdUsingDeleteParams -) { - return { - workspaceID: '空间ID', - workspaceGroupID: '分组ID', - }[field]; -} -export function displayV2ApiWorkspacesWorkspaceIdGroupsWorkspaceGroupIdUsingPostParams( - field: keyof API.V2ApiWorkspacesWorkspaceIdGroupsWorkspaceGroupIdUsingPostParams -) { - return { - workspaceID: '空间ID', - workspaceGroupID: '分组ID', - }[field]; -} -export function displayV2ApiWorkspacesWorkspaceIdPermissionsUsingGetParams( - field: keyof API.V2ApiWorkspacesWorkspaceIdPermissionsUsingGetParams -) { - return { - workspaceID: '空间ID', - }[field]; -} + export function displayV2ApiWorkspacesWorkspaceIdUsersUsingPostParams(field: keyof API.V2ApiWorkspacesWorkspaceIdUsersUsingPostParams) { + return ( + { + workspaceID: '空间ID', + }[field] + + ) + } -export function displayV2ApiWorkspacesWorkspaceIdUsersUsingGetParams( - field: keyof API.V2ApiWorkspacesWorkspaceIdUsersUsingGetParams -) { - return { - workspaceID: '空间ID', - }[field]; -} -export function displayV2ApiWorkspacesWorkspaceIdUsersUsingPostParams( - field: keyof API.V2ApiWorkspacesWorkspaceIdUsersUsingPostParams -) { - return { - workspaceID: '空间ID', - }[field]; -} -export function displayV2ApiWorkspacesWorkspaceIdUserUserIdUsingDeleteParams( - field: keyof API.V2ApiWorkspacesWorkspaceIdUserUserIdUsingDeleteParams -) { - return { - workspaceID: '空间ID', - userID: 'userID', - }[field]; -} -export function displayV2ApiWorkspacesWorkspaceIdUsingDeleteParams( - field: keyof API.V2ApiWorkspacesWorkspaceIdUsingDeleteParams -) { - return { - workspaceID: '空间ID', - }[field]; -} + export function displayV2ApiWorkspacesWorkspaceIdUserUserIdUsingDeleteParams(field: keyof API.V2ApiWorkspacesWorkspaceIdUserUserIdUsingDeleteParams) { + return ( + { + workspaceID: '空间ID', + userID: 'userID', + }[field] + + ) + } -export function displayV2ApiWorkspacesWorkspaceIdUsingPostParams( - field: keyof API.V2ApiWorkspacesWorkspaceIdUsingPostParams -) { - return { - workspaceID: '空间ID', - }[field]; -} -export function displayWJLAccount(field: keyof API.WJLAccount) { - return { - code: 'code', - data: 'data', - msg: 'msg', - success: 'success', - }[field]; -} -export function displayWorkspaceGroup(field: keyof API.WorkspaceGroup) { - return { - createdAt: 'createdAt', - name: '分组名', - updatedAt: 'updatedAt', - workspaceGroupID: 'workspaceGroupID', - workspaceID: 'workspaceID', - }[field]; -} -export function displayWorkspaceGroupReq(field: keyof API.WorkspaceGroupReq) { - return { - name: 'name', - }[field]; -} + export function displayV2ApiWorkspacesWorkspaceIdUsingDeleteParams(field: keyof API.V2ApiWorkspacesWorkspaceIdUsingDeleteParams) { + return ( + { + workspaceID: '空间ID', + }[field] + + ) + } -export function displayWorkspaceListResp(field: keyof API.WorkspaceListResp) { - return { - data: 'data', - total: 'total', - }[field]; -} -export function displayWorkspacePermissions( - field: keyof API.WorkspacePermissions -) { - return { - createdAt: 'createdAt', - email: 'email', - idpID: 'idpID', - operator: 'operator', - permission: '枚举read_only（只读）、operation（操作）', - phone: 'phone', - role: '角色(系统管理员、系统普通用户)', - updatedAt: 'updatedAt', - userID: 'iam 用户id', - userName: 'userName', - }[field]; -} -export function displayWorkspaceReq(field: keyof API.WorkspaceReq) { - return { - description: '描述', - name: '空间名', - }[field]; -} -export function displayWorkspaceResp(field: keyof API.WorkspaceResp) { - return { - description: '空间描述', - name: '空间名', - workspaceID: '空间ID', - }[field]; -} + export function displayV2ApiWorkspacesWorkspaceIdUsingPostParams(field: keyof API.V2ApiWorkspacesWorkspaceIdUsingPostParams) { + return ( + { + workspaceID: '空间ID', + }[field] + + ) + } + + + + + export function displayWJLAccount(field: keyof API.WJLAccount) { + return ( + { + code: 'code', + data: 'data', + msg: 'msg', + success: 'success', + }[field] + + ) + } + + + export function displayWorkspaceGroup(field: keyof API.WorkspaceGroup) { + return ( + { + createdAt: 'createdAt', + name: '分组名', + updatedAt: 'updatedAt', + workspaceGroupID: 'workspaceGroupID', + workspaceID: 'workspaceID', + }[field] + + ) + } + + + export function displayWorkspaceGroupReq(field: keyof API.WorkspaceGroupReq) { + return ( + { + name: 'name', + }[field] + + ) + } + + + export function displayWorkspaceListResp(field: keyof API.WorkspaceListResp) { + return ( + { + data: 'data', + total: 'total', + }[field] + + ) + } + + + export function displayWorkspacePermissions(field: keyof API.WorkspacePermissions) { + return ( + { + createdAt: 'createdAt', + email: 'email', + idpID: 'idpID', + operator: 'operator', + permission: '枚举read_only（只读）、operation（操作）', + phone: 'phone', + role: '角色(系统管理员、系统普通用户)', + updatedAt: 'updatedAt', + userID: 'iam 用户id', + userName: 'userName', + }[field] + + ) + } + + + export function displayWorkspaceReq(field: keyof API.WorkspaceReq) { + return ( + { + description: '描述', + name: '空间名', + }[field] + + ) + } + + + export function displayWorkspaceResp(field: keyof API.WorkspaceResp) { + return ( + { + description: '空间描述', + name: '空间名', + workspaceID: '空间ID', + }[field] + + ) + } + + + export function displayWorkspaceUser(field: keyof API.WorkspaceUser) { + return ( + { + role: 'workspace_admin空间超管用户；workspace_user空间普通用户', + userID: '用户id', + }[field] + + ) + } + + + export function displayWxExtra(field: keyof API.WxExtra) { + return ( + { + encodingAESKey: 'encodingAESKey', + token: 'token', + }[field] + + ) + } -export function displayWorkspaceUser(field: keyof API.WorkspaceUser) { - return { - role: 'workspace_admin空间超管用户；workspace_user空间普通用户', - userID: '用户id', - }[field]; -} -export function displayWxExtra(field: keyof API.WxExtra) { - return { - encodingAESKey: 'encodingAESKey', - token: 'token', - }[field]; -} /* eslint-disable */ // @ts-ignore import request from 'axios'; @@ -3526,7 +4306,7 @@ export function v1ApiAppAppIdRecommendedContextUsingPost({ }: { // 叠加生成的Param类型 (非body参数openapi默认没有生成对象) params: API.V1ApiAppAppIdRecommendedContextUsingPostParams; - body: API.AppRecommendedContext; + body: API.AppRecommendedContext2; options?: { [key: string]: unknown }; }) { const { appID: param0, ...queryParams } = params; @@ -4370,7 +5150,10 @@ export type QueryTokenResp = { export type QuestionRecommendReq = { conversation_id?: string; - /** Query string `json:"query"`Answer string `json:"answer"` */ + /** + * Query string `json:"query"` + * Answer string `json:"answer"` + */ user?: string; }; diff --git "a/test/__snapshots__/customRenderTemplateData/\346\265\213\350\257\225 DisplayEnumLabel hook - \350\277\207\346\273\244\346\236\232\344\270\276\347\261\273\345\236\213.snap" "b/test/__snapshots__/customRenderTemplateData/\346\265\213\350\257\225 DisplayEnumLabel hook - \350\277\207\346\273\244\346\236\232\344\270\276\347\261\273\345\236\213.snap" index db2ae1e..eb1e88a 100644 --- "a/test/__snapshots__/customRenderTemplateData/\346\265\213\350\257\225 DisplayEnumLabel hook - \350\277\207\346\273\244\346\236\232\344\270\276\347\261\273\345\236\213.snap" +++ "b/test/__snapshots__/customRenderTemplateData/\346\265\213\350\257\225 DisplayEnumLabel hook - \350\277\207\346\273\244\346\236\232\344\270\276\347\261\273\345\236\213.snap" @@ -115,7 +115,7 @@ export function displayAndonRecordVO(field: keyof API.AndonRecordVO) { receiveDurationTimeSt: 'receiveDurationTimeSt', disposeDurationTimeSt: 'disposeDurationTimeSt', statusText: - '表状态，1 已上报，2 已接收，3 已处理， 9 已撤销转换状态 已申请 已响应 已关闭 已撤销', + '表状态，1 已上报，2 已接收，3 已处理， 9 已撤销 转换状态 已申请 已响应 已关闭 已撤销', disposeUserList: 'disposeUserList', recordNodeList: 'recordNodeList', showColor: 'showColor', @@ -474,7 +474,7 @@ export type AndonRecordVO = { totalDurationTimeSt?: string; receiveDurationTimeSt?: string; disposeDurationTimeSt?: string; - /** 表状态，1 已上报，2 已接收，3 已处理， 9 已撤销转换状态 已申请 已响应 已关闭 已撤销 */ + /** 表状态，1 已上报，2 已接收，3 已处理， 9 已撤销 转换状态 已申请 已响应 已关闭 已撤销 */ statusText?: string; disposeUserList?: PlatformUser[]; recordNodeList?: AndonRecordNode[]; diff --git "a/test/__snapshots__/customRenderTemplateData/\346\265\213\350\257\225 DisplayTypeLabel hook - \344\277\256\346\224\271\347\261\273\345\236\213\346\240\207\347\255\276.snap" "b/test/__snapshots__/customRenderTemplateData/\346\265\213\350\257\225 DisplayTypeLabel hook - \344\277\256\346\224\271\347\261\273\345\236\213\346\240\207\347\255\276.snap" index c7ffd32..981cb43 100644 --- "a/test/__snapshots__/customRenderTemplateData/\346\265\213\350\257\225 DisplayTypeLabel hook - \344\277\256\346\224\271\347\261\273\345\236\213\346\240\207\347\255\276.snap" +++ "b/test/__snapshots__/customRenderTemplateData/\346\265\213\350\257\225 DisplayTypeLabel hook - \344\277\256\346\224\271\347\261\273\345\236\213\346\240\207\347\255\276.snap" @@ -121,7 +121,7 @@ export function displayLabelAndonRecordVO(field: keyof API.LabelAndonRecordVO) { receiveDurationTimeSt: 'receiveDurationTimeSt', disposeDurationTimeSt: 'disposeDurationTimeSt', statusText: - '表状态，1 已上报，2 已接收，3 已处理， 9 已撤销转换状态 已申请 已响应 已关闭 已撤销', + '表状态，1 已上报，2 已接收，3 已处理， 9 已撤销 转换状态 已申请 已响应 已关闭 已撤销', disposeUserList: 'disposeUserList', recordNodeList: 'recordNodeList', showColor: 'showColor', @@ -482,7 +482,7 @@ export type AndonRecordVO = { totalDurationTimeSt?: string; receiveDurationTimeSt?: string; disposeDurationTimeSt?: string; - /** 表状态，1 已上报，2 已接收，3 已处理， 9 已撤销转换状态 已申请 已响应 已关闭 已撤销 */ + /** 表状态，1 已上报，2 已接收，3 已处理， 9 已撤销 转换状态 已申请 已响应 已关闭 已撤销 */ statusText?: string; disposeUserList?: PlatformUser[]; recordNodeList?: AndonRecordNode[]; diff --git "a/test/__snapshots__/customRenderTemplateData/\346\265\213\350\257\225 Interface hook - \344\277\256\346\224\271JSONObject.snap" "b/test/__snapshots__/customRenderTemplateData/\346\265\213\350\257\225 Interface hook - \344\277\256\346\224\271JSONObject.snap" index 29bbf99..e1760d1 100644 --- "a/test/__snapshots__/customRenderTemplateData/\346\265\213\350\257\225 Interface hook - \344\277\256\346\224\271JSONObject.snap" +++ "b/test/__snapshots__/customRenderTemplateData/\346\265\213\350\257\225 Interface hook - \344\277\256\346\224\271JSONObject.snap" @@ -153,7 +153,7 @@ export type AndonRecordVO = { totalDurationTimeSt?: string; receiveDurationTimeSt?: string; disposeDurationTimeSt?: string; - /** 表状态，1 已上报，2 已接收，3 已处理， 9 已撤销转换状态 已申请 已响应 已关闭 已撤销 */ + /** 表状态，1 已上报，2 已接收，3 已处理， 9 已撤销 转换状态 已申请 已响应 已关闭 已撤销 */ statusText?: string; disposeUserList?: PlatformUser[]; recordNodeList?: AndonRecordNode[]; diff --git "a/test/__snapshots__/customRenderTemplateData/\346\265\213\350\257\225 Interface hook - \344\277\256\346\224\271\347\261\273\345\236\213\345\220\215\347\247\260\345\222\214\345\261\236\346\200\247.snap" "b/test/__snapshots__/customRenderTemplateData/\346\265\213\350\257\225 Interface hook - \344\277\256\346\224\271\347\261\273\345\236\213\345\220\215\347\247\260\345\222\214\345\261\236\346\200\247.snap" index 011c780..b376c29 100644 --- "a/test/__snapshots__/customRenderTemplateData/\346\265\213\350\257\225 Interface hook - \344\277\256\346\224\271\347\261\273\345\236\213\345\220\215\347\247\260\345\222\214\345\261\236\346\200\247.snap" +++ "b/test/__snapshots__/customRenderTemplateData/\346\265\213\350\257\225 Interface hook - \344\277\256\346\224\271\347\261\273\345\236\213\345\220\215\347\247\260\345\222\214\345\261\236\346\200\247.snap" @@ -153,7 +153,7 @@ export type CustomAndonRecordVO = { totalDurationTimeSt?: string; receiveDurationTimeSt?: string; disposeDurationTimeSt?: string; - /** 表状态，1 已上报，2 已接收，3 已处理， 9 已撤销转换状态 已申请 已响应 已关闭 已撤销 */ + /** 表状态，1 已上报，2 已接收，3 已处理， 9 已撤销 转换状态 已申请 已响应 已关闭 已撤销 */ statusText?: string; disposeUserList?: PlatformUser[]; recordNodeList?: AndonRecordNode[]; diff --git "a/test/__snapshots__/customRenderTemplateData/\346\265\213\350\257\225 ReactQuery hook - \350\277\207\346\273\244 GET \346\226\271\346\263\225.snap" "b/test/__snapshots__/customRenderTemplateData/\346\265\213\350\257\225 ReactQuery hook - \350\277\207\346\273\244 GET \346\226\271\346\263\225.snap" index 842cfaf..e0259c2 100644 --- "a/test/__snapshots__/customRenderTemplateData/\346\265\213\350\257\225 ReactQuery hook - \350\277\207\346\273\244 GET \346\226\271\346\263\225.snap" +++ "b/test/__snapshots__/customRenderTemplateData/\346\265\213\350\257\225 ReactQuery hook - \350\277\207\346\273\244 GET \346\226\271\346\263\225.snap" @@ -154,7 +154,7 @@ export type AndonRecordVO = { totalDurationTimeSt?: string; receiveDurationTimeSt?: string; disposeDurationTimeSt?: string; - /** 表状态，1 已上报，2 已接收，3 已处理， 9 已撤销转换状态 已申请 已响应 已关闭 已撤销 */ + /** 表状态，1 已上报，2 已接收，3 已处理， 9 已撤销 转换状态 已申请 已响应 已关闭 已撤销 */ statusText?: string; disposeUserList?: PlatformUser[]; recordNodeList?: AndonRecordNode[]; diff --git "a/test/__snapshots__/customRenderTemplateData/\346\265\213\350\257\225 Schema hook - \344\277\256\346\224\271 JSON Schema \347\261\273\345\236\213\345\220\215.snap" "b/test/__snapshots__/customRenderTemplateData/\346\265\213\350\257\225 Schema hook - \344\277\256\346\224\271 JSON Schema \347\261\273\345\236\213\345\220\215.snap" index 790f06a..8ce324e 100644 --- "a/test/__snapshots__/customRenderTemplateData/\346\265\213\350\257\225 Schema hook - \344\277\256\346\224\271 JSON Schema \347\261\273\345\236\213\345\220\215.snap" +++ "b/test/__snapshots__/customRenderTemplateData/\346\265\213\350\257\225 Schema hook - \344\277\256\346\224\271 JSON Schema \347\261\273\345\236\213\345\220\215.snap" @@ -168,7 +168,7 @@ export const $customandonRecordVO = { statusText: { type: 'string', description: - '表状态，1 已上报，2 已接收，3 已处理， 9 已撤销\n转换状态 已申请 已响应 已关闭 已撤销', + '表状态，1 已上报，2 已接收，3 已处理， 9 已撤销 转换状态 已申请 已响应 已关闭 已撤销', }, disposeUserList: { type: 'array', @@ -428,7 +428,7 @@ export const $custommyPageAndonRecordVO = { statusText: { type: 'string', description: - '表状态，1 已上报，2 已接收，3 已处理， 9 已撤销\n转换状态 已申请 已响应 已关闭 已撤销', + '表状态，1 已上报，2 已接收，3 已处理， 9 已撤销 转换状态 已申请 已响应 已关闭 已撤销', }, disposeUserList: { type: 'array', @@ -802,7 +802,7 @@ export const $customapiResultAndonRecordVO = { statusText: { type: 'string', description: - '表状态，1 已上报，2 已接收，3 已处理， 9 已撤销\n转换状态 已申请 已响应 已关闭 已撤销', + '表状态，1 已上报，2 已接收，3 已处理， 9 已撤销 转换状态 已申请 已响应 已关闭 已撤销', }, disposeUserList: { type: 'array', @@ -1111,7 +1111,7 @@ export const $customapiResultMyPageAndonRecordVO = { statusText: { type: 'string', description: - '表状态，1 已上报，2 已接收，3 已处理， 9 已撤销\n转换状态 已申请 已响应 已关闭 已撤销', + '表状态，1 已上报，2 已接收，3 已处理， 9 已撤销 转换状态 已申请 已响应 已关闭 已撤销', }, disposeUserList: { type: 'array', @@ -1533,7 +1533,7 @@ export type AndonRecordVO = { totalDurationTimeSt?: string; receiveDurationTimeSt?: string; disposeDurationTimeSt?: string; - /** 表状态，1 已上报，2 已接收，3 已处理， 9 已撤销转换状态 已申请 已响应 已关闭 已撤销 */ + /** 表状态，1 已上报，2 已接收，3 已处理， 9 已撤销 转换状态 已申请 已响应 已关闭 已撤销 */ statusText?: string; disposeUserList?: PlatformUser[]; recordNodeList?: AndonRecordNode[]; diff --git "a/test/__snapshots__/customRenderTemplateData/\346\265\213\350\257\225 ServiceController hook - \350\277\207\346\273\244\345\222\214\344\277\256\346\224\271 API \345\210\227\350\241\250.snap" "b/test/__snapshots__/customRenderTemplateData/\346\265\213\350\257\225 ServiceController hook - \350\277\207\346\273\244\345\222\214\344\277\256\346\224\271 API \345\210\227\350\241\250.snap" index 92429e3..84f1c24 100644 --- "a/test/__snapshots__/customRenderTemplateData/\346\265\213\350\257\225 ServiceController hook - \350\277\207\346\273\244\345\222\214\344\277\256\346\224\271 API \345\210\227\350\241\250.snap" +++ "b/test/__snapshots__/customRenderTemplateData/\346\265\213\350\257\225 ServiceController hook - \350\277\207\346\273\244\345\222\214\344\277\256\346\224\271 API \345\210\227\350\241\250.snap" @@ -153,7 +153,7 @@ export type AndonRecordVO = { totalDurationTimeSt?: string; receiveDurationTimeSt?: string; disposeDurationTimeSt?: string; - /** 表状态，1 已上报，2 已接收，3 已处理， 9 已撤销转换状态 已申请 已响应 已关闭 已撤销 */ + /** 表状态，1 已上报，2 已接收，3 已处理， 9 已撤销 转换状态 已申请 已响应 已关闭 已撤销 */ statusText?: string; disposeUserList?: PlatformUser[]; recordNodeList?: AndonRecordNode[]; diff --git "a/test/__snapshots__/customRenderTemplateData/\346\265\213\350\257\225 ServiceIndex hook - \346\216\222\345\272\217\346\216\247\345\210\266\345\231\250\345\210\227\350\241\250.snap" "b/test/__snapshots__/customRenderTemplateData/\346\265\213\350\257\225 ServiceIndex hook - \346\216\222\345\272\217\346\216\247\345\210\266\345\231\250\345\210\227\350\241\250.snap" index 92429e3..84f1c24 100644 --- "a/test/__snapshots__/customRenderTemplateData/\346\265\213\350\257\225 ServiceIndex hook - \346\216\222\345\272\217\346\216\247\345\210\266\345\231\250\345\210\227\350\241\250.snap" +++ "b/test/__snapshots__/customRenderTemplateData/\346\265\213\350\257\225 ServiceIndex hook - \346\216\222\345\272\217\346\216\247\345\210\266\345\231\250\345\210\227\350\241\250.snap" @@ -153,7 +153,7 @@ export type AndonRecordVO = { totalDurationTimeSt?: string; receiveDurationTimeSt?: string; disposeDurationTimeSt?: string; - /** 表状态，1 已上报，2 已接收，3 已处理， 9 已撤销转换状态 已申请 已响应 已关闭 已撤销 */ + /** 表状态，1 已上报，2 已接收，3 已处理， 9 已撤销 转换状态 已申请 已响应 已关闭 已撤销 */ statusText?: string; disposeUserList?: PlatformUser[]; recordNodeList?: AndonRecordNode[]; diff --git "a/test/__snapshots__/customRenderTemplateData/\346\265\213\350\257\225 hook \344\270\212\344\270\213\346\226\207\345\217\202\346\225\260 - \351\252\214\350\257\201 context \345\257\271\350\261\241.snap" "b/test/__snapshots__/customRenderTemplateData/\346\265\213\350\257\225 hook \344\270\212\344\270\213\346\226\207\345\217\202\346\225\260 - \351\252\214\350\257\201 context \345\257\271\350\261\241.snap" index 92429e3..84f1c24 100644 --- "a/test/__snapshots__/customRenderTemplateData/\346\265\213\350\257\225 hook \344\270\212\344\270\213\346\226\207\345\217\202\346\225\260 - \351\252\214\350\257\201 context \345\257\271\350\261\241.snap" +++ "b/test/__snapshots__/customRenderTemplateData/\346\265\213\350\257\225 hook \344\270\212\344\270\213\346\226\207\345\217\202\346\225\260 - \351\252\214\350\257\201 context \345\257\271\350\261\241.snap" @@ -153,7 +153,7 @@ export type AndonRecordVO = { totalDurationTimeSt?: string; receiveDurationTimeSt?: string; disposeDurationTimeSt?: string; - /** 表状态，1 已上报，2 已接收，3 已处理， 9 已撤销转换状态 已申请 已响应 已关闭 已撤销 */ + /** 表状态，1 已上报，2 已接收，3 已处理， 9 已撤销 转换状态 已申请 已响应 已关闭 已撤销 */ statusText?: string; disposeUserList?: PlatformUser[]; recordNodeList?: AndonRecordNode[]; diff --git "a/test/__snapshots__/customRenderTemplateData/\346\265\213\350\257\225 hook \345\274\202\345\270\270\345\244\204\347\220\206 - hook \345\207\275\346\225\260\346\212\233\345\207\272\351\224\231\350\257\257.snap" "b/test/__snapshots__/customRenderTemplateData/\346\265\213\350\257\225 hook \345\274\202\345\270\270\345\244\204\347\220\206 - hook \345\207\275\346\225\260\346\212\233\345\207\272\351\224\231\350\257\257.snap" index 3828a00..c100d0a 100644 --- "a/test/__snapshots__/customRenderTemplateData/\346\265\213\350\257\225 hook \345\274\202\345\270\270\345\244\204\347\220\206 - hook \345\207\275\346\225\260\346\212\233\345\207\272\351\224\231\350\257\257.snap" +++ "b/test/__snapshots__/customRenderTemplateData/\346\265\213\350\257\225 hook \345\274\202\345\270\270\345\244\204\347\220\206 - hook \345\207\275\346\225\260\346\212\233\345\207\272\351\224\231\350\257\257.snap" @@ -153,7 +153,7 @@ export type ErrorAndonRecordVO = { totalDurationTimeSt?: string; receiveDurationTimeSt?: string; disposeDurationTimeSt?: string; - /** 表状态，1 已上报，2 已接收，3 已处理， 9 已撤销转换状态 已申请 已响应 已关闭 已撤销 */ + /** 表状态，1 已上报，2 已接收，3 已处理， 9 已撤销 转换状态 已申请 已响应 已关闭 已撤销 */ statusText?: string; disposeUserList?: PlatformUser[]; recordNodeList?: AndonRecordNode[]; diff --git "a/test/__snapshots__/customRenderTemplateData/\346\265\213\350\257\225\345\220\221\345\220\216\345\205\274\345\256\271\346\200\247 - \344\270\215\344\275\277\347\224\250\346\226\260 hook \346\227\266\347\232\204\351\273\230\350\256\244\350\241\214\344\270\272.snap" "b/test/__snapshots__/customRenderTemplateData/\346\265\213\350\257\225\345\220\221\345\220\216\345\205\274\345\256\271\346\200\247 - \344\270\215\344\275\277\347\224\250\346\226\260 hook \346\227\266\347\232\204\351\273\230\350\256\244\350\241\214\344\270\272.snap" index 85abde6..e12bc1c 100644 --- "a/test/__snapshots__/customRenderTemplateData/\346\265\213\350\257\225\345\220\221\345\220\216\345\205\274\345\256\271\346\200\247 - \344\270\215\344\275\277\347\224\250\346\226\260 hook \346\227\266\347\232\204\351\273\230\350\256\244\350\241\214\344\270\272.snap" +++ "b/test/__snapshots__/customRenderTemplateData/\346\265\213\350\257\225\345\220\221\345\220\216\345\205\274\345\256\271\346\200\247 - \344\270\215\344\275\277\347\224\250\346\226\260 hook \346\227\266\347\232\204\351\273\230\350\256\244\350\241\214\344\270\272.snap" @@ -115,7 +115,7 @@ export function displayAndonRecordVO(field: keyof API.AndonRecordVO) { receiveDurationTimeSt: 'receiveDurationTimeSt', disposeDurationTimeSt: 'disposeDurationTimeSt', statusText: - '表状态，1 已上报，2 已接收，3 已处理， 9 已撤销转换状态 已申请 已响应 已关闭 已撤销', + '表状态，1 已上报，2 已接收，3 已处理， 9 已撤销 转换状态 已申请 已响应 已关闭 已撤销', disposeUserList: 'disposeUserList', recordNodeList: 'recordNodeList', showColor: 'showColor', @@ -490,7 +490,7 @@ export const $andonRecordVO = { statusText: { type: 'string', description: - '表状态，1 已上报，2 已接收，3 已处理， 9 已撤销\n转换状态 已申请 已响应 已关闭 已撤销', + '表状态，1 已上报，2 已接收，3 已处理， 9 已撤销 转换状态 已申请 已响应 已关闭 已撤销', }, disposeUserList: { type: 'array', @@ -750,7 +750,7 @@ export const $myPageAndonRecordVO = { statusText: { type: 'string', description: - '表状态，1 已上报，2 已接收，3 已处理， 9 已撤销\n转换状态 已申请 已响应 已关闭 已撤销', + '表状态，1 已上报，2 已接收，3 已处理， 9 已撤销 转换状态 已申请 已响应 已关闭 已撤销', }, disposeUserList: { type: 'array', @@ -1124,7 +1124,7 @@ export const $apiResultAndonRecordVO = { statusText: { type: 'string', description: - '表状态，1 已上报，2 已接收，3 已处理， 9 已撤销\n转换状态 已申请 已响应 已关闭 已撤销', + '表状态，1 已上报，2 已接收，3 已处理， 9 已撤销 转换状态 已申请 已响应 已关闭 已撤销', }, disposeUserList: { type: 'array', @@ -1433,7 +1433,7 @@ export const $apiResultMyPageAndonRecordVO = { statusText: { type: 'string', description: - '表状态，1 已上报，2 已接收，3 已处理， 9 已撤销\n转换状态 已申请 已响应 已关闭 已撤销', + '表状态，1 已上报，2 已接收，3 已处理， 9 已撤销 转换状态 已申请 已响应 已关闭 已撤销', }, disposeUserList: { type: 'array', @@ -1855,7 +1855,7 @@ export type AndonRecordVO = { totalDurationTimeSt?: string; receiveDurationTimeSt?: string; disposeDurationTimeSt?: string; - /** 表状态，1 已上报，2 已接收，3 已处理， 9 已撤销转换状态 已申请 已响应 已关闭 已撤销 */ + /** 表状态，1 已上报，2 已接收，3 已处理， 9 已撤销 转换状态 已申请 已响应 已关闭 已撤销 */ statusText?: string; disposeUserList?: PlatformUser[]; recordNodeList?: AndonRecordNode[]; diff --git "a/test/__snapshots__/customRenderTemplateData/\346\265\213\350\257\225\345\244\232\344\270\252 hook \345\220\214\346\227\266\344\275\277\347\224\250.snap" "b/test/__snapshots__/customRenderTemplateData/\346\265\213\350\257\225\345\244\232\344\270\252 hook \345\220\214\346\227\266\344\275\277\347\224\250.snap" index 9ac8129..140e7aa 100644 --- "a/test/__snapshots__/customRenderTemplateData/\346\265\213\350\257\225\345\244\232\344\270\252 hook \345\220\214\346\227\266\344\275\277\347\224\250.snap" +++ "b/test/__snapshots__/customRenderTemplateData/\346\265\213\350\257\225\345\244\232\344\270\252 hook \345\220\214\346\227\266\344\275\277\347\224\250.snap" @@ -170,7 +170,7 @@ export function displayAndonRecordVO(field: keyof API.AndonRecordVO) { receiveDurationTimeSt: 'receiveDurationTimeSt', disposeDurationTimeSt: 'disposeDurationTimeSt', statusText: - '表状态，1 已上报，2 已接收，3 已处理， 9 已撤销转换状态 已申请 已响应 已关闭 已撤销', + '表状态，1 已上报，2 已接收，3 已处理， 9 已撤销 转换状态 已申请 已响应 已关闭 已撤销', disposeUserList: 'disposeUserList', recordNodeList: 'recordNodeList', showColor: 'showColor', @@ -542,7 +542,7 @@ export const $andonRecordVO = { statusText: { type: 'string', description: - '表状态，1 已上报，2 已接收，3 已处理， 9 已撤销\n转换状态 已申请 已响应 已关闭 已撤销', + '表状态，1 已上报，2 已接收，3 已处理， 9 已撤销 转换状态 已申请 已响应 已关闭 已撤销', }, disposeUserList: { type: 'array', @@ -802,7 +802,7 @@ export const $myPageAndonRecordVO = { statusText: { type: 'string', description: - '表状态，1 已上报，2 已接收，3 已处理， 9 已撤销\n转换状态 已申请 已响应 已关闭 已撤销', + '表状态，1 已上报，2 已接收，3 已处理， 9 已撤销 转换状态 已申请 已响应 已关闭 已撤销', }, disposeUserList: { type: 'array', @@ -1176,7 +1176,7 @@ export const $apiResultAndonRecordVO = { statusText: { type: 'string', description: - '表状态，1 已上报，2 已接收，3 已处理， 9 已撤销\n转换状态 已申请 已响应 已关闭 已撤销', + '表状态，1 已上报，2 已接收，3 已处理， 9 已撤销 转换状态 已申请 已响应 已关闭 已撤销', }, disposeUserList: { type: 'array', @@ -1485,7 +1485,7 @@ export const $apiResultMyPageAndonRecordVO = { statusText: { type: 'string', description: - '表状态，1 已上报，2 已接收，3 已处理， 9 已撤销\n转换状态 已申请 已响应 已关闭 已撤销', + '表状态，1 已上报，2 已接收，3 已处理， 9 已撤销 转换状态 已申请 已响应 已关闭 已撤销', }, disposeUserList: { type: 'array', @@ -1899,7 +1899,7 @@ export type MultiAndonRecordVO = { totalDurationTimeSt?: string; receiveDurationTimeSt?: string; disposeDurationTimeSt?: string; - /** 表状态，1 已上报，2 已接收，3 已处理， 9 已撤销转换状态 已申请 已响应 已关闭 已撤销 */ + /** 表状态，1 已上报，2 已接收，3 已处理， 9 已撤销 转换状态 已申请 已响应 已关闭 已撤销 */ statusText?: string; disposeUserList?: PlatformUser[]; recordNodeList?: AndonRecordNode[]; diff --git a/test/common.spec.ts b/test/common.spec.ts index 93822fb..6807879 100644 --- a/test/common.spec.ts +++ b/test/common.spec.ts @@ -541,6 +541,19 @@ export async function ${api.functionName}(${api.body ? `data: ${api.body.type}` ).resolves.toMatchFileSnapshot(getSnapshotDir(ctx)); }); + it('测试描述信息支持换行', async (ctx) => { + await openAPI.generateService({ + schemaPath: join( + import.meta.dirname, + './example-files/openapi-complex-enum-convert.json' + ), + serversPath: './apis/desc-line-break', + }); + await expect( + readGeneratedFiles('./apis/desc-line-break') + ).resolves.toMatchFileSnapshot(getSnapshotDir(ctx)); + }); + it('测试 OpenAPI 3.1 type 数组格式 (如 ["string", "null"])', async (ctx) => { await openAPI.generateService({ schemaPath: join( diff --git a/test/example-files/openapi-complex-enum-convert.json b/test/example-files/openapi-complex-enum-convert.json index f917f78..889658b 100644 --- a/test/example-files/openapi-complex-enum-convert.json +++ b/test/example-files/openapi-complex-enum-convert.json @@ -21,10 +21,10 @@ "/hello": { "get": { "tags": ["student"], - "summary": "Returns a student object", + "summary": "Returns a student object \nname: string\nage: integer\ngender: string\nmajor: Major", "responses": { "200": { - "description": "A student object", + "description": "A student object \nname: string\nage: integer\ngender: string\nmajor: Major", "content": { "application/json": { "schema": { @@ -42,7 +42,8 @@ "Major": { "type": "string", "enum": ["COMPUTER SCIENCE", "MATHEMATICS", "PHYSICS", "LITERATURE"], - "example": "COMPUTER SCIENCE" + "example": "COMPUTER SCIENCE", + "description": "Major enum \nCOMPUTER SCIENCE: Computer Science\nMATHEMATICS: Mathematics\nPHYSICS: Physics\nLITERATURE: Literature" }, "Student": { "type": "object", diff --git a/test/example-files/openapi-custom-gen-file-list-hook.json b/test/example-files/openapi-custom-gen-file-list-hook.json index c9340a9..c2f6cb3 100644 --- a/test/example-files/openapi-custom-gen-file-list-hook.json +++ b/test/example-files/openapi-custom-gen-file-list-hook.json @@ -3001,7 +3001,7 @@ }, "statusText": { "type": "string", - "description": "表状态，1 已上报，2 已接收，3 已处理， 9 已撤销\n转换状态 已申请 已响应 已关闭 已撤销" + "description": "表状态，1 已上报，2 已接收，3 已处理， 9 已撤销 转换状态 已申请 已响应 已关闭 已撤销" }, "disposeUserList": { "type": "array",