跳转到内容
tansr 资料站

PlatformNonchatClient

显式提交非聊天操作并查询原任务、私有资源与实时会话的客户端。

方法

Section titled “方法”

createRealtimeSession()

Section titled “createRealtimeSession()”
createRealtimeSession(input, options): Promise<RealtimeSessionSubmission>;

参数

Section titled “参数”
input
Section titled “input”

RealtimeSessionInput

options
Section titled “options”

NonchatSubmitOptions

返回

Section titled “返回”

Promise<RealtimeSessionSubmission>

deleteDocumentUpload()

Section titled “deleteDocumentUpload()”
deleteDocumentUpload(uploadRef, options?): Promise<void>;

幂等删除当前身份的临时文档；返回后不再使用该引用提交任务。

参数

Section titled “参数”
uploadRef
Section titled “uploadRef”

string

options?
Section titled “options?”

NonchatCallOptions

返回

Section titled “返回”

Promise<void>

document()

Section titled “document()”
document(input, options): Promise<PlatformNonchatTask<unknown>>;

参数

Section titled “参数”
input
Section titled “input”

DocumentOperationInput

options
Section titled “options”

NonchatSubmitOptions

返回

Section titled “返回”

Promise<PlatformNonchatTask<unknown>>

embeddings()

Section titled “embeddings()”
embeddings(input, options): Promise<PlatformNonchatTask<EmbeddingsResult>>;

参数

Section titled “参数”
input
Section titled “input”

EmbeddingsInput

options
Section titled “options”

NonchatSubmitOptions

返回

Section titled “返回”

Promise<PlatformNonchatTask<EmbeddingsResult>>

getMusicSource()

Section titled “getMusicSource()”
getMusicSource(resourceId, options?): Promise<PlatformMusicSource>;

参数

Section titled “参数”
resourceId
Section titled “resourceId”

string

options?
Section titled “options?”

NonchatCallOptions

返回

Section titled “返回”

Promise<PlatformMusicSource>

getMusicSourceByTask()

Section titled “getMusicSourceByTask()”
getMusicSourceByTask(taskId, options?): Promise<PlatformMusicSource>;

从平台上传任务的 canonical v4 ID 推导资源 ID，不依赖有限列表扫描。

参数

Section titled “参数”
taskId
Section titled “taskId”

string

options?
Section titled “options?”

NonchatCallOptions

返回

Section titled “返回”

Promise<PlatformMusicSource>

getRealtimeSession()

Section titled “getRealtimeSession()”
getRealtimeSession(sessionId, options?): Promise<RealtimeSessionState>;

参数

Section titled “参数”
sessionId
Section titled “sessionId”

string

options?
Section titled “options?”

NonchatCallOptions

返回

Section titled “返回”

Promise<RealtimeSessionState>

getTask()

Section titled “getTask()”
getTask(taskId, options?): Promise<PlatformNonchatTask<unknown>>;

参数

Section titled “参数”
taskId
Section titled “taskId”

string

options?
Section titled “options?”

NonchatCallOptions

返回

Section titled “返回”

Promise<PlatformNonchatTask<unknown>>

getVoice()

Section titled “getVoice()”
getVoice(voiceRef, options?): Promise<PlatformVoiceResource>;

参数

Section titled “参数”
voiceRef
Section titled “voiceRef”

string

options?
Section titled “options?”

NonchatCallOptions

返回

Section titled “返回”

Promise<PlatformVoiceResource>

getVoiceByTask()

Section titled “getVoiceByTask()”
getVoiceByTask(taskId, options?): Promise<
  | PlatformVoiceResource
| null>;

按原创建任务查找私有音色；未知或跨作用域返回 null，不依赖最新 50 项列表。

参数

Section titled “参数”
taskId
Section titled “taskId”

string

options?
Section titled “options?”

NonchatCallOptions

返回

Section titled “返回”

Promise< | PlatformVoiceResource | null>

listModels()

Section titled “listModels()”
listModels(options?): Promise<NonchatModelsResponse>;

授权候选目录；requires-input-validation 不代表已计价或保证受理。

参数

Section titled “参数”
options?
Section titled “options?”

NonchatCallOptions

返回

Section titled “返回”

Promise<NonchatModelsResponse>

listMusicSources()

Section titled “listMusicSources()”
listMusicSources(options?): Promise<PlatformMusicSourceListResponse>;

参数

Section titled “参数”
options?
Section titled “options?”

NonchatCallOptions

