@azure/ai-projects 1.0.0-beta.1 → 1.0.0-beta.3

package/dist/commonjs/generated/src/models.js.map

@@ -1 +1 @@
-{"version":3,"file":"models.js","sourceRoot":"","sources":["../../../../src/generated/src/models.ts"],"names":[],"mappings":";AAAA,uCAAuC;AACvC,kCAAkC","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT License.\n\n/** The request details to use when creating a new agent. */\nexport interface CreateAgentOptions {\n  /** The ID of the model to use. */\n  model: string;\n  /** The name of the new agent. */\n  name?: string | null;\n  /** The description of the new agent. */\n  description?: string | null;\n  /** The system instructions for the new agent to use. */\n  instructions?: string | null;\n  /** The collection of tools to enable for the new agent. */\n  tools?: Array<ToolDefinition>;\n  /**\n   * A set of resources that are used by the agent's tools. The resources are specific to the type of tool. For example, the `code_interpreter`\n   * tool requires a list of file IDs, while the `file_search` tool requires a list of vector store IDs.\n   */\n  tool_resources?: ToolResources | null;\n  /**\n   * What sampling temperature to use, between 0 and 2. Higher values like 0.8 will make the output more random,\n   * while lower values like 0.2 will make it more focused and deterministic.\n   */\n  temperature?: number | null;\n  /**\n   * An alternative to sampling with temperature, called nucleus sampling, where the model considers the results of the tokens with top_p probability mass.\n   * So 0.1 means only the tokens comprising the top 10% probability mass are considered.\n   *\n   * We generally recommend altering this or temperature but not both.\n   */\n  top_p?: number | null;\n  /** The response format of the tool calls used by this agent. */\n  response_format?: AgentsApiResponseFormatOption | null;\n  /** A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format. Keys may be up to 64 characters in length and values may be up to 512 characters in length. */\n  metadata?: Record<string, string> | null;\n}\n\n/** An abstract representation of an input tool definition that an agent can use. */\nexport interface ToolDefinitionParent {\n  type: string;\n}\n\n/** The input definition information for a code interpreter tool as used to configure an agent. */\nexport interface CodeInterpreterToolDefinition extends ToolDefinitionParent {\n  /** The object type, which is always 'code_interpreter'. */\n  type: \"code_interpreter\";\n}\n\n/** The input definition information for a file search tool as used to configure an agent. */\nexport interface FileSearchToolDefinition extends ToolDefinitionParent {\n  /** The object type, which is always 'file_search'. */\n  type: \"file_search\";\n  /** Options overrides for the file search tool. */\n  file_search?: FileSearchToolDefinitionDetails;\n}\n\n/** Options overrides for the file search tool. */\nexport interface FileSearchToolDefinitionDetails {\n  /**\n   * The maximum number of results the file search tool should output. The default is 20 for gpt-4* models and 5 for gpt-3.5-turbo. This number should be between 1 and 50 inclusive.\n   *\n   * Note that the file search tool may output fewer than `max_num_results` results. See the file search tool documentation for more information.\n   */\n  max_num_results?: number;\n  ranking_options?: FileSearchRankingOptions;\n}\n\n/** Ranking options for file search. */\nexport interface FileSearchRankingOptions {\n  /** File search ranker. */\n  ranker: string;\n  /** Ranker search threshold. */\n  score_threshold: number;\n}\n\n/** The input definition information for a function tool as used to configure an agent. */\nexport interface FunctionToolDefinition extends ToolDefinitionParent {\n  /** The object type, which is always 'function'. */\n  type: \"function\";\n  /** The definition of the concrete function that the function tool should call. */\n  function: FunctionDefinition;\n}\n\n/** The input definition information for a function. */\nexport interface FunctionDefinition {\n  /** The name of the function to be called. */\n  name: string;\n  /** A description of what the function does, used by the model to choose when and how to call the function. */\n  description?: string;\n  /** The parameters the functions accepts, described as a JSON Schema object. */\n  parameters: unknown;\n}\n\n/** The input definition information for a bing grounding search tool as used to configure an agent. */\nexport interface BingGroundingToolDefinition extends ToolDefinitionParent {\n  /** The object type, which is always 'bing_grounding'. */\n  type: \"bing_grounding\";\n  /** The list of connections used by the bing grounding tool. */\n  bing_grounding: ToolConnectionList;\n}\n\n/** A set of connection resources currently used by either the `bing_grounding`, `microsoft_fabric`, or `sharepoint_grounding` tools. */\nexport interface ToolConnectionList {\n  /**\n   * The connections attached to this tool. There can be a maximum of 1 connection\n   * resource attached to the tool.\n   */\n  connections?: Array<ToolConnection>;\n}\n\n/** A connection resource. */\nexport interface ToolConnection {\n  /** A connection in a ToolConnectionList attached to this tool. */\n  connection_id: string;\n}\n\n/** The input definition information for a Microsoft Fabric tool as used to configure an agent. */\nexport interface MicrosoftFabricToolDefinition extends ToolDefinitionParent {\n  /** The object type, which is always 'microsoft_fabric'. */\n  type: \"microsoft_fabric\";\n  /** The list of connections used by the Microsoft Fabric tool. */\n  microsoft_fabric: ToolConnectionList;\n}\n\n/** The input definition information for a sharepoint tool as used to configure an agent. */\nexport interface SharepointToolDefinition extends ToolDefinitionParent {\n  /** The object type, which is always 'sharepoint_grounding'. */\n  type: \"sharepoint_grounding\";\n  /** The list of connections used by the SharePoint tool. */\n  sharepoint_grounding: ToolConnectionList;\n}\n\n/** The input definition information for an Azure AI search tool as used to configure an agent. */\nexport interface AzureAISearchToolDefinition extends ToolDefinitionParent {\n  /** The object type, which is always 'azure_ai_search'. */\n  type: \"azure_ai_search\";\n}\n\n/**\n * A set of resources that are used by the agent's tools. The resources are specific to the type of\n * tool. For example, the `code_interpreter` tool requires a list of file IDs, while the `file_search`\n * tool requires a list of vector store IDs.\n */\nexport interface ToolResources {\n  /** Resources to be used by the `code_interpreter tool` consisting of file IDs. */\n  code_interpreter?: CodeInterpreterToolResource;\n  /** Resources to be used by the `file_search` tool consisting of vector store IDs. */\n  file_search?: FileSearchToolResource;\n  /** Resources to be used by the `azure_ai_search` tool consisting of index IDs and names. */\n  azure_ai_search?: AzureAISearchResource;\n}\n\n/** A set of resources that are used by the `code_interpreter` tool. */\nexport interface CodeInterpreterToolResource {\n  /**\n   * A list of file IDs made available to the `code_interpreter` tool. There can be a maximum of 20 files\n   * associated with the tool.\n   */\n  file_ids?: string[];\n  /** The data sources to be used. This option is mutually exclusive with fileIds. */\n  data_sources?: Array<VectorStoreDataSource>;\n}\n\n/**\n * The structure, containing Azure asset URI path and the asset type of the file used as a data source\n * for the enterprise file search.\n */\nexport interface VectorStoreDataSource {\n  /** Asset URI. */\n  uri: string;\n  /** The asset type * */\n  type: VectorStoreDataSourceAssetType;\n}\n\n/** A set of resources that are used by the `file_search` tool. */\nexport interface FileSearchToolResource {\n  /**\n   * The ID of the vector store attached to this agent. There can be a maximum of 1 vector\n   * store attached to the agent.\n   */\n  vector_store_ids?: string[];\n  /**\n   * The list of vector store configuration objects from Azure. This list is limited to one\n   * element. The only element of this list contains\n   * the list of azure asset IDs used by the search tool.\n   */\n  vector_stores?: Array<VectorStoreConfigurations>;\n}\n\n/** The structure, containing the list of vector storage configurations i.e. the list of azure asset IDs. */\nexport interface VectorStoreConfigurations {\n  /** Name */\n  name: string;\n  /** Configurations */\n  configuration: VectorStoreConfiguration;\n}\n\n/**\n * Vector storage configuration is the list of data sources, used when multiple\n * files can be used for the enterprise file search.\n */\nexport interface VectorStoreConfiguration {\n  /** Data sources */\n  data_sources: Array<VectorStoreDataSource>;\n}\n\n/** A set of index resources used by the `azure_ai_search` tool. */\nexport interface AzureAISearchResource {\n  /**\n   * The indices attached to this agent. There can be a maximum of 1 index\n   * resource attached to the agent.\n   */\n  indexes?: Array<IndexResource>;\n}\n\n/** A Index resource. */\nexport interface IndexResource {\n  /** An index connection id in an IndexResource attached to this agent. */\n  index_connection_id: string;\n  /** The name of an index in an IndexResource attached to this agent. */\n  index_name: string;\n}\n\n/**\n * An object describing the expected output of the model. If `json_object` only `function` type `tools` are allowed to be passed to the Run.\n * If `text` the model can return text or any value needed.\n */\nexport interface AgentsApiResponseFormat {\n  /**\n   * Must be one of `text` or `json_object`.\n   *\n   * Possible values: \"text\", \"json_object\"\n   */\n  type?: ApiResponseFormat;\n}\n\n/** The request details to use when modifying an existing agent. */\nexport interface UpdateAgentOptions {\n  /** The ID of the model to use. */\n  model?: string;\n  /** The modified name for the agent to use. */\n  name?: string | null;\n  /** The modified description for the agent to use. */\n  description?: string | null;\n  /** The modified system instructions for the new agent to use. */\n  instructions?: string | null;\n  /** The modified collection of tools to enable for the agent. */\n  tools?: Array<ToolDefinition>;\n  /**\n   * A set of resources that are used by the agent's tools. The resources are specific to the type of tool. For example,\n   * the `code_interpreter` tool requires a list of file IDs, while the `file_search` tool requires a list of vector store IDs.\n   */\n  tool_resources?: ToolResources;\n  /**\n   * What sampling temperature to use, between 0 and 2. Higher values like 0.8 will make the output more random,\n   * while lower values like 0.2 will make it more focused and deterministic.\n   */\n  temperature?: number | null;\n  /**\n   * An alternative to sampling with temperature, called nucleus sampling, where the model considers the results of the tokens with top_p probability mass.\n   * So 0.1 means only the tokens comprising the top 10% probability mass are considered.\n   *\n   * We generally recommend altering this or temperature but not both.\n   */\n  top_p?: number | null;\n  /** The response format of the tool calls used by this agent. */\n  response_format?: AgentsApiResponseFormatOption | null;\n  /** A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format. Keys may be up to 64 characters in length and values may be up to 512 characters in length. */\n  metadata?: Record<string, string> | null;\n}\n\n/** The details used to create a new agent thread. */\nexport interface AgentThreadCreationOptions {\n  /** The initial messages to associate with the new thread. */\n  messages?: Array<ThreadMessageOptions>;\n  /**\n   * A set of resources that are made available to the agent's tools in this thread. The resources are specific to the\n   * type of tool. For example, the `code_interpreter` tool requires a list of file IDs, while the `file_search` tool requires\n   * a list of vector store IDs.\n   */\n  tool_resources?: ToolResources | null;\n  /** A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format. Keys may be up to 64 characters in length and values may be up to 512 characters in length. */\n  metadata?: Record<string, string> | null;\n}\n\n/** A single message within an agent thread, as provided during that thread's creation for its initial state. */\nexport interface ThreadMessageOptions {\n  /**\n   * The role of the entity that is creating the message. Allowed values include:\n   * - `user`: Indicates the message is sent by an actual user and should be used in most\n   * cases to represent user-generated messages.\n   * - `assistant`: Indicates the message is generated by the agent. Use this value to insert\n   * messages from the agent into the\n   * conversation.\n   *\n   * Possible values: \"user\", \"assistant\"\n   */\n  role: MessageRole;\n  /**\n   * The textual content of the initial message. Currently, robust input including images and annotated text may only be provided via\n   * a separate call to the create message API.\n   */\n  content: string;\n  /** A list of files attached to the message, and the tools they should be added to. */\n  attachments?: Array<MessageAttachment> | null;\n  /** A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format. Keys may be up to 64 characters in length and values may be up to 512 characters in length. */\n  metadata?: Record<string, string> | null;\n}\n\n/** This describes to which tools a file has been attached. */\nexport interface MessageAttachment {\n  /** The ID of the file to attach to the message. */\n  file_id?: string;\n  /** Azure asset ID. */\n  data_sources?: Array<VectorStoreDataSource>;\n  /** The tools to add to this file. */\n  tools: MessageAttachmentToolDefinition[];\n}\n\n/** The details used to update an existing agent thread */\nexport interface UpdateAgentThreadOptions {\n  /**\n   * A set of resources that are made available to the agent's tools in this thread. The resources are specific to the\n   * type of tool. For example, the `code_interpreter` tool requires a list of file IDs, while the `file_search` tool requires\n   * a list of vector store IDs\n   */\n  tool_resources?: ToolResources | null;\n  /** A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format. Keys may be up to 64 characters in length and values may be up to 512 characters in length. */\n  metadata?: Record<string, string> | null;\n}\n\n/** A single, existing message within an agent thread. */\nexport interface ThreadMessage {\n  /** The identifier, which can be referenced in API endpoints. */\n  id: string;\n  /** The object type, which is always 'thread.message'. */\n  object: \"thread.message\";\n  /** The Unix timestamp, in seconds, representing when this object was created. */\n  created_at: number;\n  /** The ID of the thread that this message belongs to. */\n  thread_id: string;\n  /**\n   * The status of the message.\n   *\n   * Possible values: \"in_progress\", \"incomplete\", \"completed\"\n   */\n  status: MessageStatus;\n  /** On an incomplete message, details about why the message is incomplete. */\n  incomplete_details: MessageIncompleteDetails | null;\n  /** The Unix timestamp (in seconds) for when the message was completed. */\n  completed_at: number | null;\n  /** The Unix timestamp (in seconds) for when the message was marked as incomplete. */\n  incomplete_at: number | null;\n  /**\n   * The role associated with the agent thread message.\n   *\n   * Possible values: \"user\", \"assistant\"\n   */\n  role: MessageRole;\n  /** The list of content items associated with the agent thread message. */\n  content: Array<MessageContent>;\n  /** If applicable, the ID of the agent that authored this message. */\n  assistant_id: string | null;\n  /** If applicable, the ID of the run associated with the authoring of this message. */\n  run_id: string | null;\n  /** A list of files attached to the message, and the tools they were added to. */\n  attachments: Array<MessageAttachment> | null;\n  /** A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format. Keys may be up to 64 characters in length and values may be up to 512 characters in length. */\n  metadata: Record<string, string> | null;\n}\n\n/** Information providing additional detail about a message entering an incomplete status. */\nexport interface MessageIncompleteDetails {\n  /**\n   * The provided reason describing why the message was marked as incomplete.\n   *\n   * Possible values: \"content_filter\", \"max_tokens\", \"run_cancelled\", \"run_failed\", \"run_expired\"\n   */\n  reason: MessageIncompleteDetailsReason;\n}\n\n/** An abstract representation of a single item of thread message content. */\nexport interface MessageContentParent {\n  type: string;\n}\n\n/** A representation of a textual item of thread message content. */\nexport interface MessageTextContent extends MessageContentParent {\n  /** The object type, which is always 'text'. */\n  type: \"text\";\n  /** The text and associated annotations for this thread message content item. */\n  text: MessageTextDetails;\n}\n\n/** The text and associated annotations for a single item of agent thread message content. */\nexport interface MessageTextDetails {\n  /** The text data. */\n  value: string;\n  /** A list of annotations associated with this text. */\n  annotations: Array<MessageTextAnnotation>;\n}\n\n/** An abstract representation of an annotation to text thread message content. */\nexport interface MessageTextAnnotationParent {\n  /** The textual content associated with this text annotation item. */\n  text: string;\n  type: string;\n}\n\n/** A citation within the message that points to a specific quote from a specific File associated with the agent or the message. Generated when the agent uses the 'file_search' tool to search files. */\nexport interface MessageTextFileCitationAnnotation\n  extends MessageTextAnnotationParent {\n  /** The object type, which is always 'file_citation'. */\n  type: \"file_citation\";\n  /**\n   * A citation within the message that points to a specific quote from a specific file.\n   * Generated when the agent uses the \"file_search\" tool to search files.\n   */\n  file_citation: MessageTextFileCitationDetails;\n  /** The first text index associated with this text annotation. */\n  start_index?: number;\n  /** The last text index associated with this text annotation. */\n  end_index?: number;\n}\n\n/** A representation of a file-based text citation, as used in a file-based annotation of text thread message content. */\nexport interface MessageTextFileCitationDetails {\n  /** The ID of the file associated with this citation. */\n  file_id: string;\n  /** The specific quote cited in the associated file. */\n  quote: string;\n}\n\n/** A citation within the message that points to a file located at a specific path. */\nexport interface MessageTextFilePathAnnotation\n  extends MessageTextAnnotationParent {\n  /** The object type, which is always 'file_path'. */\n  type: \"file_path\";\n  /** A URL for the file that's generated when the agent used the code_interpreter tool to generate a file. */\n  file_path: MessageTextFilePathDetails;\n  /** The first text index associated with this text annotation. */\n  start_index?: number;\n  /** The last text index associated with this text annotation. */\n  end_index?: number;\n}\n\n/** An encapsulation of an image file ID, as used by message image content. */\nexport interface MessageTextFilePathDetails {\n  /** The ID of the specific file that the citation is from. */\n  file_id: string;\n}\n\n/** A representation of image file content in a thread message. */\nexport interface MessageImageFileContent extends MessageContentParent {\n  /** The object type, which is always 'image_file'. */\n  type: \"image_file\";\n  /** The image file for this thread message content item. */\n  image_file: MessageImageFileDetails;\n}\n\n/** An image reference, as represented in thread message content. */\nexport interface MessageImageFileDetails {\n  /** The ID for the file associated with this image. */\n  file_id: string;\n}\n\n/** The details used when creating a new run of an agent thread. */\nexport interface CreateRunOptions {\n  /** The ID of the agent that should run the thread. */\n  assistant_id: string;\n  /** The overridden model name that the agent should use to run the thread. */\n  model?: string | null;\n  /** The overridden system instructions that the agent should use to run the thread. */\n  instructions?: string | null;\n  /**\n   * Additional instructions to append at the end of the instructions for the run. This is useful for modifying the behavior\n   * on a per-run basis without overriding other instructions.\n   */\n  additional_instructions?: string | null;\n  /** Adds additional messages to the thread before creating the run. */\n  additional_messages?: Array<ThreadMessage> | null;\n  /** The overridden list of enabled tools that the agent should use to run the thread. */\n  tools?: Array<ToolDefinition> | null;\n  /**\n   * If `true`, returns a stream of events that happen during the Run as server-sent events,\n   * terminating when the Run enters a terminal state with a `data: [DONE]` message.\n   */\n  stream?: boolean;\n  /**\n   * What sampling temperature to use, between 0 and 2. Higher values like 0.8 will make the output\n   * more random, while lower values like 0.2 will make it more focused and deterministic.\n   */\n  temperature?: number | null;\n  /**\n   * An alternative to sampling with temperature, called nucleus sampling, where the model\n   * considers the results of the tokens with top_p probability mass. So 0.1 means only the tokens\n   * comprising the top 10% probability mass are considered.\n   *\n   * We generally recommend altering this or temperature but not both.\n   */\n  top_p?: number | null;\n  /**\n   * The maximum number of prompt tokens that may be used over the course of the run. The run will make a best effort to use only\n   * the number of prompt tokens specified, across multiple turns of the run. If the run exceeds the number of prompt tokens specified,\n   * the run will end with status `incomplete`. See `incomplete_details` for more info.\n   */\n  max_prompt_tokens?: number | null;\n  /**\n   * The maximum number of completion tokens that may be used over the course of the run. The run will make a best effort\n   * to use only the number of completion tokens specified, across multiple turns of the run. If the run exceeds the number of\n   * completion tokens specified, the run will end with status `incomplete`. See `incomplete_details` for more info.\n   */\n  max_completion_tokens?: number | null;\n  /** The strategy to use for dropping messages as the context windows moves forward. */\n  truncation_strategy?: TruncationObject | null;\n  /** Controls whether or not and which tool is called by the model. */\n  tool_choice?: AgentsApiToolChoiceOption | null;\n  /** Specifies the format that the model must output. */\n  response_format?: AgentsApiResponseFormatOption | null;\n  /** A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format. Keys may be up to 64 characters in length and values may be up to 512 characters in length. */\n  metadata?: Record<string, string> | null;\n}\n\n/**\n * Controls for how a thread will be truncated prior to the run. Use this to control the initial\n * context window of the run.\n */\nexport interface TruncationObject {\n  /**\n   * The truncation strategy to use for the thread. The default is `auto`. If set to `last_messages`, the thread will\n   * be truncated to the `lastMessages` count most recent messages in the thread. When set to `auto`, messages in the middle of the thread\n   * will be dropped to fit the context length of the model, `max_prompt_tokens`.\n   *\n   * Possible values: \"auto\", \"last_messages\"\n   */\n  type: TruncationStrategy;\n  /** The number of most recent messages from the thread when constructing the context for the run. */\n  last_messages?: number | null;\n}\n\n/** Specifies a tool the model should use. Use to force the model to call a specific tool. */\nexport interface AgentsNamedToolChoice {\n  /**\n   * the type of tool. If type is `function`, the function name must be set.\n   *\n   * Possible values: \"function\", \"code_interpreter\", \"file_search\", \"bing_grounding\", \"microsoft_fabric\", \"sharepoint_grounding\", \"azure_ai_search\"\n   */\n  type: AgentsNamedToolChoiceType;\n  /** The name of the function to call */\n  function?: FunctionName;\n}\n\n/** The function name that will be used, if using the `function` tool */\nexport interface FunctionName {\n  /** The name of the function to call */\n  name: string;\n}\n\n/**\n * Request object. A set of resources that are used by the agent's tools. The resources are specific to the type of tool.\n * For example, the `code_interpreter` tool requires a list of file IDs, while the `file_search` tool requires a list of\n * vector store IDs.\n */\nexport interface UpdateToolResourcesOptions {\n  /**\n   * Overrides the list of file IDs made available to the `code_interpreter` tool. There can be a maximum of 20 files\n   * associated with the tool.\n   */\n  code_interpreter?: UpdateCodeInterpreterToolResourceOptions;\n  /** Overrides the vector store attached to this agent. There can be a maximum of 1 vector store attached to the agent. */\n  file_search?: UpdateFileSearchToolResourceOptions;\n  /** Overrides the resources to be used by the `azure_ai_search` tool consisting of index IDs and names. */\n  azure_ai_search?: AzureAISearchResource;\n}\n\n/** Request object to update `code_interpreted` tool resources. */\nexport interface UpdateCodeInterpreterToolResourceOptions {\n  /** A list of file IDs to override the current list of the agent. */\n  file_ids?: string[];\n}\n\n/** Request object to update `file_search` tool resources. */\nexport interface UpdateFileSearchToolResourceOptions {\n  /** A list of vector store IDs to override the current list of the agent. */\n  vector_store_ids?: string[];\n}\n\n/** The data provided during a tool outputs submission to resolve pending tool calls and allow the model to continue. */\nexport interface ToolOutput {\n  /** The ID of the tool call being resolved, as provided in the tool calls of a required action from a run. */\n  tool_call_id?: string;\n  /** The output from the tool to be submitted. */\n  output?: string;\n}\n\n/** The details used when creating and immediately running a new agent thread. */\nexport interface CreateAndRunThreadOptions {\n  /** The ID of the agent for which the thread should be created. */\n  assistant_id: string;\n  /** The details used to create the new thread. If no thread is provided, an empty one will be created. */\n  thread?: AgentThreadCreationOptions;\n  /** The overridden model that the agent should use to run the thread. */\n  model?: string | null;\n  /** The overridden system instructions the agent should use to run the thread. */\n  instructions?: string | null;\n  /** The overridden list of enabled tools the agent should use to run the thread. */\n  tools?: Array<ToolDefinition> | null;\n  /** Override the tools the agent can use for this run. This is useful for modifying the behavior on a per-run basis */\n  tool_resources?: UpdateToolResourcesOptions | null;\n  /**\n   * If `true`, returns a stream of events that happen during the Run as server-sent events,\n   * terminating when the Run enters a terminal state with a `data: [DONE]` message.\n   */\n  stream?: boolean;\n  /**\n   * What sampling temperature to use, between 0 and 2. Higher values like 0.8 will make the output\n   * more random, while lower values like 0.2 will make it more focused and deterministic.\n   */\n  temperature?: number | null;\n  /**\n   * An alternative to sampling with temperature, called nucleus sampling, where the model\n   * considers the results of the tokens with top_p probability mass. So 0.1 means only the tokens\n   * comprising the top 10% probability mass are considered.\n   *\n   * We generally recommend altering this or temperature but not both.\n   */\n  top_p?: number | null;\n  /**\n   * The maximum number of prompt tokens that may be used over the course of the run. The run will make a best effort to use only\n   * the number of prompt tokens specified, across multiple turns of the run. If the run exceeds the number of prompt tokens specified,\n   * the run will end with status `incomplete`. See `incomplete_details` for more info.\n   */\n  max_prompt_tokens?: number | null;\n  /**\n   * The maximum number of completion tokens that may be used over the course of the run. The run will make a best effort to use only\n   * the number of completion tokens specified, across multiple turns of the run. If the run exceeds the number of completion tokens\n   * specified, the run will end with status `incomplete`. See `incomplete_details` for more info.\n   */\n  max_completion_tokens?: number | null;\n  /** The strategy to use for dropping messages as the context windows moves forward. */\n  truncation_strategy?: TruncationObject | null;\n  /** Controls whether or not and which tool is called by the model. */\n  tool_choice?: AgentsApiToolChoiceOption | null;\n  /** Specifies the format that the model must output. */\n  response_format?: AgentsApiResponseFormatOption | null;\n  /** A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format. Keys may be up to 64 characters in length and values may be up to 512 characters in length. */\n  metadata?: Record<string, string> | null;\n}\n\n/** The expiration policy for a vector store. */\nexport interface VectorStoreExpirationPolicy {\n  /**\n   * Anchor timestamp after which the expiration policy applies. Supported anchors: `last_active_at`.\n   *\n   * Possible values: \"last_active_at\"\n   */\n  anchor: VectorStoreExpirationPolicyAnchor;\n  /** The anchor timestamp after which the expiration policy applies. */\n  days: number;\n}\n\n/** Request object for creating a vector store. */\nexport interface VectorStoreOptions {\n  /** A list of file IDs that the vector store should use. Useful for tools like `file_search` that can access files. */\n  file_ids?: string[];\n  /** The name of the vector store. */\n  name?: string;\n  /** The vector store configuration, used when vector store is created from Azure asset URIs. */\n  configuration?: VectorStoreConfiguration;\n  /** Details on when this vector store expires */\n  expires_after?: VectorStoreExpirationPolicy;\n  /** The chunking strategy used to chunk the file(s). If not set, will use the auto strategy. Only applicable if file_ids is non-empty. */\n  chunking_strategy?: VectorStoreChunkingStrategyRequest;\n  /** A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format. Keys may be up to 64 characters in length and values may be up to 512 characters in length. */\n  metadata?: Record<string, string> | null;\n}\n\n/** An abstract representation of a vector store chunking strategy configuration. */\nexport interface VectorStoreChunkingStrategyRequestParent {\n  type: VectorStoreChunkingStrategyRequestType;\n}\n\n/** The default strategy. This strategy currently uses a max_chunk_size_tokens of 800 and chunk_overlap_tokens of 400. */\nexport interface VectorStoreAutoChunkingStrategyRequest\n  extends VectorStoreChunkingStrategyRequestParent {\n  /** The object type, which is always 'auto'. */\n  type: \"auto\";\n}\n\n/** A statically configured chunking strategy. */\nexport interface VectorStoreStaticChunkingStrategyRequest\n  extends VectorStoreChunkingStrategyRequestParent {\n  /** The object type, which is always 'static'. */\n  type: \"static\";\n  /** The options for the static chunking strategy. */\n  static: VectorStoreStaticChunkingStrategyOptions;\n}\n\n/** Options to configure a vector store static chunking strategy. */\nexport interface VectorStoreStaticChunkingStrategyOptions {\n  /** The maximum number of tokens in each chunk. The default value is 800. The minimum value is 100 and the maximum value is 4096. */\n  max_chunk_size_tokens: number;\n  /**\n   * The number of tokens that overlap between chunks. The default value is 400.\n   * Note that the overlap must not exceed half of max_chunk_size_tokens.\n   */\n  chunk_overlap_tokens: number;\n}\n\n/** Request object for updating a vector store. */\nexport interface VectorStoreUpdateOptions {\n  /** The name of the vector store. */\n  name?: string | null;\n  /** Details on when this vector store expires */\n  expires_after?: VectorStoreExpirationPolicy | null;\n  /** A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format. Keys may be up to 64 characters in length and values may be up to 512 characters in length. */\n  metadata?: Record<string, string> | null;\n}\n\n/** Evaluation Definition */\nexport interface Evaluation {\n  /** Data for evaluation. */\n  data: InputData;\n  /** Display Name for evaluation. It helps to find evaluation easily in AI Studio. It does not need to be unique. */\n  displayName?: string;\n  /** Description of the evaluation. It can be used to store additional information about the evaluation and is mutable. */\n  description?: string;\n  /** Evaluation's tags. Unlike properties, tags are fully mutable. */\n  tags?: Record<string, string>;\n  /** Evaluation's properties. Unlike tags, properties are add-only. Once added, a property cannot be removed. */\n  properties?: Record<string, string>;\n  /** Evaluators to be used for the evaluation. */\n  evaluators: Record<string, EvaluatorConfiguration>;\n}\n\n/** Abstract data class for input data configuration. */\nexport interface InputDataParent {\n  type: string;\n}\n\n/** Data Source for Application Insights. */\nexport interface ApplicationInsightsConfiguration extends InputDataParent {\n  /** LogAnalytic Workspace resourceID associated with ApplicationInsights */\n  resourceId: string;\n  /** Query to fetch the data. */\n  query: string;\n  /** Service name. */\n  serviceName: string;\n  /** Connection String to connect to ApplicationInsights. */\n  connectionString?: string;\n}\n\n/** Dataset as source for evaluation. */\nexport interface Dataset extends InputDataParent {\n  /** Evaluation input data */\n  id: string;\n}\n\n/** Metadata pertaining to creation and last modification of the resource. */\nexport interface SystemData {}\n\n/** Evaluator Configuration */\nexport interface EvaluatorConfiguration {\n  /** Identifier of the evaluator. */\n  id: string;\n  /** Initialization parameters of the evaluator. */\n  initParams?: Record<string, unknown>;\n  /** Data parameters of the evaluator. */\n  dataMapping?: Record<string, string>;\n}\n\n/** Evaluation Schedule Definition */\nexport interface EvaluationSchedule {\n  /** Data for evaluation. */\n  data: ApplicationInsightsConfiguration;\n  /** Description of the evaluation. It can be used to store additional information about the evaluation and is mutable. */\n  description?: string;\n  /** Evaluation's tags. Unlike properties, tags are fully mutable. */\n  tags?: Record<string, string>;\n  /** Evaluation's properties. Unlike tags, properties are add-only. Once added, a property cannot be removed. */\n  properties?: Record<string, string>;\n  /** Evaluators to be used for the evaluation. */\n  evaluators: Record<string, EvaluatorConfiguration>;\n  /** Trigger for the evaluation. */\n  trigger: Trigger;\n}\n\n/** Abstract data class for input data configuration. */\nexport interface TriggerParent {\n  type: string;\n}\n\n/** Recurrence Trigger Definition */\nexport interface RecurrenceTrigger extends TriggerParent {\n  /**\n   * The frequency to trigger schedule.\n   *\n   * Possible values: \"Month\", \"Week\", \"Day\", \"Hour\", \"Minute\"\n   */\n  frequency: Frequency;\n  /** Specifies schedule interval in conjunction with frequency */\n  interval: number;\n  /** The recurrence schedule. */\n  schedule?: RecurrenceSchedule;\n}\n\n/** RecurrenceSchedule Definition */\nexport interface RecurrenceSchedule {\n  /** List of hours for the schedule. */\n  hours: number[];\n  /** List of minutes for the schedule. */\n  minutes: number[];\n  /** List of days for the schedule. */\n  weekDays?: WeekDays[];\n  /** List of month days for the schedule */\n  monthDays?: number[];\n}\n\n/** Cron Trigger Definition */\nexport interface CronTrigger extends TriggerParent {\n  /** Cron expression for the trigger. */\n  expression: string;\n}\n\n/** An abstract representation of an input tool definition that an agent can use. */\nexport type ToolDefinition =\n  | ToolDefinitionParent\n  | CodeInterpreterToolDefinition\n  | FileSearchToolDefinition\n  | FunctionToolDefinition\n  | BingGroundingToolDefinition\n  | MicrosoftFabricToolDefinition\n  | SharepointToolDefinition\n  | AzureAISearchToolDefinition;\n/** An abstract representation of a single item of thread message content. */\nexport type MessageContent =\n  | MessageContentParent\n  | MessageTextContent\n  | MessageImageFileContent;\n/** An abstract representation of an annotation to text thread message content. */\nexport type MessageTextAnnotation =\n  | MessageTextAnnotationParent\n  | MessageTextFileCitationAnnotation\n  | MessageTextFilePathAnnotation;\n/** An abstract representation of a vector store chunking strategy configuration. */\nexport type VectorStoreChunkingStrategyRequest =\n  | VectorStoreChunkingStrategyRequestParent\n  | VectorStoreAutoChunkingStrategyRequest\n  | VectorStoreStaticChunkingStrategyRequest;\n/** Abstract data class for input data configuration. */\nexport type InputData =\n  | InputDataParent\n  | ApplicationInsightsConfiguration\n  | Dataset;\n/** Abstract data class for input data configuration. */\nexport type Trigger = TriggerParent | RecurrenceTrigger | CronTrigger;\n/** Alias for VectorStoreDataSourceAssetType */\nexport type VectorStoreDataSourceAssetType = \"uri_asset\" | \"id_asset\";\n/** Alias for AgentsApiResponseFormatMode */\nexport type AgentsApiResponseFormatMode = string;\n/** Alias for ApiResponseFormat */\nexport type ApiResponseFormat = string;\n/** Alias for AgentsApiResponseFormatOption */\nexport type AgentsApiResponseFormatOption =\n  | string\n  | AgentsApiResponseFormatMode\n  | AgentsApiResponseFormat;\n/** Alias for ListSortOrder */\nexport type ListSortOrder = \"asc\" | \"desc\";\n/** Alias for MessageRole */\nexport type MessageRole = string;\n/** Alias for MessageAttachmentToolDefinition */\nexport type MessageAttachmentToolDefinition =\n  | CodeInterpreterToolDefinition\n  | FileSearchToolDefinition;\n/** Alias for MessageStatus */\nexport type MessageStatus = string;\n/** Alias for MessageIncompleteDetailsReason */\nexport type MessageIncompleteDetailsReason = string;\n/** Alias for TruncationStrategy */\nexport type TruncationStrategy = string;\n/** Alias for AgentsApiToolChoiceOptionMode */\nexport type AgentsApiToolChoiceOptionMode = string;\n/** Alias for AgentsNamedToolChoiceType */\nexport type AgentsNamedToolChoiceType = string;\n/** Alias for AgentsApiToolChoiceOption */\nexport type AgentsApiToolChoiceOption =\n  | string\n  | AgentsApiToolChoiceOptionMode\n  | AgentsNamedToolChoice;\n/** Alias for FilePurpose */\nexport type FilePurpose = string;\n/** Alias for VectorStoreExpirationPolicyAnchor */\nexport type VectorStoreExpirationPolicyAnchor = string;\n/** Alias for VectorStoreChunkingStrategyRequestType */\nexport type VectorStoreChunkingStrategyRequestType = string;\n/** Alias for VectorStoreFileStatusFilter */\nexport type VectorStoreFileStatusFilter = string;\n/** The Type (or category) of the connection */\nexport type ConnectionType =\n  | \"AzureOpenAI\"\n  | \"Serverless\"\n  | \"AzureBlob\"\n  | \"AIServices\"\n  | \"CognitiveSearch\";\n/** Alias for Frequency */\nexport type Frequency = string;\n/** Alias for WeekDays */\nexport type WeekDays = string;\n"]}
+{"version":3,"file":"models.js","sourceRoot":"","sources":["../../../../src/generated/src/models.ts"],"names":[],"mappings":";AAAA,uCAAuC;AACvC,kCAAkC","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT License.\n\n/** The request details to use when creating a new agent. */\nexport interface CreateAgentOptions {\n  /** The ID of the model to use. */\n  model: string;\n  /** The name of the new agent. */\n  name?: string | null;\n  /** The description of the new agent. */\n  description?: string | null;\n  /** The system instructions for the new agent to use. */\n  instructions?: string | null;\n  /** The collection of tools to enable for the new agent. */\n  tools?: Array<ToolDefinition>;\n  /**\n   * A set of resources that are used by the agent's tools. The resources are specific to the type of tool. For example, the `code_interpreter`\n   * tool requires a list of file IDs, while the `file_search` tool requires a list of vector store IDs.\n   */\n  tool_resources?: ToolResources | null;\n  /**\n   * What sampling temperature to use, between 0 and 2. Higher values like 0.8 will make the output more random,\n   * while lower values like 0.2 will make it more focused and deterministic.\n   */\n  temperature?: number | null;\n  /**\n   * An alternative to sampling with temperature, called nucleus sampling, where the model considers the results of the tokens with top_p probability mass.\n   * So 0.1 means only the tokens comprising the top 10% probability mass are considered.\n   *\n   * We generally recommend altering this or temperature but not both.\n   */\n  top_p?: number | null;\n  /** The response format of the tool calls used by this agent. */\n  response_format?: AgentsApiResponseFormatOption | null;\n  /** A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format. Keys may be up to 64 characters in length and values may be up to 512 characters in length. */\n  metadata?: Record<string, string> | null;\n}\n\n/** An abstract representation of an input tool definition that an agent can use. */\nexport interface ToolDefinitionParent {\n  type: string;\n}\n\n/** The input definition information for a code interpreter tool as used to configure an agent. */\nexport interface CodeInterpreterToolDefinition extends ToolDefinitionParent {\n  /** The object type, which is always 'code_interpreter'. */\n  type: \"code_interpreter\";\n}\n\n/** The input definition information for a file search tool as used to configure an agent. */\nexport interface FileSearchToolDefinition extends ToolDefinitionParent {\n  /** The object type, which is always 'file_search'. */\n  type: \"file_search\";\n  /** Options overrides for the file search tool. */\n  file_search?: FileSearchToolDefinitionDetails;\n}\n\n/** Options overrides for the file search tool. */\nexport interface FileSearchToolDefinitionDetails {\n  /**\n   * The maximum number of results the file search tool should output. The default is 20 for gpt-4* models and 5 for gpt-3.5-turbo. This number should be between 1 and 50 inclusive.\n   *\n   * Note that the file search tool may output fewer than `max_num_results` results. See the file search tool documentation for more information.\n   */\n  max_num_results?: number;\n  /** Ranking options for file search. */\n  ranking_options?: FileSearchRankingOptions;\n}\n\n/** Ranking options for file search. */\nexport interface FileSearchRankingOptions {\n  /** File search ranker. */\n  ranker: string;\n  /** Ranker search threshold. */\n  score_threshold: number;\n}\n\n/** The input definition information for a function tool as used to configure an agent. */\nexport interface FunctionToolDefinition extends ToolDefinitionParent {\n  /** The object type, which is always 'function'. */\n  type: \"function\";\n  /** The definition of the concrete function that the function tool should call. */\n  function: FunctionDefinition;\n}\n\n/** The input definition information for a function. */\nexport interface FunctionDefinition {\n  /** The name of the function to be called. */\n  name: string;\n  /** A description of what the function does, used by the model to choose when and how to call the function. */\n  description?: string;\n  /** The parameters the functions accepts, described as a JSON Schema object. */\n  parameters: unknown;\n}\n\n/** The input definition information for a bing grounding search tool as used to configure an agent. */\nexport interface BingGroundingToolDefinition extends ToolDefinitionParent {\n  /** The object type, which is always 'bing_grounding'. */\n  type: \"bing_grounding\";\n  /** The list of connections used by the bing grounding tool. */\n  bing_grounding: ToolConnectionList;\n}\n\n/** A set of connection resources currently used by either the `bing_grounding`, `fabric_aiskill`, or `sharepoint_grounding` tools. */\nexport interface ToolConnectionList {\n  /**\n   * The connections attached to this tool. There can be a maximum of 1 connection\n   * resource attached to the tool.\n   */\n  connections?: Array<ToolConnection>;\n}\n\n/** A connection resource. */\nexport interface ToolConnection {\n  /** A connection in a ToolConnectionList attached to this tool. */\n  connection_id: string;\n}\n\n/** The input definition information for a Microsoft Fabric tool as used to configure an agent. */\nexport interface MicrosoftFabricToolDefinition extends ToolDefinitionParent {\n  /** The object type, which is always 'fabric_aiskill'. */\n  type: \"fabric_aiskill\";\n  /** The list of connections used by the Microsoft Fabric tool. */\n  fabric_aiskill: ToolConnectionList;\n}\n\n/** The input definition information for a sharepoint tool as used to configure an agent. */\nexport interface SharepointToolDefinition extends ToolDefinitionParent {\n  /** The object type, which is always 'sharepoint_grounding'. */\n  type: \"sharepoint_grounding\";\n  /** The list of connections used by the SharePoint tool. */\n  sharepoint_grounding: ToolConnectionList;\n}\n\n/** The input definition information for an Azure AI search tool as used to configure an agent. */\nexport interface AzureAISearchToolDefinition extends ToolDefinitionParent {\n  /** The object type, which is always 'azure_ai_search'. */\n  type: \"azure_ai_search\";\n}\n\n/** The input definition information for an OpenAPI tool as used to configure an agent. */\nexport interface OpenApiToolDefinition extends ToolDefinitionParent {\n  /** The object type, which is always 'openapi'. */\n  type: \"openapi\";\n  /** The openapi function definition. */\n  openapi: OpenApiFunctionDefinition;\n}\n\n/** The input definition information for an openapi function. */\nexport interface OpenApiFunctionDefinition {\n  /** The name of the function to be called. */\n  name: string;\n  /** A description of what the function does, used by the model to choose when and how to call the function. */\n  description?: string;\n  /** The openapi function shape, described as a JSON Schema object. */\n  spec: unknown;\n  /** Open API authentication details */\n  auth: OpenApiAuthDetails;\n}\n\n/** authentication details for OpenApiFunctionDefinition */\nexport interface OpenApiAuthDetailsParent {\n  type: OpenApiAuthType;\n}\n\n/** Security details for OpenApi anonymous authentication */\nexport interface OpenApiAnonymousAuthDetails extends OpenApiAuthDetailsParent {\n  /** The object type, which is always 'anonymous'. */\n  type: \"anonymous\";\n}\n\n/** Security details for OpenApi connection authentication */\nexport interface OpenApiConnectionAuthDetails extends OpenApiAuthDetailsParent {\n  /** The object type, which is always 'connection'. */\n  type: \"connection\";\n  /** Connection auth security details */\n  security_scheme: OpenApiConnectionSecurityScheme;\n}\n\n/** Security scheme for OpenApi managed_identity authentication */\nexport interface OpenApiConnectionSecurityScheme {\n  /** Connection id for Connection auth type */\n  connection_id: string;\n}\n\n/** Security details for OpenApi managed_identity authentication */\nexport interface OpenApiManagedAuthDetails extends OpenApiAuthDetailsParent {\n  /** The object type, which is always 'managed_identity'. */\n  type: \"managed_identity\";\n  /** Connection auth security details */\n  security_scheme: OpenApiManagedSecurityScheme;\n}\n\n/** Security scheme for OpenApi managed_identity authentication */\nexport interface OpenApiManagedSecurityScheme {\n  /** Authentication scope for managed_identity auth type */\n  audience: string;\n}\n\n/** The input definition information for a azure function tool as used to configure an agent. */\nexport interface AzureFunctionToolDefinition extends ToolDefinitionParent {\n  /** The object type, which is always 'azure_function'. */\n  type: \"azure_function\";\n  /** The definition of the concrete function that the function tool should call. */\n  azure_function: AzureFunctionDefinition;\n}\n\n/** The definition of Azure function. */\nexport interface AzureFunctionDefinition {\n  /** The definition of azure function and its parameters. */\n  function: FunctionDefinition;\n  /** Input storage queue. The queue storage trigger runs a function as messages are added to it. */\n  input_binding: AzureFunctionBinding;\n  /** Output storage queue. The function writes output to this queue when the input items are processed. */\n  output_binding: AzureFunctionBinding;\n}\n\n/** The structure for keeping storage queue name and URI. */\nexport interface AzureFunctionBinding {\n  /** The type of binding, which is always 'storage_queue'. */\n  type: \"storage_queue\";\n  /** Storage queue. */\n  storage_queue: AzureFunctionStorageQueue;\n}\n\n/** The structure for keeping storage queue name and URI. */\nexport interface AzureFunctionStorageQueue {\n  /** URI to the Azure Storage Queue service allowing you to manipulate a queue. */\n  queue_service_endpoint: string;\n  /** The name of an Azure function storage queue. */\n  queue_name: string;\n}\n\n/**\n * A set of resources that are used by the agent's tools. The resources are specific to the type of\n * tool. For example, the `code_interpreter` tool requires a list of file IDs, while the `file_search`\n * tool requires a list of vector store IDs.\n */\nexport interface ToolResources {\n  /** Resources to be used by the `code_interpreter` tool consisting of file IDs. */\n  code_interpreter?: CodeInterpreterToolResource;\n  /** Resources to be used by the `file_search` tool consisting of vector store IDs. */\n  file_search?: FileSearchToolResource;\n  /** Resources to be used by the `azure_ai_search` tool consisting of index IDs and names. */\n  azure_ai_search?: AzureAISearchResource;\n}\n\n/** A set of resources that are used by the `code_interpreter` tool. */\nexport interface CodeInterpreterToolResource {\n  /**\n   * A list of file IDs made available to the `code_interpreter` tool. There can be a maximum of 20 files\n   * associated with the tool.\n   */\n  file_ids?: string[];\n  /** The data sources to be used. This option is mutually exclusive with the `fileIds` property. */\n  data_sources?: Array<VectorStoreDataSource>;\n}\n\n/**\n * The structure, containing Azure asset URI path and the asset type of the file used as a data source\n * for the enterprise file search.\n */\nexport interface VectorStoreDataSource {\n  /** Asset URI. */\n  uri: string;\n  /**\n   * The asset type\n   *\n   * Possible values: \"uri_asset\", \"id_asset\"\n   */\n  type: VectorStoreDataSourceAssetType;\n}\n\n/** A set of resources that are used by the `file_search` tool. */\nexport interface FileSearchToolResource {\n  /**\n   * The ID of the vector store attached to this agent. There can be a maximum of 1 vector\n   * store attached to the agent.\n   */\n  vector_store_ids?: string[];\n  /**\n   * The list of vector store configuration objects from Azure.\n   * This list is limited to one element.\n   * The only element of this list contains the list of azure asset IDs used by the search tool.\n   */\n  vector_stores?: Array<VectorStoreConfigurations>;\n}\n\n/** The structure, containing the list of vector storage configurations i.e. the list of azure asset IDs. */\nexport interface VectorStoreConfigurations {\n  /** Name */\n  name: string;\n  /** Configurations */\n  configuration: VectorStoreConfiguration;\n}\n\n/**\n * Vector storage configuration is the list of data sources, used when multiple\n * files can be used for the enterprise file search.\n */\nexport interface VectorStoreConfiguration {\n  /** Data sources */\n  data_sources: Array<VectorStoreDataSource>;\n}\n\n/** A set of index resources used by the `azure_ai_search` tool. */\nexport interface AzureAISearchResource {\n  /**\n   * The indices attached to this agent. There can be a maximum of 1 index\n   * resource attached to the agent.\n   */\n  indexes?: Array<IndexResource>;\n}\n\n/** A Index resource. */\nexport interface IndexResource {\n  /** An index connection id in an IndexResource attached to this agent. */\n  index_connection_id: string;\n  /** The name of an index in an IndexResource attached to this agent. */\n  index_name: string;\n}\n\n/**\n * An object describing the expected output of the model. If `json_object` only `function` type `tools` are allowed to be passed to the Run.\n * If `text` the model can return text or any value needed.\n */\nexport interface AgentsApiResponseFormat {\n  /**\n   * Must be one of `text` or `json_object`.\n   *\n   * Possible values: \"text\", \"json_object\"\n   */\n  type?: ResponseFormat;\n}\n\n/** The type of response format being defined: `json_schema` */\nexport interface ResponseFormatJsonSchemaType {\n  /** Type */\n  type: \"json_schema\";\n  /** The JSON schema, describing response format. */\n  json_schema: ResponseFormatJsonSchema;\n}\n\n/** A description of what the response format is for, used by the model to determine how to respond in the format. */\nexport interface ResponseFormatJsonSchema {\n  /** A description of what the response format is for, used by the model to determine how to respond in the format. */\n  description?: string;\n  /** The name of a schema. */\n  name: string;\n  /** The JSON schema object, describing the response format. */\n  schema: unknown;\n}\n\n/** The request details to use when modifying an existing agent. */\nexport interface UpdateAgentOptions {\n  /** The ID of the model to use. */\n  model?: string;\n  /** The modified name for the agent to use. */\n  name?: string | null;\n  /** The modified description for the agent to use. */\n  description?: string | null;\n  /** The modified system instructions for the new agent to use. */\n  instructions?: string | null;\n  /** The modified collection of tools to enable for the agent. */\n  tools?: Array<ToolDefinition>;\n  /**\n   * A set of resources that are used by the agent's tools. The resources are specific to the type of tool. For example,\n   * the `code_interpreter` tool requires a list of file IDs, while the `file_search` tool requires a list of vector store IDs.\n   */\n  tool_resources?: ToolResources;\n  /**\n   * What sampling temperature to use, between 0 and 2. Higher values like 0.8 will make the output more random,\n   * while lower values like 0.2 will make it more focused and deterministic.\n   */\n  temperature?: number | null;\n  /**\n   * An alternative to sampling with temperature, called nucleus sampling, where the model considers the results of the tokens with top_p probability mass.\n   * So 0.1 means only the tokens comprising the top 10% probability mass are considered.\n   *\n   * We generally recommend altering this or temperature but not both.\n   */\n  top_p?: number | null;\n  /** The response format of the tool calls used by this agent. */\n  response_format?: AgentsApiResponseFormatOption | null;\n  /** A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format. Keys may be up to 64 characters in length and values may be up to 512 characters in length. */\n  metadata?: Record<string, string> | null;\n}\n\n/** The details used to create a new agent thread. */\nexport interface AgentThreadCreationOptions {\n  /** The initial messages to associate with the new thread. */\n  messages?: Array<ThreadMessageOptions>;\n  /**\n   * A set of resources that are made available to the agent's tools in this thread. The resources are specific to the\n   * type of tool. For example, the `code_interpreter` tool requires a list of file IDs, while the `file_search` tool requires\n   * a list of vector store IDs.\n   */\n  tool_resources?: ToolResources | null;\n  /** A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format. Keys may be up to 64 characters in length and values may be up to 512 characters in length. */\n  metadata?: Record<string, string> | null;\n}\n\n/** A single message within an agent thread, as provided during that thread's creation for its initial state. */\nexport interface ThreadMessageOptions {\n  /**\n   * The role of the entity that is creating the message. Allowed values include:\n   * - `user`: Indicates the message is sent by an actual user and should be used in most\n   * cases to represent user-generated messages.\n   * - `assistant`: Indicates the message is generated by the agent. Use this value to insert\n   * messages from the agent into the\n   * conversation.\n   *\n   * Possible values: \"user\", \"assistant\"\n   */\n  role: MessageRole;\n  /**\n   * The textual content of the initial message. Currently, robust input including images and annotated text may only be provided via\n   * a separate call to the create message API.\n   */\n  content: string;\n  /** A list of files attached to the message, and the tools they should be added to. */\n  attachments?: Array<MessageAttachment> | null;\n  /** A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format. Keys may be up to 64 characters in length and values may be up to 512 characters in length. */\n  metadata?: Record<string, string> | null;\n}\n\n/** This describes to which tools a file has been attached. */\nexport interface MessageAttachment {\n  /** The ID of the file to attach to the message. */\n  file_id?: string;\n  /** Azure asset ID. */\n  data_source?: VectorStoreDataSource;\n  /** The tools to add to this file. */\n  tools: MessageAttachmentToolDefinition[];\n}\n\n/** The details used to update an existing agent thread */\nexport interface UpdateAgentThreadOptions {\n  /**\n   * A set of resources that are made available to the agent's tools in this thread. The resources are specific to the\n   * type of tool. For example, the `code_interpreter` tool requires a list of file IDs, while the `file_search` tool requires\n   * a list of vector store IDs\n   */\n  tool_resources?: ToolResources | null;\n  /** A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format. Keys may be up to 64 characters in length and values may be up to 512 characters in length. */\n  metadata?: Record<string, string> | null;\n}\n\n/** The details used when creating a new run of an agent thread. */\nexport interface CreateRunOptions {\n  /** The ID of the agent that should run the thread. */\n  assistant_id: string;\n  /** The overridden model name that the agent should use to run the thread. */\n  model?: string | null;\n  /** The overridden system instructions that the agent should use to run the thread. */\n  instructions?: string | null;\n  /**\n   * Additional instructions to append at the end of the instructions for the run. This is useful for modifying the behavior\n   * on a per-run basis without overriding other instructions.\n   */\n  additional_instructions?: string | null;\n  /** Adds additional messages to the thread before creating the run. */\n  additional_messages?: Array<ThreadMessageOptions> | null;\n  /** The overridden list of enabled tools that the agent should use to run the thread. */\n  tools?: Array<ToolDefinition> | null;\n  /**\n   * If `true`, returns a stream of events that happen during the Run as server-sent events,\n   * terminating when the Run enters a terminal state with a `data: [DONE]` message.\n   */\n  stream?: boolean;\n  /**\n   * What sampling temperature to use, between 0 and 2. Higher values like 0.8 will make the output\n   * more random, while lower values like 0.2 will make it more focused and deterministic.\n   */\n  temperature?: number | null;\n  /**\n   * An alternative to sampling with temperature, called nucleus sampling, where the model\n   * considers the results of the tokens with top_p probability mass. So 0.1 means only the tokens\n   * comprising the top 10% probability mass are considered.\n   *\n   * We generally recommend altering this or temperature but not both.\n   */\n  top_p?: number | null;\n  /**\n   * The maximum number of prompt tokens that may be used over the course of the run. The run will make a best effort to use only\n   * the number of prompt tokens specified, across multiple turns of the run. If the run exceeds the number of prompt tokens specified,\n   * the run will end with status `incomplete`. See `incomplete_details` for more info.\n   */\n  max_prompt_tokens?: number | null;\n  /**\n   * The maximum number of completion tokens that may be used over the course of the run. The run will make a best effort\n   * to use only the number of completion tokens specified, across multiple turns of the run. If the run exceeds the number of\n   * completion tokens specified, the run will end with status `incomplete`. See `incomplete_details` for more info.\n   */\n  max_completion_tokens?: number | null;\n  /** The strategy to use for dropping messages as the context windows moves forward. */\n  truncation_strategy?: TruncationObject | null;\n  /** Controls whether or not and which tool is called by the model. */\n  tool_choice?: AgentsApiToolChoiceOption | null;\n  /** Specifies the format that the model must output. */\n  response_format?: AgentsApiResponseFormatOption | null;\n  /** If `true` functions will run in parallel during tool use. */\n  parallel_tool_calls?: boolean;\n  /** A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format. Keys may be up to 64 characters in length and values may be up to 512 characters in length. */\n  metadata?: Record<string, string> | null;\n}\n\n/**\n * Controls for how a thread will be truncated prior to the run. Use this to control the initial\n * context window of the run.\n */\nexport interface TruncationObject {\n  /**\n   * The truncation strategy to use for the thread. The default is `auto`. If set to `last_messages`, the thread will\n   * be truncated to the `lastMessages` count most recent messages in the thread. When set to `auto`, messages in the middle of the thread\n   * will be dropped to fit the context length of the model, `max_prompt_tokens`.\n   *\n   * Possible values: \"auto\", \"last_messages\"\n   */\n  type: TruncationStrategy;\n  /** The number of most recent messages from the thread when constructing the context for the run. */\n  last_messages?: number | null;\n}\n\n/** Specifies a tool the model should use. Use to force the model to call a specific tool. */\nexport interface AgentsNamedToolChoice {\n  /**\n   * the type of tool. If type is `function`, the function name must be set.\n   *\n   * Possible values: \"function\", \"code_interpreter\", \"file_search\", \"bing_grounding\", \"fabric_aiskill\", \"sharepoint_grounding\", \"azure_ai_search\"\n   */\n  type: AgentsNamedToolChoiceType;\n  /** The name of the function to call */\n  function?: FunctionName;\n}\n\n/** The function name that will be used, if using the `function` tool */\nexport interface FunctionName {\n  /** The name of the function to call */\n  name: string;\n}\n\n/**\n * Request object. A set of resources that are used by the agent's tools. The resources are specific to the type of tool.\n * For example, the `code_interpreter` tool requires a list of file IDs, while the `file_search` tool requires a list of\n * vector store IDs.\n */\nexport interface UpdateToolResourcesOptions {\n  /**\n   * Overrides the list of file IDs made available to the `code_interpreter` tool. There can be a maximum of 20 files\n   * associated with the tool.\n   */\n  code_interpreter?: UpdateCodeInterpreterToolResourceOptions;\n  /** Overrides the vector store attached to this agent. There can be a maximum of 1 vector store attached to the agent. */\n  file_search?: UpdateFileSearchToolResourceOptions;\n  /** Overrides the resources to be used by the `azure_ai_search` tool consisting of index IDs and names. */\n  azure_ai_search?: AzureAISearchResource;\n}\n\n/** Request object to update `code_interpreted` tool resources. */\nexport interface UpdateCodeInterpreterToolResourceOptions {\n  /** A list of file IDs to override the current list of the agent. */\n  file_ids?: string[];\n}\n\n/** Request object to update `file_search` tool resources. */\nexport interface UpdateFileSearchToolResourceOptions {\n  /** A list of vector store IDs to override the current list of the agent. */\n  vector_store_ids?: string[];\n}\n\n/** The data provided during a tool outputs submission to resolve pending tool calls and allow the model to continue. */\nexport interface ToolOutput {\n  /** The ID of the tool call being resolved, as provided in the tool calls of a required action from a run. */\n  tool_call_id?: string;\n  /** The output from the tool to be submitted. */\n  output?: string;\n}\n\n/** The details used when creating and immediately running a new agent thread. */\nexport interface CreateAndRunThreadOptions {\n  /** The ID of the agent for which the thread should be created. */\n  assistant_id: string;\n  /** The details used to create the new thread. If no thread is provided, an empty one will be created. */\n  thread?: AgentThreadCreationOptions;\n  /** The overridden model that the agent should use to run the thread. */\n  model?: string | null;\n  /** The overridden system instructions the agent should use to run the thread. */\n  instructions?: string | null;\n  /** The overridden list of enabled tools the agent should use to run the thread. */\n  tools?: Array<ToolDefinition> | null;\n  /** Override the tools the agent can use for this run. This is useful for modifying the behavior on a per-run basis */\n  tool_resources?: UpdateToolResourcesOptions | null;\n  /**\n   * If `true`, returns a stream of events that happen during the Run as server-sent events,\n   * terminating when the Run enters a terminal state with a `data: [DONE]` message.\n   */\n  stream?: boolean;\n  /**\n   * What sampling temperature to use, between 0 and 2. Higher values like 0.8 will make the output\n   * more random, while lower values like 0.2 will make it more focused and deterministic.\n   */\n  temperature?: number | null;\n  /**\n   * An alternative to sampling with temperature, called nucleus sampling, where the model\n   * considers the results of the tokens with top_p probability mass. So 0.1 means only the tokens\n   * comprising the top 10% probability mass are considered.\n   *\n   * We generally recommend altering this or temperature but not both.\n   */\n  top_p?: number | null;\n  /**\n   * The maximum number of prompt tokens that may be used over the course of the run. The run will make a best effort to use only\n   * the number of prompt tokens specified, across multiple turns of the run. If the run exceeds the number of prompt tokens specified,\n   * the run will end with status `incomplete`. See `incomplete_details` for more info.\n   */\n  max_prompt_tokens?: number | null;\n  /**\n   * The maximum number of completion tokens that may be used over the course of the run. The run will make a best effort to use only\n   * the number of completion tokens specified, across multiple turns of the run. If the run exceeds the number of completion tokens\n   * specified, the run will end with status `incomplete`. See `incomplete_details` for more info.\n   */\n  max_completion_tokens?: number | null;\n  /** The strategy to use for dropping messages as the context windows moves forward. */\n  truncation_strategy?: TruncationObject | null;\n  /** Controls whether or not and which tool is called by the model. */\n  tool_choice?: AgentsApiToolChoiceOption | null;\n  /** Specifies the format that the model must output. */\n  response_format?: AgentsApiResponseFormatOption | null;\n  /** If `true` functions will run in parallel during tool use. */\n  parallel_tool_calls?: boolean;\n  /** A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format. Keys may be up to 64 characters in length and values may be up to 512 characters in length. */\n  metadata?: Record<string, string> | null;\n}\n\n/** The expiration policy for a vector store. */\nexport interface VectorStoreExpirationPolicy {\n  /**\n   * Anchor timestamp after which the expiration policy applies. Supported anchors: `last_active_at`.\n   *\n   * Possible values: \"last_active_at\"\n   */\n  anchor: VectorStoreExpirationPolicyAnchor;\n  /** The anchor timestamp after which the expiration policy applies. */\n  days: number;\n}\n\n/** Request object for creating a vector store. */\nexport interface VectorStoreOptions {\n  /** A list of file IDs that the vector store should use. Useful for tools like `file_search` that can access files. */\n  file_ids?: string[];\n  /** The name of the vector store. */\n  name?: string;\n  /** The vector store configuration, used when vector store is created from Azure asset URIs. */\n  configuration?: VectorStoreConfiguration;\n  /** Details on when this vector store expires */\n  expires_after?: VectorStoreExpirationPolicy;\n  /** The chunking strategy used to chunk the file(s). If not set, will use the auto strategy. Only applicable if file_ids is non-empty. */\n  chunking_strategy?: VectorStoreChunkingStrategyRequest;\n  /** A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format. Keys may be up to 64 characters in length and values may be up to 512 characters in length. */\n  metadata?: Record<string, string> | null;\n}\n\n/** An abstract representation of a vector store chunking strategy configuration. */\nexport interface VectorStoreChunkingStrategyRequestParent {\n  type: VectorStoreChunkingStrategyRequestType;\n}\n\n/** The default strategy. This strategy currently uses a max_chunk_size_tokens of 800 and chunk_overlap_tokens of 400. */\nexport interface VectorStoreAutoChunkingStrategyRequest\n  extends VectorStoreChunkingStrategyRequestParent {\n  /** The object type, which is always 'auto'. */\n  type: \"auto\";\n}\n\n/** A statically configured chunking strategy. */\nexport interface VectorStoreStaticChunkingStrategyRequest\n  extends VectorStoreChunkingStrategyRequestParent {\n  /** The object type, which is always 'static'. */\n  type: \"static\";\n  /** The options for the static chunking strategy. */\n  static: VectorStoreStaticChunkingStrategyOptions;\n}\n\n/** Options to configure a vector store static chunking strategy. */\nexport interface VectorStoreStaticChunkingStrategyOptions {\n  /** The maximum number of tokens in each chunk. The default value is 800. The minimum value is 100 and the maximum value is 4096. */\n  max_chunk_size_tokens: number;\n  /**\n   * The number of tokens that overlap between chunks. The default value is 400.\n   * Note that the overlap must not exceed half of max_chunk_size_tokens.\n   */\n  chunk_overlap_tokens: number;\n}\n\n/** Request object for updating a vector store. */\nexport interface VectorStoreUpdateOptions {\n  /** The name of the vector store. */\n  name?: string | null;\n  /** Details on when this vector store expires */\n  expires_after?: VectorStoreExpirationPolicy | null;\n  /** A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format. Keys may be up to 64 characters in length and values may be up to 512 characters in length. */\n  metadata?: Record<string, string> | null;\n}\n\n/** Evaluation Definition */\nexport interface Evaluation {\n  /** Data for evaluation. */\n  data: InputData;\n  /** Display Name for evaluation. It helps to find the evaluation easily in AI Foundry. It does not need to be unique. */\n  displayName?: string;\n  /** Description of the evaluation. It can be used to store additional information about the evaluation and is mutable. */\n  description?: string;\n  /** Evaluation's tags. Unlike properties, tags are fully mutable. */\n  tags?: Record<string, string>;\n  /** Evaluation's properties. Unlike tags, properties are add-only. Once added, a property cannot be removed. */\n  properties?: Record<string, string>;\n  /** Evaluators to be used for the evaluation. */\n  evaluators: Record<string, EvaluatorConfiguration>;\n}\n\n/** Abstract data class for input data configuration. */\nexport interface InputDataParent {\n  type: string;\n}\n\n/** Data Source for Application Insights. */\nexport interface ApplicationInsightsConfiguration extends InputDataParent {\n  /** LogAnalytic Workspace resourceID associated with ApplicationInsights */\n  resourceId: string;\n  /** Query to fetch the data. */\n  query: string;\n  /** Service name. */\n  serviceName: string;\n  /** Connection String to connect to ApplicationInsights. */\n  connectionString?: string;\n}\n\n/** Dataset as source for evaluation. */\nexport interface Dataset extends InputDataParent {\n  /** Evaluation input data */\n  id: string;\n}\n\n/** Metadata pertaining to creation and last modification of the resource. */\nexport interface SystemData {}\n\n/** Evaluator Configuration */\nexport interface EvaluatorConfiguration {\n  /** Identifier of the evaluator. */\n  id: string;\n  /** Initialization parameters of the evaluator. */\n  initParams?: Record<string, unknown>;\n  /** Data parameters of the evaluator. */\n  dataMapping?: Record<string, string>;\n}\n\n/** Evaluation Schedule Definition */\nexport interface EvaluationSchedule {\n  /** Data for evaluation. */\n  data: ApplicationInsightsConfiguration;\n  /** Description of the evaluation. It can be used to store additional information about the evaluation and is mutable. */\n  description?: string;\n  /** Evaluation's tags. Unlike properties, tags are fully mutable. */\n  tags?: Record<string, string>;\n  /** Evaluation's properties. Unlike tags, properties are add-only. Once added, a property cannot be removed. */\n  properties?: Record<string, string>;\n  /** Evaluators to be used for the evaluation. */\n  evaluators: Record<string, EvaluatorConfiguration>;\n  /** Trigger for the evaluation. */\n  trigger: Trigger;\n}\n\n/** Abstract data class for input data configuration. */\nexport interface TriggerParent {\n  type: string;\n}\n\n/** Recurrence Trigger Definition */\nexport interface RecurrenceTrigger extends TriggerParent {\n  /**\n   * The frequency to trigger schedule.\n   *\n   * Possible values: \"Month\", \"Week\", \"Day\", \"Hour\", \"Minute\"\n   */\n  frequency: Frequency;\n  /** Specifies schedule interval in conjunction with frequency */\n  interval: number;\n  /** The recurrence schedule. */\n  schedule?: RecurrenceSchedule;\n}\n\n/** RecurrenceSchedule Definition */\nexport interface RecurrenceSchedule {\n  /** List of hours for the schedule. */\n  hours: number[];\n  /** List of minutes for the schedule. */\n  minutes: number[];\n  /** List of days for the schedule. */\n  weekDays?: WeekDays[];\n  /** List of month days for the schedule */\n  monthDays?: number[];\n}\n\n/** Cron Trigger Definition */\nexport interface CronTrigger extends TriggerParent {\n  /** Cron expression for the trigger. */\n  expression: string;\n}\n\n/** An abstract representation of an input tool definition that an agent can use. */\nexport type ToolDefinition =\n  | ToolDefinitionParent\n  | CodeInterpreterToolDefinition\n  | FileSearchToolDefinition\n  | FunctionToolDefinition\n  | BingGroundingToolDefinition\n  | MicrosoftFabricToolDefinition\n  | SharepointToolDefinition\n  | AzureAISearchToolDefinition\n  | OpenApiToolDefinition\n  | AzureFunctionToolDefinition;\n/** authentication details for OpenApiFunctionDefinition */\nexport type OpenApiAuthDetails =\n  | OpenApiAuthDetailsParent\n  | OpenApiAnonymousAuthDetails\n  | OpenApiConnectionAuthDetails\n  | OpenApiManagedAuthDetails;\n/** An abstract representation of a vector store chunking strategy configuration. */\nexport type VectorStoreChunkingStrategyRequest =\n  | VectorStoreChunkingStrategyRequestParent\n  | VectorStoreAutoChunkingStrategyRequest\n  | VectorStoreStaticChunkingStrategyRequest;\n/** Abstract data class for input data configuration. */\nexport type InputData =\n  | InputDataParent\n  | ApplicationInsightsConfiguration\n  | Dataset;\n/** Abstract data class for input data configuration. */\nexport type Trigger = TriggerParent | RecurrenceTrigger | CronTrigger;\n/** Alias for OpenApiAuthType */\nexport type OpenApiAuthType = string;\n/** Alias for VectorStoreDataSourceAssetType */\nexport type VectorStoreDataSourceAssetType = string;\n/** Alias for AgentsApiResponseFormatMode */\nexport type AgentsApiResponseFormatMode = string;\n/** Alias for ResponseFormat */\nexport type ResponseFormat = string;\n/** Alias for AgentsApiResponseFormatOption */\nexport type AgentsApiResponseFormatOption =\n  | string\n  | AgentsApiResponseFormatMode\n  | AgentsApiResponseFormat\n  | ResponseFormatJsonSchemaType;\n/** Alias for ListSortOrder */\nexport type ListSortOrder = string;\n/** Alias for MessageRole */\nexport type MessageRole = string;\n/** Alias for MessageAttachmentToolDefinition */\nexport type MessageAttachmentToolDefinition =\n  | CodeInterpreterToolDefinition\n  | FileSearchToolDefinition;\n/** Alias for TruncationStrategy */\nexport type TruncationStrategy = string;\n/** Alias for AgentsApiToolChoiceOptionMode */\nexport type AgentsApiToolChoiceOptionMode = string;\n/** Alias for AgentsNamedToolChoiceType */\nexport type AgentsNamedToolChoiceType = string;\n/** Alias for AgentsApiToolChoiceOption */\nexport type AgentsApiToolChoiceOption =\n  | string\n  | AgentsApiToolChoiceOptionMode\n  | AgentsNamedToolChoice;\n/** Alias for FilePurpose */\nexport type FilePurpose = string;\n/** Alias for VectorStoreExpirationPolicyAnchor */\nexport type VectorStoreExpirationPolicyAnchor = string;\n/** Alias for VectorStoreChunkingStrategyRequestType */\nexport type VectorStoreChunkingStrategyRequestType = string;\n/** Alias for VectorStoreFileStatusFilter */\nexport type VectorStoreFileStatusFilter = string;\n/** The Type (or category) of the connection */\nexport type ConnectionType =\n  | \"AzureOpenAI\"\n  | \"Serverless\"\n  | \"AzureBlob\"\n  | \"AIServices\"\n  | \"CognitiveSearch\";\n/** Alias for Frequency */\nexport type Frequency = string;\n/** Alias for WeekDays */\nexport type WeekDays = string;\n"]}

