Aspose.Pdf.AI

Aspose.Pdf.AI 命名空间提供用于 AI 功能的类,包括 API 客户端和智能助手。

描述
AIClientBase表示访问 AI API 的客户端。
AIClientException表示特定于 AI 客户端操作的异常。
AICopilotException表示特定于 Copilots 操作的异常。
AICopilotFactory创建不同类型的 copilots 的工厂类。
Annotation表示消息的一部分的文本内容。
AssistantCreateRequest创建助手的请求对象。
AssistantListQueryParameters表示用于列出助手的查询参数对象。
AssistantListResponse表示包含助手响应列表的响应。
AssistantModifyRequest修改助手的请求对象。
AssistantResponse表示可以调用模型并使用工具的助手。
Attachment表示附加到消息的文件列表,以及它们应添加到的工具。
BaseListQueryParameters列出对象的基本查询参数。
BaseResponseAPI 响应的基类。
CancellationTokenExtensions提供 CancellationToken 的扩展方法。
ChatMessage模型生成的聊天完成消息。
Choice表示聊天完成响应中的一个选择。
CodeInterpreter表示代码解释器工具资源。
CompletionCreateRequest表示创建聊天完成端点的请求。
CompletionFunction表示函数对象。
CompletionResponse表示模型根据提供的输入返回的聊天完成响应。
CreateChatCompletionChunkResponse表示模型根据提供的输入返回的聊天完成响应的流式块。
CreateEmbeddingRequest表示创建嵌入端点的请求。
CreateEmbeddingResponse表示来自创建嵌入端点的响应。
CreateFineTuningJobRequest表示创建微调作业端点的请求。
CreateFineTuningJobResponse表示来自创建微调作业端点的响应。
DataResponse<T>表示包含指定数据的数据响应。
DeleteStatusResponse表示对象删除的状态。
DocumentCollection表示要处理的文档集合。
Embedding表示嵌入端点返回的嵌入向量。
Error表示 API 响应中的错误。
ExpiresAfter表示向量存储的过期策略。
FileCitation表示文件引用。
FileContentResponse<T>
FileCounts
FileListResponse表示包含文件响应列表的文件列表响应。
FileResponseFileResponse 对象表示已上传到 OpenAI 的文档。
FileSearch表示文件搜索工具资源。
Function表示可以被模型调用的函数。
Hyperparameters表示用于微调作业的超参数。
ImageDescription表示图像描述。
ImageDescriptionResult表示包含图像描述的响应。
ImageFile表示消息内容中的图像文件。
ImageUrl表示消息内容中的图像 URL。
IncompleteDetails运行不完整的原因的详细信息。如果运行没有不完整,则为 null。
LastError与此运行相关的最后一个错误。如果没有错误,则为 null。
ListDataResponse<T>表示包含附加信息(如第一个和最后一个 ID 以及是否有更多项目)的列表数据响应。
LlamaChatCompletionRequest表示 ChatGPT API 请求的请求体。
LlamaChatCompletionResponse表示模型根据提供的输入返回的聊天完成响应。
LlamaClient表示与 Llama API 交互的客户端。
LlamaCopilotOptionsBase表示配置 LlamaCopilot 的基本选项。
LlamaModels包含与不同 Llama 模型相关的常量。
LlamaSummaryCopilot提供使用 AI 模型获取文档摘要的功能。示例用法包括创建 Llama 客户端、配置选项和使用摘要 copilots。注意:此 copilot 使用完成 API,因此可以发送的文本总量受模型上下文窗口的限制。
LlamaSummaryCopilotOptions表示配置 OpenAICopilot 的选项。
Logprobs表示选择的对数概率信息。
MessageContentBase消息内容的文本和/或图像数组。
MessageContentRequest消息内容的文本和/或图像数组。
MessageContentResponse响应消息的内容,包含文本和/或图像数组。
MessageCreation表示具有唯一标识符的消息的创建。
OpenAIAssistantCopilotOptionsBase表示基于 Assistants API 配置 OpenAICopilots 的基本选项。
OpenAIChatCopilot表示用于通过 AI 模型与文档交互的聊天 copilot。示例用法包括创建 OpenAI 客户端、配置选项和使用 ChatCopilot 与用户查询交互并管理对话上下文。
OpenAIChatCopilotOptions表示配置 OpenAICopilot 的选项。
OpenAIClient提供与 OpenAI API 交互以管理向量存储文件批次的方法。
OpenAIContext表示与助手相关的实体 ID。
OpenAICopilotOptionsBase表示配置 OpenAICopilot 的基本选项。
OpenAIImageDescriptionCopilot提供 OpenAICopilot 类的图像处理功能。示例用法包括创建 OpenAI 客户端、配置 ImageDescriptionCopilot 选项,并使用 copilot 生成图像描述并将描述添加到附加文档中。
OpenAIImageDescriptionCopilotExtensions提供 OpenAIImageDescriptionCopilot 类的扩展方法。
OpenAIImageDescriptionCopilotOptions表示配置 OpenAICopilot 的选项。
OpenAIModels包含可用的 OpenAI 模型标识符。
OpenAISummaryCopilot提供使用 AI 模型获取文档摘要的功能。示例用法包括创建 OpenAI 客户端、配置选项和使用摘要 copilot。
OpenAISummaryCopilotOptions表示配置 OpenAICopilot 的选项。
PdfDocument表示具有名称的 PDF 文档。
RequiredAction继续运行所需的操作的详细信息。如果不需要任何操作,则为 null。
ResponseFormat表示响应的格式,可以是字符串值或对象值。
RunCreateRequest表示创建运行的请求。
RunListQueryParameters列出运行的查询参数对象。
RunListResponse表示包含运行数据的列表响应。
RunModifyRequest表示修改运行的请求。
RunResponse表示在线程上执行的运行。
RunStepDetails运行步骤的详细信息。
RunStepListQueryParameters列出运行步骤的查询参数对象。
RunStepListResponse表示包含运行步骤数据的列表响应。
RunStepResponse表示运行执行中的一步。
RunThreadCreateRequest表示创建线程并在一个请求中运行的请求。
SubmitToolOutputs表示继续运行所需的工具输出的详细信息。
TextDocument表示具有名称和内容的文本文档。
TextResponse表示消息的一部分的文本内容。
ThreadCreateRequest表示创建线程的请求。
ThreadMessageCreateRequest表示在线程内创建消息的请求。
ThreadMessageListQueryParameters列出线程消息的查询参数对象。
ThreadMessageListResponse表示包含线程消息数据的列表响应。
ThreadMessageModifyRequest表示修改线程内消息的请求。
ThreadMessageResponse表示线程内的消息。
ThreadModifyRequest表示修改线程的请求。
ThreadResponse表示包含消息的线程。
Tool表示可以被模型调用的工具。
ToolCall表示消息中的工具调用。
ToolChoice表示 ToolChoice,可以是字符串值或对象值。
ToolResources表示助手工具使用的一组资源。资源特定于工具类型。例如,code_interpreter 工具需要文件 ID 列表,而 file_search 工具需要向量存储 ID 列表。
TruncationStrategy表示控制线程在运行之前如何被截断的截断策略。
Usage表示请求的使用统计信息。
VectorStore帮助创建一个带有 file_ids 的向量存储并将其附加到此线程。线程最多可以附加 1 个向量存储。
VectorStoreCreateRequest创建向量存储请求。
VectorStoreFileBatchCreateRequest创建向量存储文件批次请求。
VectorStoreFileBatchFileListQueryParameters列出向量存储文件批次文件的查询参数对象。
VectorStoreFileBatchFileListResponse表示包含向量存储文件批次数据的列表响应。
VectorStoreFileBatchResponse向量存储文件批次响应对象。
VectorStoreFileCreateRequest创建向量存储文件请求。
VectorStoreFileListQueryParameters列出向量存储文件的查询参数对象。
VectorStoreFileListResponse表示包含向量存储文件数据的列表响应。
VectorStoreFileResponse向量存储文件响应。
VectorStoreListQueryParameters列出向量存储的查询参数对象。
VectorStoreListResponse表示包含向量存储数据的列表响应。
VectorStoreModifyRequest修改向量存储请求。
VectorStoreResponse向量存储对象。