返回

Section titled “返回”

Promise<PlatformMusicSourceListResponse>

listVoices()

Section titled “listVoices()”
listVoices(options?): Promise<PlatformVoiceListResponse>;

当前身份的私有音色；包含非 ready 状态，HTTP 暂无分页参数。

参数

Section titled “参数”
options?
Section titled “options?”

NonchatCallOptions

返回

Section titled “返回”

Promise<PlatformVoiceListResponse>

music()

Section titled “music()”
music(input, options): Promise<PlatformNonchatTask<unknown>>;

参数

Section titled “参数”
input
Section titled “input”

MusicOperationInput

options
Section titled “options”

NonchatSubmitOptions

返回

Section titled “返回”

Promise<PlatformNonchatTask<unknown>>

realtimeConnectionOptions()

Section titled “realtimeConnectionOptions()”
realtimeConnectionOptions(submission): RealtimeConnectionOptions;

经校验的同源连接材料，供支持headers的原生WS工厂单次消费；不自动连接或重连。

参数

Section titled “参数”
submission
Section titled “submission”

RealtimeSessionSubmission

返回

Section titled “返回”

RealtimeConnectionOptions

rerank()

Section titled “rerank()”
rerank(input, options): Promise<PlatformNonchatTask<RerankResult>>;

参数

Section titled “参数”
input
Section titled “input”

RerankInput

options
Section titled “options”

NonchatSubmitOptions

返回

Section titled “返回”

Promise<PlatformNonchatTask<RerankResult>>

submit()

Section titled “submit()”
submit<Operation>(
   operation,
   input,
   options
): Promise<PlatformNonchatTask<NonchatResult<Operation>>>;

类型参数

Section titled “类型参数”
Operation
Section titled “Operation”

Operation extends | "rerank" | "music.upload" | "music.generate" | "music.cover" | "music.lyrics" | "music.style" | "music.separate" | "sound.generate" | "embeddings" | "document.parse" | "document.extract" | "document.redact" | "voice.create" | "voice.refresh" | "voice.delete"

参数

Section titled “参数”
operation
Section titled “operation”

Operation

input
Section titled “input”

NonchatInput<Operation>

options
Section titled “options”

NonchatSubmitOptions

返回

Section titled “返回”

Promise<PlatformNonchatTask<NonchatResult<Operation>>>

uploadDocument()

Section titled “uploadDocument()”
uploadDocument(input, options?): Promise<DocumentUpload>;

将文档暂存到当前实例十分钟；不要求幂等键，不自动重提，也不提交收费模型任务。

参数

Section titled “参数”
input
Section titled “input”

DocumentUploadInput

options?
Section titled “options?”

NonchatCallOptions

返回

Section titled “返回”

Promise<DocumentUpload>

uploadMusicSource()

Section titled “uploadMusicSource()”
uploadMusicSource(input, options): Promise<PlatformNonchatTask<never>>;

显式上传为平台私有 sourceResourceId；未证明计量上界时平台在外呼前拒绝。

参数

Section titled “参数”
input
Section titled “input”

MusicUploadInput

options
Section titled “options”

NonchatSubmitOptions

返回

Section titled “返回”

Promise<PlatformNonchatTask<never>>

video()

Section titled “video()”
video(input, options?): Promise<MediaTaskOutcome>;

现役媒体任务合同，返回形与 /operations 不混用；不回落为第二次同步提交。

参数

Section titled “参数”
input
Section titled “input”

PlatformVideoInput

options?
Section titled “options?”

NonchatCallOptions

返回

Section titled “返回”

Promise<MediaTaskOutcome>

voice()

Section titled “voice()”
voice(input, options): Promise<PlatformNonchatTask<unknown>>;

参数

Section titled “参数”
input
Section titled “input”

VoiceOperationInput

options
Section titled “options”

NonchatSubmitOptions

返回

Section titled “返回”

Promise<PlatformNonchatTask<unknown>>

wait()

Section titled “wait()”
wait<Result>(task, options?): Promise<NonchatWaitResult<Result>>;

只查询原任务；unknown/failed/succeeded 都停止轮询，资金状态依然以 billing 为准。

类型参数

Section titled “类型参数”
Result
Section titled “Result”

Result

参数

Section titled “参数”
task
Section titled “task”

PlatformNonchatTask<Result>

options?
Section titled “options?”

NonchatWaitOptions

返回

Section titled “返回”

Promise<NonchatWaitResult<Result>>