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 | 列出对象的基本查询参数。 |
| BaseResponse | API 响应的基类。 |
| 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 | 表示包含文件响应列表的文件列表响应。 |
| FileResponse | FileResponse 对象表示已上传到 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 选项的接口。 |