AISearchIndexResource
|
AI 搜索索引资源。
|
Agent
|
表示可以调用模型并使用工具的代理。
|
AgentDeletionStatus
|
代理删除操作的状态。
|
AgentEventMessage
|
服务器发送的事件流中的每个事件都有一个 event 和 data 属性: * *
示例
-
- event:thread.created
- data: {“id”: “thread_123”, “object”: “thread”, ...}
-
- 每当创建新对象、转换为新状态或正在发生时,我们都会发出事件
- 流式传输部分(deltas)。 例如,在新运行时发出
thread.run.created
- 创建、运行完成时
thread.run.completed ,等等。 代理选择时
- 若要在运行期间创建消息,我们将发出一个
thread.message.created event ,a
-
thread.message.in_progress 事件、许多 thread.message.delta 事件,最后是
-
thread.message.completed 事件。
- 我们可能会随着时间的推移添加其他事件,因此我们建议正常处理未知事件
- 在代码中。
|
AgentEventMessageStream
|
表示代理事件消息流。
|
AgentThread
|
有关与代理关联的单个线程的信息。
|
AgentThreadCreationOptions
|
用于创建新代理线程的详细信息。
|
AgentsClientOptionalParams
|
客户端的可选参数。
|
AgentsNamedToolChoice
|
指定模型应使用的工具。 用于强制模型调用特定工具。
|
AgentsResponseFormat
|
描述模型的预期输出的对象。 如果为 json_object ,则只允许将 function 类型 tools 传递给 Run。
如果为 text ,则模型可以返回文本或任何所需的值。
|
AzureAISearchResource
|
azure_ai_search 工具使用的一组索引资源。
|
AzureAISearchToolDefinition
|
用于配置代理的 Azure AI 搜索工具的输入定义信息。
|
AzureFunctionBinding
|
用于保留存储队列名称和 URI 的结构。
|
AzureFunctionDefinition
|
Azure 函数的定义。
|
AzureFunctionStorageQueue
|
用于保留存储队列名称和 URI 的结构。
|
AzureFunctionToolDefinition
|
用于配置代理的 Azure 函数工具的输入定义信息。
|
BingCustomSearchConfiguration
|
必应自定义搜索配置。
|
BingCustomSearchConfigurationList
|
该工具当前使用的 bing_custom_search 搜索配置列表。
|
BingCustomSearchToolDefinition
|
用于配置代理的必应自定义搜索工具的输入定义信息。
|
BingGroundingSearchConfiguration
|
搜索 Bing Grounding 的配置
|
BingGroundingSearchConfigurationList
|
该工具当前使用的 bing_grounding 搜索配置列表。
|
BingGroundingToolDefinition
|
用于配置代理的必应地面搜索工具的输入定义信息。
|
CodeInterpreterToolDefinition
|
用于配置代理的代码解释器工具的输入定义信息。
|
CodeInterpreterToolResource
|
code_interpreter 工具使用的一组资源。
|
ConnectedAgentDetails
|
将一个代理作为工具连接到另一个代理的信息
|
ConnectedAgentToolDefinition
|
已连接代理程序工具的输入定义信息,用于定义特定于域的子代理程序
|
CreateAgentOptionalParams
|
可选参数。
|
CreateThreadAndRunOptionalParams
|
可选参数。
|
DeleteAgentOptionalParams
|
可选参数。
|
FileDeletionStatus
|
文件删除操作的状态响应。
|
FileInfo
|
表示可以调用模型并使用工具的代理。
|
FileListResponse
|
文件列表操作中的响应数据。
|
FileSearchRankingOptions
|
文件搜索的排名选项。
|
FileSearchToolCallContent
|
文件搜索结果内容对象。
|
FileSearchToolDefinition
|
用于配置代理的文件搜索工具的输入定义信息。
|
FileSearchToolDefinitionDetails
|
文件搜索工具的选项替代。
|
FileSearchToolResource
|
file_search 工具使用的一组资源。
|
FilesDeleteFileOptionalParams
|
可选参数。
|
FilesGetFileContentOptionalParams
|
可选参数。
|
FilesGetFileOptionalParams
|
可选参数。
|
FilesListFilesOptionalParams
|
可选参数。
|
FilesOperations
|
表示 Files作的接口。
|
FilesUploadFileOptionalParams
|
可选参数。
|
FunctionDefinition
|
函数的输入定义信息。
|
FunctionName
|
将使用的函数名称(如果使用 function 工具)
|
FunctionToolDefinition
|
用于配置代理的函数工具的输入定义信息。
|
GetAgentOptionalParams
|
可选参数。
|
IncompleteRunDetails
|
有关运行为何不完整的详细信息。 如果运行不完整,将 null 。
|
ListAgentsOptionalParams
|
可选参数。
|
MessageAttachment
|
这描述了文件已附加到哪些工具。
|
MessageContent
|
线程消息内容的单个项的抽象表示形式。
|
MessageDelta
|
表示流式处理消息增量区块中的类型化“delta”有效负载。
|
MessageDeltaChunk
|
表示消息增量,例如,流式传输期间任何消息字段的更改。
|
MessageDeltaContent
|
部分流式处理消息内容有效负载的抽象基表示形式。
|
MessageDeltaImageFileContent
|
表示流式处理消息增量区块中的流式处理图像文件内容部件。
|
MessageDeltaImageFileContentObject
|
表示流式处理图像文件内容中的“image_file”有效负载。
|
MessageDeltaTextAnnotation
|
流式处理文本内容部件的文本批注的抽象基表示形式。
|
MessageDeltaTextContent
|
表示流式处理消息增量区块中的流式处理文本内容部件。
|
MessageDeltaTextContentObject
|
表示流式处理消息增量区块中流式传输的文本内容部件的数据。
|
MessageDeltaTextFileCitationAnnotation
|
表示应用于流式处理文本内容部件的流式处理文件引文。
|
MessageDeltaTextFileCitationAnnotationObject
|
表示应用于流式处理文本内容部件的流式处理文件引文的数据。
|
MessageDeltaTextFilePathAnnotation
|
表示应用于流式处理文本内容部件的流式处理文件路径注释。
|
MessageDeltaTextFilePathAnnotationObject
|
表示应用于流式处理文本内容部件的流式处理文件路径批注的数据。
|
MessageDeltaTextUrlCitationAnnotation
|
消息中指向与消息关联的特定 URL 的引文。 当代理使用“bing_grounding”等工具搜索 Internet 时生成。
|
MessageDeltaTextUrlCitationDetails
|
URL 引用的表示形式,用于文本线程消息内容。
|
MessageImageFileContent
|
线程消息中图像文件内容的表示形式。
|
MessageImageFileDetails
|
图像引用,如线程消息内容中所示。
|
MessageImageFileParam
|
定义在创建 image-file 块时如何引用内部上传的 image 文件。
|
MessageImageUrlParam
|
定义在创建 image-URL 块时如何引用外部图像 URL。
|
MessageIncompleteDetails
|
提供有关输入不完整状态的邮件的其他详细信息的信息。
|
MessageInputContentBlock
|
创建消息时定义单个内容块。 “type”字段确定它是文本、图像文件还是外部图像 URL 等。
|
MessageInputImageFileBlock
|
新消息中的 image-file 块,通过文件 ID 引用内部上传的图像。
|
MessageInputImageUrlBlock
|
新消息中的 image-URL 块,通过 URL 引用外部图像。
|
MessageInputTextBlock
|
新消息中的文本块,包含纯文本内容。
|
MessageTextAnnotation
|
文本线程消息内容的批注的抽象表示形式。
|
MessageTextContent
|
线程消息内容的文本项的表示形式。
|
MessageTextDetails
|
代理线程消息内容的单个项的文本和关联批注。
|
MessageTextFileCitationAnnotation
|
消息中的引文,该引文指向与代理或消息关联的特定文件中的特定引文。 代理使用“file_search”工具搜索文件时生成。
|
MessageTextFileCitationDetails
|
基于文件的文字引文的表示形式,如基于文件的文本线程消息内容的批注所示。
|
MessageTextFilePathAnnotation
|
指向位于特定路径的文件的消息中的引文。
|
MessageTextFilePathDetails
|
消息图像内容使用的映像文件 ID 的封装。
|
MessageTextUrlCitationAnnotation
|
消息中指向与消息关联的特定 URL 的引文。 当代理使用“bing_grounding”等工具搜索 Internet 时生成。
|
MessageTextUrlCitationDetails
|
URL 引用的表示形式,用于文本线程消息内容。
|
MessagesCreateMessageOptionalParams
|
可选参数。
|
MessagesGetMessageOptionalParams
|
可选参数。
|
MessagesListMessagesOptionalParams
|
可选参数。
|
MessagesOperations
|
表示 Messages作的接口。
|
MessagesUpdateMessageOptionalParams
|
可选参数。
|
MicrosoftFabricToolDefinition
|
用于配置代理的 Microsoft Fabric 工具的输入定义信息。
|
OpenApiAnonymousAuthDetails
|
OpenApi 匿名身份验证的安全详细信息
|
OpenApiAuthDetails
|
OpenApiFunctionDefinition 的身份验证详细信息
|
OpenApiConnectionAuthDetails
|
OpenApi 连接身份验证的安全详细信息
|
OpenApiConnectionSecurityScheme
|
OpenApi managed_identity身份验证的安全方案
|
OpenApiFunctionDefinition
|
openapi 函数的输入定义信息。
|
OpenApiManagedAuthDetails
|
OpenApi managed_identity身份验证的安全详细信息
|
OpenApiManagedSecurityScheme
|
OpenApi managed_identity身份验证的安全方案
|
OpenApiToolDefinition
|
用于配置代理的 OpenAPI 工具的输入定义信息。
|
PageSettings
|
byPage 方法的选项
|
PagedAsyncIterableIterator
|
允许异步迭代到完成和逐页迭代的接口。
|
PollingOptions
|
用于配置轮询行为的选项。
|
PollingOptionsParams
|
配置轮询行为的可选参数。
|
RequiredAction
|
代理线程运行继续所需的操作的抽象表示形式。
|
RequiredFunctionToolCall
|
对函数工具的请求调用的表示形式,模型需要它才能继续评估运行。
|
RequiredFunctionToolCallDetails
|
调用函数工具所需的操作提供函数调用的详细信息,其中包括函数的名称和参数。
|
RequiredToolCall
|
模型继续运行所需的工具调用的抽象表示形式。
|
ResponseFormatJsonSchema
|
对响应格式用途的描述,由模型用于确定如何以该格式进行响应。
|
ResponseFormatJsonSchemaType
|
要定义的响应格式的类型:json_schema
|
RunCompletionUsage
|
与运行相关的使用情况统计信息。 如果运行不处于终端状态(即 null 、in_progress 等),则此值将 queued 。
|
RunError
|
代理线程运行遇到的错误的详细信息。
|
RunStep
|
有关代理线程运行的单个步骤的详细信息。
|
RunStepAzureAISearchToolCall
|
对 Azure AI 搜索工具的调用记录,该工具由模型在评估定义的工具时发出,该工具表示已执行的 Azure AI 搜索。
|
RunStepBingCustomSearchToolCall
|
对必应自定义搜索工具的调用记录,由模型在评估定义的工具时发出,表示使用必应自定义搜索执行的搜索。
|
RunStepBingGroundingToolCall
|
调用必应地面工具的记录,由模型在评估定义的工具时发出,该记录表示使用必应地面执行的搜索。
|
RunStepCodeInterpreterImageOutput
|
代码解释器工具发出的图像输出的表示形式,以响应模型调用的工具。
|
RunStepCodeInterpreterImageReference
|
代码解释器工具发出的图像引用,以响应模型调用的工具。
|
RunStepCodeInterpreterLogOutput
|
代码解释器工具发出的日志输出的表示形式,以响应模型调用的工具。
|
RunStepCodeInterpreterToolCall
|
调用代码解释器工具的记录,该工具由模型在评估定义的工具时发出,表示由代码解释器使用和发出的输入和输出。
|
RunStepCodeInterpreterToolCallDetails
|
有关模型调用代码解释器的详细信息。
|
RunStepCodeInterpreterToolCallOutput
|
从代码解释器工具发出的输出的抽象表示形式。
|
RunStepCompletionUsage
|
与运行步骤相关的使用情况统计信息。
|
RunStepDelta
|
表示流式处理运行步骤增量区块中的增量有效负载。
|
RunStepDeltaChunk
|
表示运行步骤增量,例如,流式传输期间任何运行步骤字段的更改。
|
RunStepDeltaCodeInterpreterDetailItemObject
|
表示流式处理运行步骤工具调用中的代码解释器工具调用数据。
|
RunStepDeltaCodeInterpreterImageOutput
|
表示生成代码解释器工具的图像输出,并在流式处理运行步骤的增量工具调用集合中表示。
|
RunStepDeltaCodeInterpreterImageOutputObject
|
表示流式处理运行步骤的代码解释器工具调用图像输出的数据。
|
RunStepDeltaCodeInterpreterLogOutput
|
表示由代码解释器工具生成的日志输出,并在流式处理运行步骤的增量工具调用集合中表示。
|
RunStepDeltaCodeInterpreterOutput
|
流式处理运行步骤工具调用的代码解释器工具输出的抽象基表示形式。
|
RunStepDeltaCodeInterpreterToolCall
|
表示流式处理运行步骤的工具调用详细信息中的代码解释器工具调用。
|
RunStepDeltaDetail
|
表示流式处理运行步骤的增量有效负载中的单个运行步骤详细信息项。
|
RunStepDeltaFileSearchToolCall
|
表示流式处理运行步骤的工具调用详细信息中的文件搜索工具调用。
|
RunStepDeltaFunction
|
表示流式处理运行步骤 delta 函数工具调用中的函数数据。
|
RunStepDeltaFunctionToolCall
|
表示流式处理运行步骤的工具调用详细信息中的函数工具调用。
|
RunStepDeltaMessageCreation
|
表示流式处理运行步骤增量中的消息创建。
|
RunStepDeltaMessageCreationObject
|
表示流式处理运行步骤消息创建响应对象中的数据。
|
RunStepDeltaToolCall
|
流式处理运行步骤的增量工具调用详细信息中单个工具调用的抽象基表示形式。
|
RunStepDeltaToolCallObject
|
表示作为流式运行步骤的一部分调用工具调用。
|
RunStepDetails
|
运行步骤的详细信息的抽象表示形式。
|
RunStepError
|
与失败的运行步骤关联的错误信息。
|
RunStepFileSearchToolCall
|
调用文件搜索工具的记录,由模型在评估定义的工具时发出,表示执行的文件搜索。
|
RunStepFileSearchToolCallResult
|
文件搜索工具调用结果。
|
RunStepFileSearchToolCallResults
|
文件搜索的结果。
|
RunStepFunctionToolCall
|
对函数工具的调用记录(由模型在计算定义的工具时发出)的记录,该记录表示指定函数使用和发出的输入和输出。
|
RunStepFunctionToolCallDetails
|
有关模型调用的函数的详细信息。
|
RunStepMessageCreationDetails
|
与消息创建运行步骤关联的详细信息。
|
RunStepMessageCreationReference
|
作为运行步骤的一部分创建的消息的详细信息。
|
RunStepMicrosoftFabricToolCall
|
调用 Microsoft Fabric 工具的记录,该工具由模型在评估定义的工具时发出,表示执行Microsoft Fabric 操作。
|
RunStepOpenAPIToolCall
|
对 OpenAPI 工具的调用记录,由模型在评估已定义的工具时发出,表示已执行的 OpenAPI作。
|
RunStepSharepointToolCall
|
调用 SharePoint 工具的记录,该工具由模型在评估定义的工具时发出,表示已执行的 SharePoint 操作。
|
RunStepToolCall
|
在现有运行的运行步骤中记录的详细工具调用的抽象表示形式。
|
RunStepToolCallDetails
|
与运行步骤调用工具关联的详细信息。
|
RunStepsGetRunStepOptionalParams
|
可选参数。
|
RunStepsListRunStepsOptionalParams
|
可选参数。
|
RunStepsOperations
|
表示 RunSteps作的接口。
|
RunsCancelRunOptionalParams
|
可选参数。
|
RunsCreateRunOptionalParams
|
可选参数。
|
RunsGetRunOptionalParams
|
可选参数。
|
RunsListRunsOptionalParams
|
可选参数。
|
RunsOperations
|
表示 Runs作的接口。
|
RunsSubmitToolOutputsToRunOptionalParams
|
可选参数。
|
RunsUpdateRunOptionalParams
|
可选参数。
|
SharepointToolDefinition
|
用于配置代理的 sharepoint 工具的输入定义信息。
|
SubmitToolOutputsAction
|
必须提交代理线程运行才能继续的所需工具调用的详细信息。
|
SubmitToolOutputsDetails
|
描述应调用以提交工具输出的工具的详细信息。
|
ThreadDeletionStatus
|
线程删除操作的状态。
|
ThreadMessage
|
代理线程中的单个现有消息。
|
ThreadMessageOptions
|
代理线程中的单个消息,在该线程创建期间为初始状态提供。
|
ThreadRun
|
表示代理线程的单个评估运行的数据。
|
ThreadsCreateThreadOptionalParams
|
可选参数。
|
ThreadsDeleteThreadOptionalParams
|
可选参数。
|
ThreadsGetThreadOptionalParams
|
可选参数。
|
ThreadsListThreadsOptionalParams
|
可选参数。
|
ThreadsOperations
|
表示 Threads作的接口。
|
ThreadsUpdateThreadOptionalParams
|
可选参数。
|
ToolConnection
|
连接资源。
|
ToolConnectionList
|
当前由 bing_grounding 、fabric_dataagent 或 sharepoint_grounding 工具使用的一组连接资源。
|
ToolDefinition
|
代理可以使用的输入工具定义的抽象表示形式。
|
ToolOutput
|
工具期间提供的数据输出提交以解析挂起的工具调用并允许模型继续。
|
ToolResources
|
代理工具使用的一组资源。 资源特定于工具类型。 例如,code_interpreter 工具需要文件 ID 列表,而 file_search 工具需要矢量存储 ID 列表。
|
TruncationObject
|
用于指示在运行之前如何截断线程的控件。 使用此控件可控制运行的初始上下文窗口。
|
UpdateAgentOptionalParams
|
可选参数。
|
UpdateCodeInterpreterToolResourceOptions
|
请求对象以更新 code_interpreted 工具资源。
|
UpdateFileSearchToolResourceOptions
|
请求对象以更新 file_search 工具资源。
|
UpdateToolResourcesOptions
|
请求对象。 代理工具使用的一组资源。 资源特定于工具类型。
例如,code_interpreter 工具需要文件 ID 列表,而 file_search 工具需要矢量存储 ID 列表。
|
VectorStore
|
矢量存储是 file_search 工具可以使用已处理文件的集合。
|
VectorStoreAutoChunkingStrategyRequest
|
默认策略。 此策略目前使用的max_chunk_size_tokens为 800,chunk_overlap_tokens为 400。
|
VectorStoreAutoChunkingStrategyResponse
|
当分块策略未知时,将返回此值。 通常,这是因为文件是在 API 中引入chunking_strategy概念之前编制索引的。
|
VectorStoreChunkingStrategyRequest
|
矢量存储分块策略配置的抽象表示形式。
|
VectorStoreChunkingStrategyResponse
|
矢量存储分块策略配置的抽象表示形式。
|
VectorStoreConfiguration
|
矢量存储配置是数据源列表,当多个文件可用于企业文件搜索时使用。
|
VectorStoreConfigurations
|
结构,包含矢量存储配置列表,即 Azure 资产 ID 的列表。
|
VectorStoreDataSource
|
结构,包含 Azure 资产 URI 路径和用作企业文件搜索数据源的文件的资产类型。
|
VectorStoreDeletionStatus
|
用于删除向量存储的响应对象。
|
VectorStoreExpirationPolicy
|
矢量存储过期策略。
|
VectorStoreFile
|
附加到向量存储的文件的说明。
|
VectorStoreFileBatch
|
附加到矢量存储的批量文件。
|
VectorStoreFileBatchesCancelVectorStoreFileBatchOptionalParams
|
可选参数。
|
VectorStoreFileBatchesCreateVectorStoreFileBatchOptionalParams
|
可选参数。
|
VectorStoreFileBatchesGetVectorStoreFileBatchOptionalParams
|
可选参数。
|
VectorStoreFileBatchesListVectorStoreFileBatchFilesOptionalParams
|
可选参数。
|
VectorStoreFileBatchesOperations
|
表示 VectorStoreFileBatches作的接口。
|
VectorStoreFileCount
|
此矢量存储按状态分组处理或正在处理的文件计数。
|
VectorStoreFileDeletionStatus
|
用于删除矢量存储文件关系的响应对象。
|
VectorStoreFileError
|
有关处理此矢量存储的文件时可能发生的错误的详细信息
|
VectorStoreFilesCreateVectorStoreFileOptionalParams
|
可选参数。
|
VectorStoreFilesDeleteVectorStoreFileOptionalParams
|
可选参数。
|
VectorStoreFilesGetVectorStoreFileOptionalParams
|
可选参数。
|
VectorStoreFilesListVectorStoreFilesOptionalParams
|
可选参数。
|
VectorStoreFilesOperations
|
表示 VectorStoreFiles作的接口。
|
VectorStoreStaticChunkingStrategyOptions
|
配置矢量存储静态分块策略的选项。
|
VectorStoreStaticChunkingStrategyRequest
|
静态配置的分块策略。
|
VectorStoreStaticChunkingStrategyResponse
|
静态配置的分块策略。
|
VectorStoresCreateVectorStoreOptionalParams
|
可选参数。
|
VectorStoresDeleteVectorStoreOptionalParams
|
可选参数。
|
VectorStoresGetVectorStoreOptionalParams
|
可选参数。
|
VectorStoresListVectorStoresOptionalParams
|
可选参数。
|
VectorStoresModifyVectorStoreOptionalParams
|
可选参数。
|
VectorStoresOperations
|
表示 VectorStores作的接口。
|