接口

接口描述
IAIClient表示 AI 客户端的接口。
IAICopilot表示用于 AI 交互的 copilot。
IChatClient<TOptions>表示具有特定选项的聊天客户端接口。
IChatCopilot表示用于通过 AI 模型与文档交互的聊天 copilot。
IChatCopilotOptions<TOptions>表示具有特定类型的聊天 copilot 选项的接口。
IEntityId表示具有 ID 的实体。
IImageDescriptionClient<TOptions>表示具有特定选项的图像描述客户端接口。
IImageDescriptionCopilot表示用于提取图像描述的图像描述 copilot,使用 AI 模型。
IImageDescriptionCopilotOptions<TOptions>表示具有特定类型的图像描述 copilot 选项的接口。
ILlamaClient表示与 Llama API 交互的客户端接口。
IOpenAIClient表示与 OpenAI API 交互的客户端接口,扩展基本 AI 客户端功能。
IQueryParameters表示 API 请求的查询参数。
IStatus表示操作的状态。
IStringOrObject<T>表示可以是字符串值或对象值的对象。
ISummaryClient<TOptions>表示具有特定选项的摘要客户端接口。
ISummaryCopilot表示用于生成文档摘要的摘要 copilot,使用 AI 模型。
ISummaryCopilotOptions<TOptions>表示具有特定类型的摘要 copilot 选项的接口。