package/dist/commonjs/generated/src/outputModels.d.ts

@@ -1,4 +1,3 @@
-import { Paged } from "@azure/core-paging";
 /** An abstract representation of an input tool definition that an agent can use. */
 export interface ToolDefinitionOutputParent {
     type: string;
@@ -23,6 +22,7 @@ export interface FileSearchToolDefinitionDetailsOutput {
      * Note that the file search tool may output fewer than `max_num_results` results. See the file search tool documentation for more information.
      */
     max_num_results?: number;
+    /** Ranking options for file search. */
     ranking_options?: FileSearchRankingOptionsOutput;
 }
 /** Ranking options for file search. */
@@ -55,7 +55,7 @@ export interface BingGroundingToolDefinitionOutput extends ToolDefinitionOutputP
     /** The list of connections used by the bing grounding tool. */
     bing_grounding: ToolConnectionListOutput;
 }
-/** A set of connection resources currently used by either the `bing_grounding`, `microsoft_fabric`, or `sharepoint_grounding` tools. */
+/** A set of connection resources currently used by either the `bing_grounding`, `fabric_aiskill`, or `sharepoint_grounding` tools. */
 export interface ToolConnectionListOutput {
     /**
      * The connections attached to this tool. There can be a maximum of 1 connection
@@ -70,10 +70,10 @@ export interface ToolConnectionOutput {
 }
 /** The input definition information for a Microsoft Fabric tool as used to configure an agent. */
 export interface MicrosoftFabricToolDefinitionOutput extends ToolDefinitionOutputParent {
-    /** The object type, which is always 'microsoft_fabric'. */
-    type: "microsoft_fabric";
+    /** The object type, which is always 'fabric_aiskill'. */
+    type: "fabric_aiskill";
     /** The list of connections used by the Microsoft Fabric tool. */
-    microsoft_fabric: ToolConnectionListOutput;
+    fabric_aiskill: ToolConnectionListOutput;
 }
 /** The input definition information for a sharepoint tool as used to configure an agent. */
 export interface SharepointToolDefinitionOutput extends ToolDefinitionOutputParent {
@@ -87,13 +87,94 @@ export interface AzureAISearchToolDefinitionOutput extends ToolDefinitionOutputP
     /** The object type, which is always 'azure_ai_search'. */
     type: "azure_ai_search";
 }
+/** The input definition information for an OpenAPI tool as used to configure an agent. */
+export interface OpenApiToolDefinitionOutput extends ToolDefinitionOutputParent {
+    /** The object type, which is always 'openapi'. */
+    type: "openapi";
+    /** The openapi function definition. */
+    openapi: OpenApiFunctionDefinitionOutput;
+}
+/** The input definition information for an openapi function. */
+export interface OpenApiFunctionDefinitionOutput {
+    /** The name of the function to be called. */
+    name: string;
+    /** A description of what the function does, used by the model to choose when and how to call the function. */
+    description?: string;
+    /** The openapi function shape, described as a JSON Schema object. */
+    spec: any;
+    /** Open API authentication details */
+    auth: OpenApiAuthDetailsOutput;
+}
+/** authentication details for OpenApiFunctionDefinition */
+export interface OpenApiAuthDetailsOutputParent {
+    type: OpenApiAuthTypeOutput;
+}
+/** Security details for OpenApi anonymous authentication */
+export interface OpenApiAnonymousAuthDetailsOutput extends OpenApiAuthDetailsOutputParent {
+    /** The object type, which is always 'anonymous'. */
+    type: "anonymous";
+}
+/** Security details for OpenApi connection authentication */
+export interface OpenApiConnectionAuthDetailsOutput extends OpenApiAuthDetailsOutputParent {
+    /** The object type, which is always 'connection'. */
+    type: "connection";
+    /** Connection auth security details */
+    security_scheme: OpenApiConnectionSecuritySchemeOutput;
+}
+/** Security scheme for OpenApi managed_identity authentication */
+export interface OpenApiConnectionSecuritySchemeOutput {
+    /** Connection id for Connection auth type */
+    connection_id: string;
+}
+/** Security details for OpenApi managed_identity authentication */
+export interface OpenApiManagedAuthDetailsOutput extends OpenApiAuthDetailsOutputParent {
+    /** The object type, which is always 'managed_identity'. */
+    type: "managed_identity";
+    /** Connection auth security details */
+    security_scheme: OpenApiManagedSecuritySchemeOutput;
+}
+/** Security scheme for OpenApi managed_identity authentication */
+export interface OpenApiManagedSecuritySchemeOutput {
+    /** Authentication scope for managed_identity auth type */
+    audience: string;
+}
+/** The input definition information for a azure function tool as used to configure an agent. */
+export interface AzureFunctionToolDefinitionOutput extends ToolDefinitionOutputParent {
+    /** The object type, which is always 'azure_function'. */
+    type: "azure_function";
+    /** The definition of the concrete function that the function tool should call. */
+    azure_function: AzureFunctionDefinitionOutput;
+}
+/** The definition of Azure function. */
+export interface AzureFunctionDefinitionOutput {
+    /** The definition of azure function and its parameters. */
+    function: FunctionDefinitionOutput;
+    /** Input storage queue. The queue storage trigger runs a function as messages are added to it. */
+    input_binding: AzureFunctionBindingOutput;
+    /** Output storage queue. The function writes output to this queue when the input items are processed. */
+    output_binding: AzureFunctionBindingOutput;
+}
+/** The structure for keeping storage queue name and URI. */
+export interface AzureFunctionBindingOutput {
+    /** The type of binding, which is always 'storage_queue'. */
+    type: "storage_queue";
+    /** Storage queue. */
+    storage_queue: AzureFunctionStorageQueueOutput;
+}
+/** The structure for keeping storage queue name and URI. */
+export interface AzureFunctionStorageQueueOutput {
+    /** URI to the Azure Storage Queue service allowing you to manipulate a queue. */
+    queue_service_endpoint: string;
+    /** The name of an Azure function storage queue. */
+    queue_name: string;
+}
 /**
  * A set of resources that are used by the agent's tools. The resources are specific to the type of
  * tool. For example, the `code_interpreter` tool requires a list of file IDs, while the `file_search`
  * tool requires a list of vector store IDs.
  */
 export interface ToolResourcesOutput {
-    /** Resources to be used by the `code_interpreter tool` consisting of file IDs. */
+    /** Resources to be used by the `code_interpreter` tool consisting of file IDs. */
     code_interpreter?: CodeInterpreterToolResourceOutput;
     /** Resources to be used by the `file_search` tool consisting of vector store IDs. */
     file_search?: FileSearchToolResourceOutput;
@@ -107,7 +188,7 @@ export interface CodeInterpreterToolResourceOutput {
      * associated with the tool.
      */
     file_ids?: string[];
-    /** The data sources to be used. This option is mutually exclusive with fileIds. */
+    /** The data sources to be used. This option is mutually exclusive with the `fileIds` property. */
     data_sources?: Array<VectorStoreDataSourceOutput>;
 }
 /**
@@ -117,7 +198,11 @@ export interface CodeInterpreterToolResourceOutput {
 export interface VectorStoreDataSourceOutput {
     /** Asset URI. */
     uri: string;
-    /** The asset type * */
+    /**
+     * The asset type
+     *
+     * Possible values: "uri_asset", "id_asset"
+     */
     type: VectorStoreDataSourceAssetTypeOutput;
 }
 /** A set of resources that are used by the `file_search` tool. */
@@ -128,9 +213,9 @@ export interface FileSearchToolResourceOutput {
      */
     vector_store_ids?: string[];
     /**
-     * The list of vector store configuration objects from Azure. This list is limited to one
-     * element. The only element of this list contains
-     * the list of azure asset IDs used by the search tool.
+     * The list of vector store configuration objects from Azure.
+     * This list is limited to one element.
+     * The only element of this list contains the list of azure asset IDs used by the search tool.
      */
     vector_stores?: Array<VectorStoreConfigurationsOutput>;
 }
@@ -174,7 +259,23 @@ export interface AgentsApiResponseFormatOutput {
      *
      * Possible values: "text", "json_object"
      */
-    type?: ApiResponseFormatOutput;
+    type?: ResponseFormatOutput;
+}
+/** The type of response format being defined: `json_schema` */
+export interface ResponseFormatJsonSchemaTypeOutput {
+    /** Type */
+    type: "json_schema";
+    /** The JSON schema, describing response format. */
+    json_schema: ResponseFormatJsonSchemaOutput;
+}
+/** A description of what the response format is for, used by the model to determine how to respond in the format. */
+export interface ResponseFormatJsonSchemaOutput {
+    /** A description of what the response format is for, used by the model to determine how to respond in the format. */
+    description?: string;
+    /** The name of a schema. */
+    name: string;
+    /** The JSON schema object, describing the response format. */
+    schema: any;
 }
 /** Represents an agent that can call the model and use tools. */
 export interface AgentOutput {
@@ -243,7 +344,7 @@ export interface MessageAttachmentOutput {
     /** The ID of the file to attach to the message. */
     file_id?: string;
     /** Azure asset ID. */
-    data_sources?: Array<VectorStoreDataSourceOutput>;
+    data_source?: VectorStoreDataSourceOutput;
     /** The tools to add to this file. */
     tools: MessageAttachmentToolDefinitionOutput[];
 }
@@ -428,7 +529,7 @@ export interface AgentsNamedToolChoiceOutput {
     /**
      * the type of tool. If type is `function`, the function name must be set.
      *
-     * Possible values: "function", "code_interpreter", "file_search", "bing_grounding", "microsoft_fabric", "sharepoint_grounding", "azure_ai_search"
+     * Possible values: "function", "code_interpreter", "file_search", "bing_grounding", "fabric_aiskill", "sharepoint_grounding", "azure_ai_search"
      */
     type: AgentsNamedToolChoiceTypeOutput;
     /** The name of the function to call */
@@ -500,7 +601,7 @@ export interface ThreadRunOutput {
     /** Override the tools the agent can use for this run. This is useful for modifying the behavior on a per-run basis */
     tool_resources?: UpdateToolResourcesOptionsOutput | null;
     /** Determines if tools can be executed in parallel within the run. */
-    parallelToolCalls?: boolean;
+    parallel_tool_calls: boolean;
 }
 /** An abstract representation of a required action for an agent thread run to continue. */
 export interface RequiredActionOutputParent {
@@ -518,7 +619,7 @@ export interface SubmitToolOutputsDetailsOutput {
     /** The list of tool calls that must be resolved for the agent thread run to continue. */
     tool_calls: Array<RequiredToolCallOutput>;
 }
-/** An abstract representation a a tool invocation needed by the model to continue a run. */
+/** An abstract representation of a tool invocation needed by the model to continue a run. */
 export interface RequiredToolCallOutputParent {
     /** The ID of the tool call. This ID must be referenced when submitting tool outputs. */
     id: string;
@@ -545,6 +646,15 @@ export interface RunErrorOutput {
     /** The human-readable text associated with the error. */
     message: string;
 }
+/** Details on why the run is incomplete. Will be `null` if the run is not incomplete. */
+export interface IncompleteRunDetailsOutput {
+    /**
+     * The reason why the run is incomplete. This indicates which specific token limit was reached during the run.
+     *
+     * Possible values: "max_completion_tokens", "max_prompt_tokens"
+     */
+    reason: IncompleteDetailsReasonOutput;
+}
 /** Usage statistics related to the run. This value will be `null` if the run is not in a terminal state (i.e. `in_progress`, `queued`, etc.). */
 export interface RunCompletionUsageOutput {
     /** Number of completion tokens used over the course of the run. */
@@ -712,8 +822,35 @@ export interface RunStepCodeInterpreterImageReferenceOutput {
 export interface RunStepFileSearchToolCallOutput extends RunStepToolCallOutputParent {
     /** The object type, which is always 'file_search'. */
     type: "file_search";
-    /** Reserved for future use. */
-    file_search: Record<string, string>;
+    /** The ID of the tool call. This ID must be referenced when you submit tool outputs. */
+    id: string;
+    /** For now, this is always going to be an empty object. */
+    file_search: RunStepFileSearchToolCallResultsOutput;
+}
+/** The results of the file search. */
+export interface RunStepFileSearchToolCallResultsOutput {
+    /** Ranking options for file search. */
+    ranking_options?: FileSearchRankingOptionsOutput;
+    /** The array of a file search results */
+    results: Array<RunStepFileSearchToolCallResultOutput>;
+}
+/**   File search tool call result. */
+export interface RunStepFileSearchToolCallResultOutput {
+    /** The ID of the file that result was found in. */
+    file_id: string;
+    /** The name of the file that result was found in. */
+    file_name: string;
+    /** The score of the result. All values must be a floating point number between 0 and 1. */
+    score: number;
+    /** The content of the result that was found. The content is only included if requested via the include query parameter. */
+    content?: Array<FileSearchToolCallContentOutput>;
+}
+/** The file search result content object. */
+export interface FileSearchToolCallContentOutput {
+    /** The type of the content. */
+    type: "text";
+    /** The text content of the file. */
+    text: string;
 }
 /**
  * A record of a call to a bing grounding tool, issued by the model in evaluation of a defined tool, that represents
@@ -750,10 +887,10 @@ export interface RunStepSharepointToolCallOutput extends RunStepToolCallOutputPa
  * executed Microsoft Fabric operations.
  */
 export interface RunStepMicrosoftFabricToolCallOutput extends RunStepToolCallOutputParent {
-    /** The object type, which is always 'microsoft_fabric'. */
-    type: "microsoft_fabric";
+    /** The object type, which is always 'fabric_aiskill'. */
+    type: "fabric_aiskill";
     /** Reserved for future use. */
-    microsoft_fabric: Record<string, string>;
+    fabric_aiskill: Record<string, string>;
 }
 /**
  * A record of a call to a function tool, issued by the model in evaluation of a defined tool, that represents the inputs
@@ -974,12 +1111,12 @@ export interface VectorStoreFileOutput {
     /** The strategy used to chunk the file. */
     chunking_strategy: VectorStoreChunkingStrategyResponseOutput;
 }
-/** Details on the error that may have ocurred while processing a file for this vector store */
+/** Details on the error that may have occurred while processing a file for this vector store */
 export interface VectorStoreFileErrorOutput {
     /**
      * One of `server_error` or `rate_limit_exceeded`.
      *
-     * Possible values: "internal_error", "file_not_found", "parsing_error", "unhandled_mime_type"
+     * Possible values: "server_error", "invalid_file", "unsupported_file"
      */
     code: VectorStoreFileErrorCodeOutput;
     /** A human-readable description of the error. */
@@ -1114,7 +1251,7 @@ export interface EvaluationOutput {
     readonly id: string;
     /** Data for evaluation. */
     data: InputDataOutput;
-    /** Display Name for evaluation. It helps to find evaluation easily in AI Studio. It does not need to be unique. */
+    /** Display Name for evaluation. It helps to find the evaluation easily in AI Foundry. It does not need to be unique. */
     displayName?: string;
     /** Description of the evaluation. It can be used to store additional information about the evaluation and is mutable. */
     description?: string;
@@ -1171,6 +1308,13 @@ export interface EvaluatorConfigurationOutput {
     /** Data parameters of the evaluator. */
     dataMapping?: Record<string, string>;
 }
+/** Paged collection of Evaluation items */
+export interface PagedEvaluationOutput {
+    /** The Evaluation items on this page */
+    value: Array<EvaluationOutput>;
+    /** The link to the next page of items */
+    nextLink?: string;
+}
 /** Evaluation Schedule Definition */
 export interface EvaluationScheduleOutput {
     /** Name of the schedule, which also serves as the unique identifier for the evaluation */
@@ -1229,15 +1373,24 @@ export interface CronTriggerOutput extends TriggerOutputParent {
     /** Cron expression for the trigger. */
     expression: string;
 }
+/** Paged collection of EvaluationSchedule items */
+export interface PagedEvaluationScheduleOutput {
+    /** The EvaluationSchedule items on this page */
+    value: Array<EvaluationScheduleOutput>;
+    /** The link to the next page of items */
+    nextLink?: string;
+}
 /** An abstract representation of an input tool definition that an agent can use. */
-export type ToolDefinitionOutput = ToolDefinitionOutputParent | CodeInterpreterToolDefinitionOutput | FileSearchToolDefinitionOutput | FunctionToolDefinitionOutput | BingGroundingToolDefinitionOutput | MicrosoftFabricToolDefinitionOutput | SharepointToolDefinitionOutput | AzureAISearchToolDefinitionOutput;
+export type ToolDefinitionOutput = ToolDefinitionOutputParent | CodeInterpreterToolDefinitionOutput | FileSearchToolDefinitionOutput | FunctionToolDefinitionOutput | BingGroundingToolDefinitionOutput | MicrosoftFabricToolDefinitionOutput | SharepointToolDefinitionOutput | AzureAISearchToolDefinitionOutput | OpenApiToolDefinitionOutput | AzureFunctionToolDefinitionOutput;
+/** authentication details for OpenApiFunctionDefinition */
+export type OpenApiAuthDetailsOutput = OpenApiAuthDetailsOutputParent | OpenApiAnonymousAuthDetailsOutput | OpenApiConnectionAuthDetailsOutput | OpenApiManagedAuthDetailsOutput;
 /** An abstract representation of a single item of thread message content. */
 export type MessageContentOutput = MessageContentOutputParent | MessageTextContentOutput | MessageImageFileContentOutput;
 /** An abstract representation of an annotation to text thread message content. */
 export type MessageTextAnnotationOutput = MessageTextAnnotationOutputParent | MessageTextFileCitationAnnotationOutput | MessageTextFilePathAnnotationOutput;
 /** An abstract representation of a required action for an agent thread run to continue. */
 export type RequiredActionOutput = RequiredActionOutputParent | SubmitToolOutputsActionOutput;
-/** An abstract representation a a tool invocation needed by the model to continue a run. */
+/** An abstract representation of a tool invocation needed by the model to continue a run. */
 export type RequiredToolCallOutput = RequiredToolCallOutputParent | RequiredFunctionToolCallOutput;
 /** An abstract representation of the details for a run step. */
 export type RunStepDetailsOutput = RunStepDetailsOutputParent | RunStepMessageCreationDetailsOutput | RunStepToolCallDetailsOutput;
@@ -1253,14 +1406,16 @@ export type InternalConnectionPropertiesOutput = InternalConnectionPropertiesOut
 export type InputDataOutput = InputDataOutputParent | ApplicationInsightsConfigurationOutput | DatasetOutput;
 /** Abstract data class for input data configuration. */
 export type TriggerOutput = TriggerOutputParent | RecurrenceTriggerOutput | CronTriggerOutput;
+/** Alias for OpenApiAuthTypeOutput */
+export type OpenApiAuthTypeOutput = string;
 /** Alias for VectorStoreDataSourceAssetTypeOutput */
-export type VectorStoreDataSourceAssetTypeOutput = "uri_asset" | "id_asset";
+export type VectorStoreDataSourceAssetTypeOutput = string;
 /** Alias for AgentsApiResponseFormatModeOutput */
 export type AgentsApiResponseFormatModeOutput = string;
-/** Alias for ApiResponseFormatOutput */
-export type ApiResponseFormatOutput = string;
+/** Alias for ResponseFormatOutput */
+export type ResponseFormatOutput = string;
 /** Alias for AgentsApiResponseFormatOptionOutput */
-export type AgentsApiResponseFormatOptionOutput = string | AgentsApiResponseFormatModeOutput | AgentsApiResponseFormatOutput;
+export type AgentsApiResponseFormatOptionOutput = string | AgentsApiResponseFormatModeOutput | AgentsApiResponseFormatOutput | ResponseFormatJsonSchemaTypeOutput;
 /** Alias for MessageRoleOutput */
 export type MessageRoleOutput = string;
 /** Alias for MessageAttachmentToolDefinitionOutput */
@@ -1279,8 +1434,8 @@ export type AgentsNamedToolChoiceTypeOutput = string;
 export type AgentsApiToolChoiceOptionOutput = string | AgentsApiToolChoiceOptionModeOutput | AgentsNamedToolChoiceOutput;
 /** Alias for RunStatusOutput */
 export type RunStatusOutput = string;
-/** Alias for IncompleteRunDetailsOutput */
-export type IncompleteRunDetailsOutput = string;
+/** Alias for IncompleteDetailsReasonOutput */
+export type IncompleteDetailsReasonOutput = string;
 /** Alias for RunStepTypeOutput */
 export type RunStepTypeOutput = string;
 /** Alias for RunStepStatusOutput */
@@ -1307,12 +1462,8 @@ export type VectorStoreFileBatchStatusOutput = string;
 export type ConnectionTypeOutput = "AzureOpenAI" | "Serverless" | "AzureBlob" | "AIServices" | "CognitiveSearch";
 /** Authentication type used by Azure AI service to connect to another service */
 export type AuthenticationTypeOutput = "ApiKey" | "AAD" | "SAS";
-/** Paged collection of Evaluation items */
-export type PagedEvaluationOutput = Paged<EvaluationOutput>;
 /** Alias for FrequencyOutput */
 export type FrequencyOutput = string;
 /** Alias for WeekDaysOutput */
 export type WeekDaysOutput = string;
-/** Paged collection of EvaluationSchedule items */
-export type PagedEvaluationScheduleOutput = Paged<EvaluationScheduleOutput>;
 //# sourceMappingURL=outputModels.d.ts.map