9771 lines
980 KiB
XML
Executable File
9771 lines
980 KiB
XML
Executable File
<?xml version="1.0" encoding="utf-8"?>
|
|
<doc>
|
|
<assembly>
|
|
<name>Azure.AI.OpenAI.Assistants</name>
|
|
</assembly>
|
|
<members>
|
|
<member name="T:Azure.AI.OpenAI.Assistants.AssistantsClient">
|
|
<summary> Azure OpenAI APIs for Assistants. </summary>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.AssistantsClient.CreateThread(System.Threading.CancellationToken)">
|
|
<summary>
|
|
Creates a new, empty thread using a default <see cref="T:Azure.AI.OpenAI.Assistants.AssistantThreadCreationOptions" /> instance.
|
|
</summary>
|
|
<param name="cancellationToken"> The cancellation token to use. </param>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.AssistantsClient.CreateThreadAsync(System.Threading.CancellationToken)">
|
|
<summary>
|
|
Creates a new, empty thread using a default <see cref="T:Azure.AI.OpenAI.Assistants.AssistantThreadCreationOptions" /> instance.
|
|
</summary>
|
|
<param name="cancellationToken"> The cancellation token to use. </param>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.AssistantsClient.CreateRun(Azure.AI.OpenAI.Assistants.AssistantThread,Azure.AI.OpenAI.Assistants.Assistant,System.Threading.CancellationToken)">
|
|
<summary>
|
|
Creates a new run of the specified thread using a specified assistant.
|
|
</summary>
|
|
<remarks>
|
|
This method will create the run with default configuration.
|
|
To customize the run, use <see cref="M:Azure.AI.OpenAI.Assistants.AssistantsClient.CreateRun(System.String,Azure.AI.OpenAI.Assistants.CreateRunOptions,System.Threading.CancellationToken)" />.
|
|
</remarks>
|
|
<param name="thread"> The thread that should be run. </param>
|
|
<param name="assistant"> The assistant that should run the thread. </param>
|
|
<param name="cancellationToken"> The cancellation token to use. </param>
|
|
<returns> A new <see cref="T:Azure.AI.OpenAI.Assistants.ThreadRun" /> instance. </returns>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.AssistantsClient.CreateRunAsync(Azure.AI.OpenAI.Assistants.AssistantThread,Azure.AI.OpenAI.Assistants.Assistant,System.Threading.CancellationToken)">
|
|
<summary>
|
|
Creates a new run of the specified thread using a specified assistant.
|
|
</summary>
|
|
<remarks>
|
|
This method will create the run with default configuration.
|
|
To customize the run, use <see cref="M:Azure.AI.OpenAI.Assistants.AssistantsClient.CreateRun(System.String,Azure.AI.OpenAI.Assistants.CreateRunOptions,System.Threading.CancellationToken)" />.
|
|
</remarks>
|
|
<param name="thread"> The thread that should be run. </param>
|
|
<param name="assistant"> The assistant that should run the thread. </param>
|
|
<param name="cancellationToken"> The cancellation token to use. </param>
|
|
<returns> A new <see cref="T:Azure.AI.OpenAI.Assistants.ThreadRun" /> instance. </returns>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.AssistantsClient.GetRunSteps(Azure.AI.OpenAI.Assistants.ThreadRun,System.Nullable{System.Int32},System.Nullable{Azure.AI.OpenAI.Assistants.ListSortOrder},System.String,System.String,System.Threading.CancellationToken)">
|
|
<summary> Returns a list of run steps associated an assistant thread run. </summary>
|
|
<param name="run"> The <see cref="T:Azure.AI.OpenAI.Assistants.ThreadRun" /> instance from which run steps should be listed. </param>
|
|
<param name="limit"> A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20. </param>
|
|
<param name="order"> Sort order by the created_at timestamp of the objects. asc for ascending order and desc for descending order. </param>
|
|
<param name="after"> A cursor for use in pagination. after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include after=obj_foo in order to fetch the next page of the list. </param>
|
|
<param name="before"> A cursor for use in pagination. before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include before=obj_foo in order to fetch the previous page of the list. </param>
|
|
<param name="cancellationToken"> The cancellation token to use. </param>
|
|
<exception cref="T:System.ArgumentNullException"> <paramref name="run" /> is null. </exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.AssistantsClient.GetRunStepsAsync(Azure.AI.OpenAI.Assistants.ThreadRun,System.Nullable{System.Int32},System.Nullable{Azure.AI.OpenAI.Assistants.ListSortOrder},System.String,System.String,System.Threading.CancellationToken)">
|
|
<summary> Returns a list of run steps associated an assistant thread run. </summary>
|
|
<param name="run"> The <see cref="T:Azure.AI.OpenAI.Assistants.ThreadRun" /> instance from which run steps should be listed. </param>
|
|
<param name="limit"> A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20. </param>
|
|
<param name="order"> Sort order by the created_at timestamp of the objects. asc for ascending order and desc for descending order. </param>
|
|
<param name="after"> A cursor for use in pagination. after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include after=obj_foo in order to fetch the next page of the list. </param>
|
|
<param name="before"> A cursor for use in pagination. before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include before=obj_foo in order to fetch the previous page of the list. </param>
|
|
<param name="cancellationToken"> The cancellation token to use. </param>
|
|
<exception cref="T:System.ArgumentNullException"> <paramref name="run" /> is null. </exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.AssistantsClient.SubmitToolOutputsToRun(Azure.AI.OpenAI.Assistants.ThreadRun,System.Collections.Generic.IEnumerable{Azure.AI.OpenAI.Assistants.ToolOutput},System.Threading.CancellationToken)">
|
|
<summary> Submits outputs from tool calls as requested by a run with a status of 'requires_action' with required_action.type of 'submit_tool_outputs'. </summary>
|
|
<param name="run"> The <see cref="T:Azure.AI.OpenAI.Assistants.ThreadRun" /> that the tool outputs should be submitted to. </param>
|
|
<param name="toolOutputs"> The list of tool call outputs to provide as part of an output submission to an assistant thread run. </param>
|
|
<param name="cancellationToken"> The cancellation token to use. </param>
|
|
<exception cref="T:System.ArgumentNullException"> <paramref name="run" /> is null. </exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.AssistantsClient.SubmitToolOutputsToRunAsync(Azure.AI.OpenAI.Assistants.ThreadRun,System.Collections.Generic.IEnumerable{Azure.AI.OpenAI.Assistants.ToolOutput},System.Threading.CancellationToken)">
|
|
<summary> Submits outputs from tool calls as requested by a run with a status of 'requires_action' with required_action.type of 'submit_tool_outputs'. </summary>
|
|
<param name="run"> The <see cref="T:Azure.AI.OpenAI.Assistants.ThreadRun" /> that the tool outputs should be submitted to. </param>
|
|
<param name="toolOutputs"> The list of tool call outputs to provide as part of an output submission to an assistant thread run. </param>
|
|
<param name="cancellationToken"> The cancellation token to use. </param>
|
|
<exception cref="T:System.ArgumentNullException"> <paramref name="run" /> is null. </exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.AssistantsClient.UploadFile(System.String,Azure.AI.OpenAI.Assistants.OpenAIFilePurpose,System.Threading.CancellationToken)">
|
|
<summary>
|
|
Uploads a file from a local file path accessible to <see cref="T:System.IO.File" />.
|
|
</summary>
|
|
<param name="localFilePath"> The local file path. </param>
|
|
<param name="purpose"> The intended purpose of the uploaded file. </param>
|
|
<param name="cancellationToken"> The cancellation token to use. </param>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.AssistantsClient.UploadFileAsync(System.String,Azure.AI.OpenAI.Assistants.OpenAIFilePurpose,System.Threading.CancellationToken)">
|
|
<summary>
|
|
Uploads a file from a local file path accessible to <see cref="T:System.IO.File" />.
|
|
</summary>
|
|
<param name="localFilePath"> The local file path. </param>
|
|
<param name="purpose"> The intended purpose of the uploaded file. </param>
|
|
<param name="cancellationToken"> The cancellation token to use. </param>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.AssistantsClient.#ctor(System.Uri,Azure.AzureKeyCredential,Azure.AI.OpenAI.Assistants.AssistantsClientOptions)">
|
|
<summary>
|
|
Creates a new instance of <see cref="T:Azure.AI.OpenAI.Assistants.AssistantsClient" /> for use with an Azure OpenAI resource.
|
|
</summary>
|
|
<param name="endpoint"> An Azure OpenAI resource URL, e.g. https://my-resource.openai.azure.com. </param>
|
|
<param name="keyCredential"> The authentication information for the Azure OpenAI resource. </param>
|
|
<param name="options"> Additional options for customizing the behavior of the client. </param>
|
|
<exception cref="T:System.ArgumentNullException">
|
|
<paramref name="endpoint" /> or <paramref name="keyCredential" /> is null.
|
|
</exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.AssistantsClient.#ctor(System.Uri,Azure.AzureKeyCredential)">
|
|
<summary>
|
|
Creates a new instance of <see cref="T:Azure.AI.OpenAI.Assistants.AssistantsClient" /> for use with an Azure OpenAI resource.
|
|
</summary>
|
|
<param name="endpoint"> An Azure OpenAI resource URL, e.g. https://my-resource.openai.azure.com. </param>
|
|
<param name="keyCredential"> The authentication information for the Azure OpenAI resource. </param>
|
|
<exception cref="T:System.ArgumentNullException">
|
|
<paramref name="endpoint" /> or <paramref name="keyCredential" /> is null.
|
|
</exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.AssistantsClient.#ctor(System.Uri,Azure.Core.TokenCredential,Azure.AI.OpenAI.Assistants.AssistantsClientOptions)">
|
|
<summary>
|
|
Creates a new instance of <see cref="T:Azure.AI.OpenAI.Assistants.AssistantsClient" /> for use with an Azure OpenAI resource.
|
|
</summary>
|
|
<param name="endpoint"> An Azure OpenAI resource URL, e.g. https://my-resource.openai.azure.com. </param>
|
|
<param name="tokenCredential"> The authentication information for the Azure OpenAI resource. </param>
|
|
<param name="options"> Additional options for customizing the behavior of the client. </param>
|
|
<exception cref="T:System.ArgumentNullException">
|
|
<paramref name="endpoint" /> or <paramref name="tokenCredential" /> is null.
|
|
</exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.AssistantsClient.#ctor(System.Uri,Azure.Core.TokenCredential)">
|
|
<summary>
|
|
Creates a new instance of <see cref="T:Azure.AI.OpenAI.Assistants.AssistantsClient" /> for use with an Azure OpenAI resource.
|
|
</summary>
|
|
<param name="endpoint"> An Azure OpenAI resource URL, e.g. https://my-resource.openai.azure.com. </param>
|
|
<param name="tokenCredential"> The authentication information for the Azure OpenAI resource. </param>
|
|
<exception cref="T:System.ArgumentNullException">
|
|
<paramref name="endpoint" /> is null.
|
|
</exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.AssistantsClient.#ctor(System.String,Azure.AI.OpenAI.Assistants.AssistantsClientOptions)">
|
|
<summary>
|
|
Creates a new instance of <see cref="T:Azure.AI.OpenAI.Assistants.AssistantsClient" /> for use with OpenAI's api.openai.com endpoint.
|
|
</summary>
|
|
<param name="openAIApiKey"> An OpenAI API key as obtained from platform.openai.com. </param>
|
|
<param name="options"> Additional options for customizing the behavior of the client. </param>
|
|
<exception cref="T:System.ArgumentNullException"> <paramref name="openAIApiKey" /> is null. </exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.AssistantsClient.#ctor(System.String)">
|
|
<summary>
|
|
Creates a new instance of <see cref="T:Azure.AI.OpenAI.Assistants.AssistantsClient" /> for use with OpenAI's api.openai.com endpoint.
|
|
</summary>
|
|
<param name="openAIApiKey"> An OpenAI API key as obtained from platform.openai.com. </param>
|
|
<exception cref="T:System.ArgumentNullException"> <paramref name="openAIApiKey" /> is null. </exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.AssistantsClient.DeleteAssistant(System.String,System.Threading.CancellationToken)">
|
|
<summary> Deletes an assistant. </summary>
|
|
<param name="assistantId"> The ID of the assistant to delete. </param>
|
|
<param name="cancellationToken"> The cancellation token to use. </param>
|
|
<exception cref="T:System.ArgumentNullException"> <paramref name="assistantId" /> is null. </exception>
|
|
<exception cref="T:System.ArgumentException"> <paramref name="assistantId" /> is an empty string, and was expected to be non-empty. </exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.AssistantsClient.DeleteAssistantAsync(System.String,System.Threading.CancellationToken)">
|
|
<summary> Deletes an assistant. </summary>
|
|
<param name="assistantId"> The ID of the assistant to delete. </param>
|
|
<param name="cancellationToken"> The cancellation token to use. </param>
|
|
<exception cref="T:System.ArgumentNullException"> <paramref name="assistantId" /> is null. </exception>
|
|
<exception cref="T:System.ArgumentException"> <paramref name="assistantId" /> is an empty string, and was expected to be non-empty. </exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.AssistantsClient.DeleteThread(System.String,System.Threading.CancellationToken)">
|
|
<summary> Deletes a thread. </summary>
|
|
<param name="threadId"> The ID of the thread to delete. </param>
|
|
<param name="cancellationToken"> The cancellation token to use. </param>
|
|
<exception cref="T:System.ArgumentNullException"> <paramref name="threadId" /> is null. </exception>
|
|
<exception cref="T:System.ArgumentException"> <paramref name="threadId" /> is an empty string, and was expected to be non-empty. </exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.AssistantsClient.DeleteThreadAsync(System.String,System.Threading.CancellationToken)">
|
|
<summary> Deletes a thread. </summary>
|
|
<param name="threadId"> The ID of the thread to delete. </param>
|
|
<param name="cancellationToken"> The cancellation token to use. </param>
|
|
<exception cref="T:System.ArgumentNullException"> <paramref name="threadId" /> is null. </exception>
|
|
<exception cref="T:System.ArgumentException"> <paramref name="threadId" /> is an empty string, and was expected to be non-empty. </exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.AssistantsClient.UnlinkAssistantFile(System.String,System.String,System.Threading.CancellationToken)">
|
|
<summary> Associates a previously uploaded file with an assistant for use by supported tools. </summary>
|
|
<param name="assistantId"> The ID of the assistant associated with the attached file to delete. </param>
|
|
<param name="fileId"> The ID of the attached file to delete. </param>
|
|
<param name="cancellationToken"> The cancellation token to use. </param>
|
|
<exception cref="T:System.ArgumentNullException"> <paramref name="assistantId" /> or <paramref name="fileId" /> is null. </exception>
|
|
<exception cref="T:System.ArgumentException"> <paramref name="assistantId" /> or <paramref name="fileId" /> is an empty string, and was expected to be non-empty. </exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.AssistantsClient.UnlinkAssistantFileAsync(System.String,System.String,System.Threading.CancellationToken)">
|
|
<summary>
|
|
Removes an association between an uploaded file and an assistant, making it inaccessible to supported tools
|
|
for that assistant.
|
|
</summary>
|
|
<remarks>
|
|
This operation only removes the link between the file and assistant; it does not delete the file itself.
|
|
To delete the file, use <see cref="M:Azure.AI.OpenAI.Assistants.AssistantsClient.DeleteFile(System.String,System.Threading.CancellationToken)" />, instead.
|
|
</remarks>
|
|
<param name="assistantId"> The ID of the assistant associated with the attached file to delete. </param>
|
|
<param name="fileId"> The ID of the attached file to delete. </param>
|
|
<param name="cancellationToken"> The cancellation token to use. </param>
|
|
<exception cref="T:System.ArgumentNullException"> <paramref name="assistantId" /> or <paramref name="fileId" /> is null. </exception>
|
|
<exception cref="T:System.ArgumentException"> <paramref name="assistantId" /> or <paramref name="fileId" /> is an empty string, and was expected to be non-empty. </exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.AssistantsClient.GetFiles(System.Nullable{Azure.AI.OpenAI.Assistants.OpenAIFilePurpose},System.Threading.CancellationToken)">
|
|
<summary> Returns a list of files that belong to the user's organization. </summary>
|
|
<param name="purpose"> Limits files in the response to those with the specified purpose. </param>
|
|
<param name="cancellationToken"> The cancellation token to use. </param>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.AssistantsClient.GetFilesAsync(System.Nullable{Azure.AI.OpenAI.Assistants.OpenAIFilePurpose},System.Threading.CancellationToken)">
|
|
<summary> Returns a list of files that belong to the user's organization. </summary>
|
|
<param name="purpose"> Limits files in the response to those with the specified purpose. </param>
|
|
<param name="cancellationToken"> The cancellation token to use. </param>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.AssistantsClient.DeleteFile(System.String,System.Threading.CancellationToken)">
|
|
<summary> Delete a previously uploaded file. </summary>
|
|
<param name="fileId"> The ID of the file to delete. </param>
|
|
<param name="cancellationToken"> The cancellation token to use. </param>
|
|
<exception cref="T:System.ArgumentNullException"> <paramref name="fileId" /> is null. </exception>
|
|
<exception cref="T:System.ArgumentException"> <paramref name="fileId" /> is an empty string, and was expected to be non-empty. </exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.AssistantsClient.DeleteFileAsync(System.String,System.Threading.CancellationToken)">
|
|
<summary> Delete a previously uploaded file. </summary>
|
|
<param name="fileId"> The ID of the file to delete. </param>
|
|
<param name="cancellationToken"> The cancellation token to use. </param>
|
|
<exception cref="T:System.ArgumentNullException"> <paramref name="fileId" /> is null. </exception>
|
|
<exception cref="T:System.ArgumentException"> <paramref name="fileId" /> is an empty string, and was expected to be non-empty. </exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.AssistantsClient.GetAssistants(System.Nullable{System.Int32},System.Nullable{Azure.AI.OpenAI.Assistants.ListSortOrder},System.String,System.String,System.Threading.CancellationToken)">
|
|
<summary> Gets a list of assistants that were previously created. </summary>
|
|
<param name="limit"> A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20. </param>
|
|
<param name="order"> Sort order by the created_at timestamp of the objects. asc for ascending order and desc for descending order. </param>
|
|
<param name="after"> A cursor for use in pagination. after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include after=obj_foo in order to fetch the next page of the list. </param>
|
|
<param name="before"> A cursor for use in pagination. before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include before=obj_foo in order to fetch the previous page of the list. </param>
|
|
<param name="cancellationToken"> The cancellation token to use. </param>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.AssistantsClient.GetAssistantsAsync(System.Nullable{System.Int32},System.Nullable{Azure.AI.OpenAI.Assistants.ListSortOrder},System.String,System.String,System.Threading.CancellationToken)">
|
|
<summary> Gets a list of assistants that were previously created. </summary>
|
|
<param name="limit"> A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20. </param>
|
|
<param name="order"> Sort order by the created_at timestamp of the objects. asc for ascending order and desc for descending order. </param>
|
|
<param name="after"> A cursor for use in pagination. after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include after=obj_foo in order to fetch the next page of the list. </param>
|
|
<param name="before"> A cursor for use in pagination. before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include before=obj_foo in order to fetch the previous page of the list. </param>
|
|
<param name="cancellationToken"> The cancellation token to use. </param>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.AssistantsClient.GetAssistantFiles(System.String,System.Nullable{System.Int32},System.Nullable{Azure.AI.OpenAI.Assistants.ListSortOrder},System.String,System.String,System.Threading.CancellationToken)">
|
|
<summary> Gets a list of files attached to a specific assistant, as used by tools that can read files. </summary>
|
|
<param name="assistantId"> The ID of the assistant to retrieve the list of attached files for. </param>
|
|
<param name="limit"> A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20. </param>
|
|
<param name="order"> Sort order by the created_at timestamp of the objects. asc for ascending order and desc for descending order. </param>
|
|
<param name="after"> A cursor for use in pagination. after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include after=obj_foo in order to fetch the next page of the list. </param>
|
|
<param name="before"> A cursor for use in pagination. before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include before=obj_foo in order to fetch the previous page of the list. </param>
|
|
<param name="cancellationToken"> The cancellation token to use. </param>
|
|
<exception cref="T:System.ArgumentNullException"> <paramref name="assistantId" /> is null. </exception>
|
|
<exception cref="T:System.ArgumentException"> <paramref name="assistantId" /> is an empty string, and was expected to be non-empty. </exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.AssistantsClient.GetAssistantFilesAsync(System.String,System.Nullable{System.Int32},System.Nullable{Azure.AI.OpenAI.Assistants.ListSortOrder},System.String,System.String,System.Threading.CancellationToken)">
|
|
<summary> Gets a list of files attached to a specific assistant, as used by tools that can read files. </summary>
|
|
<param name="assistantId"> The ID of the assistant to retrieve the list of attached files for. </param>
|
|
<param name="limit"> A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20. </param>
|
|
<param name="order"> Sort order by the created_at timestamp of the objects. asc for ascending order and desc for descending order. </param>
|
|
<param name="after"> A cursor for use in pagination. after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include after=obj_foo in order to fetch the next page of the list. </param>
|
|
<param name="before"> A cursor for use in pagination. before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include before=obj_foo in order to fetch the previous page of the list. </param>
|
|
<param name="cancellationToken"> The cancellation token to use. </param>
|
|
<exception cref="T:System.ArgumentNullException"> <paramref name="assistantId" /> is null. </exception>
|
|
<exception cref="T:System.ArgumentException"> <paramref name="assistantId" /> is an empty string, and was expected to be non-empty. </exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.AssistantsClient.GetMessageFiles(System.String,System.String,System.Nullable{System.Int32},System.Nullable{Azure.AI.OpenAI.Assistants.ListSortOrder},System.String,System.String,System.Threading.CancellationToken)">
|
|
<summary> Gets a list of previously uploaded files associated with a message from a thread. </summary>
|
|
<param name="threadId"> The ID of the thread containing the message to list files from. </param>
|
|
<param name="messageId"> The ID of the message to list files from. </param>
|
|
<param name="limit"> A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20. </param>
|
|
<param name="order"> Sort order by the created_at timestamp of the objects. asc for ascending order and desc for descending order. </param>
|
|
<param name="after"> A cursor for use in pagination. after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include after=obj_foo in order to fetch the next page of the list. </param>
|
|
<param name="before"> A cursor for use in pagination. before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include before=obj_foo in order to fetch the previous page of the list. </param>
|
|
<param name="cancellationToken"> The cancellation token to use. </param>
|
|
<exception cref="T:System.ArgumentNullException"> <paramref name="threadId" /> or <paramref name="messageId" /> is null. </exception>
|
|
<exception cref="T:System.ArgumentException"> <paramref name="threadId" /> or <paramref name="messageId" /> is an empty string, and was expected to be non-empty. </exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.AssistantsClient.GetMessageFilesAsync(System.String,System.String,System.Nullable{System.Int32},System.Nullable{Azure.AI.OpenAI.Assistants.ListSortOrder},System.String,System.String,System.Threading.CancellationToken)">
|
|
<summary> Gets a list of previously uploaded files associated with a message from a thread. </summary>
|
|
<param name="threadId"> The ID of the thread containing the message to list files from. </param>
|
|
<param name="messageId"> The ID of the message to list files from. </param>
|
|
<param name="limit"> A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20. </param>
|
|
<param name="order"> Sort order by the created_at timestamp of the objects. asc for ascending order and desc for descending order. </param>
|
|
<param name="after"> A cursor for use in pagination. after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include after=obj_foo in order to fetch the next page of the list. </param>
|
|
<param name="before"> A cursor for use in pagination. before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include before=obj_foo in order to fetch the previous page of the list. </param>
|
|
<param name="cancellationToken"> The cancellation token to use. </param>
|
|
<exception cref="T:System.ArgumentNullException"> <paramref name="threadId" /> or <paramref name="messageId" /> is null. </exception>
|
|
<exception cref="T:System.ArgumentException"> <paramref name="threadId" /> or <paramref name="messageId" /> is an empty string, and was expected to be non-empty. </exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.AssistantsClient.GetRunSteps(System.String,System.String,System.Nullable{System.Int32},System.Nullable{Azure.AI.OpenAI.Assistants.ListSortOrder},System.String,System.String,System.Threading.CancellationToken)">
|
|
<summary> Gets a list of run steps from a thread run. </summary>
|
|
<param name="threadId"> The ID of the thread that was run. </param>
|
|
<param name="runId"> The ID of the run to list steps from. </param>
|
|
<param name="limit"> A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20. </param>
|
|
<param name="order"> Sort order by the created_at timestamp of the objects. asc for ascending order and desc for descending order. </param>
|
|
<param name="after"> A cursor for use in pagination. after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include after=obj_foo in order to fetch the next page of the list. </param>
|
|
<param name="before"> A cursor for use in pagination. before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include before=obj_foo in order to fetch the previous page of the list. </param>
|
|
<param name="cancellationToken"> The cancellation token to use. </param>
|
|
<exception cref="T:System.ArgumentNullException"> <paramref name="threadId" /> or <paramref name="runId" /> is null. </exception>
|
|
<exception cref="T:System.ArgumentException"> <paramref name="threadId" /> or <paramref name="runId" /> is an empty string, and was expected to be non-empty. </exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.AssistantsClient.GetRunStepsAsync(System.String,System.String,System.Nullable{System.Int32},System.Nullable{Azure.AI.OpenAI.Assistants.ListSortOrder},System.String,System.String,System.Threading.CancellationToken)">
|
|
<summary> Gets a list of run steps from a thread run. </summary>
|
|
<param name="threadId"> The ID of the thread that was run. </param>
|
|
<param name="runId"> The ID of the run to list steps from. </param>
|
|
<param name="limit"> A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20. </param>
|
|
<param name="order"> Sort order by the created_at timestamp of the objects. asc for ascending order and desc for descending order. </param>
|
|
<param name="after"> A cursor for use in pagination. after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include after=obj_foo in order to fetch the next page of the list. </param>
|
|
<param name="before"> A cursor for use in pagination. before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include before=obj_foo in order to fetch the previous page of the list. </param>
|
|
<param name="cancellationToken"> The cancellation token to use. </param>
|
|
<exception cref="T:System.ArgumentNullException"> <paramref name="threadId" /> or <paramref name="runId" /> is null. </exception>
|
|
<exception cref="T:System.ArgumentException"> <paramref name="threadId" /> or <paramref name="runId" /> is an empty string, and was expected to be non-empty. </exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.AssistantsClient.GetMessages(System.String,System.Nullable{System.Int32},System.Nullable{Azure.AI.OpenAI.Assistants.ListSortOrder},System.String,System.String,System.Threading.CancellationToken)">
|
|
<summary> Gets a list of messages that exist on a thread. </summary>
|
|
<param name="threadId"> The ID of the thread to list messages from. </param>
|
|
<param name="limit"> A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20. </param>
|
|
<param name="order"> Sort order by the created_at timestamp of the objects. asc for ascending order and desc for descending order. </param>
|
|
<param name="after"> A cursor for use in pagination. after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include after=obj_foo in order to fetch the next page of the list. </param>
|
|
<param name="before"> A cursor for use in pagination. before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include before=obj_foo in order to fetch the previous page of the list. </param>
|
|
<param name="cancellationToken"> The cancellation token to use. </param>
|
|
<exception cref="T:System.ArgumentNullException"> <paramref name="threadId" /> is null. </exception>
|
|
<exception cref="T:System.ArgumentException"> <paramref name="threadId" /> is an empty string, and was expected to be non-empty. </exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.AssistantsClient.GetMessagesAsync(System.String,System.Nullable{System.Int32},System.Nullable{Azure.AI.OpenAI.Assistants.ListSortOrder},System.String,System.String,System.Threading.CancellationToken)">
|
|
<summary> Gets a list of messages that exist on a thread. </summary>
|
|
<param name="threadId"> The ID of the thread to list messages from. </param>
|
|
<param name="limit"> A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20. </param>
|
|
<param name="order"> Sort order by the created_at timestamp of the objects. asc for ascending order and desc for descending order. </param>
|
|
<param name="after"> A cursor for use in pagination. after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include after=obj_foo in order to fetch the next page of the list. </param>
|
|
<param name="before"> A cursor for use in pagination. before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include before=obj_foo in order to fetch the previous page of the list. </param>
|
|
<param name="cancellationToken"> The cancellation token to use. </param>
|
|
<exception cref="T:System.ArgumentNullException"> <paramref name="threadId" /> is null. </exception>
|
|
<exception cref="T:System.ArgumentException"> <paramref name="threadId" /> is an empty string, and was expected to be non-empty. </exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.AssistantsClient.GetRuns(System.String,System.Nullable{System.Int32},System.Nullable{Azure.AI.OpenAI.Assistants.ListSortOrder},System.String,System.String,System.Threading.CancellationToken)">
|
|
<summary> Gets a list of runs for a specified thread. </summary>
|
|
<param name="threadId"> The ID of the thread to list runs from. </param>
|
|
<param name="limit"> A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20. </param>
|
|
<param name="order"> Sort order by the created_at timestamp of the objects. asc for ascending order and desc for descending order. </param>
|
|
<param name="after"> A cursor for use in pagination. after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include after=obj_foo in order to fetch the next page of the list. </param>
|
|
<param name="before"> A cursor for use in pagination. before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include before=obj_foo in order to fetch the previous page of the list. </param>
|
|
<param name="cancellationToken"> The cancellation token to use. </param>
|
|
<exception cref="T:System.ArgumentNullException"> <paramref name="threadId" /> is null. </exception>
|
|
<exception cref="T:System.ArgumentException"> <paramref name="threadId" /> is an empty string, and was expected to be non-empty. </exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.AssistantsClient.GetRunsAsync(System.String,System.Nullable{System.Int32},System.Nullable{Azure.AI.OpenAI.Assistants.ListSortOrder},System.String,System.String,System.Threading.CancellationToken)">
|
|
<summary> Gets a list of runs for a specified thread. </summary>
|
|
<param name="threadId"> The ID of the thread to list runs from. </param>
|
|
<param name="limit"> A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20. </param>
|
|
<param name="order"> Sort order by the created_at timestamp of the objects. asc for ascending order and desc for descending order. </param>
|
|
<param name="after"> A cursor for use in pagination. after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include after=obj_foo in order to fetch the next page of the list. </param>
|
|
<param name="before"> A cursor for use in pagination. before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include before=obj_foo in order to fetch the previous page of the list. </param>
|
|
<param name="cancellationToken"> The cancellation token to use. </param>
|
|
<exception cref="T:System.ArgumentNullException"> <paramref name="threadId" /> is null. </exception>
|
|
<exception cref="T:System.ArgumentException"> <paramref name="threadId" /> is an empty string, and was expected to be non-empty. </exception>
|
|
</member>
|
|
<member name="P:Azure.AI.OpenAI.Assistants.AssistantsClient.ClientDiagnostics">
|
|
<summary> The ClientDiagnostics is used to provide tracing support for the client library. </summary>
|
|
</member>
|
|
<member name="P:Azure.AI.OpenAI.Assistants.AssistantsClient.Pipeline">
|
|
<summary> The HTTP pipeline for sending and receiving REST requests and responses. </summary>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.AssistantsClient.#ctor">
|
|
<summary> Initializes a new instance of AssistantsClient for mocking. </summary>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.AssistantsClient.CreateAssistantAsync(Azure.AI.OpenAI.Assistants.AssistantCreationOptions,System.Threading.CancellationToken)">
|
|
<summary> Creates a new assistant. </summary>
|
|
<param name="assistantCreationOptions"> The request details to use when creating a new assistant. </param>
|
|
<param name="cancellationToken"> The cancellation token to use. </param>
|
|
<exception cref="T:System.ArgumentNullException"> <paramref name="assistantCreationOptions" /> is null. </exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.AssistantsClient.CreateAssistant(Azure.AI.OpenAI.Assistants.AssistantCreationOptions,System.Threading.CancellationToken)">
|
|
<summary> Creates a new assistant. </summary>
|
|
<param name="assistantCreationOptions"> The request details to use when creating a new assistant. </param>
|
|
<param name="cancellationToken"> The cancellation token to use. </param>
|
|
<exception cref="T:System.ArgumentNullException"> <paramref name="assistantCreationOptions" /> is null. </exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.AssistantsClient.CreateAssistantAsync(Azure.Core.RequestContent,Azure.RequestContext)">
|
|
<summary>
|
|
[Protocol Method] Creates a new assistant.
|
|
<list type="bullet">
|
|
<item>
|
|
<description>
|
|
This <see href="https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/core/Azure.Core/samples/ProtocolMethods.md">protocol method</see> allows explicit creation of the request and processing of the response for advanced scenarios.
|
|
</description>
|
|
</item>
|
|
</list>
|
|
</summary>
|
|
<param name="content"> The content to send as the body of the request. </param>
|
|
<param name="context"> The request context, which can override default behaviors of the client pipeline on a per-call basis. </param>
|
|
<exception cref="T:System.ArgumentNullException"> <paramref name="content" /> is null. </exception>
|
|
<exception cref="T:Azure.RequestFailedException"> Service returned a non-success status code. </exception>
|
|
<returns> The response returned from the service. </returns>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.AssistantsClient.CreateAssistant(Azure.Core.RequestContent,Azure.RequestContext)">
|
|
<summary>
|
|
[Protocol Method] Creates a new assistant.
|
|
<list type="bullet">
|
|
<item>
|
|
<description>
|
|
This <see href="https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/core/Azure.Core/samples/ProtocolMethods.md">protocol method</see> allows explicit creation of the request and processing of the response for advanced scenarios.
|
|
</description>
|
|
</item>
|
|
</list>
|
|
</summary>
|
|
<param name="content"> The content to send as the body of the request. </param>
|
|
<param name="context"> The request context, which can override default behaviors of the client pipeline on a per-call basis. </param>
|
|
<exception cref="T:System.ArgumentNullException"> <paramref name="content" /> is null. </exception>
|
|
<exception cref="T:Azure.RequestFailedException"> Service returned a non-success status code. </exception>
|
|
<returns> The response returned from the service. </returns>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.AssistantsClient.InternalGetAssistantsAsync(System.Nullable{System.Int32},System.Nullable{Azure.AI.OpenAI.Assistants.ListSortOrder},System.String,System.String,System.Threading.CancellationToken)">
|
|
<summary> Gets a list of assistants that were previously created. </summary>
|
|
<param name="limit"> A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20. </param>
|
|
<param name="order"> Sort order by the created_at timestamp of the objects. asc for ascending order and desc for descending order. </param>
|
|
<param name="after"> A cursor for use in pagination. after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include after=obj_foo in order to fetch the next page of the list. </param>
|
|
<param name="before"> A cursor for use in pagination. before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include before=obj_foo in order to fetch the previous page of the list. </param>
|
|
<param name="cancellationToken"> The cancellation token to use. </param>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.AssistantsClient.InternalGetAssistants(System.Nullable{System.Int32},System.Nullable{Azure.AI.OpenAI.Assistants.ListSortOrder},System.String,System.String,System.Threading.CancellationToken)">
|
|
<summary> Gets a list of assistants that were previously created. </summary>
|
|
<param name="limit"> A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20. </param>
|
|
<param name="order"> Sort order by the created_at timestamp of the objects. asc for ascending order and desc for descending order. </param>
|
|
<param name="after"> A cursor for use in pagination. after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include after=obj_foo in order to fetch the next page of the list. </param>
|
|
<param name="before"> A cursor for use in pagination. before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include before=obj_foo in order to fetch the previous page of the list. </param>
|
|
<param name="cancellationToken"> The cancellation token to use. </param>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.AssistantsClient.InternalGetAssistantsAsync(System.Nullable{System.Int32},System.String,System.String,System.String,Azure.RequestContext)">
|
|
<summary>
|
|
[Protocol Method] Gets a list of assistants that were previously created.
|
|
<list type="bullet">
|
|
<item>
|
|
<description>
|
|
This <see href="https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/core/Azure.Core/samples/ProtocolMethods.md">protocol method</see> allows explicit creation of the request and processing of the response for advanced scenarios.
|
|
</description>
|
|
</item>
|
|
<item>
|
|
<description>
|
|
Please try the simpler <see cref="M:Azure.AI.OpenAI.Assistants.AssistantsClient.InternalGetAssistantsAsync(System.Nullable{System.Int32},System.Nullable{Azure.AI.OpenAI.Assistants.ListSortOrder},System.String,System.String,System.Threading.CancellationToken)" /> convenience overload with strongly typed models first.
|
|
</description>
|
|
</item>
|
|
</list>
|
|
</summary>
|
|
<param name="limit"> A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20. </param>
|
|
<param name="order"> Sort order by the created_at timestamp of the objects. asc for ascending order and desc for descending order. Allowed values: "asc" | "desc". </param>
|
|
<param name="after"> A cursor for use in pagination. after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include after=obj_foo in order to fetch the next page of the list. </param>
|
|
<param name="before"> A cursor for use in pagination. before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include before=obj_foo in order to fetch the previous page of the list. </param>
|
|
<param name="context"> The request context, which can override default behaviors of the client pipeline on a per-call basis. </param>
|
|
<exception cref="T:Azure.RequestFailedException"> Service returned a non-success status code. </exception>
|
|
<returns> The response returned from the service. </returns>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.AssistantsClient.InternalGetAssistants(System.Nullable{System.Int32},System.String,System.String,System.String,Azure.RequestContext)">
|
|
<summary>
|
|
[Protocol Method] Gets a list of assistants that were previously created.
|
|
<list type="bullet">
|
|
<item>
|
|
<description>
|
|
This <see href="https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/core/Azure.Core/samples/ProtocolMethods.md">protocol method</see> allows explicit creation of the request and processing of the response for advanced scenarios.
|
|
</description>
|
|
</item>
|
|
<item>
|
|
<description>
|
|
Please try the simpler <see cref="M:Azure.AI.OpenAI.Assistants.AssistantsClient.InternalGetAssistants(System.Nullable{System.Int32},System.Nullable{Azure.AI.OpenAI.Assistants.ListSortOrder},System.String,System.String,System.Threading.CancellationToken)" /> convenience overload with strongly typed models first.
|
|
</description>
|
|
</item>
|
|
</list>
|
|
</summary>
|
|
<param name="limit"> A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20. </param>
|
|
<param name="order"> Sort order by the created_at timestamp of the objects. asc for ascending order and desc for descending order. Allowed values: "asc" | "desc". </param>
|
|
<param name="after"> A cursor for use in pagination. after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include after=obj_foo in order to fetch the next page of the list. </param>
|
|
<param name="before"> A cursor for use in pagination. before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include before=obj_foo in order to fetch the previous page of the list. </param>
|
|
<param name="context"> The request context, which can override default behaviors of the client pipeline on a per-call basis. </param>
|
|
<exception cref="T:Azure.RequestFailedException"> Service returned a non-success status code. </exception>
|
|
<returns> The response returned from the service. </returns>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.AssistantsClient.GetAssistantAsync(System.String,System.Threading.CancellationToken)">
|
|
<summary> Retrieves an existing assistant. </summary>
|
|
<param name="assistantId"> The ID of the assistant to retrieve. </param>
|
|
<param name="cancellationToken"> The cancellation token to use. </param>
|
|
<exception cref="T:System.ArgumentNullException"> <paramref name="assistantId" /> is null. </exception>
|
|
<exception cref="T:System.ArgumentException"> <paramref name="assistantId" /> is an empty string, and was expected to be non-empty. </exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.AssistantsClient.GetAssistant(System.String,System.Threading.CancellationToken)">
|
|
<summary> Retrieves an existing assistant. </summary>
|
|
<param name="assistantId"> The ID of the assistant to retrieve. </param>
|
|
<param name="cancellationToken"> The cancellation token to use. </param>
|
|
<exception cref="T:System.ArgumentNullException"> <paramref name="assistantId" /> is null. </exception>
|
|
<exception cref="T:System.ArgumentException"> <paramref name="assistantId" /> is an empty string, and was expected to be non-empty. </exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.AssistantsClient.GetAssistantAsync(System.String,Azure.RequestContext)">
|
|
<summary>
|
|
[Protocol Method] Retrieves an existing assistant.
|
|
<list type="bullet">
|
|
<item>
|
|
<description>
|
|
This <see href="https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/core/Azure.Core/samples/ProtocolMethods.md">protocol method</see> allows explicit creation of the request and processing of the response for advanced scenarios.
|
|
</description>
|
|
</item>
|
|
</list>
|
|
</summary>
|
|
<param name="assistantId"> The ID of the assistant to retrieve. </param>
|
|
<param name="context"> The request context, which can override default behaviors of the client pipeline on a per-call basis. </param>
|
|
<exception cref="T:System.ArgumentNullException"> <paramref name="assistantId" /> is null. </exception>
|
|
<exception cref="T:System.ArgumentException"> <paramref name="assistantId" /> is an empty string, and was expected to be non-empty. </exception>
|
|
<exception cref="T:Azure.RequestFailedException"> Service returned a non-success status code. </exception>
|
|
<returns> The response returned from the service. </returns>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.AssistantsClient.GetAssistant(System.String,Azure.RequestContext)">
|
|
<summary>
|
|
[Protocol Method] Retrieves an existing assistant.
|
|
<list type="bullet">
|
|
<item>
|
|
<description>
|
|
This <see href="https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/core/Azure.Core/samples/ProtocolMethods.md">protocol method</see> allows explicit creation of the request and processing of the response for advanced scenarios.
|
|
</description>
|
|
</item>
|
|
</list>
|
|
</summary>
|
|
<param name="assistantId"> The ID of the assistant to retrieve. </param>
|
|
<param name="context"> The request context, which can override default behaviors of the client pipeline on a per-call basis. </param>
|
|
<exception cref="T:System.ArgumentNullException"> <paramref name="assistantId" /> is null. </exception>
|
|
<exception cref="T:System.ArgumentException"> <paramref name="assistantId" /> is an empty string, and was expected to be non-empty. </exception>
|
|
<exception cref="T:Azure.RequestFailedException"> Service returned a non-success status code. </exception>
|
|
<returns> The response returned from the service. </returns>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.AssistantsClient.UpdateAssistantAsync(System.String,Azure.AI.OpenAI.Assistants.UpdateAssistantOptions,System.Threading.CancellationToken)">
|
|
<summary> Modifies an existing assistant. </summary>
|
|
<param name="assistantId"> The ID of the assistant to modify. </param>
|
|
<param name="updateAssistantOptions"> The request details to use when modifying an existing assistant. </param>
|
|
<param name="cancellationToken"> The cancellation token to use. </param>
|
|
<exception cref="T:System.ArgumentNullException"> <paramref name="assistantId" /> or <paramref name="updateAssistantOptions" /> is null. </exception>
|
|
<exception cref="T:System.ArgumentException"> <paramref name="assistantId" /> is an empty string, and was expected to be non-empty. </exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.AssistantsClient.UpdateAssistant(System.String,Azure.AI.OpenAI.Assistants.UpdateAssistantOptions,System.Threading.CancellationToken)">
|
|
<summary> Modifies an existing assistant. </summary>
|
|
<param name="assistantId"> The ID of the assistant to modify. </param>
|
|
<param name="updateAssistantOptions"> The request details to use when modifying an existing assistant. </param>
|
|
<param name="cancellationToken"> The cancellation token to use. </param>
|
|
<exception cref="T:System.ArgumentNullException"> <paramref name="assistantId" /> or <paramref name="updateAssistantOptions" /> is null. </exception>
|
|
<exception cref="T:System.ArgumentException"> <paramref name="assistantId" /> is an empty string, and was expected to be non-empty. </exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.AssistantsClient.UpdateAssistantAsync(System.String,Azure.Core.RequestContent,Azure.RequestContext)">
|
|
<summary>
|
|
[Protocol Method] Modifies an existing assistant.
|
|
<list type="bullet">
|
|
<item>
|
|
<description>
|
|
This <see href="https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/core/Azure.Core/samples/ProtocolMethods.md">protocol method</see> allows explicit creation of the request and processing of the response for advanced scenarios.
|
|
</description>
|
|
</item>
|
|
</list>
|
|
</summary>
|
|
<param name="assistantId"> The ID of the assistant to modify. </param>
|
|
<param name="content"> The content to send as the body of the request. </param>
|
|
<param name="context"> The request context, which can override default behaviors of the client pipeline on a per-call basis. </param>
|
|
<exception cref="T:System.ArgumentNullException"> <paramref name="assistantId" /> or <paramref name="content" /> is null. </exception>
|
|
<exception cref="T:System.ArgumentException"> <paramref name="assistantId" /> is an empty string, and was expected to be non-empty. </exception>
|
|
<exception cref="T:Azure.RequestFailedException"> Service returned a non-success status code. </exception>
|
|
<returns> The response returned from the service. </returns>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.AssistantsClient.UpdateAssistant(System.String,Azure.Core.RequestContent,Azure.RequestContext)">
|
|
<summary>
|
|
[Protocol Method] Modifies an existing assistant.
|
|
<list type="bullet">
|
|
<item>
|
|
<description>
|
|
This <see href="https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/core/Azure.Core/samples/ProtocolMethods.md">protocol method</see> allows explicit creation of the request and processing of the response for advanced scenarios.
|
|
</description>
|
|
</item>
|
|
</list>
|
|
</summary>
|
|
<param name="assistantId"> The ID of the assistant to modify. </param>
|
|
<param name="content"> The content to send as the body of the request. </param>
|
|
<param name="context"> The request context, which can override default behaviors of the client pipeline on a per-call basis. </param>
|
|
<exception cref="T:System.ArgumentNullException"> <paramref name="assistantId" /> or <paramref name="content" /> is null. </exception>
|
|
<exception cref="T:System.ArgumentException"> <paramref name="assistantId" /> is an empty string, and was expected to be non-empty. </exception>
|
|
<exception cref="T:Azure.RequestFailedException"> Service returned a non-success status code. </exception>
|
|
<returns> The response returned from the service. </returns>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.AssistantsClient.InternalDeleteAssistantAsync(System.String,System.Threading.CancellationToken)">
|
|
<summary> Deletes an assistant. </summary>
|
|
<param name="assistantId"> The ID of the assistant to delete. </param>
|
|
<param name="cancellationToken"> The cancellation token to use. </param>
|
|
<exception cref="T:System.ArgumentNullException"> <paramref name="assistantId" /> is null. </exception>
|
|
<exception cref="T:System.ArgumentException"> <paramref name="assistantId" /> is an empty string, and was expected to be non-empty. </exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.AssistantsClient.InternalDeleteAssistant(System.String,System.Threading.CancellationToken)">
|
|
<summary> Deletes an assistant. </summary>
|
|
<param name="assistantId"> The ID of the assistant to delete. </param>
|
|
<param name="cancellationToken"> The cancellation token to use. </param>
|
|
<exception cref="T:System.ArgumentNullException"> <paramref name="assistantId" /> is null. </exception>
|
|
<exception cref="T:System.ArgumentException"> <paramref name="assistantId" /> is an empty string, and was expected to be non-empty. </exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.AssistantsClient.InternalDeleteAssistantAsync(System.String,Azure.RequestContext)">
|
|
<summary>
|
|
[Protocol Method] Deletes an assistant.
|
|
<list type="bullet">
|
|
<item>
|
|
<description>
|
|
This <see href="https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/core/Azure.Core/samples/ProtocolMethods.md">protocol method</see> allows explicit creation of the request and processing of the response for advanced scenarios.
|
|
</description>
|
|
</item>
|
|
<item>
|
|
<description>
|
|
Please try the simpler <see cref="M:Azure.AI.OpenAI.Assistants.AssistantsClient.InternalDeleteAssistantAsync(System.String,System.Threading.CancellationToken)" /> convenience overload with strongly typed models first.
|
|
</description>
|
|
</item>
|
|
</list>
|
|
</summary>
|
|
<param name="assistantId"> The ID of the assistant to delete. </param>
|
|
<param name="context"> The request context, which can override default behaviors of the client pipeline on a per-call basis. </param>
|
|
<exception cref="T:System.ArgumentNullException"> <paramref name="assistantId" /> is null. </exception>
|
|
<exception cref="T:System.ArgumentException"> <paramref name="assistantId" /> is an empty string, and was expected to be non-empty. </exception>
|
|
<exception cref="T:Azure.RequestFailedException"> Service returned a non-success status code. </exception>
|
|
<returns> The response returned from the service. </returns>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.AssistantsClient.InternalDeleteAssistant(System.String,Azure.RequestContext)">
|
|
<summary>
|
|
[Protocol Method] Deletes an assistant.
|
|
<list type="bullet">
|
|
<item>
|
|
<description>
|
|
This <see href="https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/core/Azure.Core/samples/ProtocolMethods.md">protocol method</see> allows explicit creation of the request and processing of the response for advanced scenarios.
|
|
</description>
|
|
</item>
|
|
<item>
|
|
<description>
|
|
Please try the simpler <see cref="M:Azure.AI.OpenAI.Assistants.AssistantsClient.InternalDeleteAssistant(System.String,System.Threading.CancellationToken)" /> convenience overload with strongly typed models first.
|
|
</description>
|
|
</item>
|
|
</list>
|
|
</summary>
|
|
<param name="assistantId"> The ID of the assistant to delete. </param>
|
|
<param name="context"> The request context, which can override default behaviors of the client pipeline on a per-call basis. </param>
|
|
<exception cref="T:System.ArgumentNullException"> <paramref name="assistantId" /> is null. </exception>
|
|
<exception cref="T:System.ArgumentException"> <paramref name="assistantId" /> is an empty string, and was expected to be non-empty. </exception>
|
|
<exception cref="T:Azure.RequestFailedException"> Service returned a non-success status code. </exception>
|
|
<returns> The response returned from the service. </returns>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.AssistantsClient.LinkAssistantFileAsync(System.String,System.String,System.Threading.CancellationToken)">
|
|
<summary> Attaches a previously uploaded file to an assistant for use by tools that can read files. </summary>
|
|
<param name="assistantId"> The ID of the assistant to attach the file to. </param>
|
|
<param name="fileId"> The ID of the previously uploaded file to attach. </param>
|
|
<param name="cancellationToken"> The cancellation token to use. </param>
|
|
<exception cref="T:System.ArgumentNullException"> <paramref name="assistantId" /> or <paramref name="fileId" /> is null. </exception>
|
|
<exception cref="T:System.ArgumentException"> <paramref name="assistantId" /> is an empty string, and was expected to be non-empty. </exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.AssistantsClient.LinkAssistantFile(System.String,System.String,System.Threading.CancellationToken)">
|
|
<summary> Attaches a previously uploaded file to an assistant for use by tools that can read files. </summary>
|
|
<param name="assistantId"> The ID of the assistant to attach the file to. </param>
|
|
<param name="fileId"> The ID of the previously uploaded file to attach. </param>
|
|
<param name="cancellationToken"> The cancellation token to use. </param>
|
|
<exception cref="T:System.ArgumentNullException"> <paramref name="assistantId" /> or <paramref name="fileId" /> is null. </exception>
|
|
<exception cref="T:System.ArgumentException"> <paramref name="assistantId" /> is an empty string, and was expected to be non-empty. </exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.AssistantsClient.LinkAssistantFileAsync(System.String,Azure.Core.RequestContent,Azure.RequestContext)">
|
|
<summary>
|
|
[Protocol Method] Attaches a previously uploaded file to an assistant for use by tools that can read files.
|
|
<list type="bullet">
|
|
<item>
|
|
<description>
|
|
This <see href="https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/core/Azure.Core/samples/ProtocolMethods.md">protocol method</see> allows explicit creation of the request and processing of the response for advanced scenarios.
|
|
</description>
|
|
</item>
|
|
</list>
|
|
</summary>
|
|
<param name="assistantId"> The ID of the assistant to attach the file to. </param>
|
|
<param name="content"> The content to send as the body of the request. </param>
|
|
<param name="context"> The request context, which can override default behaviors of the client pipeline on a per-call basis. </param>
|
|
<exception cref="T:System.ArgumentNullException"> <paramref name="assistantId" /> or <paramref name="content" /> is null. </exception>
|
|
<exception cref="T:System.ArgumentException"> <paramref name="assistantId" /> is an empty string, and was expected to be non-empty. </exception>
|
|
<exception cref="T:Azure.RequestFailedException"> Service returned a non-success status code. </exception>
|
|
<returns> The response returned from the service. </returns>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.AssistantsClient.LinkAssistantFile(System.String,Azure.Core.RequestContent,Azure.RequestContext)">
|
|
<summary>
|
|
[Protocol Method] Attaches a previously uploaded file to an assistant for use by tools that can read files.
|
|
<list type="bullet">
|
|
<item>
|
|
<description>
|
|
This <see href="https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/core/Azure.Core/samples/ProtocolMethods.md">protocol method</see> allows explicit creation of the request and processing of the response for advanced scenarios.
|
|
</description>
|
|
</item>
|
|
</list>
|
|
</summary>
|
|
<param name="assistantId"> The ID of the assistant to attach the file to. </param>
|
|
<param name="content"> The content to send as the body of the request. </param>
|
|
<param name="context"> The request context, which can override default behaviors of the client pipeline on a per-call basis. </param>
|
|
<exception cref="T:System.ArgumentNullException"> <paramref name="assistantId" /> or <paramref name="content" /> is null. </exception>
|
|
<exception cref="T:System.ArgumentException"> <paramref name="assistantId" /> is an empty string, and was expected to be non-empty. </exception>
|
|
<exception cref="T:Azure.RequestFailedException"> Service returned a non-success status code. </exception>
|
|
<returns> The response returned from the service. </returns>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.AssistantsClient.InternalGetAssistantFilesAsync(System.String,System.Nullable{System.Int32},System.Nullable{Azure.AI.OpenAI.Assistants.ListSortOrder},System.String,System.String,System.Threading.CancellationToken)">
|
|
<summary> Gets a list of files attached to a specific assistant, as used by tools that can read files. </summary>
|
|
<param name="assistantId"> The ID of the assistant to retrieve the list of attached files for. </param>
|
|
<param name="limit"> A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20. </param>
|
|
<param name="order"> Sort order by the created_at timestamp of the objects. asc for ascending order and desc for descending order. </param>
|
|
<param name="after"> A cursor for use in pagination. after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include after=obj_foo in order to fetch the next page of the list. </param>
|
|
<param name="before"> A cursor for use in pagination. before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include before=obj_foo in order to fetch the previous page of the list. </param>
|
|
<param name="cancellationToken"> The cancellation token to use. </param>
|
|
<exception cref="T:System.ArgumentNullException"> <paramref name="assistantId" /> is null. </exception>
|
|
<exception cref="T:System.ArgumentException"> <paramref name="assistantId" /> is an empty string, and was expected to be non-empty. </exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.AssistantsClient.InternalGetAssistantFiles(System.String,System.Nullable{System.Int32},System.Nullable{Azure.AI.OpenAI.Assistants.ListSortOrder},System.String,System.String,System.Threading.CancellationToken)">
|
|
<summary> Gets a list of files attached to a specific assistant, as used by tools that can read files. </summary>
|
|
<param name="assistantId"> The ID of the assistant to retrieve the list of attached files for. </param>
|
|
<param name="limit"> A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20. </param>
|
|
<param name="order"> Sort order by the created_at timestamp of the objects. asc for ascending order and desc for descending order. </param>
|
|
<param name="after"> A cursor for use in pagination. after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include after=obj_foo in order to fetch the next page of the list. </param>
|
|
<param name="before"> A cursor for use in pagination. before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include before=obj_foo in order to fetch the previous page of the list. </param>
|
|
<param name="cancellationToken"> The cancellation token to use. </param>
|
|
<exception cref="T:System.ArgumentNullException"> <paramref name="assistantId" /> is null. </exception>
|
|
<exception cref="T:System.ArgumentException"> <paramref name="assistantId" /> is an empty string, and was expected to be non-empty. </exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.AssistantsClient.InternalGetAssistantFilesAsync(System.String,System.Nullable{System.Int32},System.String,System.String,System.String,Azure.RequestContext)">
|
|
<summary>
|
|
[Protocol Method] Gets a list of files attached to a specific assistant, as used by tools that can read files.
|
|
<list type="bullet">
|
|
<item>
|
|
<description>
|
|
This <see href="https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/core/Azure.Core/samples/ProtocolMethods.md">protocol method</see> allows explicit creation of the request and processing of the response for advanced scenarios.
|
|
</description>
|
|
</item>
|
|
<item>
|
|
<description>
|
|
Please try the simpler <see cref="M:Azure.AI.OpenAI.Assistants.AssistantsClient.InternalGetAssistantFilesAsync(System.String,System.Nullable{System.Int32},System.Nullable{Azure.AI.OpenAI.Assistants.ListSortOrder},System.String,System.String,System.Threading.CancellationToken)" /> convenience overload with strongly typed models first.
|
|
</description>
|
|
</item>
|
|
</list>
|
|
</summary>
|
|
<param name="assistantId"> The ID of the assistant to retrieve the list of attached files for. </param>
|
|
<param name="limit"> A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20. </param>
|
|
<param name="order"> Sort order by the created_at timestamp of the objects. asc for ascending order and desc for descending order. Allowed values: "asc" | "desc". </param>
|
|
<param name="after"> A cursor for use in pagination. after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include after=obj_foo in order to fetch the next page of the list. </param>
|
|
<param name="before"> A cursor for use in pagination. before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include before=obj_foo in order to fetch the previous page of the list. </param>
|
|
<param name="context"> The request context, which can override default behaviors of the client pipeline on a per-call basis. </param>
|
|
<exception cref="T:System.ArgumentNullException"> <paramref name="assistantId" /> is null. </exception>
|
|
<exception cref="T:System.ArgumentException"> <paramref name="assistantId" /> is an empty string, and was expected to be non-empty. </exception>
|
|
<exception cref="T:Azure.RequestFailedException"> Service returned a non-success status code. </exception>
|
|
<returns> The response returned from the service. </returns>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.AssistantsClient.InternalGetAssistantFiles(System.String,System.Nullable{System.Int32},System.String,System.String,System.String,Azure.RequestContext)">
|
|
<summary>
|
|
[Protocol Method] Gets a list of files attached to a specific assistant, as used by tools that can read files.
|
|
<list type="bullet">
|
|
<item>
|
|
<description>
|
|
This <see href="https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/core/Azure.Core/samples/ProtocolMethods.md">protocol method</see> allows explicit creation of the request and processing of the response for advanced scenarios.
|
|
</description>
|
|
</item>
|
|
<item>
|
|
<description>
|
|
Please try the simpler <see cref="M:Azure.AI.OpenAI.Assistants.AssistantsClient.InternalGetAssistantFiles(System.String,System.Nullable{System.Int32},System.Nullable{Azure.AI.OpenAI.Assistants.ListSortOrder},System.String,System.String,System.Threading.CancellationToken)" /> convenience overload with strongly typed models first.
|
|
</description>
|
|
</item>
|
|
</list>
|
|
</summary>
|
|
<param name="assistantId"> The ID of the assistant to retrieve the list of attached files for. </param>
|
|
<param name="limit"> A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20. </param>
|
|
<param name="order"> Sort order by the created_at timestamp of the objects. asc for ascending order and desc for descending order. Allowed values: "asc" | "desc". </param>
|
|
<param name="after"> A cursor for use in pagination. after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include after=obj_foo in order to fetch the next page of the list. </param>
|
|
<param name="before"> A cursor for use in pagination. before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include before=obj_foo in order to fetch the previous page of the list. </param>
|
|
<param name="context"> The request context, which can override default behaviors of the client pipeline on a per-call basis. </param>
|
|
<exception cref="T:System.ArgumentNullException"> <paramref name="assistantId" /> is null. </exception>
|
|
<exception cref="T:System.ArgumentException"> <paramref name="assistantId" /> is an empty string, and was expected to be non-empty. </exception>
|
|
<exception cref="T:Azure.RequestFailedException"> Service returned a non-success status code. </exception>
|
|
<returns> The response returned from the service. </returns>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.AssistantsClient.GetAssistantFileAsync(System.String,System.String,System.Threading.CancellationToken)">
|
|
<summary> Retrieves a file attached to an assistant. </summary>
|
|
<param name="assistantId"> The ID of the assistant associated with the attached file. </param>
|
|
<param name="fileId"> The ID of the file to retrieve. </param>
|
|
<param name="cancellationToken"> The cancellation token to use. </param>
|
|
<exception cref="T:System.ArgumentNullException"> <paramref name="assistantId" /> or <paramref name="fileId" /> is null. </exception>
|
|
<exception cref="T:System.ArgumentException"> <paramref name="assistantId" /> or <paramref name="fileId" /> is an empty string, and was expected to be non-empty. </exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.AssistantsClient.GetAssistantFile(System.String,System.String,System.Threading.CancellationToken)">
|
|
<summary> Retrieves a file attached to an assistant. </summary>
|
|
<param name="assistantId"> The ID of the assistant associated with the attached file. </param>
|
|
<param name="fileId"> The ID of the file to retrieve. </param>
|
|
<param name="cancellationToken"> The cancellation token to use. </param>
|
|
<exception cref="T:System.ArgumentNullException"> <paramref name="assistantId" /> or <paramref name="fileId" /> is null. </exception>
|
|
<exception cref="T:System.ArgumentException"> <paramref name="assistantId" /> or <paramref name="fileId" /> is an empty string, and was expected to be non-empty. </exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.AssistantsClient.GetAssistantFileAsync(System.String,System.String,Azure.RequestContext)">
|
|
<summary>
|
|
[Protocol Method] Retrieves a file attached to an assistant.
|
|
<list type="bullet">
|
|
<item>
|
|
<description>
|
|
This <see href="https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/core/Azure.Core/samples/ProtocolMethods.md">protocol method</see> allows explicit creation of the request and processing of the response for advanced scenarios.
|
|
</description>
|
|
</item>
|
|
</list>
|
|
</summary>
|
|
<param name="assistantId"> The ID of the assistant associated with the attached file. </param>
|
|
<param name="fileId"> The ID of the file to retrieve. </param>
|
|
<param name="context"> The request context, which can override default behaviors of the client pipeline on a per-call basis. </param>
|
|
<exception cref="T:System.ArgumentNullException"> <paramref name="assistantId" /> or <paramref name="fileId" /> is null. </exception>
|
|
<exception cref="T:System.ArgumentException"> <paramref name="assistantId" /> or <paramref name="fileId" /> is an empty string, and was expected to be non-empty. </exception>
|
|
<exception cref="T:Azure.RequestFailedException"> Service returned a non-success status code. </exception>
|
|
<returns> The response returned from the service. </returns>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.AssistantsClient.GetAssistantFile(System.String,System.String,Azure.RequestContext)">
|
|
<summary>
|
|
[Protocol Method] Retrieves a file attached to an assistant.
|
|
<list type="bullet">
|
|
<item>
|
|
<description>
|
|
This <see href="https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/core/Azure.Core/samples/ProtocolMethods.md">protocol method</see> allows explicit creation of the request and processing of the response for advanced scenarios.
|
|
</description>
|
|
</item>
|
|
</list>
|
|
</summary>
|
|
<param name="assistantId"> The ID of the assistant associated with the attached file. </param>
|
|
<param name="fileId"> The ID of the file to retrieve. </param>
|
|
<param name="context"> The request context, which can override default behaviors of the client pipeline on a per-call basis. </param>
|
|
<exception cref="T:System.ArgumentNullException"> <paramref name="assistantId" /> or <paramref name="fileId" /> is null. </exception>
|
|
<exception cref="T:System.ArgumentException"> <paramref name="assistantId" /> or <paramref name="fileId" /> is an empty string, and was expected to be non-empty. </exception>
|
|
<exception cref="T:Azure.RequestFailedException"> Service returned a non-success status code. </exception>
|
|
<returns> The response returned from the service. </returns>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.AssistantsClient.InternalUnlinkAssistantFileAsync(System.String,System.String,System.Threading.CancellationToken)">
|
|
<summary>
|
|
Unlinks a previously attached file from an assistant, rendering it unavailable for use by tools that can read
|
|
files.
|
|
</summary>
|
|
<param name="assistantId"> The ID of the assistant from which the specified file should be unlinked. </param>
|
|
<param name="fileId"> The ID of the file to unlink from the specified assistant. </param>
|
|
<param name="cancellationToken"> The cancellation token to use. </param>
|
|
<exception cref="T:System.ArgumentNullException"> <paramref name="assistantId" /> or <paramref name="fileId" /> is null. </exception>
|
|
<exception cref="T:System.ArgumentException"> <paramref name="assistantId" /> or <paramref name="fileId" /> is an empty string, and was expected to be non-empty. </exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.AssistantsClient.InternalUnlinkAssistantFile(System.String,System.String,System.Threading.CancellationToken)">
|
|
<summary>
|
|
Unlinks a previously attached file from an assistant, rendering it unavailable for use by tools that can read
|
|
files.
|
|
</summary>
|
|
<param name="assistantId"> The ID of the assistant from which the specified file should be unlinked. </param>
|
|
<param name="fileId"> The ID of the file to unlink from the specified assistant. </param>
|
|
<param name="cancellationToken"> The cancellation token to use. </param>
|
|
<exception cref="T:System.ArgumentNullException"> <paramref name="assistantId" /> or <paramref name="fileId" /> is null. </exception>
|
|
<exception cref="T:System.ArgumentException"> <paramref name="assistantId" /> or <paramref name="fileId" /> is an empty string, and was expected to be non-empty. </exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.AssistantsClient.InternalUnlinkAssistantFileAsync(System.String,System.String,Azure.RequestContext)">
|
|
<summary>
|
|
[Protocol Method] Unlinks a previously attached file from an assistant, rendering it unavailable for use by tools that can read
|
|
files.
|
|
<list type="bullet">
|
|
<item>
|
|
<description>
|
|
This <see href="https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/core/Azure.Core/samples/ProtocolMethods.md">protocol method</see> allows explicit creation of the request and processing of the response for advanced scenarios.
|
|
</description>
|
|
</item>
|
|
<item>
|
|
<description>
|
|
Please try the simpler <see cref="M:Azure.AI.OpenAI.Assistants.AssistantsClient.InternalUnlinkAssistantFileAsync(System.String,System.String,System.Threading.CancellationToken)" /> convenience overload with strongly typed models first.
|
|
</description>
|
|
</item>
|
|
</list>
|
|
</summary>
|
|
<param name="assistantId"> The ID of the assistant from which the specified file should be unlinked. </param>
|
|
<param name="fileId"> The ID of the file to unlink from the specified assistant. </param>
|
|
<param name="context"> The request context, which can override default behaviors of the client pipeline on a per-call basis. </param>
|
|
<exception cref="T:System.ArgumentNullException"> <paramref name="assistantId" /> or <paramref name="fileId" /> is null. </exception>
|
|
<exception cref="T:System.ArgumentException"> <paramref name="assistantId" /> or <paramref name="fileId" /> is an empty string, and was expected to be non-empty. </exception>
|
|
<exception cref="T:Azure.RequestFailedException"> Service returned a non-success status code. </exception>
|
|
<returns> The response returned from the service. </returns>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.AssistantsClient.InternalUnlinkAssistantFile(System.String,System.String,Azure.RequestContext)">
|
|
<summary>
|
|
[Protocol Method] Unlinks a previously attached file from an assistant, rendering it unavailable for use by tools that can read
|
|
files.
|
|
<list type="bullet">
|
|
<item>
|
|
<description>
|
|
This <see href="https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/core/Azure.Core/samples/ProtocolMethods.md">protocol method</see> allows explicit creation of the request and processing of the response for advanced scenarios.
|
|
</description>
|
|
</item>
|
|
<item>
|
|
<description>
|
|
Please try the simpler <see cref="M:Azure.AI.OpenAI.Assistants.AssistantsClient.InternalUnlinkAssistantFile(System.String,System.String,System.Threading.CancellationToken)" /> convenience overload with strongly typed models first.
|
|
</description>
|
|
</item>
|
|
</list>
|
|
</summary>
|
|
<param name="assistantId"> The ID of the assistant from which the specified file should be unlinked. </param>
|
|
<param name="fileId"> The ID of the file to unlink from the specified assistant. </param>
|
|
<param name="context"> The request context, which can override default behaviors of the client pipeline on a per-call basis. </param>
|
|
<exception cref="T:System.ArgumentNullException"> <paramref name="assistantId" /> or <paramref name="fileId" /> is null. </exception>
|
|
<exception cref="T:System.ArgumentException"> <paramref name="assistantId" /> or <paramref name="fileId" /> is an empty string, and was expected to be non-empty. </exception>
|
|
<exception cref="T:Azure.RequestFailedException"> Service returned a non-success status code. </exception>
|
|
<returns> The response returned from the service. </returns>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.AssistantsClient.CreateThreadAsync(Azure.AI.OpenAI.Assistants.AssistantThreadCreationOptions,System.Threading.CancellationToken)">
|
|
<summary> Creates a new thread. Threads contain messages and can be run by assistants. </summary>
|
|
<param name="assistantThreadCreationOptions"> The details used to create a new assistant thread. </param>
|
|
<param name="cancellationToken"> The cancellation token to use. </param>
|
|
<exception cref="T:System.ArgumentNullException"> <paramref name="assistantThreadCreationOptions" /> is null. </exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.AssistantsClient.CreateThread(Azure.AI.OpenAI.Assistants.AssistantThreadCreationOptions,System.Threading.CancellationToken)">
|
|
<summary> Creates a new thread. Threads contain messages and can be run by assistants. </summary>
|
|
<param name="assistantThreadCreationOptions"> The details used to create a new assistant thread. </param>
|
|
<param name="cancellationToken"> The cancellation token to use. </param>
|
|
<exception cref="T:System.ArgumentNullException"> <paramref name="assistantThreadCreationOptions" /> is null. </exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.AssistantsClient.CreateThreadAsync(Azure.Core.RequestContent,Azure.RequestContext)">
|
|
<summary>
|
|
[Protocol Method] Creates a new thread. Threads contain messages and can be run by assistants.
|
|
<list type="bullet">
|
|
<item>
|
|
<description>
|
|
This <see href="https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/core/Azure.Core/samples/ProtocolMethods.md">protocol method</see> allows explicit creation of the request and processing of the response for advanced scenarios.
|
|
</description>
|
|
</item>
|
|
</list>
|
|
</summary>
|
|
<param name="content"> The content to send as the body of the request. </param>
|
|
<param name="context"> The request context, which can override default behaviors of the client pipeline on a per-call basis. </param>
|
|
<exception cref="T:System.ArgumentNullException"> <paramref name="content" /> is null. </exception>
|
|
<exception cref="T:Azure.RequestFailedException"> Service returned a non-success status code. </exception>
|
|
<returns> The response returned from the service. </returns>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.AssistantsClient.CreateThread(Azure.Core.RequestContent,Azure.RequestContext)">
|
|
<summary>
|
|
[Protocol Method] Creates a new thread. Threads contain messages and can be run by assistants.
|
|
<list type="bullet">
|
|
<item>
|
|
<description>
|
|
This <see href="https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/core/Azure.Core/samples/ProtocolMethods.md">protocol method</see> allows explicit creation of the request and processing of the response for advanced scenarios.
|
|
</description>
|
|
</item>
|
|
</list>
|
|
</summary>
|
|
<param name="content"> The content to send as the body of the request. </param>
|
|
<param name="context"> The request context, which can override default behaviors of the client pipeline on a per-call basis. </param>
|
|
<exception cref="T:System.ArgumentNullException"> <paramref name="content" /> is null. </exception>
|
|
<exception cref="T:Azure.RequestFailedException"> Service returned a non-success status code. </exception>
|
|
<returns> The response returned from the service. </returns>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.AssistantsClient.GetThreadAsync(System.String,System.Threading.CancellationToken)">
|
|
<summary> Gets information about an existing thread. </summary>
|
|
<param name="threadId"> The ID of the thread to retrieve information about. </param>
|
|
<param name="cancellationToken"> The cancellation token to use. </param>
|
|
<exception cref="T:System.ArgumentNullException"> <paramref name="threadId" /> is null. </exception>
|
|
<exception cref="T:System.ArgumentException"> <paramref name="threadId" /> is an empty string, and was expected to be non-empty. </exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.AssistantsClient.GetThread(System.String,System.Threading.CancellationToken)">
|
|
<summary> Gets information about an existing thread. </summary>
|
|
<param name="threadId"> The ID of the thread to retrieve information about. </param>
|
|
<param name="cancellationToken"> The cancellation token to use. </param>
|
|
<exception cref="T:System.ArgumentNullException"> <paramref name="threadId" /> is null. </exception>
|
|
<exception cref="T:System.ArgumentException"> <paramref name="threadId" /> is an empty string, and was expected to be non-empty. </exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.AssistantsClient.GetThreadAsync(System.String,Azure.RequestContext)">
|
|
<summary>
|
|
[Protocol Method] Gets information about an existing thread.
|
|
<list type="bullet">
|
|
<item>
|
|
<description>
|
|
This <see href="https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/core/Azure.Core/samples/ProtocolMethods.md">protocol method</see> allows explicit creation of the request and processing of the response for advanced scenarios.
|
|
</description>
|
|
</item>
|
|
</list>
|
|
</summary>
|
|
<param name="threadId"> The ID of the thread to retrieve information about. </param>
|
|
<param name="context"> The request context, which can override default behaviors of the client pipeline on a per-call basis. </param>
|
|
<exception cref="T:System.ArgumentNullException"> <paramref name="threadId" /> is null. </exception>
|
|
<exception cref="T:System.ArgumentException"> <paramref name="threadId" /> is an empty string, and was expected to be non-empty. </exception>
|
|
<exception cref="T:Azure.RequestFailedException"> Service returned a non-success status code. </exception>
|
|
<returns> The response returned from the service. </returns>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.AssistantsClient.GetThread(System.String,Azure.RequestContext)">
|
|
<summary>
|
|
[Protocol Method] Gets information about an existing thread.
|
|
<list type="bullet">
|
|
<item>
|
|
<description>
|
|
This <see href="https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/core/Azure.Core/samples/ProtocolMethods.md">protocol method</see> allows explicit creation of the request and processing of the response for advanced scenarios.
|
|
</description>
|
|
</item>
|
|
</list>
|
|
</summary>
|
|
<param name="threadId"> The ID of the thread to retrieve information about. </param>
|
|
<param name="context"> The request context, which can override default behaviors of the client pipeline on a per-call basis. </param>
|
|
<exception cref="T:System.ArgumentNullException"> <paramref name="threadId" /> is null. </exception>
|
|
<exception cref="T:System.ArgumentException"> <paramref name="threadId" /> is an empty string, and was expected to be non-empty. </exception>
|
|
<exception cref="T:Azure.RequestFailedException"> Service returned a non-success status code. </exception>
|
|
<returns> The response returned from the service. </returns>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.AssistantsClient.UpdateThreadAsync(System.String,System.Collections.Generic.IDictionary{System.String,System.String},System.Threading.CancellationToken)">
|
|
<summary> Modifies an existing thread. </summary>
|
|
<param name="threadId"> The ID of the thread to modify. </param>
|
|
<param name="metadata"> 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. </param>
|
|
<param name="cancellationToken"> The cancellation token to use. </param>
|
|
<exception cref="T:System.ArgumentNullException"> <paramref name="threadId" /> is null. </exception>
|
|
<exception cref="T:System.ArgumentException"> <paramref name="threadId" /> is an empty string, and was expected to be non-empty. </exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.AssistantsClient.UpdateThread(System.String,System.Collections.Generic.IDictionary{System.String,System.String},System.Threading.CancellationToken)">
|
|
<summary> Modifies an existing thread. </summary>
|
|
<param name="threadId"> The ID of the thread to modify. </param>
|
|
<param name="metadata"> 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. </param>
|
|
<param name="cancellationToken"> The cancellation token to use. </param>
|
|
<exception cref="T:System.ArgumentNullException"> <paramref name="threadId" /> is null. </exception>
|
|
<exception cref="T:System.ArgumentException"> <paramref name="threadId" /> is an empty string, and was expected to be non-empty. </exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.AssistantsClient.UpdateThreadAsync(System.String,Azure.Core.RequestContent,Azure.RequestContext)">
|
|
<summary>
|
|
[Protocol Method] Modifies an existing thread.
|
|
<list type="bullet">
|
|
<item>
|
|
<description>
|
|
This <see href="https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/core/Azure.Core/samples/ProtocolMethods.md">protocol method</see> allows explicit creation of the request and processing of the response for advanced scenarios.
|
|
</description>
|
|
</item>
|
|
</list>
|
|
</summary>
|
|
<param name="threadId"> The ID of the thread to modify. </param>
|
|
<param name="content"> The content to send as the body of the request. </param>
|
|
<param name="context"> The request context, which can override default behaviors of the client pipeline on a per-call basis. </param>
|
|
<exception cref="T:System.ArgumentNullException"> <paramref name="threadId" /> or <paramref name="content" /> is null. </exception>
|
|
<exception cref="T:System.ArgumentException"> <paramref name="threadId" /> is an empty string, and was expected to be non-empty. </exception>
|
|
<exception cref="T:Azure.RequestFailedException"> Service returned a non-success status code. </exception>
|
|
<returns> The response returned from the service. </returns>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.AssistantsClient.UpdateThread(System.String,Azure.Core.RequestContent,Azure.RequestContext)">
|
|
<summary>
|
|
[Protocol Method] Modifies an existing thread.
|
|
<list type="bullet">
|
|
<item>
|
|
<description>
|
|
This <see href="https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/core/Azure.Core/samples/ProtocolMethods.md">protocol method</see> allows explicit creation of the request and processing of the response for advanced scenarios.
|
|
</description>
|
|
</item>
|
|
</list>
|
|
</summary>
|
|
<param name="threadId"> The ID of the thread to modify. </param>
|
|
<param name="content"> The content to send as the body of the request. </param>
|
|
<param name="context"> The request context, which can override default behaviors of the client pipeline on a per-call basis. </param>
|
|
<exception cref="T:System.ArgumentNullException"> <paramref name="threadId" /> or <paramref name="content" /> is null. </exception>
|
|
<exception cref="T:System.ArgumentException"> <paramref name="threadId" /> is an empty string, and was expected to be non-empty. </exception>
|
|
<exception cref="T:Azure.RequestFailedException"> Service returned a non-success status code. </exception>
|
|
<returns> The response returned from the service. </returns>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.AssistantsClient.InternalDeleteThreadAsync(System.String,System.Threading.CancellationToken)">
|
|
<summary> Deletes an existing thread. </summary>
|
|
<param name="threadId"> The ID of the thread to delete. </param>
|
|
<param name="cancellationToken"> The cancellation token to use. </param>
|
|
<exception cref="T:System.ArgumentNullException"> <paramref name="threadId" /> is null. </exception>
|
|
<exception cref="T:System.ArgumentException"> <paramref name="threadId" /> is an empty string, and was expected to be non-empty. </exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.AssistantsClient.InternalDeleteThread(System.String,System.Threading.CancellationToken)">
|
|
<summary> Deletes an existing thread. </summary>
|
|
<param name="threadId"> The ID of the thread to delete. </param>
|
|
<param name="cancellationToken"> The cancellation token to use. </param>
|
|
<exception cref="T:System.ArgumentNullException"> <paramref name="threadId" /> is null. </exception>
|
|
<exception cref="T:System.ArgumentException"> <paramref name="threadId" /> is an empty string, and was expected to be non-empty. </exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.AssistantsClient.InternalDeleteThreadAsync(System.String,Azure.RequestContext)">
|
|
<summary>
|
|
[Protocol Method] Deletes an existing thread.
|
|
<list type="bullet">
|
|
<item>
|
|
<description>
|
|
This <see href="https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/core/Azure.Core/samples/ProtocolMethods.md">protocol method</see> allows explicit creation of the request and processing of the response for advanced scenarios.
|
|
</description>
|
|
</item>
|
|
<item>
|
|
<description>
|
|
Please try the simpler <see cref="M:Azure.AI.OpenAI.Assistants.AssistantsClient.InternalDeleteThreadAsync(System.String,System.Threading.CancellationToken)" /> convenience overload with strongly typed models first.
|
|
</description>
|
|
</item>
|
|
</list>
|
|
</summary>
|
|
<param name="threadId"> The ID of the thread to delete. </param>
|
|
<param name="context"> The request context, which can override default behaviors of the client pipeline on a per-call basis. </param>
|
|
<exception cref="T:System.ArgumentNullException"> <paramref name="threadId" /> is null. </exception>
|
|
<exception cref="T:System.ArgumentException"> <paramref name="threadId" /> is an empty string, and was expected to be non-empty. </exception>
|
|
<exception cref="T:Azure.RequestFailedException"> Service returned a non-success status code. </exception>
|
|
<returns> The response returned from the service. </returns>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.AssistantsClient.InternalDeleteThread(System.String,Azure.RequestContext)">
|
|
<summary>
|
|
[Protocol Method] Deletes an existing thread.
|
|
<list type="bullet">
|
|
<item>
|
|
<description>
|
|
This <see href="https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/core/Azure.Core/samples/ProtocolMethods.md">protocol method</see> allows explicit creation of the request and processing of the response for advanced scenarios.
|
|
</description>
|
|
</item>
|
|
<item>
|
|
<description>
|
|
Please try the simpler <see cref="M:Azure.AI.OpenAI.Assistants.AssistantsClient.InternalDeleteThread(System.String,System.Threading.CancellationToken)" /> convenience overload with strongly typed models first.
|
|
</description>
|
|
</item>
|
|
</list>
|
|
</summary>
|
|
<param name="threadId"> The ID of the thread to delete. </param>
|
|
<param name="context"> The request context, which can override default behaviors of the client pipeline on a per-call basis. </param>
|
|
<exception cref="T:System.ArgumentNullException"> <paramref name="threadId" /> is null. </exception>
|
|
<exception cref="T:System.ArgumentException"> <paramref name="threadId" /> is an empty string, and was expected to be non-empty. </exception>
|
|
<exception cref="T:Azure.RequestFailedException"> Service returned a non-success status code. </exception>
|
|
<returns> The response returned from the service. </returns>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.AssistantsClient.CreateMessageAsync(System.String,Azure.AI.OpenAI.Assistants.MessageRole,System.String,System.Collections.Generic.IEnumerable{System.String},System.Collections.Generic.IDictionary{System.String,System.String},System.Threading.CancellationToken)">
|
|
<summary> Creates a new message on a specified thread. </summary>
|
|
<param name="threadId"> The ID of the thread to create the new message on. </param>
|
|
<param name="role"> The role to associate with the new message. </param>
|
|
<param name="content"> The textual content for the new message. </param>
|
|
<param name="fileIds"> A list of up to 10 file IDs to associate with the message, as used by tools like 'code_interpreter' or 'retrieval' that can read files. </param>
|
|
<param name="metadata"> 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. </param>
|
|
<param name="cancellationToken"> The cancellation token to use. </param>
|
|
<exception cref="T:System.ArgumentNullException"> <paramref name="threadId" /> or <paramref name="content" /> is null. </exception>
|
|
<exception cref="T:System.ArgumentException"> <paramref name="threadId" /> is an empty string, and was expected to be non-empty. </exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.AssistantsClient.CreateMessage(System.String,Azure.AI.OpenAI.Assistants.MessageRole,System.String,System.Collections.Generic.IEnumerable{System.String},System.Collections.Generic.IDictionary{System.String,System.String},System.Threading.CancellationToken)">
|
|
<summary> Creates a new message on a specified thread. </summary>
|
|
<param name="threadId"> The ID of the thread to create the new message on. </param>
|
|
<param name="role"> The role to associate with the new message. </param>
|
|
<param name="content"> The textual content for the new message. </param>
|
|
<param name="fileIds"> A list of up to 10 file IDs to associate with the message, as used by tools like 'code_interpreter' or 'retrieval' that can read files. </param>
|
|
<param name="metadata"> 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. </param>
|
|
<param name="cancellationToken"> The cancellation token to use. </param>
|
|
<exception cref="T:System.ArgumentNullException"> <paramref name="threadId" /> or <paramref name="content" /> is null. </exception>
|
|
<exception cref="T:System.ArgumentException"> <paramref name="threadId" /> is an empty string, and was expected to be non-empty. </exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.AssistantsClient.CreateMessageAsync(System.String,Azure.Core.RequestContent,Azure.RequestContext)">
|
|
<summary>
|
|
[Protocol Method] Creates a new message on a specified thread.
|
|
<list type="bullet">
|
|
<item>
|
|
<description>
|
|
This <see href="https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/core/Azure.Core/samples/ProtocolMethods.md">protocol method</see> allows explicit creation of the request and processing of the response for advanced scenarios.
|
|
</description>
|
|
</item>
|
|
</list>
|
|
</summary>
|
|
<param name="threadId"> The ID of the thread to create the new message on. </param>
|
|
<param name="content"> The content to send as the body of the request. </param>
|
|
<param name="context"> The request context, which can override default behaviors of the client pipeline on a per-call basis. </param>
|
|
<exception cref="T:System.ArgumentNullException"> <paramref name="threadId" /> or <paramref name="content" /> is null. </exception>
|
|
<exception cref="T:System.ArgumentException"> <paramref name="threadId" /> is an empty string, and was expected to be non-empty. </exception>
|
|
<exception cref="T:Azure.RequestFailedException"> Service returned a non-success status code. </exception>
|
|
<returns> The response returned from the service. </returns>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.AssistantsClient.CreateMessage(System.String,Azure.Core.RequestContent,Azure.RequestContext)">
|
|
<summary>
|
|
[Protocol Method] Creates a new message on a specified thread.
|
|
<list type="bullet">
|
|
<item>
|
|
<description>
|
|
This <see href="https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/core/Azure.Core/samples/ProtocolMethods.md">protocol method</see> allows explicit creation of the request and processing of the response for advanced scenarios.
|
|
</description>
|
|
</item>
|
|
</list>
|
|
</summary>
|
|
<param name="threadId"> The ID of the thread to create the new message on. </param>
|
|
<param name="content"> The content to send as the body of the request. </param>
|
|
<param name="context"> The request context, which can override default behaviors of the client pipeline on a per-call basis. </param>
|
|
<exception cref="T:System.ArgumentNullException"> <paramref name="threadId" /> or <paramref name="content" /> is null. </exception>
|
|
<exception cref="T:System.ArgumentException"> <paramref name="threadId" /> is an empty string, and was expected to be non-empty. </exception>
|
|
<exception cref="T:Azure.RequestFailedException"> Service returned a non-success status code. </exception>
|
|
<returns> The response returned from the service. </returns>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.AssistantsClient.InternalGetMessagesAsync(System.String,System.Nullable{System.Int32},System.Nullable{Azure.AI.OpenAI.Assistants.ListSortOrder},System.String,System.String,System.Threading.CancellationToken)">
|
|
<summary> Gets a list of messages that exist on a thread. </summary>
|
|
<param name="threadId"> The ID of the thread to list messages from. </param>
|
|
<param name="limit"> A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20. </param>
|
|
<param name="order"> Sort order by the created_at timestamp of the objects. asc for ascending order and desc for descending order. </param>
|
|
<param name="after"> A cursor for use in pagination. after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include after=obj_foo in order to fetch the next page of the list. </param>
|
|
<param name="before"> A cursor for use in pagination. before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include before=obj_foo in order to fetch the previous page of the list. </param>
|
|
<param name="cancellationToken"> The cancellation token to use. </param>
|
|
<exception cref="T:System.ArgumentNullException"> <paramref name="threadId" /> is null. </exception>
|
|
<exception cref="T:System.ArgumentException"> <paramref name="threadId" /> is an empty string, and was expected to be non-empty. </exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.AssistantsClient.InternalGetMessages(System.String,System.Nullable{System.Int32},System.Nullable{Azure.AI.OpenAI.Assistants.ListSortOrder},System.String,System.String,System.Threading.CancellationToken)">
|
|
<summary> Gets a list of messages that exist on a thread. </summary>
|
|
<param name="threadId"> The ID of the thread to list messages from. </param>
|
|
<param name="limit"> A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20. </param>
|
|
<param name="order"> Sort order by the created_at timestamp of the objects. asc for ascending order and desc for descending order. </param>
|
|
<param name="after"> A cursor for use in pagination. after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include after=obj_foo in order to fetch the next page of the list. </param>
|
|
<param name="before"> A cursor for use in pagination. before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include before=obj_foo in order to fetch the previous page of the list. </param>
|
|
<param name="cancellationToken"> The cancellation token to use. </param>
|
|
<exception cref="T:System.ArgumentNullException"> <paramref name="threadId" /> is null. </exception>
|
|
<exception cref="T:System.ArgumentException"> <paramref name="threadId" /> is an empty string, and was expected to be non-empty. </exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.AssistantsClient.InternalGetMessagesAsync(System.String,System.Nullable{System.Int32},System.String,System.String,System.String,Azure.RequestContext)">
|
|
<summary>
|
|
[Protocol Method] Gets a list of messages that exist on a thread.
|
|
<list type="bullet">
|
|
<item>
|
|
<description>
|
|
This <see href="https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/core/Azure.Core/samples/ProtocolMethods.md">protocol method</see> allows explicit creation of the request and processing of the response for advanced scenarios.
|
|
</description>
|
|
</item>
|
|
<item>
|
|
<description>
|
|
Please try the simpler <see cref="M:Azure.AI.OpenAI.Assistants.AssistantsClient.InternalGetMessagesAsync(System.String,System.Nullable{System.Int32},System.Nullable{Azure.AI.OpenAI.Assistants.ListSortOrder},System.String,System.String,System.Threading.CancellationToken)" /> convenience overload with strongly typed models first.
|
|
</description>
|
|
</item>
|
|
</list>
|
|
</summary>
|
|
<param name="threadId"> The ID of the thread to list messages from. </param>
|
|
<param name="limit"> A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20. </param>
|
|
<param name="order"> Sort order by the created_at timestamp of the objects. asc for ascending order and desc for descending order. Allowed values: "asc" | "desc". </param>
|
|
<param name="after"> A cursor for use in pagination. after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include after=obj_foo in order to fetch the next page of the list. </param>
|
|
<param name="before"> A cursor for use in pagination. before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include before=obj_foo in order to fetch the previous page of the list. </param>
|
|
<param name="context"> The request context, which can override default behaviors of the client pipeline on a per-call basis. </param>
|
|
<exception cref="T:System.ArgumentNullException"> <paramref name="threadId" /> is null. </exception>
|
|
<exception cref="T:System.ArgumentException"> <paramref name="threadId" /> is an empty string, and was expected to be non-empty. </exception>
|
|
<exception cref="T:Azure.RequestFailedException"> Service returned a non-success status code. </exception>
|
|
<returns> The response returned from the service. </returns>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.AssistantsClient.InternalGetMessages(System.String,System.Nullable{System.Int32},System.String,System.String,System.String,Azure.RequestContext)">
|
|
<summary>
|
|
[Protocol Method] Gets a list of messages that exist on a thread.
|
|
<list type="bullet">
|
|
<item>
|
|
<description>
|
|
This <see href="https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/core/Azure.Core/samples/ProtocolMethods.md">protocol method</see> allows explicit creation of the request and processing of the response for advanced scenarios.
|
|
</description>
|
|
</item>
|
|
<item>
|
|
<description>
|
|
Please try the simpler <see cref="M:Azure.AI.OpenAI.Assistants.AssistantsClient.InternalGetMessages(System.String,System.Nullable{System.Int32},System.Nullable{Azure.AI.OpenAI.Assistants.ListSortOrder},System.String,System.String,System.Threading.CancellationToken)" /> convenience overload with strongly typed models first.
|
|
</description>
|
|
</item>
|
|
</list>
|
|
</summary>
|
|
<param name="threadId"> The ID of the thread to list messages from. </param>
|
|
<param name="limit"> A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20. </param>
|
|
<param name="order"> Sort order by the created_at timestamp of the objects. asc for ascending order and desc for descending order. Allowed values: "asc" | "desc". </param>
|
|
<param name="after"> A cursor for use in pagination. after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include after=obj_foo in order to fetch the next page of the list. </param>
|
|
<param name="before"> A cursor for use in pagination. before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include before=obj_foo in order to fetch the previous page of the list. </param>
|
|
<param name="context"> The request context, which can override default behaviors of the client pipeline on a per-call basis. </param>
|
|
<exception cref="T:System.ArgumentNullException"> <paramref name="threadId" /> is null. </exception>
|
|
<exception cref="T:System.ArgumentException"> <paramref name="threadId" /> is an empty string, and was expected to be non-empty. </exception>
|
|
<exception cref="T:Azure.RequestFailedException"> Service returned a non-success status code. </exception>
|
|
<returns> The response returned from the service. </returns>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.AssistantsClient.GetMessageAsync(System.String,System.String,System.Threading.CancellationToken)">
|
|
<summary> Gets an existing message from an existing thread. </summary>
|
|
<param name="threadId"> The ID of the thread to retrieve the specified message from. </param>
|
|
<param name="messageId"> The ID of the message to retrieve from the specified thread. </param>
|
|
<param name="cancellationToken"> The cancellation token to use. </param>
|
|
<exception cref="T:System.ArgumentNullException"> <paramref name="threadId" /> or <paramref name="messageId" /> is null. </exception>
|
|
<exception cref="T:System.ArgumentException"> <paramref name="threadId" /> or <paramref name="messageId" /> is an empty string, and was expected to be non-empty. </exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.AssistantsClient.GetMessage(System.String,System.String,System.Threading.CancellationToken)">
|
|
<summary> Gets an existing message from an existing thread. </summary>
|
|
<param name="threadId"> The ID of the thread to retrieve the specified message from. </param>
|
|
<param name="messageId"> The ID of the message to retrieve from the specified thread. </param>
|
|
<param name="cancellationToken"> The cancellation token to use. </param>
|
|
<exception cref="T:System.ArgumentNullException"> <paramref name="threadId" /> or <paramref name="messageId" /> is null. </exception>
|
|
<exception cref="T:System.ArgumentException"> <paramref name="threadId" /> or <paramref name="messageId" /> is an empty string, and was expected to be non-empty. </exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.AssistantsClient.GetMessageAsync(System.String,System.String,Azure.RequestContext)">
|
|
<summary>
|
|
[Protocol Method] Gets an existing message from an existing thread.
|
|
<list type="bullet">
|
|
<item>
|
|
<description>
|
|
This <see href="https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/core/Azure.Core/samples/ProtocolMethods.md">protocol method</see> allows explicit creation of the request and processing of the response for advanced scenarios.
|
|
</description>
|
|
</item>
|
|
</list>
|
|
</summary>
|
|
<param name="threadId"> The ID of the thread to retrieve the specified message from. </param>
|
|
<param name="messageId"> The ID of the message to retrieve from the specified thread. </param>
|
|
<param name="context"> The request context, which can override default behaviors of the client pipeline on a per-call basis. </param>
|
|
<exception cref="T:System.ArgumentNullException"> <paramref name="threadId" /> or <paramref name="messageId" /> is null. </exception>
|
|
<exception cref="T:System.ArgumentException"> <paramref name="threadId" /> or <paramref name="messageId" /> is an empty string, and was expected to be non-empty. </exception>
|
|
<exception cref="T:Azure.RequestFailedException"> Service returned a non-success status code. </exception>
|
|
<returns> The response returned from the service. </returns>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.AssistantsClient.GetMessage(System.String,System.String,Azure.RequestContext)">
|
|
<summary>
|
|
[Protocol Method] Gets an existing message from an existing thread.
|
|
<list type="bullet">
|
|
<item>
|
|
<description>
|
|
This <see href="https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/core/Azure.Core/samples/ProtocolMethods.md">protocol method</see> allows explicit creation of the request and processing of the response for advanced scenarios.
|
|
</description>
|
|
</item>
|
|
</list>
|
|
</summary>
|
|
<param name="threadId"> The ID of the thread to retrieve the specified message from. </param>
|
|
<param name="messageId"> The ID of the message to retrieve from the specified thread. </param>
|
|
<param name="context"> The request context, which can override default behaviors of the client pipeline on a per-call basis. </param>
|
|
<exception cref="T:System.ArgumentNullException"> <paramref name="threadId" /> or <paramref name="messageId" /> is null. </exception>
|
|
<exception cref="T:System.ArgumentException"> <paramref name="threadId" /> or <paramref name="messageId" /> is an empty string, and was expected to be non-empty. </exception>
|
|
<exception cref="T:Azure.RequestFailedException"> Service returned a non-success status code. </exception>
|
|
<returns> The response returned from the service. </returns>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.AssistantsClient.UpdateMessageAsync(System.String,System.String,System.Collections.Generic.IDictionary{System.String,System.String},System.Threading.CancellationToken)">
|
|
<summary> Modifies an existing message on an existing thread. </summary>
|
|
<param name="threadId"> The ID of the thread containing the specified message to modify. </param>
|
|
<param name="messageId"> The ID of the message to modify on the specified thread. </param>
|
|
<param name="metadata"> 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. </param>
|
|
<param name="cancellationToken"> The cancellation token to use. </param>
|
|
<exception cref="T:System.ArgumentNullException"> <paramref name="threadId" /> or <paramref name="messageId" /> is null. </exception>
|
|
<exception cref="T:System.ArgumentException"> <paramref name="threadId" /> or <paramref name="messageId" /> is an empty string, and was expected to be non-empty. </exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.AssistantsClient.UpdateMessage(System.String,System.String,System.Collections.Generic.IDictionary{System.String,System.String},System.Threading.CancellationToken)">
|
|
<summary> Modifies an existing message on an existing thread. </summary>
|
|
<param name="threadId"> The ID of the thread containing the specified message to modify. </param>
|
|
<param name="messageId"> The ID of the message to modify on the specified thread. </param>
|
|
<param name="metadata"> 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. </param>
|
|
<param name="cancellationToken"> The cancellation token to use. </param>
|
|
<exception cref="T:System.ArgumentNullException"> <paramref name="threadId" /> or <paramref name="messageId" /> is null. </exception>
|
|
<exception cref="T:System.ArgumentException"> <paramref name="threadId" /> or <paramref name="messageId" /> is an empty string, and was expected to be non-empty. </exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.AssistantsClient.UpdateMessageAsync(System.String,System.String,Azure.Core.RequestContent,Azure.RequestContext)">
|
|
<summary>
|
|
[Protocol Method] Modifies an existing message on an existing thread.
|
|
<list type="bullet">
|
|
<item>
|
|
<description>
|
|
This <see href="https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/core/Azure.Core/samples/ProtocolMethods.md">protocol method</see> allows explicit creation of the request and processing of the response for advanced scenarios.
|
|
</description>
|
|
</item>
|
|
</list>
|
|
</summary>
|
|
<param name="threadId"> The ID of the thread containing the specified message to modify. </param>
|
|
<param name="messageId"> The ID of the message to modify on the specified thread. </param>
|
|
<param name="content"> The content to send as the body of the request. </param>
|
|
<param name="context"> The request context, which can override default behaviors of the client pipeline on a per-call basis. </param>
|
|
<exception cref="T:System.ArgumentNullException"> <paramref name="threadId" />, <paramref name="messageId" /> or <paramref name="content" /> is null. </exception>
|
|
<exception cref="T:System.ArgumentException"> <paramref name="threadId" /> or <paramref name="messageId" /> is an empty string, and was expected to be non-empty. </exception>
|
|
<exception cref="T:Azure.RequestFailedException"> Service returned a non-success status code. </exception>
|
|
<returns> The response returned from the service. </returns>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.AssistantsClient.UpdateMessage(System.String,System.String,Azure.Core.RequestContent,Azure.RequestContext)">
|
|
<summary>
|
|
[Protocol Method] Modifies an existing message on an existing thread.
|
|
<list type="bullet">
|
|
<item>
|
|
<description>
|
|
This <see href="https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/core/Azure.Core/samples/ProtocolMethods.md">protocol method</see> allows explicit creation of the request and processing of the response for advanced scenarios.
|
|
</description>
|
|
</item>
|
|
</list>
|
|
</summary>
|
|
<param name="threadId"> The ID of the thread containing the specified message to modify. </param>
|
|
<param name="messageId"> The ID of the message to modify on the specified thread. </param>
|
|
<param name="content"> The content to send as the body of the request. </param>
|
|
<param name="context"> The request context, which can override default behaviors of the client pipeline on a per-call basis. </param>
|
|
<exception cref="T:System.ArgumentNullException"> <paramref name="threadId" />, <paramref name="messageId" /> or <paramref name="content" /> is null. </exception>
|
|
<exception cref="T:System.ArgumentException"> <paramref name="threadId" /> or <paramref name="messageId" /> is an empty string, and was expected to be non-empty. </exception>
|
|
<exception cref="T:Azure.RequestFailedException"> Service returned a non-success status code. </exception>
|
|
<returns> The response returned from the service. </returns>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.AssistantsClient.InternalGetMessageFilesAsync(System.String,System.String,System.Nullable{System.Int32},System.Nullable{Azure.AI.OpenAI.Assistants.ListSortOrder},System.String,System.String,System.Threading.CancellationToken)">
|
|
<summary> Gets a list of previously uploaded files associated with a message from a thread. </summary>
|
|
<param name="threadId"> The ID of the thread containing the message to list files from. </param>
|
|
<param name="messageId"> The ID of the message to list files from. </param>
|
|
<param name="limit"> A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20. </param>
|
|
<param name="order"> Sort order by the created_at timestamp of the objects. asc for ascending order and desc for descending order. </param>
|
|
<param name="after"> A cursor for use in pagination. after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include after=obj_foo in order to fetch the next page of the list. </param>
|
|
<param name="before"> A cursor for use in pagination. before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include before=obj_foo in order to fetch the previous page of the list. </param>
|
|
<param name="cancellationToken"> The cancellation token to use. </param>
|
|
<exception cref="T:System.ArgumentNullException"> <paramref name="threadId" /> or <paramref name="messageId" /> is null. </exception>
|
|
<exception cref="T:System.ArgumentException"> <paramref name="threadId" /> or <paramref name="messageId" /> is an empty string, and was expected to be non-empty. </exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.AssistantsClient.InternalGetMessageFiles(System.String,System.String,System.Nullable{System.Int32},System.Nullable{Azure.AI.OpenAI.Assistants.ListSortOrder},System.String,System.String,System.Threading.CancellationToken)">
|
|
<summary> Gets a list of previously uploaded files associated with a message from a thread. </summary>
|
|
<param name="threadId"> The ID of the thread containing the message to list files from. </param>
|
|
<param name="messageId"> The ID of the message to list files from. </param>
|
|
<param name="limit"> A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20. </param>
|
|
<param name="order"> Sort order by the created_at timestamp of the objects. asc for ascending order and desc for descending order. </param>
|
|
<param name="after"> A cursor for use in pagination. after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include after=obj_foo in order to fetch the next page of the list. </param>
|
|
<param name="before"> A cursor for use in pagination. before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include before=obj_foo in order to fetch the previous page of the list. </param>
|
|
<param name="cancellationToken"> The cancellation token to use. </param>
|
|
<exception cref="T:System.ArgumentNullException"> <paramref name="threadId" /> or <paramref name="messageId" /> is null. </exception>
|
|
<exception cref="T:System.ArgumentException"> <paramref name="threadId" /> or <paramref name="messageId" /> is an empty string, and was expected to be non-empty. </exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.AssistantsClient.InternalGetMessageFilesAsync(System.String,System.String,System.Nullable{System.Int32},System.String,System.String,System.String,Azure.RequestContext)">
|
|
<summary>
|
|
[Protocol Method] Gets a list of previously uploaded files associated with a message from a thread.
|
|
<list type="bullet">
|
|
<item>
|
|
<description>
|
|
This <see href="https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/core/Azure.Core/samples/ProtocolMethods.md">protocol method</see> allows explicit creation of the request and processing of the response for advanced scenarios.
|
|
</description>
|
|
</item>
|
|
<item>
|
|
<description>
|
|
Please try the simpler <see cref="M:Azure.AI.OpenAI.Assistants.AssistantsClient.InternalGetMessageFilesAsync(System.String,System.String,System.Nullable{System.Int32},System.Nullable{Azure.AI.OpenAI.Assistants.ListSortOrder},System.String,System.String,System.Threading.CancellationToken)" /> convenience overload with strongly typed models first.
|
|
</description>
|
|
</item>
|
|
</list>
|
|
</summary>
|
|
<param name="threadId"> The ID of the thread containing the message to list files from. </param>
|
|
<param name="messageId"> The ID of the message to list files from. </param>
|
|
<param name="limit"> A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20. </param>
|
|
<param name="order"> Sort order by the created_at timestamp of the objects. asc for ascending order and desc for descending order. Allowed values: "asc" | "desc". </param>
|
|
<param name="after"> A cursor for use in pagination. after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include after=obj_foo in order to fetch the next page of the list. </param>
|
|
<param name="before"> A cursor for use in pagination. before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include before=obj_foo in order to fetch the previous page of the list. </param>
|
|
<param name="context"> The request context, which can override default behaviors of the client pipeline on a per-call basis. </param>
|
|
<exception cref="T:System.ArgumentNullException"> <paramref name="threadId" /> or <paramref name="messageId" /> is null. </exception>
|
|
<exception cref="T:System.ArgumentException"> <paramref name="threadId" /> or <paramref name="messageId" /> is an empty string, and was expected to be non-empty. </exception>
|
|
<exception cref="T:Azure.RequestFailedException"> Service returned a non-success status code. </exception>
|
|
<returns> The response returned from the service. </returns>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.AssistantsClient.InternalGetMessageFiles(System.String,System.String,System.Nullable{System.Int32},System.String,System.String,System.String,Azure.RequestContext)">
|
|
<summary>
|
|
[Protocol Method] Gets a list of previously uploaded files associated with a message from a thread.
|
|
<list type="bullet">
|
|
<item>
|
|
<description>
|
|
This <see href="https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/core/Azure.Core/samples/ProtocolMethods.md">protocol method</see> allows explicit creation of the request and processing of the response for advanced scenarios.
|
|
</description>
|
|
</item>
|
|
<item>
|
|
<description>
|
|
Please try the simpler <see cref="M:Azure.AI.OpenAI.Assistants.AssistantsClient.InternalGetMessageFiles(System.String,System.String,System.Nullable{System.Int32},System.Nullable{Azure.AI.OpenAI.Assistants.ListSortOrder},System.String,System.String,System.Threading.CancellationToken)" /> convenience overload with strongly typed models first.
|
|
</description>
|
|
</item>
|
|
</list>
|
|
</summary>
|
|
<param name="threadId"> The ID of the thread containing the message to list files from. </param>
|
|
<param name="messageId"> The ID of the message to list files from. </param>
|
|
<param name="limit"> A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20. </param>
|
|
<param name="order"> Sort order by the created_at timestamp of the objects. asc for ascending order and desc for descending order. Allowed values: "asc" | "desc". </param>
|
|
<param name="after"> A cursor for use in pagination. after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include after=obj_foo in order to fetch the next page of the list. </param>
|
|
<param name="before"> A cursor for use in pagination. before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include before=obj_foo in order to fetch the previous page of the list. </param>
|
|
<param name="context"> The request context, which can override default behaviors of the client pipeline on a per-call basis. </param>
|
|
<exception cref="T:System.ArgumentNullException"> <paramref name="threadId" /> or <paramref name="messageId" /> is null. </exception>
|
|
<exception cref="T:System.ArgumentException"> <paramref name="threadId" /> or <paramref name="messageId" /> is an empty string, and was expected to be non-empty. </exception>
|
|
<exception cref="T:Azure.RequestFailedException"> Service returned a non-success status code. </exception>
|
|
<returns> The response returned from the service. </returns>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.AssistantsClient.GetMessageFileAsync(System.String,System.String,System.String,System.Threading.CancellationToken)">
|
|
<summary> Gets information about a file attachment to a message within a thread. </summary>
|
|
<param name="threadId"> The ID of the thread containing the message to get information from. </param>
|
|
<param name="messageId"> The ID of the message to get information from. </param>
|
|
<param name="fileId"> The ID of the file to get information about. </param>
|
|
<param name="cancellationToken"> The cancellation token to use. </param>
|
|
<exception cref="T:System.ArgumentNullException"> <paramref name="threadId" />, <paramref name="messageId" /> or <paramref name="fileId" /> is null. </exception>
|
|
<exception cref="T:System.ArgumentException"> <paramref name="threadId" />, <paramref name="messageId" /> or <paramref name="fileId" /> is an empty string, and was expected to be non-empty. </exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.AssistantsClient.GetMessageFile(System.String,System.String,System.String,System.Threading.CancellationToken)">
|
|
<summary> Gets information about a file attachment to a message within a thread. </summary>
|
|
<param name="threadId"> The ID of the thread containing the message to get information from. </param>
|
|
<param name="messageId"> The ID of the message to get information from. </param>
|
|
<param name="fileId"> The ID of the file to get information about. </param>
|
|
<param name="cancellationToken"> The cancellation token to use. </param>
|
|
<exception cref="T:System.ArgumentNullException"> <paramref name="threadId" />, <paramref name="messageId" /> or <paramref name="fileId" /> is null. </exception>
|
|
<exception cref="T:System.ArgumentException"> <paramref name="threadId" />, <paramref name="messageId" /> or <paramref name="fileId" /> is an empty string, and was expected to be non-empty. </exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.AssistantsClient.GetMessageFileAsync(System.String,System.String,System.String,Azure.RequestContext)">
|
|
<summary>
|
|
[Protocol Method] Gets information about a file attachment to a message within a thread.
|
|
<list type="bullet">
|
|
<item>
|
|
<description>
|
|
This <see href="https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/core/Azure.Core/samples/ProtocolMethods.md">protocol method</see> allows explicit creation of the request and processing of the response for advanced scenarios.
|
|
</description>
|
|
</item>
|
|
</list>
|
|
</summary>
|
|
<param name="threadId"> The ID of the thread containing the message to get information from. </param>
|
|
<param name="messageId"> The ID of the message to get information from. </param>
|
|
<param name="fileId"> The ID of the file to get information about. </param>
|
|
<param name="context"> The request context, which can override default behaviors of the client pipeline on a per-call basis. </param>
|
|
<exception cref="T:System.ArgumentNullException"> <paramref name="threadId" />, <paramref name="messageId" /> or <paramref name="fileId" /> is null. </exception>
|
|
<exception cref="T:System.ArgumentException"> <paramref name="threadId" />, <paramref name="messageId" /> or <paramref name="fileId" /> is an empty string, and was expected to be non-empty. </exception>
|
|
<exception cref="T:Azure.RequestFailedException"> Service returned a non-success status code. </exception>
|
|
<returns> The response returned from the service. </returns>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.AssistantsClient.GetMessageFile(System.String,System.String,System.String,Azure.RequestContext)">
|
|
<summary>
|
|
[Protocol Method] Gets information about a file attachment to a message within a thread.
|
|
<list type="bullet">
|
|
<item>
|
|
<description>
|
|
This <see href="https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/core/Azure.Core/samples/ProtocolMethods.md">protocol method</see> allows explicit creation of the request and processing of the response for advanced scenarios.
|
|
</description>
|
|
</item>
|
|
</list>
|
|
</summary>
|
|
<param name="threadId"> The ID of the thread containing the message to get information from. </param>
|
|
<param name="messageId"> The ID of the message to get information from. </param>
|
|
<param name="fileId"> The ID of the file to get information about. </param>
|
|
<param name="context"> The request context, which can override default behaviors of the client pipeline on a per-call basis. </param>
|
|
<exception cref="T:System.ArgumentNullException"> <paramref name="threadId" />, <paramref name="messageId" /> or <paramref name="fileId" /> is null. </exception>
|
|
<exception cref="T:System.ArgumentException"> <paramref name="threadId" />, <paramref name="messageId" /> or <paramref name="fileId" /> is an empty string, and was expected to be non-empty. </exception>
|
|
<exception cref="T:Azure.RequestFailedException"> Service returned a non-success status code. </exception>
|
|
<returns> The response returned from the service. </returns>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.AssistantsClient.CreateRunAsync(System.String,Azure.AI.OpenAI.Assistants.CreateRunOptions,System.Threading.CancellationToken)">
|
|
<summary> Creates a new run for an assistant thread. </summary>
|
|
<param name="threadId"> The ID of the thread to run. </param>
|
|
<param name="createRunOptions"> The details for the run to create. </param>
|
|
<param name="cancellationToken"> The cancellation token to use. </param>
|
|
<exception cref="T:System.ArgumentNullException"> <paramref name="threadId" /> or <paramref name="createRunOptions" /> is null. </exception>
|
|
<exception cref="T:System.ArgumentException"> <paramref name="threadId" /> is an empty string, and was expected to be non-empty. </exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.AssistantsClient.CreateRun(System.String,Azure.AI.OpenAI.Assistants.CreateRunOptions,System.Threading.CancellationToken)">
|
|
<summary> Creates a new run for an assistant thread. </summary>
|
|
<param name="threadId"> The ID of the thread to run. </param>
|
|
<param name="createRunOptions"> The details for the run to create. </param>
|
|
<param name="cancellationToken"> The cancellation token to use. </param>
|
|
<exception cref="T:System.ArgumentNullException"> <paramref name="threadId" /> or <paramref name="createRunOptions" /> is null. </exception>
|
|
<exception cref="T:System.ArgumentException"> <paramref name="threadId" /> is an empty string, and was expected to be non-empty. </exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.AssistantsClient.CreateRunAsync(System.String,Azure.Core.RequestContent,Azure.RequestContext)">
|
|
<summary>
|
|
[Protocol Method] Creates a new run for an assistant thread.
|
|
<list type="bullet">
|
|
<item>
|
|
<description>
|
|
This <see href="https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/core/Azure.Core/samples/ProtocolMethods.md">protocol method</see> allows explicit creation of the request and processing of the response for advanced scenarios.
|
|
</description>
|
|
</item>
|
|
</list>
|
|
</summary>
|
|
<param name="threadId"> The ID of the thread to run. </param>
|
|
<param name="content"> The content to send as the body of the request. </param>
|
|
<param name="context"> The request context, which can override default behaviors of the client pipeline on a per-call basis. </param>
|
|
<exception cref="T:System.ArgumentNullException"> <paramref name="threadId" /> or <paramref name="content" /> is null. </exception>
|
|
<exception cref="T:System.ArgumentException"> <paramref name="threadId" /> is an empty string, and was expected to be non-empty. </exception>
|
|
<exception cref="T:Azure.RequestFailedException"> Service returned a non-success status code. </exception>
|
|
<returns> The response returned from the service. </returns>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.AssistantsClient.CreateRun(System.String,Azure.Core.RequestContent,Azure.RequestContext)">
|
|
<summary>
|
|
[Protocol Method] Creates a new run for an assistant thread.
|
|
<list type="bullet">
|
|
<item>
|
|
<description>
|
|
This <see href="https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/core/Azure.Core/samples/ProtocolMethods.md">protocol method</see> allows explicit creation of the request and processing of the response for advanced scenarios.
|
|
</description>
|
|
</item>
|
|
</list>
|
|
</summary>
|
|
<param name="threadId"> The ID of the thread to run. </param>
|
|
<param name="content"> The content to send as the body of the request. </param>
|
|
<param name="context"> The request context, which can override default behaviors of the client pipeline on a per-call basis. </param>
|
|
<exception cref="T:System.ArgumentNullException"> <paramref name="threadId" /> or <paramref name="content" /> is null. </exception>
|
|
<exception cref="T:System.ArgumentException"> <paramref name="threadId" /> is an empty string, and was expected to be non-empty. </exception>
|
|
<exception cref="T:Azure.RequestFailedException"> Service returned a non-success status code. </exception>
|
|
<returns> The response returned from the service. </returns>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.AssistantsClient.InternalGetRunsAsync(System.String,System.Nullable{System.Int32},System.Nullable{Azure.AI.OpenAI.Assistants.ListSortOrder},System.String,System.String,System.Threading.CancellationToken)">
|
|
<summary> Gets a list of runs for a specified thread. </summary>
|
|
<param name="threadId"> The ID of the thread to list runs from. </param>
|
|
<param name="limit"> A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20. </param>
|
|
<param name="order"> Sort order by the created_at timestamp of the objects. asc for ascending order and desc for descending order. </param>
|
|
<param name="after"> A cursor for use in pagination. after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include after=obj_foo in order to fetch the next page of the list. </param>
|
|
<param name="before"> A cursor for use in pagination. before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include before=obj_foo in order to fetch the previous page of the list. </param>
|
|
<param name="cancellationToken"> The cancellation token to use. </param>
|
|
<exception cref="T:System.ArgumentNullException"> <paramref name="threadId" /> is null. </exception>
|
|
<exception cref="T:System.ArgumentException"> <paramref name="threadId" /> is an empty string, and was expected to be non-empty. </exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.AssistantsClient.InternalGetRuns(System.String,System.Nullable{System.Int32},System.Nullable{Azure.AI.OpenAI.Assistants.ListSortOrder},System.String,System.String,System.Threading.CancellationToken)">
|
|
<summary> Gets a list of runs for a specified thread. </summary>
|
|
<param name="threadId"> The ID of the thread to list runs from. </param>
|
|
<param name="limit"> A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20. </param>
|
|
<param name="order"> Sort order by the created_at timestamp of the objects. asc for ascending order and desc for descending order. </param>
|
|
<param name="after"> A cursor for use in pagination. after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include after=obj_foo in order to fetch the next page of the list. </param>
|
|
<param name="before"> A cursor for use in pagination. before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include before=obj_foo in order to fetch the previous page of the list. </param>
|
|
<param name="cancellationToken"> The cancellation token to use. </param>
|
|
<exception cref="T:System.ArgumentNullException"> <paramref name="threadId" /> is null. </exception>
|
|
<exception cref="T:System.ArgumentException"> <paramref name="threadId" /> is an empty string, and was expected to be non-empty. </exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.AssistantsClient.InternalGetRunsAsync(System.String,System.Nullable{System.Int32},System.String,System.String,System.String,Azure.RequestContext)">
|
|
<summary>
|
|
[Protocol Method] Gets a list of runs for a specified thread.
|
|
<list type="bullet">
|
|
<item>
|
|
<description>
|
|
This <see href="https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/core/Azure.Core/samples/ProtocolMethods.md">protocol method</see> allows explicit creation of the request and processing of the response for advanced scenarios.
|
|
</description>
|
|
</item>
|
|
<item>
|
|
<description>
|
|
Please try the simpler <see cref="M:Azure.AI.OpenAI.Assistants.AssistantsClient.InternalGetRunsAsync(System.String,System.Nullable{System.Int32},System.Nullable{Azure.AI.OpenAI.Assistants.ListSortOrder},System.String,System.String,System.Threading.CancellationToken)" /> convenience overload with strongly typed models first.
|
|
</description>
|
|
</item>
|
|
</list>
|
|
</summary>
|
|
<param name="threadId"> The ID of the thread to list runs from. </param>
|
|
<param name="limit"> A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20. </param>
|
|
<param name="order"> Sort order by the created_at timestamp of the objects. asc for ascending order and desc for descending order. Allowed values: "asc" | "desc". </param>
|
|
<param name="after"> A cursor for use in pagination. after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include after=obj_foo in order to fetch the next page of the list. </param>
|
|
<param name="before"> A cursor for use in pagination. before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include before=obj_foo in order to fetch the previous page of the list. </param>
|
|
<param name="context"> The request context, which can override default behaviors of the client pipeline on a per-call basis. </param>
|
|
<exception cref="T:System.ArgumentNullException"> <paramref name="threadId" /> is null. </exception>
|
|
<exception cref="T:System.ArgumentException"> <paramref name="threadId" /> is an empty string, and was expected to be non-empty. </exception>
|
|
<exception cref="T:Azure.RequestFailedException"> Service returned a non-success status code. </exception>
|
|
<returns> The response returned from the service. </returns>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.AssistantsClient.InternalGetRuns(System.String,System.Nullable{System.Int32},System.String,System.String,System.String,Azure.RequestContext)">
|
|
<summary>
|
|
[Protocol Method] Gets a list of runs for a specified thread.
|
|
<list type="bullet">
|
|
<item>
|
|
<description>
|
|
This <see href="https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/core/Azure.Core/samples/ProtocolMethods.md">protocol method</see> allows explicit creation of the request and processing of the response for advanced scenarios.
|
|
</description>
|
|
</item>
|
|
<item>
|
|
<description>
|
|
Please try the simpler <see cref="M:Azure.AI.OpenAI.Assistants.AssistantsClient.InternalGetRuns(System.String,System.Nullable{System.Int32},System.Nullable{Azure.AI.OpenAI.Assistants.ListSortOrder},System.String,System.String,System.Threading.CancellationToken)" /> convenience overload with strongly typed models first.
|
|
</description>
|
|
</item>
|
|
</list>
|
|
</summary>
|
|
<param name="threadId"> The ID of the thread to list runs from. </param>
|
|
<param name="limit"> A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20. </param>
|
|
<param name="order"> Sort order by the created_at timestamp of the objects. asc for ascending order and desc for descending order. Allowed values: "asc" | "desc". </param>
|
|
<param name="after"> A cursor for use in pagination. after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include after=obj_foo in order to fetch the next page of the list. </param>
|
|
<param name="before"> A cursor for use in pagination. before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include before=obj_foo in order to fetch the previous page of the list. </param>
|
|
<param name="context"> The request context, which can override default behaviors of the client pipeline on a per-call basis. </param>
|
|
<exception cref="T:System.ArgumentNullException"> <paramref name="threadId" /> is null. </exception>
|
|
<exception cref="T:System.ArgumentException"> <paramref name="threadId" /> is an empty string, and was expected to be non-empty. </exception>
|
|
<exception cref="T:Azure.RequestFailedException"> Service returned a non-success status code. </exception>
|
|
<returns> The response returned from the service. </returns>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.AssistantsClient.GetRunAsync(System.String,System.String,System.Threading.CancellationToken)">
|
|
<summary> Gets an existing run from an existing thread. </summary>
|
|
<param name="threadId"> The ID of the thread to retrieve run information from. </param>
|
|
<param name="runId"> The ID of the thread to retrieve information about. </param>
|
|
<param name="cancellationToken"> The cancellation token to use. </param>
|
|
<exception cref="T:System.ArgumentNullException"> <paramref name="threadId" /> or <paramref name="runId" /> is null. </exception>
|
|
<exception cref="T:System.ArgumentException"> <paramref name="threadId" /> or <paramref name="runId" /> is an empty string, and was expected to be non-empty. </exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.AssistantsClient.GetRun(System.String,System.String,System.Threading.CancellationToken)">
|
|
<summary> Gets an existing run from an existing thread. </summary>
|
|
<param name="threadId"> The ID of the thread to retrieve run information from. </param>
|
|
<param name="runId"> The ID of the thread to retrieve information about. </param>
|
|
<param name="cancellationToken"> The cancellation token to use. </param>
|
|
<exception cref="T:System.ArgumentNullException"> <paramref name="threadId" /> or <paramref name="runId" /> is null. </exception>
|
|
<exception cref="T:System.ArgumentException"> <paramref name="threadId" /> or <paramref name="runId" /> is an empty string, and was expected to be non-empty. </exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.AssistantsClient.GetRunAsync(System.String,System.String,Azure.RequestContext)">
|
|
<summary>
|
|
[Protocol Method] Gets an existing run from an existing thread.
|
|
<list type="bullet">
|
|
<item>
|
|
<description>
|
|
This <see href="https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/core/Azure.Core/samples/ProtocolMethods.md">protocol method</see> allows explicit creation of the request and processing of the response for advanced scenarios.
|
|
</description>
|
|
</item>
|
|
</list>
|
|
</summary>
|
|
<param name="threadId"> The ID of the thread to retrieve run information from. </param>
|
|
<param name="runId"> The ID of the thread to retrieve information about. </param>
|
|
<param name="context"> The request context, which can override default behaviors of the client pipeline on a per-call basis. </param>
|
|
<exception cref="T:System.ArgumentNullException"> <paramref name="threadId" /> or <paramref name="runId" /> is null. </exception>
|
|
<exception cref="T:System.ArgumentException"> <paramref name="threadId" /> or <paramref name="runId" /> is an empty string, and was expected to be non-empty. </exception>
|
|
<exception cref="T:Azure.RequestFailedException"> Service returned a non-success status code. </exception>
|
|
<returns> The response returned from the service. </returns>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.AssistantsClient.GetRun(System.String,System.String,Azure.RequestContext)">
|
|
<summary>
|
|
[Protocol Method] Gets an existing run from an existing thread.
|
|
<list type="bullet">
|
|
<item>
|
|
<description>
|
|
This <see href="https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/core/Azure.Core/samples/ProtocolMethods.md">protocol method</see> allows explicit creation of the request and processing of the response for advanced scenarios.
|
|
</description>
|
|
</item>
|
|
</list>
|
|
</summary>
|
|
<param name="threadId"> The ID of the thread to retrieve run information from. </param>
|
|
<param name="runId"> The ID of the thread to retrieve information about. </param>
|
|
<param name="context"> The request context, which can override default behaviors of the client pipeline on a per-call basis. </param>
|
|
<exception cref="T:System.ArgumentNullException"> <paramref name="threadId" /> or <paramref name="runId" /> is null. </exception>
|
|
<exception cref="T:System.ArgumentException"> <paramref name="threadId" /> or <paramref name="runId" /> is an empty string, and was expected to be non-empty. </exception>
|
|
<exception cref="T:Azure.RequestFailedException"> Service returned a non-success status code. </exception>
|
|
<returns> The response returned from the service. </returns>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.AssistantsClient.UpdateRunAsync(System.String,System.String,System.Collections.Generic.IDictionary{System.String,System.String},System.Threading.CancellationToken)">
|
|
<summary> Modifies an existing thread run. </summary>
|
|
<param name="threadId"> The ID of the thread associated with the specified run. </param>
|
|
<param name="runId"> The ID of the run to modify. </param>
|
|
<param name="metadata"> 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. </param>
|
|
<param name="cancellationToken"> The cancellation token to use. </param>
|
|
<exception cref="T:System.ArgumentNullException"> <paramref name="threadId" /> or <paramref name="runId" /> is null. </exception>
|
|
<exception cref="T:System.ArgumentException"> <paramref name="threadId" /> or <paramref name="runId" /> is an empty string, and was expected to be non-empty. </exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.AssistantsClient.UpdateRun(System.String,System.String,System.Collections.Generic.IDictionary{System.String,System.String},System.Threading.CancellationToken)">
|
|
<summary> Modifies an existing thread run. </summary>
|
|
<param name="threadId"> The ID of the thread associated with the specified run. </param>
|
|
<param name="runId"> The ID of the run to modify. </param>
|
|
<param name="metadata"> 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. </param>
|
|
<param name="cancellationToken"> The cancellation token to use. </param>
|
|
<exception cref="T:System.ArgumentNullException"> <paramref name="threadId" /> or <paramref name="runId" /> is null. </exception>
|
|
<exception cref="T:System.ArgumentException"> <paramref name="threadId" /> or <paramref name="runId" /> is an empty string, and was expected to be non-empty. </exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.AssistantsClient.UpdateRunAsync(System.String,System.String,Azure.Core.RequestContent,Azure.RequestContext)">
|
|
<summary>
|
|
[Protocol Method] Modifies an existing thread run.
|
|
<list type="bullet">
|
|
<item>
|
|
<description>
|
|
This <see href="https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/core/Azure.Core/samples/ProtocolMethods.md">protocol method</see> allows explicit creation of the request and processing of the response for advanced scenarios.
|
|
</description>
|
|
</item>
|
|
</list>
|
|
</summary>
|
|
<param name="threadId"> The ID of the thread associated with the specified run. </param>
|
|
<param name="runId"> The ID of the run to modify. </param>
|
|
<param name="content"> The content to send as the body of the request. </param>
|
|
<param name="context"> The request context, which can override default behaviors of the client pipeline on a per-call basis. </param>
|
|
<exception cref="T:System.ArgumentNullException"> <paramref name="threadId" />, <paramref name="runId" /> or <paramref name="content" /> is null. </exception>
|
|
<exception cref="T:System.ArgumentException"> <paramref name="threadId" /> or <paramref name="runId" /> is an empty string, and was expected to be non-empty. </exception>
|
|
<exception cref="T:Azure.RequestFailedException"> Service returned a non-success status code. </exception>
|
|
<returns> The response returned from the service. </returns>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.AssistantsClient.UpdateRun(System.String,System.String,Azure.Core.RequestContent,Azure.RequestContext)">
|
|
<summary>
|
|
[Protocol Method] Modifies an existing thread run.
|
|
<list type="bullet">
|
|
<item>
|
|
<description>
|
|
This <see href="https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/core/Azure.Core/samples/ProtocolMethods.md">protocol method</see> allows explicit creation of the request and processing of the response for advanced scenarios.
|
|
</description>
|
|
</item>
|
|
</list>
|
|
</summary>
|
|
<param name="threadId"> The ID of the thread associated with the specified run. </param>
|
|
<param name="runId"> The ID of the run to modify. </param>
|
|
<param name="content"> The content to send as the body of the request. </param>
|
|
<param name="context"> The request context, which can override default behaviors of the client pipeline on a per-call basis. </param>
|
|
<exception cref="T:System.ArgumentNullException"> <paramref name="threadId" />, <paramref name="runId" /> or <paramref name="content" /> is null. </exception>
|
|
<exception cref="T:System.ArgumentException"> <paramref name="threadId" /> or <paramref name="runId" /> is an empty string, and was expected to be non-empty. </exception>
|
|
<exception cref="T:Azure.RequestFailedException"> Service returned a non-success status code. </exception>
|
|
<returns> The response returned from the service. </returns>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.AssistantsClient.SubmitToolOutputsToRunAsync(System.String,System.String,System.Collections.Generic.IEnumerable{Azure.AI.OpenAI.Assistants.ToolOutput},System.Threading.CancellationToken)">
|
|
<summary> Submits outputs from tools as requested by tool calls in a run. Runs that need submitted tool outputs will have a status of 'requires_action' with a required_action.type of 'submit_tool_outputs'. </summary>
|
|
<param name="threadId"> The ID of the thread that was run. </param>
|
|
<param name="runId"> The ID of the run that requires tool outputs. </param>
|
|
<param name="toolOutputs"> The list of tool outputs requested by tool calls from the specified run. </param>
|
|
<param name="cancellationToken"> The cancellation token to use. </param>
|
|
<exception cref="T:System.ArgumentNullException"> <paramref name="threadId" />, <paramref name="runId" /> or <paramref name="toolOutputs" /> is null. </exception>
|
|
<exception cref="T:System.ArgumentException"> <paramref name="threadId" /> or <paramref name="runId" /> is an empty string, and was expected to be non-empty. </exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.AssistantsClient.SubmitToolOutputsToRun(System.String,System.String,System.Collections.Generic.IEnumerable{Azure.AI.OpenAI.Assistants.ToolOutput},System.Threading.CancellationToken)">
|
|
<summary> Submits outputs from tools as requested by tool calls in a run. Runs that need submitted tool outputs will have a status of 'requires_action' with a required_action.type of 'submit_tool_outputs'. </summary>
|
|
<param name="threadId"> The ID of the thread that was run. </param>
|
|
<param name="runId"> The ID of the run that requires tool outputs. </param>
|
|
<param name="toolOutputs"> The list of tool outputs requested by tool calls from the specified run. </param>
|
|
<param name="cancellationToken"> The cancellation token to use. </param>
|
|
<exception cref="T:System.ArgumentNullException"> <paramref name="threadId" />, <paramref name="runId" /> or <paramref name="toolOutputs" /> is null. </exception>
|
|
<exception cref="T:System.ArgumentException"> <paramref name="threadId" /> or <paramref name="runId" /> is an empty string, and was expected to be non-empty. </exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.AssistantsClient.SubmitToolOutputsToRunAsync(System.String,System.String,Azure.Core.RequestContent,Azure.RequestContext)">
|
|
<summary>
|
|
[Protocol Method] Submits outputs from tools as requested by tool calls in a run. Runs that need submitted tool outputs will have a status of 'requires_action' with a required_action.type of 'submit_tool_outputs'.
|
|
<list type="bullet">
|
|
<item>
|
|
<description>
|
|
This <see href="https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/core/Azure.Core/samples/ProtocolMethods.md">protocol method</see> allows explicit creation of the request and processing of the response for advanced scenarios.
|
|
</description>
|
|
</item>
|
|
</list>
|
|
</summary>
|
|
<param name="threadId"> The ID of the thread that was run. </param>
|
|
<param name="runId"> The ID of the run that requires tool outputs. </param>
|
|
<param name="content"> The content to send as the body of the request. </param>
|
|
<param name="context"> The request context, which can override default behaviors of the client pipeline on a per-call basis. </param>
|
|
<exception cref="T:System.ArgumentNullException"> <paramref name="threadId" />, <paramref name="runId" /> or <paramref name="content" /> is null. </exception>
|
|
<exception cref="T:System.ArgumentException"> <paramref name="threadId" /> or <paramref name="runId" /> is an empty string, and was expected to be non-empty. </exception>
|
|
<exception cref="T:Azure.RequestFailedException"> Service returned a non-success status code. </exception>
|
|
<returns> The response returned from the service. </returns>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.AssistantsClient.SubmitToolOutputsToRun(System.String,System.String,Azure.Core.RequestContent,Azure.RequestContext)">
|
|
<summary>
|
|
[Protocol Method] Submits outputs from tools as requested by tool calls in a run. Runs that need submitted tool outputs will have a status of 'requires_action' with a required_action.type of 'submit_tool_outputs'.
|
|
<list type="bullet">
|
|
<item>
|
|
<description>
|
|
This <see href="https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/core/Azure.Core/samples/ProtocolMethods.md">protocol method</see> allows explicit creation of the request and processing of the response for advanced scenarios.
|
|
</description>
|
|
</item>
|
|
</list>
|
|
</summary>
|
|
<param name="threadId"> The ID of the thread that was run. </param>
|
|
<param name="runId"> The ID of the run that requires tool outputs. </param>
|
|
<param name="content"> The content to send as the body of the request. </param>
|
|
<param name="context"> The request context, which can override default behaviors of the client pipeline on a per-call basis. </param>
|
|
<exception cref="T:System.ArgumentNullException"> <paramref name="threadId" />, <paramref name="runId" /> or <paramref name="content" /> is null. </exception>
|
|
<exception cref="T:System.ArgumentException"> <paramref name="threadId" /> or <paramref name="runId" /> is an empty string, and was expected to be non-empty. </exception>
|
|
<exception cref="T:Azure.RequestFailedException"> Service returned a non-success status code. </exception>
|
|
<returns> The response returned from the service. </returns>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.AssistantsClient.CancelRunAsync(System.String,System.String,System.Threading.CancellationToken)">
|
|
<summary> Cancels a run of an in progress thread. </summary>
|
|
<param name="threadId"> The ID of the thread being run. </param>
|
|
<param name="runId"> The ID of the run to cancel. </param>
|
|
<param name="cancellationToken"> The cancellation token to use. </param>
|
|
<exception cref="T:System.ArgumentNullException"> <paramref name="threadId" /> or <paramref name="runId" /> is null. </exception>
|
|
<exception cref="T:System.ArgumentException"> <paramref name="threadId" /> or <paramref name="runId" /> is an empty string, and was expected to be non-empty. </exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.AssistantsClient.CancelRun(System.String,System.String,System.Threading.CancellationToken)">
|
|
<summary> Cancels a run of an in progress thread. </summary>
|
|
<param name="threadId"> The ID of the thread being run. </param>
|
|
<param name="runId"> The ID of the run to cancel. </param>
|
|
<param name="cancellationToken"> The cancellation token to use. </param>
|
|
<exception cref="T:System.ArgumentNullException"> <paramref name="threadId" /> or <paramref name="runId" /> is null. </exception>
|
|
<exception cref="T:System.ArgumentException"> <paramref name="threadId" /> or <paramref name="runId" /> is an empty string, and was expected to be non-empty. </exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.AssistantsClient.CancelRunAsync(System.String,System.String,Azure.RequestContext)">
|
|
<summary>
|
|
[Protocol Method] Cancels a run of an in progress thread.
|
|
<list type="bullet">
|
|
<item>
|
|
<description>
|
|
This <see href="https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/core/Azure.Core/samples/ProtocolMethods.md">protocol method</see> allows explicit creation of the request and processing of the response for advanced scenarios.
|
|
</description>
|
|
</item>
|
|
</list>
|
|
</summary>
|
|
<param name="threadId"> The ID of the thread being run. </param>
|
|
<param name="runId"> The ID of the run to cancel. </param>
|
|
<param name="context"> The request context, which can override default behaviors of the client pipeline on a per-call basis. </param>
|
|
<exception cref="T:System.ArgumentNullException"> <paramref name="threadId" /> or <paramref name="runId" /> is null. </exception>
|
|
<exception cref="T:System.ArgumentException"> <paramref name="threadId" /> or <paramref name="runId" /> is an empty string, and was expected to be non-empty. </exception>
|
|
<exception cref="T:Azure.RequestFailedException"> Service returned a non-success status code. </exception>
|
|
<returns> The response returned from the service. </returns>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.AssistantsClient.CancelRun(System.String,System.String,Azure.RequestContext)">
|
|
<summary>
|
|
[Protocol Method] Cancels a run of an in progress thread.
|
|
<list type="bullet">
|
|
<item>
|
|
<description>
|
|
This <see href="https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/core/Azure.Core/samples/ProtocolMethods.md">protocol method</see> allows explicit creation of the request and processing of the response for advanced scenarios.
|
|
</description>
|
|
</item>
|
|
</list>
|
|
</summary>
|
|
<param name="threadId"> The ID of the thread being run. </param>
|
|
<param name="runId"> The ID of the run to cancel. </param>
|
|
<param name="context"> The request context, which can override default behaviors of the client pipeline on a per-call basis. </param>
|
|
<exception cref="T:System.ArgumentNullException"> <paramref name="threadId" /> or <paramref name="runId" /> is null. </exception>
|
|
<exception cref="T:System.ArgumentException"> <paramref name="threadId" /> or <paramref name="runId" /> is an empty string, and was expected to be non-empty. </exception>
|
|
<exception cref="T:Azure.RequestFailedException"> Service returned a non-success status code. </exception>
|
|
<returns> The response returned from the service. </returns>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.AssistantsClient.CreateThreadAndRunAsync(Azure.AI.OpenAI.Assistants.CreateAndRunThreadOptions,System.Threading.CancellationToken)">
|
|
<summary> Creates a new assistant thread and immediately starts a run using that new thread. </summary>
|
|
<param name="createAndRunThreadOptions"> The details used when creating and immediately running a new assistant thread. </param>
|
|
<param name="cancellationToken"> The cancellation token to use. </param>
|
|
<exception cref="T:System.ArgumentNullException"> <paramref name="createAndRunThreadOptions" /> is null. </exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.AssistantsClient.CreateThreadAndRun(Azure.AI.OpenAI.Assistants.CreateAndRunThreadOptions,System.Threading.CancellationToken)">
|
|
<summary> Creates a new assistant thread and immediately starts a run using that new thread. </summary>
|
|
<param name="createAndRunThreadOptions"> The details used when creating and immediately running a new assistant thread. </param>
|
|
<param name="cancellationToken"> The cancellation token to use. </param>
|
|
<exception cref="T:System.ArgumentNullException"> <paramref name="createAndRunThreadOptions" /> is null. </exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.AssistantsClient.CreateThreadAndRunAsync(Azure.Core.RequestContent,Azure.RequestContext)">
|
|
<summary>
|
|
[Protocol Method] Creates a new assistant thread and immediately starts a run using that new thread.
|
|
<list type="bullet">
|
|
<item>
|
|
<description>
|
|
This <see href="https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/core/Azure.Core/samples/ProtocolMethods.md">protocol method</see> allows explicit creation of the request and processing of the response for advanced scenarios.
|
|
</description>
|
|
</item>
|
|
</list>
|
|
</summary>
|
|
<param name="content"> The content to send as the body of the request. </param>
|
|
<param name="context"> The request context, which can override default behaviors of the client pipeline on a per-call basis. </param>
|
|
<exception cref="T:System.ArgumentNullException"> <paramref name="content" /> is null. </exception>
|
|
<exception cref="T:Azure.RequestFailedException"> Service returned a non-success status code. </exception>
|
|
<returns> The response returned from the service. </returns>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.AssistantsClient.CreateThreadAndRun(Azure.Core.RequestContent,Azure.RequestContext)">
|
|
<summary>
|
|
[Protocol Method] Creates a new assistant thread and immediately starts a run using that new thread.
|
|
<list type="bullet">
|
|
<item>
|
|
<description>
|
|
This <see href="https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/core/Azure.Core/samples/ProtocolMethods.md">protocol method</see> allows explicit creation of the request and processing of the response for advanced scenarios.
|
|
</description>
|
|
</item>
|
|
</list>
|
|
</summary>
|
|
<param name="content"> The content to send as the body of the request. </param>
|
|
<param name="context"> The request context, which can override default behaviors of the client pipeline on a per-call basis. </param>
|
|
<exception cref="T:System.ArgumentNullException"> <paramref name="content" /> is null. </exception>
|
|
<exception cref="T:Azure.RequestFailedException"> Service returned a non-success status code. </exception>
|
|
<returns> The response returned from the service. </returns>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.AssistantsClient.GetRunStepAsync(System.String,System.String,System.String,System.Threading.CancellationToken)">
|
|
<summary> Gets a single run step from a thread run. </summary>
|
|
<param name="threadId"> The ID of the thread that was run. </param>
|
|
<param name="runId"> The ID of the specific run to retrieve the step from. </param>
|
|
<param name="stepId"> The ID of the step to retrieve information about. </param>
|
|
<param name="cancellationToken"> The cancellation token to use. </param>
|
|
<exception cref="T:System.ArgumentNullException"> <paramref name="threadId" />, <paramref name="runId" /> or <paramref name="stepId" /> is null. </exception>
|
|
<exception cref="T:System.ArgumentException"> <paramref name="threadId" />, <paramref name="runId" /> or <paramref name="stepId" /> is an empty string, and was expected to be non-empty. </exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.AssistantsClient.GetRunStep(System.String,System.String,System.String,System.Threading.CancellationToken)">
|
|
<summary> Gets a single run step from a thread run. </summary>
|
|
<param name="threadId"> The ID of the thread that was run. </param>
|
|
<param name="runId"> The ID of the specific run to retrieve the step from. </param>
|
|
<param name="stepId"> The ID of the step to retrieve information about. </param>
|
|
<param name="cancellationToken"> The cancellation token to use. </param>
|
|
<exception cref="T:System.ArgumentNullException"> <paramref name="threadId" />, <paramref name="runId" /> or <paramref name="stepId" /> is null. </exception>
|
|
<exception cref="T:System.ArgumentException"> <paramref name="threadId" />, <paramref name="runId" /> or <paramref name="stepId" /> is an empty string, and was expected to be non-empty. </exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.AssistantsClient.GetRunStepAsync(System.String,System.String,System.String,Azure.RequestContext)">
|
|
<summary>
|
|
[Protocol Method] Gets a single run step from a thread run.
|
|
<list type="bullet">
|
|
<item>
|
|
<description>
|
|
This <see href="https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/core/Azure.Core/samples/ProtocolMethods.md">protocol method</see> allows explicit creation of the request and processing of the response for advanced scenarios.
|
|
</description>
|
|
</item>
|
|
</list>
|
|
</summary>
|
|
<param name="threadId"> The ID of the thread that was run. </param>
|
|
<param name="runId"> The ID of the specific run to retrieve the step from. </param>
|
|
<param name="stepId"> The ID of the step to retrieve information about. </param>
|
|
<param name="context"> The request context, which can override default behaviors of the client pipeline on a per-call basis. </param>
|
|
<exception cref="T:System.ArgumentNullException"> <paramref name="threadId" />, <paramref name="runId" /> or <paramref name="stepId" /> is null. </exception>
|
|
<exception cref="T:System.ArgumentException"> <paramref name="threadId" />, <paramref name="runId" /> or <paramref name="stepId" /> is an empty string, and was expected to be non-empty. </exception>
|
|
<exception cref="T:Azure.RequestFailedException"> Service returned a non-success status code. </exception>
|
|
<returns> The response returned from the service. </returns>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.AssistantsClient.GetRunStep(System.String,System.String,System.String,Azure.RequestContext)">
|
|
<summary>
|
|
[Protocol Method] Gets a single run step from a thread run.
|
|
<list type="bullet">
|
|
<item>
|
|
<description>
|
|
This <see href="https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/core/Azure.Core/samples/ProtocolMethods.md">protocol method</see> allows explicit creation of the request and processing of the response for advanced scenarios.
|
|
</description>
|
|
</item>
|
|
</list>
|
|
</summary>
|
|
<param name="threadId"> The ID of the thread that was run. </param>
|
|
<param name="runId"> The ID of the specific run to retrieve the step from. </param>
|
|
<param name="stepId"> The ID of the step to retrieve information about. </param>
|
|
<param name="context"> The request context, which can override default behaviors of the client pipeline on a per-call basis. </param>
|
|
<exception cref="T:System.ArgumentNullException"> <paramref name="threadId" />, <paramref name="runId" /> or <paramref name="stepId" /> is null. </exception>
|
|
<exception cref="T:System.ArgumentException"> <paramref name="threadId" />, <paramref name="runId" /> or <paramref name="stepId" /> is an empty string, and was expected to be non-empty. </exception>
|
|
<exception cref="T:Azure.RequestFailedException"> Service returned a non-success status code. </exception>
|
|
<returns> The response returned from the service. </returns>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.AssistantsClient.InternalGetRunStepsAsync(System.String,System.String,System.Nullable{System.Int32},System.Nullable{Azure.AI.OpenAI.Assistants.ListSortOrder},System.String,System.String,System.Threading.CancellationToken)">
|
|
<summary> Gets a list of run steps from a thread run. </summary>
|
|
<param name="threadId"> The ID of the thread that was run. </param>
|
|
<param name="runId"> The ID of the run to list steps from. </param>
|
|
<param name="limit"> A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20. </param>
|
|
<param name="order"> Sort order by the created_at timestamp of the objects. asc for ascending order and desc for descending order. </param>
|
|
<param name="after"> A cursor for use in pagination. after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include after=obj_foo in order to fetch the next page of the list. </param>
|
|
<param name="before"> A cursor for use in pagination. before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include before=obj_foo in order to fetch the previous page of the list. </param>
|
|
<param name="cancellationToken"> The cancellation token to use. </param>
|
|
<exception cref="T:System.ArgumentNullException"> <paramref name="threadId" /> or <paramref name="runId" /> is null. </exception>
|
|
<exception cref="T:System.ArgumentException"> <paramref name="threadId" /> or <paramref name="runId" /> is an empty string, and was expected to be non-empty. </exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.AssistantsClient.InternalGetRunSteps(System.String,System.String,System.Nullable{System.Int32},System.Nullable{Azure.AI.OpenAI.Assistants.ListSortOrder},System.String,System.String,System.Threading.CancellationToken)">
|
|
<summary> Gets a list of run steps from a thread run. </summary>
|
|
<param name="threadId"> The ID of the thread that was run. </param>
|
|
<param name="runId"> The ID of the run to list steps from. </param>
|
|
<param name="limit"> A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20. </param>
|
|
<param name="order"> Sort order by the created_at timestamp of the objects. asc for ascending order and desc for descending order. </param>
|
|
<param name="after"> A cursor for use in pagination. after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include after=obj_foo in order to fetch the next page of the list. </param>
|
|
<param name="before"> A cursor for use in pagination. before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include before=obj_foo in order to fetch the previous page of the list. </param>
|
|
<param name="cancellationToken"> The cancellation token to use. </param>
|
|
<exception cref="T:System.ArgumentNullException"> <paramref name="threadId" /> or <paramref name="runId" /> is null. </exception>
|
|
<exception cref="T:System.ArgumentException"> <paramref name="threadId" /> or <paramref name="runId" /> is an empty string, and was expected to be non-empty. </exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.AssistantsClient.InternalGetRunStepsAsync(System.String,System.String,System.Nullable{System.Int32},System.String,System.String,System.String,Azure.RequestContext)">
|
|
<summary>
|
|
[Protocol Method] Gets a list of run steps from a thread run.
|
|
<list type="bullet">
|
|
<item>
|
|
<description>
|
|
This <see href="https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/core/Azure.Core/samples/ProtocolMethods.md">protocol method</see> allows explicit creation of the request and processing of the response for advanced scenarios.
|
|
</description>
|
|
</item>
|
|
<item>
|
|
<description>
|
|
Please try the simpler <see cref="M:Azure.AI.OpenAI.Assistants.AssistantsClient.InternalGetRunStepsAsync(System.String,System.String,System.Nullable{System.Int32},System.Nullable{Azure.AI.OpenAI.Assistants.ListSortOrder},System.String,System.String,System.Threading.CancellationToken)" /> convenience overload with strongly typed models first.
|
|
</description>
|
|
</item>
|
|
</list>
|
|
</summary>
|
|
<param name="threadId"> The ID of the thread that was run. </param>
|
|
<param name="runId"> The ID of the run to list steps from. </param>
|
|
<param name="limit"> A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20. </param>
|
|
<param name="order"> Sort order by the created_at timestamp of the objects. asc for ascending order and desc for descending order. Allowed values: "asc" | "desc". </param>
|
|
<param name="after"> A cursor for use in pagination. after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include after=obj_foo in order to fetch the next page of the list. </param>
|
|
<param name="before"> A cursor for use in pagination. before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include before=obj_foo in order to fetch the previous page of the list. </param>
|
|
<param name="context"> The request context, which can override default behaviors of the client pipeline on a per-call basis. </param>
|
|
<exception cref="T:System.ArgumentNullException"> <paramref name="threadId" /> or <paramref name="runId" /> is null. </exception>
|
|
<exception cref="T:System.ArgumentException"> <paramref name="threadId" /> or <paramref name="runId" /> is an empty string, and was expected to be non-empty. </exception>
|
|
<exception cref="T:Azure.RequestFailedException"> Service returned a non-success status code. </exception>
|
|
<returns> The response returned from the service. </returns>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.AssistantsClient.InternalGetRunSteps(System.String,System.String,System.Nullable{System.Int32},System.String,System.String,System.String,Azure.RequestContext)">
|
|
<summary>
|
|
[Protocol Method] Gets a list of run steps from a thread run.
|
|
<list type="bullet">
|
|
<item>
|
|
<description>
|
|
This <see href="https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/core/Azure.Core/samples/ProtocolMethods.md">protocol method</see> allows explicit creation of the request and processing of the response for advanced scenarios.
|
|
</description>
|
|
</item>
|
|
<item>
|
|
<description>
|
|
Please try the simpler <see cref="M:Azure.AI.OpenAI.Assistants.AssistantsClient.InternalGetRunSteps(System.String,System.String,System.Nullable{System.Int32},System.Nullable{Azure.AI.OpenAI.Assistants.ListSortOrder},System.String,System.String,System.Threading.CancellationToken)" /> convenience overload with strongly typed models first.
|
|
</description>
|
|
</item>
|
|
</list>
|
|
</summary>
|
|
<param name="threadId"> The ID of the thread that was run. </param>
|
|
<param name="runId"> The ID of the run to list steps from. </param>
|
|
<param name="limit"> A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20. </param>
|
|
<param name="order"> Sort order by the created_at timestamp of the objects. asc for ascending order and desc for descending order. Allowed values: "asc" | "desc". </param>
|
|
<param name="after"> A cursor for use in pagination. after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include after=obj_foo in order to fetch the next page of the list. </param>
|
|
<param name="before"> A cursor for use in pagination. before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include before=obj_foo in order to fetch the previous page of the list. </param>
|
|
<param name="context"> The request context, which can override default behaviors of the client pipeline on a per-call basis. </param>
|
|
<exception cref="T:System.ArgumentNullException"> <paramref name="threadId" /> or <paramref name="runId" /> is null. </exception>
|
|
<exception cref="T:System.ArgumentException"> <paramref name="threadId" /> or <paramref name="runId" /> is an empty string, and was expected to be non-empty. </exception>
|
|
<exception cref="T:Azure.RequestFailedException"> Service returned a non-success status code. </exception>
|
|
<returns> The response returned from the service. </returns>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.AssistantsClient.InternalListFilesAsync(System.Nullable{Azure.AI.OpenAI.Assistants.OpenAIFilePurpose},System.Threading.CancellationToken)">
|
|
<summary> Gets a list of previously uploaded files. </summary>
|
|
<param name="purpose"> A value that, when provided, limits list results to files matching the corresponding purpose. </param>
|
|
<param name="cancellationToken"> The cancellation token to use. </param>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.AssistantsClient.InternalListFiles(System.Nullable{Azure.AI.OpenAI.Assistants.OpenAIFilePurpose},System.Threading.CancellationToken)">
|
|
<summary> Gets a list of previously uploaded files. </summary>
|
|
<param name="purpose"> A value that, when provided, limits list results to files matching the corresponding purpose. </param>
|
|
<param name="cancellationToken"> The cancellation token to use. </param>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.AssistantsClient.InternalListFilesAsync(System.String,Azure.RequestContext)">
|
|
<summary>
|
|
[Protocol Method] Gets a list of previously uploaded files.
|
|
<list type="bullet">
|
|
<item>
|
|
<description>
|
|
This <see href="https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/core/Azure.Core/samples/ProtocolMethods.md">protocol method</see> allows explicit creation of the request and processing of the response for advanced scenarios.
|
|
</description>
|
|
</item>
|
|
<item>
|
|
<description>
|
|
Please try the simpler <see cref="M:Azure.AI.OpenAI.Assistants.AssistantsClient.InternalListFilesAsync(System.Nullable{Azure.AI.OpenAI.Assistants.OpenAIFilePurpose},System.Threading.CancellationToken)" /> convenience overload with strongly typed models first.
|
|
</description>
|
|
</item>
|
|
</list>
|
|
</summary>
|
|
<param name="purpose"> A value that, when provided, limits list results to files matching the corresponding purpose. Allowed values: "fine-tune" | "fine-tune-results" | "assistants" | "assistants_output". </param>
|
|
<param name="context"> The request context, which can override default behaviors of the client pipeline on a per-call basis. </param>
|
|
<exception cref="T:Azure.RequestFailedException"> Service returned a non-success status code. </exception>
|
|
<returns> The response returned from the service. </returns>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.AssistantsClient.InternalListFiles(System.String,Azure.RequestContext)">
|
|
<summary>
|
|
[Protocol Method] Gets a list of previously uploaded files.
|
|
<list type="bullet">
|
|
<item>
|
|
<description>
|
|
This <see href="https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/core/Azure.Core/samples/ProtocolMethods.md">protocol method</see> allows explicit creation of the request and processing of the response for advanced scenarios.
|
|
</description>
|
|
</item>
|
|
<item>
|
|
<description>
|
|
Please try the simpler <see cref="M:Azure.AI.OpenAI.Assistants.AssistantsClient.InternalListFiles(System.Nullable{Azure.AI.OpenAI.Assistants.OpenAIFilePurpose},System.Threading.CancellationToken)" /> convenience overload with strongly typed models first.
|
|
</description>
|
|
</item>
|
|
</list>
|
|
</summary>
|
|
<param name="purpose"> A value that, when provided, limits list results to files matching the corresponding purpose. Allowed values: "fine-tune" | "fine-tune-results" | "assistants" | "assistants_output". </param>
|
|
<param name="context"> The request context, which can override default behaviors of the client pipeline on a per-call basis. </param>
|
|
<exception cref="T:Azure.RequestFailedException"> Service returned a non-success status code. </exception>
|
|
<returns> The response returned from the service. </returns>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.AssistantsClient.UploadFileAsync(System.IO.Stream,Azure.AI.OpenAI.Assistants.OpenAIFilePurpose,System.String,System.Threading.CancellationToken)">
|
|
<summary> Uploads a file for use by other operations. </summary>
|
|
<param name="data"> The file data (not filename) to upload. </param>
|
|
<param name="purpose"> The intended purpose of the file. </param>
|
|
<param name="filename"> A filename to associate with the uploaded data. </param>
|
|
<param name="cancellationToken"> The cancellation token to use. </param>
|
|
<exception cref="T:System.ArgumentNullException"> <paramref name="data" /> is null. </exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.AssistantsClient.UploadFile(System.IO.Stream,Azure.AI.OpenAI.Assistants.OpenAIFilePurpose,System.String,System.Threading.CancellationToken)">
|
|
<summary> Uploads a file for use by other operations. </summary>
|
|
<param name="data"> The file data (not filename) to upload. </param>
|
|
<param name="purpose"> The intended purpose of the file. </param>
|
|
<param name="filename"> A filename to associate with the uploaded data. </param>
|
|
<param name="cancellationToken"> The cancellation token to use. </param>
|
|
<exception cref="T:System.ArgumentNullException"> <paramref name="data" /> is null. </exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.AssistantsClient.UploadFileAsync(Azure.Core.RequestContent,System.String,Azure.RequestContext)">
|
|
<summary>
|
|
[Protocol Method] Uploads a file for use by other operations.
|
|
<list type="bullet">
|
|
<item>
|
|
<description>
|
|
This <see href="https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/core/Azure.Core/samples/ProtocolMethods.md">protocol method</see> allows explicit creation of the request and processing of the response for advanced scenarios.
|
|
</description>
|
|
</item>
|
|
</list>
|
|
</summary>
|
|
<param name="content"> The content to send as the body of the request. </param>
|
|
<param name="contentType"> The 'content-type' header value, always 'multipart/format-data' for this operation. Allowed values: "multipart/form-data". </param>
|
|
<param name="context"> The request context, which can override default behaviors of the client pipeline on a per-call basis. </param>
|
|
<exception cref="T:System.ArgumentNullException"> <paramref name="content" /> is null. </exception>
|
|
<exception cref="T:Azure.RequestFailedException"> Service returned a non-success status code. </exception>
|
|
<returns> The response returned from the service. </returns>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.AssistantsClient.UploadFile(Azure.Core.RequestContent,System.String,Azure.RequestContext)">
|
|
<summary>
|
|
[Protocol Method] Uploads a file for use by other operations.
|
|
<list type="bullet">
|
|
<item>
|
|
<description>
|
|
This <see href="https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/core/Azure.Core/samples/ProtocolMethods.md">protocol method</see> allows explicit creation of the request and processing of the response for advanced scenarios.
|
|
</description>
|
|
</item>
|
|
</list>
|
|
</summary>
|
|
<param name="content"> The content to send as the body of the request. </param>
|
|
<param name="contentType"> The 'content-type' header value, always 'multipart/format-data' for this operation. Allowed values: "multipart/form-data". </param>
|
|
<param name="context"> The request context, which can override default behaviors of the client pipeline on a per-call basis. </param>
|
|
<exception cref="T:System.ArgumentNullException"> <paramref name="content" /> is null. </exception>
|
|
<exception cref="T:Azure.RequestFailedException"> Service returned a non-success status code. </exception>
|
|
<returns> The response returned from the service. </returns>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.AssistantsClient.InternalDeleteFileAsync(System.String,System.Threading.CancellationToken)">
|
|
<summary> Delete a previously uploaded file. </summary>
|
|
<param name="fileId"> The ID of the file to delete. </param>
|
|
<param name="cancellationToken"> The cancellation token to use. </param>
|
|
<exception cref="T:System.ArgumentNullException"> <paramref name="fileId" /> is null. </exception>
|
|
<exception cref="T:System.ArgumentException"> <paramref name="fileId" /> is an empty string, and was expected to be non-empty. </exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.AssistantsClient.InternalDeleteFile(System.String,System.Threading.CancellationToken)">
|
|
<summary> Delete a previously uploaded file. </summary>
|
|
<param name="fileId"> The ID of the file to delete. </param>
|
|
<param name="cancellationToken"> The cancellation token to use. </param>
|
|
<exception cref="T:System.ArgumentNullException"> <paramref name="fileId" /> is null. </exception>
|
|
<exception cref="T:System.ArgumentException"> <paramref name="fileId" /> is an empty string, and was expected to be non-empty. </exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.AssistantsClient.InternalDeleteFileAsync(System.String,Azure.RequestContext)">
|
|
<summary>
|
|
[Protocol Method] Delete a previously uploaded file.
|
|
<list type="bullet">
|
|
<item>
|
|
<description>
|
|
This <see href="https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/core/Azure.Core/samples/ProtocolMethods.md">protocol method</see> allows explicit creation of the request and processing of the response for advanced scenarios.
|
|
</description>
|
|
</item>
|
|
<item>
|
|
<description>
|
|
Please try the simpler <see cref="M:Azure.AI.OpenAI.Assistants.AssistantsClient.InternalDeleteFileAsync(System.String,System.Threading.CancellationToken)" /> convenience overload with strongly typed models first.
|
|
</description>
|
|
</item>
|
|
</list>
|
|
</summary>
|
|
<param name="fileId"> The ID of the file to delete. </param>
|
|
<param name="context"> The request context, which can override default behaviors of the client pipeline on a per-call basis. </param>
|
|
<exception cref="T:System.ArgumentNullException"> <paramref name="fileId" /> is null. </exception>
|
|
<exception cref="T:System.ArgumentException"> <paramref name="fileId" /> is an empty string, and was expected to be non-empty. </exception>
|
|
<exception cref="T:Azure.RequestFailedException"> Service returned a non-success status code. </exception>
|
|
<returns> The response returned from the service. </returns>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.AssistantsClient.InternalDeleteFile(System.String,Azure.RequestContext)">
|
|
<summary>
|
|
[Protocol Method] Delete a previously uploaded file.
|
|
<list type="bullet">
|
|
<item>
|
|
<description>
|
|
This <see href="https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/core/Azure.Core/samples/ProtocolMethods.md">protocol method</see> allows explicit creation of the request and processing of the response for advanced scenarios.
|
|
</description>
|
|
</item>
|
|
<item>
|
|
<description>
|
|
Please try the simpler <see cref="M:Azure.AI.OpenAI.Assistants.AssistantsClient.InternalDeleteFile(System.String,System.Threading.CancellationToken)" /> convenience overload with strongly typed models first.
|
|
</description>
|
|
</item>
|
|
</list>
|
|
</summary>
|
|
<param name="fileId"> The ID of the file to delete. </param>
|
|
<param name="context"> The request context, which can override default behaviors of the client pipeline on a per-call basis. </param>
|
|
<exception cref="T:System.ArgumentNullException"> <paramref name="fileId" /> is null. </exception>
|
|
<exception cref="T:System.ArgumentException"> <paramref name="fileId" /> is an empty string, and was expected to be non-empty. </exception>
|
|
<exception cref="T:Azure.RequestFailedException"> Service returned a non-success status code. </exception>
|
|
<returns> The response returned from the service. </returns>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.AssistantsClient.GetFileAsync(System.String,System.Threading.CancellationToken)">
|
|
<summary> Returns information about a specific file. Does not retrieve file content. </summary>
|
|
<param name="fileId"> The ID of the file to retrieve. </param>
|
|
<param name="cancellationToken"> The cancellation token to use. </param>
|
|
<exception cref="T:System.ArgumentNullException"> <paramref name="fileId" /> is null. </exception>
|
|
<exception cref="T:System.ArgumentException"> <paramref name="fileId" /> is an empty string, and was expected to be non-empty. </exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.AssistantsClient.GetFile(System.String,System.Threading.CancellationToken)">
|
|
<summary> Returns information about a specific file. Does not retrieve file content. </summary>
|
|
<param name="fileId"> The ID of the file to retrieve. </param>
|
|
<param name="cancellationToken"> The cancellation token to use. </param>
|
|
<exception cref="T:System.ArgumentNullException"> <paramref name="fileId" /> is null. </exception>
|
|
<exception cref="T:System.ArgumentException"> <paramref name="fileId" /> is an empty string, and was expected to be non-empty. </exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.AssistantsClient.GetFileAsync(System.String,Azure.RequestContext)">
|
|
<summary>
|
|
[Protocol Method] Returns information about a specific file. Does not retrieve file content.
|
|
<list type="bullet">
|
|
<item>
|
|
<description>
|
|
This <see href="https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/core/Azure.Core/samples/ProtocolMethods.md">protocol method</see> allows explicit creation of the request and processing of the response for advanced scenarios.
|
|
</description>
|
|
</item>
|
|
</list>
|
|
</summary>
|
|
<param name="fileId"> The ID of the file to retrieve. </param>
|
|
<param name="context"> The request context, which can override default behaviors of the client pipeline on a per-call basis. </param>
|
|
<exception cref="T:System.ArgumentNullException"> <paramref name="fileId" /> is null. </exception>
|
|
<exception cref="T:System.ArgumentException"> <paramref name="fileId" /> is an empty string, and was expected to be non-empty. </exception>
|
|
<exception cref="T:Azure.RequestFailedException"> Service returned a non-success status code. </exception>
|
|
<returns> The response returned from the service. </returns>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.AssistantsClient.GetFile(System.String,Azure.RequestContext)">
|
|
<summary>
|
|
[Protocol Method] Returns information about a specific file. Does not retrieve file content.
|
|
<list type="bullet">
|
|
<item>
|
|
<description>
|
|
This <see href="https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/core/Azure.Core/samples/ProtocolMethods.md">protocol method</see> allows explicit creation of the request and processing of the response for advanced scenarios.
|
|
</description>
|
|
</item>
|
|
</list>
|
|
</summary>
|
|
<param name="fileId"> The ID of the file to retrieve. </param>
|
|
<param name="context"> The request context, which can override default behaviors of the client pipeline on a per-call basis. </param>
|
|
<exception cref="T:System.ArgumentNullException"> <paramref name="fileId" /> is null. </exception>
|
|
<exception cref="T:System.ArgumentException"> <paramref name="fileId" /> is an empty string, and was expected to be non-empty. </exception>
|
|
<exception cref="T:Azure.RequestFailedException"> Service returned a non-success status code. </exception>
|
|
<returns> The response returned from the service. </returns>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.AssistantsClient.GetFileContentAsync(System.String,System.Threading.CancellationToken)">
|
|
<summary> Returns information about a specific file. Does not retrieve file content. </summary>
|
|
<param name="fileId"> The ID of the file to retrieve. </param>
|
|
<param name="cancellationToken"> The cancellation token to use. </param>
|
|
<exception cref="T:System.ArgumentNullException"> <paramref name="fileId" /> is null. </exception>
|
|
<exception cref="T:System.ArgumentException"> <paramref name="fileId" /> is an empty string, and was expected to be non-empty. </exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.AssistantsClient.GetFileContent(System.String,System.Threading.CancellationToken)">
|
|
<summary> Returns information about a specific file. Does not retrieve file content. </summary>
|
|
<param name="fileId"> The ID of the file to retrieve. </param>
|
|
<param name="cancellationToken"> The cancellation token to use. </param>
|
|
<exception cref="T:System.ArgumentNullException"> <paramref name="fileId" /> is null. </exception>
|
|
<exception cref="T:System.ArgumentException"> <paramref name="fileId" /> is an empty string, and was expected to be non-empty. </exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.AssistantsClient.GetFileContentAsync(System.String,Azure.RequestContext)">
|
|
<summary>
|
|
[Protocol Method] Returns information about a specific file. Does not retrieve file content.
|
|
<list type="bullet">
|
|
<item>
|
|
<description>
|
|
This <see href="https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/core/Azure.Core/samples/ProtocolMethods.md">protocol method</see> allows explicit creation of the request and processing of the response for advanced scenarios.
|
|
</description>
|
|
</item>
|
|
</list>
|
|
</summary>
|
|
<param name="fileId"> The ID of the file to retrieve. </param>
|
|
<param name="context"> The request context, which can override default behaviors of the client pipeline on a per-call basis. </param>
|
|
<exception cref="T:System.ArgumentNullException"> <paramref name="fileId" /> is null. </exception>
|
|
<exception cref="T:System.ArgumentException"> <paramref name="fileId" /> is an empty string, and was expected to be non-empty. </exception>
|
|
<exception cref="T:Azure.RequestFailedException"> Service returned a non-success status code. </exception>
|
|
<returns> The response returned from the service. </returns>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.AssistantsClient.GetFileContent(System.String,Azure.RequestContext)">
|
|
<summary>
|
|
[Protocol Method] Returns information about a specific file. Does not retrieve file content.
|
|
<list type="bullet">
|
|
<item>
|
|
<description>
|
|
This <see href="https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/core/Azure.Core/samples/ProtocolMethods.md">protocol method</see> allows explicit creation of the request and processing of the response for advanced scenarios.
|
|
</description>
|
|
</item>
|
|
</list>
|
|
</summary>
|
|
<param name="fileId"> The ID of the file to retrieve. </param>
|
|
<param name="context"> The request context, which can override default behaviors of the client pipeline on a per-call basis. </param>
|
|
<exception cref="T:System.ArgumentNullException"> <paramref name="fileId" /> is null. </exception>
|
|
<exception cref="T:System.ArgumentException"> <paramref name="fileId" /> is an empty string, and was expected to be non-empty. </exception>
|
|
<exception cref="T:Azure.RequestFailedException"> Service returned a non-success status code. </exception>
|
|
<returns> The response returned from the service. </returns>
|
|
</member>
|
|
<member name="T:Azure.AI.OpenAI.Assistants.FunctionToolDefinition">
|
|
<summary> The input definition information for a function tool as used to configure an assistant. </summary>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.FunctionToolDefinition.Equals(System.Object)">
|
|
<summary>Determines whether the specified object is equal to the current object.</summary><param name="obj">The object to compare with the current object.</param><returns><see langword="true" /> if the specified object is equal to the current object; otherwise, <see langword="false" />.</returns>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.FunctionToolDefinition.GetHashCode">
|
|
<summary>Serves as the default hash function.</summary><returns>A hash code for the current object.</returns>
|
|
</member>
|
|
<member name="P:Azure.AI.OpenAI.Assistants.FunctionToolDefinition.Name">
|
|
<summary> The name of the function to be called. </summary>
|
|
</member>
|
|
<member name="P:Azure.AI.OpenAI.Assistants.FunctionToolDefinition.Description">
|
|
<summary> A description of what the function does, used by the model to choose when and how to call the function. </summary>
|
|
</member>
|
|
<member name="P:Azure.AI.OpenAI.Assistants.FunctionToolDefinition.Parameters">
|
|
<summary>
|
|
The parameters the functions accepts, described as a JSON Schema object.
|
|
<para>
|
|
To assign an object to this property use <see cref="M:System.BinaryData.FromObjectAsJson``1(``0,System.Text.Json.JsonSerializerOptions)" />.
|
|
</para>
|
|
<para>
|
|
To assign an already formatted json string to this property use <see cref="M:System.BinaryData.FromString(System.String)" />.
|
|
</para>
|
|
<para>
|
|
Examples:
|
|
<list type="bullet">
|
|
<item>
|
|
<term>BinaryData.FromObjectAsJson("foo")</term>
|
|
<description>Creates a payload of "foo".</description>
|
|
</item>
|
|
<item>
|
|
<term>BinaryData.FromString("\"foo\"")</term>
|
|
<description>Creates a payload of "foo".</description>
|
|
</item>
|
|
<item>
|
|
<term>BinaryData.FromObjectAsJson(new { key = "value" })</term>
|
|
<description>Creates a payload of { "key": "value" }.</description>
|
|
</item>
|
|
<item>
|
|
<term>BinaryData.FromString("{\"key\": \"value\"}")</term>
|
|
<description>Creates a payload of { "key": "value" }.</description>
|
|
</item>
|
|
</list>
|
|
</para>
|
|
</summary>
|
|
</member>
|
|
<member name="P:Azure.AI.OpenAI.Assistants.FunctionToolDefinition.InternalFunction">
|
|
<summary> The definition of the function that the function tool should call. </summary>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.FunctionToolDefinition.#ctor(System.String,System.String,System.BinaryData)">
|
|
<summary>
|
|
Initializes a new instance of FunctionToolDefinition.
|
|
</summary>
|
|
<param name="name"> The name of the function to be called. </param>
|
|
<param name="description"> A description of what the function does, used by the model to choose when and how to call the function. </param>
|
|
<param name="parameters"> The parameters the functions accepts, described as a JSON Schema object. </param>
|
|
<exception cref="T:System.ArgumentNullException"> <paramref name="name" />, <paramref name="description" /> or <paramref name="parameters" /> is null. </exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.FunctionToolDefinition.#ctor(System.String,System.String)">
|
|
<summary>
|
|
Initializes a new instance of FunctionTool for a function that requires no explicit function parameters.
|
|
</summary>
|
|
<param name="name"> The name of the function to be called. </param>
|
|
<param name="description"> A description of what the function does, used by the model to choose when and how to call the function. </param>
|
|
<exception cref="T:System.ArgumentNullException"> <paramref name="name" /> or <paramref name="description" /> is null. </exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.FunctionToolDefinition.#ctor(System.String,System.Collections.Generic.IDictionary{System.String,System.BinaryData},Azure.AI.OpenAI.Assistants.InternalFunctionDefinition)">
|
|
<summary> Initializes a new instance of <see cref="T:Azure.AI.OpenAI.Assistants.FunctionToolDefinition" />. </summary>
|
|
<param name="type"> The object type. </param>
|
|
<param name="serializedAdditionalRawData"> Keeps track of any properties unknown to the library. </param>
|
|
<param name="internalFunction"> The definition of the concrete function that the function tool should call. </param>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.FunctionToolDefinition.#ctor">
|
|
<summary> Initializes a new instance of <see cref="T:Azure.AI.OpenAI.Assistants.FunctionToolDefinition" /> for deserialization. </summary>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.FunctionToolDefinition.FromResponse(Azure.Response)">
|
|
<summary> Deserializes the model from a raw response. </summary>
|
|
<param name="response"> The response to deserialize the model from. </param>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.FunctionToolDefinition.ToRequestContent">
|
|
<summary> Convert into a <see cref="T:Azure.Core.RequestContent" />. </summary>
|
|
</member>
|
|
<member name="T:Azure.AI.OpenAI.Assistants.PageableList`1">
|
|
<summary>
|
|
Represents a pageable list of data items with item ID cursors representing the start and end of the current page.
|
|
</summary>
|
|
<remarks>
|
|
<see cref="P:Azure.AI.OpenAI.Assistants.PageableList`1.FirstId" /> and <see cref="P:Azure.AI.OpenAI.Assistants.PageableList`1.LastId" /> can be used as inputs into methods that list items to retrieve
|
|
additional items before or after the current page's view.
|
|
</remarks>
|
|
<typeparam name="T"> The type of the data instances contained in the list. </typeparam>
|
|
</member>
|
|
<member name="P:Azure.AI.OpenAI.Assistants.PageableList`1.Item(System.Int32)">
|
|
<summary>
|
|
Gets the data item at the specified index.
|
|
</summary>
|
|
<param name="index"> The index of the data item to retrieve. </param>
|
|
<returns> The indexed data item. </returns>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.PageableList`1.GetEnumerator">
|
|
<summary>Returns an enumerator that iterates through the collection.</summary><returns>An enumerator that can be used to iterate through the collection.</returns>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.PageableList`1.System#Collections#IEnumerable#GetEnumerator">
|
|
<summary>Returns an enumerator that iterates through a collection.</summary><returns>An <see cref="T:System.Collections.IEnumerator" /> object that can be used to iterate through the collection.</returns>
|
|
</member>
|
|
<member name="P:Azure.AI.OpenAI.Assistants.PageableList`1.Data">
|
|
<summary> The requested list of items. </summary>
|
|
</member>
|
|
<member name="P:Azure.AI.OpenAI.Assistants.PageableList`1.FirstId">
|
|
<summary> The first ID represented in this list. </summary>
|
|
</member>
|
|
<member name="P:Azure.AI.OpenAI.Assistants.PageableList`1.LastId">
|
|
<summary> The last ID represented in this list. </summary>
|
|
</member>
|
|
<member name="P:Azure.AI.OpenAI.Assistants.PageableList`1.HasMore">
|
|
<summary> A value indicating whether there are additional values available not captured in this list. </summary>
|
|
</member>
|
|
<member name="T:Azure.AI.OpenAI.Assistants.AssistantsModelFactory">
|
|
<summary> Model factory for models. </summary>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.AssistantsModelFactory.Assistant(System.String,System.DateTimeOffset,System.String,System.String,System.String,System.String,System.Collections.Generic.IEnumerable{Azure.AI.OpenAI.Assistants.ToolDefinition},System.Collections.Generic.IEnumerable{System.String},System.Collections.Generic.IReadOnlyDictionary{System.String,System.String})">
|
|
<summary> Initializes a new instance of <see cref="T:Azure.AI.OpenAI.Assistants.Assistant" />. </summary>
|
|
<param name="id"> The identifier, which can be referenced in API endpoints. </param>
|
|
<param name="createdAt"> The Unix timestamp, in seconds, representing when this object was created. </param>
|
|
<param name="name"> The name of the assistant. </param>
|
|
<param name="description"> The description of the assistant. </param>
|
|
<param name="model"> The ID of the model to use. </param>
|
|
<param name="instructions"> The system instructions for the assistant to use. </param>
|
|
<param name="tools"> The collection of tools enabled for the assistant. </param>
|
|
<param name="fileIds"> A list of attached file IDs, ordered by creation date in ascending order. </param>
|
|
<param name="metadata"> 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. </param>
|
|
<returns> A new <see cref="T:Azure.AI.OpenAI.Assistants.Assistant" /> instance for mocking. </returns>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.AssistantsModelFactory.AssistantFile(System.String,System.DateTimeOffset,System.String)">
|
|
<summary> Initializes a new instance of <see cref="T:Azure.AI.OpenAI.Assistants.AssistantFile" />. </summary>
|
|
<param name="id"> The identifier, which can be referenced in API endpoints. </param>
|
|
<param name="createdAt"> The Unix timestamp, in seconds, representing when this object was created. </param>
|
|
<param name="assistantId"> The assistant ID that the file is attached to. </param>
|
|
<returns> A new <see cref="T:Azure.AI.OpenAI.Assistants.AssistantFile" /> instance for mocking. </returns>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.AssistantsModelFactory.AssistantThread(System.String,System.DateTimeOffset,System.Collections.Generic.IReadOnlyDictionary{System.String,System.String})">
|
|
<summary> Initializes a new instance of <see cref="T:Azure.AI.OpenAI.Assistants.AssistantThread" />. </summary>
|
|
<param name="id"> The identifier, which can be referenced in API endpoints. </param>
|
|
<param name="createdAt"> The Unix timestamp, in seconds, representing when this object was created. </param>
|
|
<param name="metadata"> 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. </param>
|
|
<returns> A new <see cref="T:Azure.AI.OpenAI.Assistants.AssistantThread" /> instance for mocking. </returns>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.AssistantsModelFactory.MessageFile(System.String,System.DateTimeOffset,System.String)">
|
|
<summary> Initializes a new instance of <see cref="T:Azure.AI.OpenAI.Assistants.MessageFile" />. </summary>
|
|
<param name="id"> The identifier, which can be referenced in API endpoints. </param>
|
|
<param name="createdAt"> The Unix timestamp, in seconds, representing when this object was created. </param>
|
|
<param name="messageId"> The ID of the message that this file is attached to. </param>
|
|
<returns> A new <see cref="T:Azure.AI.OpenAI.Assistants.MessageFile" /> instance for mocking. </returns>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.AssistantsModelFactory.ThreadRun(System.String,System.String,System.String,Azure.AI.OpenAI.Assistants.RunStatus,Azure.AI.OpenAI.Assistants.RequiredAction,Azure.AI.OpenAI.Assistants.RunError,System.String,System.String,System.Collections.Generic.IEnumerable{Azure.AI.OpenAI.Assistants.ToolDefinition},System.Collections.Generic.IEnumerable{System.String},System.DateTimeOffset,System.Nullable{System.DateTimeOffset},System.Nullable{System.DateTimeOffset},System.Nullable{System.DateTimeOffset},System.Nullable{System.DateTimeOffset},System.Nullable{System.DateTimeOffset},System.Collections.Generic.IReadOnlyDictionary{System.String,System.String})">
|
|
<summary> Initializes a new instance of <see cref="T:Azure.AI.OpenAI.Assistants.ThreadRun" />. </summary>
|
|
<param name="id"> The identifier, which can be referenced in API endpoints. </param>
|
|
<param name="threadId"> The ID of the thread associated with this run. </param>
|
|
<param name="assistantId"> The ID of the assistant associated with the thread this run was performed against. </param>
|
|
<param name="status"> The status of the assistant thread run. </param>
|
|
<param name="requiredAction"> The details of the action required for the assistant thread run to continue. </param>
|
|
<param name="lastError"> The last error, if any, encountered by this assistant thread run. </param>
|
|
<param name="model"> The ID of the model to use. </param>
|
|
<param name="instructions"> The overridden system instructions used for this assistant thread run. </param>
|
|
<param name="tools"> The overridden enabled tools used for this assistant thread run. </param>
|
|
<param name="fileIds"> A list of attached file IDs, ordered by creation date in ascending order. </param>
|
|
<param name="createdAt"> The Unix timestamp, in seconds, representing when this object was created. </param>
|
|
<param name="expiresAt"> The Unix timestamp, in seconds, representing when this item expires. </param>
|
|
<param name="startedAt"> The Unix timestamp, in seconds, representing when this item was started. </param>
|
|
<param name="completedAt"> The Unix timestamp, in seconds, representing when this completed. </param>
|
|
<param name="cancelledAt"> The Unix timestamp, in seconds, representing when this was cancelled. </param>
|
|
<param name="failedAt"> The Unix timestamp, in seconds, representing when this failed. </param>
|
|
<param name="metadata"> 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. </param>
|
|
<returns> A new <see cref="T:Azure.AI.OpenAI.Assistants.ThreadRun" /> instance for mocking. </returns>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.AssistantsModelFactory.OpenAIFile(System.String,System.Int32,System.String,System.DateTimeOffset,Azure.AI.OpenAI.Assistants.OpenAIFilePurpose)">
|
|
<summary> Initializes a new instance of <see cref="T:Azure.AI.OpenAI.Assistants.OpenAIFile" />. </summary>
|
|
<param name="id"> The identifier, which can be referenced in API endpoints. </param>
|
|
<param name="size"> The size of the file, in bytes. </param>
|
|
<param name="filename"> The name of the file. </param>
|
|
<param name="createdAt"> The Unix timestamp, in seconds, representing when this object was created. </param>
|
|
<param name="purpose"> The intended purpose of a file. </param>
|
|
<returns> A new <see cref="T:Azure.AI.OpenAI.Assistants.OpenAIFile" /> instance for mocking. </returns>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.AssistantsModelFactory.RunStep(System.String,Azure.AI.OpenAI.Assistants.RunStepType,System.String,System.String,System.String,Azure.AI.OpenAI.Assistants.RunStepStatus,Azure.AI.OpenAI.Assistants.RunStepDetails,Azure.AI.OpenAI.Assistants.RunStepError,System.DateTimeOffset,System.Nullable{System.DateTimeOffset},System.Nullable{System.DateTimeOffset},System.Nullable{System.DateTimeOffset},System.Nullable{System.DateTimeOffset},System.Collections.Generic.IReadOnlyDictionary{System.String,System.String})">
|
|
<summary> Initializes a new instance of <see cref="T:Azure.AI.OpenAI.Assistants.RunStep" />. </summary>
|
|
<param name="id"> The identifier, which can be referenced in API endpoints. </param>
|
|
<param name="type"> The type of run step, which can be either message_creation or tool_calls. </param>
|
|
<param name="assistantId"> The ID of the assistant associated with the run step. </param>
|
|
<param name="threadId"> The ID of the thread that was run. </param>
|
|
<param name="runId"> The ID of the run that this run step is a part of. </param>
|
|
<param name="status"> The status of this run step. </param>
|
|
<param name="stepDetails"> The details for this run step. </param>
|
|
<param name="lastError"> If applicable, information about the last error encountered by this run step. </param>
|
|
<param name="createdAt"> The Unix timestamp, in seconds, representing when this object was created. </param>
|
|
<param name="expiredAt"> The Unix timestamp, in seconds, representing when this item expired. </param>
|
|
<param name="completedAt"> The Unix timestamp, in seconds, representing when this completed. </param>
|
|
<param name="cancelledAt"> The Unix timestamp, in seconds, representing when this was cancelled. </param>
|
|
<param name="failedAt"> The Unix timestamp, in seconds, representing when this failed. </param>
|
|
<param name="metadata"> 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. </param>
|
|
<returns> A new <see cref="T:Azure.AI.OpenAI.Assistants.RunStep" /> instance for mocking. </returns>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.AssistantsModelFactory.ThreadMessage(System.String,System.DateTimeOffset,System.String,Azure.AI.OpenAI.Assistants.MessageRole,System.Collections.Generic.IEnumerable{Azure.AI.OpenAI.Assistants.MessageContent},System.String,System.String,System.Collections.Generic.IEnumerable{System.String},System.Collections.Generic.IReadOnlyDictionary{System.String,System.String})">
|
|
<summary> Initializes a new instance of <see cref="T:Azure.AI.OpenAI.Assistants.ThreadMessage" />. </summary>
|
|
<param name="id"> The identifier, which can be referenced in API endpoints. </param>
|
|
<param name="createdAt"> The Unix timestamp, in seconds, representing when this object was created. </param>
|
|
<param name="threadId"> The ID of the thread that this message belongs to. </param>
|
|
<param name="role"> The role associated with the assistant thread message. </param>
|
|
<param name="contentItems"> The list of content items associated with the assistant thread message. </param>
|
|
<param name="assistantId"> If applicable, the ID of the assistant that authored this message. </param>
|
|
<param name="runId"> If applicable, the ID of the run associated with the authoring of this message. </param>
|
|
<param name="fileIds">
|
|
A list of file IDs that the assistant should use. Useful for tools like retrieval and code_interpreter that can
|
|
access files.
|
|
</param>
|
|
<param name="metadata"> 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. </param>
|
|
<returns> A new <see cref="T:Azure.AI.OpenAI.Assistants.ThreadMessage" /> instance for mocking. </returns>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.AssistantsModelFactory.SubmitToolOutputsAction(System.Collections.Generic.IEnumerable{Azure.AI.OpenAI.Assistants.RequiredToolCall})">
|
|
<summary>
|
|
Instantiates a new instance of <see cref="T:Azure.AI.OpenAI.Assistants.SubmitToolOutputsAction" />.
|
|
</summary>
|
|
<param name="toolCalls"> The tool calls to include in the mocked action. </param>
|
|
<returns> A new instance of SubmitToolOutputsAction. </returns>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.AssistantsModelFactory.MessageTextContent(System.String,System.Collections.Generic.IEnumerable{Azure.AI.OpenAI.Assistants.MessageTextAnnotation})">
|
|
<summary>
|
|
Creates a new instance of MessageTextContent.
|
|
</summary>
|
|
<param name="text"> The text for the content item. </param>
|
|
<param name="annotations"> The annotations for the content item. </param>
|
|
<returns> A new instance of MessageTextContent. </returns>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.AssistantsModelFactory.MessageImageFileContent(System.String)">
|
|
<summary>
|
|
Creates a new instance of MessageImageFileContent.
|
|
</summary>
|
|
<param name="fileId"> The file ID for the image file content. </param>
|
|
<returns> A new instance of MessageImageFileContent. </returns>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.AssistantsModelFactory.MessageFileCitationTextAnnotation(System.String,System.Int32,System.Int32,System.String,System.String)">
|
|
<summary>
|
|
Creates a new instance of MessageFileCitationTextAnnotation.
|
|
</summary>
|
|
<param name="text"> The text for the citation. </param>
|
|
<param name="startIndex"> The start index of the citation. </param>
|
|
<param name="endIndex"> The end index of the citation. </param>
|
|
<param name="fileId"> The file ID for the citation. </param>
|
|
<param name="quote"> The quote for the citation. </param>
|
|
<returns> A new instance of MessageFileCitationTextAnnotation. </returns>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.AssistantsModelFactory.MessageFilePathTextAnnotation(System.String,System.Int32,System.Int32,System.String)">
|
|
<summary>
|
|
Creates a new instance of MessageFilePathTextAnnotation.
|
|
</summary>
|
|
<param name="text"> The text for the annotation. </param>
|
|
<param name="startIndex"> The start index for the annotation. </param>
|
|
<param name="endIndex"> The end index for the annotation. </param>
|
|
<param name="fileId"> The file ID for the annotation. </param>
|
|
<returns> A new instance of MessageFilePathTextAnnotation. </returns>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.AssistantsModelFactory.PageableList``1(System.Collections.Generic.IReadOnlyList{``0},System.String,System.String,System.Boolean)">
|
|
<summary>
|
|
Creates a new instance of PageableList<typeparamref name="T" />.
|
|
</summary>
|
|
<typeparam name="T"> The data type of the listed items. </typeparam>
|
|
<param name="data"> The items for the list. </param>
|
|
<param name="firstId"> The ID of the first item in the list. </param>
|
|
<param name="lastId"> The ID of the last item in the list. </param>
|
|
<param name="hasMore"> Whether more items not included in the list exist. </param>
|
|
<returns> A new instance of PageableList<typeparamref name="T" />. </returns>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.AssistantsModelFactory.AssistantCreationOptions(System.String,System.String,System.String,System.String,System.Collections.Generic.IEnumerable{Azure.AI.OpenAI.Assistants.ToolDefinition},System.Collections.Generic.IEnumerable{System.String},System.Collections.Generic.IDictionary{System.String,System.String})">
|
|
<summary> Initializes a new instance of <see cref="T:Azure.AI.OpenAI.Assistants.AssistantCreationOptions" />. </summary>
|
|
<param name="model"> The ID of the model to use. </param>
|
|
<param name="name"> The name of the new assistant. </param>
|
|
<param name="description"> The description of the new assistant. </param>
|
|
<param name="instructions"> The system instructions for the new assistant to use. </param>
|
|
<param name="tools">
|
|
The collection of tools to enable for the new assistant.
|
|
Please note <see cref="T:Azure.AI.OpenAI.Assistants.ToolDefinition" /> is the base class. According to the scenario, a derived class of the base class might need to be assigned here, or this property needs to be casted to one of the possible derived classes.
|
|
The available derived classes include <see cref="T:Azure.AI.OpenAI.Assistants.CodeInterpreterToolDefinition" />, <see cref="T:Azure.AI.OpenAI.Assistants.FunctionToolDefinition" /> and <see cref="T:Azure.AI.OpenAI.Assistants.RetrievalToolDefinition" />.
|
|
</param>
|
|
<param name="fileIds"> A list of previously uploaded file IDs to attach to the assistant. </param>
|
|
<param name="metadata"> 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. </param>
|
|
<returns> A new <see cref="T:Azure.AI.OpenAI.Assistants.AssistantCreationOptions" /> instance for mocking. </returns>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.AssistantsModelFactory.ThreadInitializationMessage(Azure.AI.OpenAI.Assistants.MessageRole,System.String,System.Collections.Generic.IEnumerable{System.String},System.Collections.Generic.IDictionary{System.String,System.String})">
|
|
<summary> Initializes a new instance of <see cref="T:Azure.AI.OpenAI.Assistants.ThreadInitializationMessage" />. </summary>
|
|
<param name="role"> The role associated with the assistant thread message. Currently, only 'user' is supported when providing initial messages to a new thread. </param>
|
|
<param name="content"> The textual content of the initial message. Currently, robust input including images and annotated text may only be provided via a separate call to the create message API. </param>
|
|
<param name="fileIds">
|
|
A list of file IDs that the assistant should use. Useful for tools like retrieval and code_interpreter that can
|
|
access files.
|
|
</param>
|
|
<param name="metadata"> 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. </param>
|
|
<returns> A new <see cref="T:Azure.AI.OpenAI.Assistants.ThreadInitializationMessage" /> instance for mocking. </returns>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.AssistantsModelFactory.CreateRunOptions(System.String,System.String,System.String,System.String,System.Collections.Generic.IEnumerable{Azure.AI.OpenAI.Assistants.ToolDefinition},System.Collections.Generic.IDictionary{System.String,System.String})">
|
|
<summary> Initializes a new instance of <see cref="T:Azure.AI.OpenAI.Assistants.CreateRunOptions" />. </summary>
|
|
<param name="assistantId"> The ID of the assistant that should run the thread. </param>
|
|
<param name="overrideModelName"> The overridden model name that the assistant should use to run the thread. </param>
|
|
<param name="overrideInstructions"> The overridden system instructions that the assistant should use to run the thread. </param>
|
|
<param name="additionalInstructions">
|
|
Additional instructions to append at the end of the instructions for the run. This is useful for modifying the behavior
|
|
on a per-run basis without overriding other instructions.
|
|
</param>
|
|
<param name="overrideTools">
|
|
The overridden list of enabled tools that the assistant should use to run the thread.
|
|
Please note <see cref="T:Azure.AI.OpenAI.Assistants.ToolDefinition" /> is the base class. According to the scenario, a derived class of the base class might need to be assigned here, or this property needs to be casted to one of the possible derived classes.
|
|
The available derived classes include <see cref="T:Azure.AI.OpenAI.Assistants.CodeInterpreterToolDefinition" />, <see cref="T:Azure.AI.OpenAI.Assistants.FunctionToolDefinition" /> and <see cref="T:Azure.AI.OpenAI.Assistants.RetrievalToolDefinition" />.
|
|
</param>
|
|
<param name="metadata"> 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. </param>
|
|
<returns> A new <see cref="T:Azure.AI.OpenAI.Assistants.CreateRunOptions" /> instance for mocking. </returns>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.AssistantsModelFactory.RunError(System.String,System.String)">
|
|
<summary> Initializes a new instance of <see cref="T:Azure.AI.OpenAI.Assistants.RunError" />. </summary>
|
|
<param name="code"> The status for the error. </param>
|
|
<param name="message"> The human-readable text associated with the error. </param>
|
|
<returns> A new <see cref="T:Azure.AI.OpenAI.Assistants.RunError" /> instance for mocking. </returns>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.AssistantsModelFactory.CreateAndRunThreadOptions(System.String,Azure.AI.OpenAI.Assistants.AssistantThreadCreationOptions,System.String,System.String,System.Collections.Generic.IEnumerable{Azure.AI.OpenAI.Assistants.ToolDefinition},System.Collections.Generic.IDictionary{System.String,System.String})">
|
|
<summary> Initializes a new instance of <see cref="T:Azure.AI.OpenAI.Assistants.CreateAndRunThreadOptions" />. </summary>
|
|
<param name="assistantId"> The ID of the assistant for which the thread should be created. </param>
|
|
<param name="thread"> The details used to create the new thread. </param>
|
|
<param name="overrideModelName"> The overridden model that the assistant should use to run the thread. </param>
|
|
<param name="overrideInstructions"> The overridden system instructions the assistant should use to run the thread. </param>
|
|
<param name="overrideTools">
|
|
The overridden list of enabled tools the assistant should use to run the thread.
|
|
Please note <see cref="T:Azure.AI.OpenAI.Assistants.ToolDefinition" /> is the base class. According to the scenario, a derived class of the base class might need to be assigned here, or this property needs to be casted to one of the possible derived classes.
|
|
The available derived classes include <see cref="T:Azure.AI.OpenAI.Assistants.CodeInterpreterToolDefinition" />, <see cref="T:Azure.AI.OpenAI.Assistants.FunctionToolDefinition" /> and <see cref="T:Azure.AI.OpenAI.Assistants.RetrievalToolDefinition" />.
|
|
</param>
|
|
<param name="metadata"> 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. </param>
|
|
<returns> A new <see cref="T:Azure.AI.OpenAI.Assistants.CreateAndRunThreadOptions" /> instance for mocking. </returns>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.AssistantsModelFactory.RunStepError(Azure.AI.OpenAI.Assistants.RunStepErrorCode,System.String)">
|
|
<summary> Initializes a new instance of <see cref="T:Azure.AI.OpenAI.Assistants.RunStepError" />. </summary>
|
|
<param name="code"> The error code for this error. </param>
|
|
<param name="message"> The human-readable text associated with this error. </param>
|
|
<returns> A new <see cref="T:Azure.AI.OpenAI.Assistants.RunStepError" /> instance for mocking. </returns>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.AssistantsModelFactory.RequiredToolCall(System.String,System.String)">
|
|
<summary> Initializes a new instance of <see cref="T:Azure.AI.OpenAI.Assistants.RequiredToolCall" />. </summary>
|
|
<param name="type"> The object type for the required tool call. </param>
|
|
<param name="id"> The ID of the tool call. This ID must be referenced when submitting tool outputs. </param>
|
|
<returns> A new <see cref="T:Azure.AI.OpenAI.Assistants.RequiredToolCall" /> instance for mocking. </returns>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.AssistantsModelFactory.RunStepToolCall(System.String,System.String)">
|
|
<summary> Initializes a new instance of <see cref="T:Azure.AI.OpenAI.Assistants.RunStepToolCall" />. </summary>
|
|
<param name="type"> The object type. </param>
|
|
<param name="id"> The ID of the tool call. This ID must be referenced when you submit tool outputs. </param>
|
|
<returns> A new <see cref="T:Azure.AI.OpenAI.Assistants.RunStepToolCall" /> instance for mocking. </returns>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.AssistantsModelFactory.RunStepRetrievalToolCall(System.String,System.Collections.Generic.IReadOnlyDictionary{System.String,System.String})">
|
|
<summary> Initializes a new instance of <see cref="T:Azure.AI.OpenAI.Assistants.RunStepRetrievalToolCall" />. </summary>
|
|
<param name="id"> The ID of the tool call. This ID must be referenced when you submit tool outputs. </param>
|
|
<param name="retrieval"> The key/value pairs produced by the retrieval tool. </param>
|
|
<returns> A new <see cref="T:Azure.AI.OpenAI.Assistants.RunStepRetrievalToolCall" /> instance for mocking. </returns>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.AssistantsModelFactory.RunStepCodeInterpreterLogOutput(System.String)">
|
|
<summary> Initializes a new instance of <see cref="T:Azure.AI.OpenAI.Assistants.RunStepCodeInterpreterLogOutput" />. </summary>
|
|
<param name="logs"> The serialized log output emitted by the code interpreter. </param>
|
|
<returns> A new <see cref="T:Azure.AI.OpenAI.Assistants.RunStepCodeInterpreterLogOutput" /> instance for mocking. </returns>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.AssistantsModelFactory.RunStepCodeInterpreterImageOutput(Azure.AI.OpenAI.Assistants.RunStepCodeInterpreterImageReference)">
|
|
<summary> Initializes a new instance of <see cref="T:Azure.AI.OpenAI.Assistants.RunStepCodeInterpreterImageOutput" />. </summary>
|
|
<param name="image"> Referential information for the image associated with this output. </param>
|
|
<returns> A new <see cref="T:Azure.AI.OpenAI.Assistants.RunStepCodeInterpreterImageOutput" /> instance for mocking. </returns>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.AssistantsModelFactory.RunStepCodeInterpreterImageReference(System.String)">
|
|
<summary> Initializes a new instance of <see cref="T:Azure.AI.OpenAI.Assistants.RunStepCodeInterpreterImageReference" />. </summary>
|
|
<param name="fileId"> The ID of the file associated with this image. </param>
|
|
<returns> A new <see cref="T:Azure.AI.OpenAI.Assistants.RunStepCodeInterpreterImageReference" /> instance for mocking. </returns>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.AssistantsModelFactory.MessageTextAnnotation(System.String,System.String,System.Int32,System.Int32)">
|
|
<summary> Initializes a new instance of <see cref="T:Azure.AI.OpenAI.Assistants.MessageTextAnnotation" />. </summary>
|
|
<param name="type"> The object type. </param>
|
|
<param name="text"> The textual content associated with this text annotation item. </param>
|
|
<param name="startIndex"> The first text index associated with this text annotation. </param>
|
|
<param name="endIndex"> The last text index associated with this text annotation. </param>
|
|
<returns> A new <see cref="T:Azure.AI.OpenAI.Assistants.MessageTextAnnotation" /> instance for mocking. </returns>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.AssistantsModelFactory.RunStepMessageCreationDetails(Azure.AI.OpenAI.Assistants.RunStepMessageCreationReference)">
|
|
<summary> Initializes a new instance of <see cref="T:Azure.AI.OpenAI.Assistants.RunStepMessageCreationDetails" />. </summary>
|
|
<param name="messageCreation"> Information about the message creation associated with this run step. </param>
|
|
<returns> A new <see cref="T:Azure.AI.OpenAI.Assistants.RunStepMessageCreationDetails" /> instance for mocking. </returns>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.AssistantsModelFactory.RunStepMessageCreationReference(System.String)">
|
|
<summary> Initializes a new instance of <see cref="T:Azure.AI.OpenAI.Assistants.RunStepMessageCreationReference" />. </summary>
|
|
<param name="messageId"> The ID of the message created by this run step. </param>
|
|
<returns> A new <see cref="T:Azure.AI.OpenAI.Assistants.RunStepMessageCreationReference" /> instance for mocking. </returns>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.AssistantsModelFactory.RunStepToolCallDetails(System.Collections.Generic.IEnumerable{Azure.AI.OpenAI.Assistants.RunStepToolCall})">
|
|
<summary> Initializes a new instance of <see cref="T:Azure.AI.OpenAI.Assistants.RunStepToolCallDetails" />. </summary>
|
|
<param name="toolCalls">
|
|
A list of tool call details for this run step.
|
|
Please note <see cref="T:Azure.AI.OpenAI.Assistants.RunStepToolCall" /> is the base class. According to the scenario, a derived class of the base class might need to be assigned here, or this property needs to be casted to one of the possible derived classes.
|
|
The available derived classes include <see cref="T:Azure.AI.OpenAI.Assistants.RunStepCodeInterpreterToolCall" />, <see cref="T:Azure.AI.OpenAI.Assistants.RunStepFunctionToolCall" /> and <see cref="T:Azure.AI.OpenAI.Assistants.RunStepRetrievalToolCall" />.
|
|
</param>
|
|
<returns> A new <see cref="T:Azure.AI.OpenAI.Assistants.RunStepToolCallDetails" /> instance for mocking. </returns>
|
|
</member>
|
|
<member name="T:Azure.AI.OpenAI.Assistants.MessageImageFileContent">
|
|
<summary> A representation of image file content in a thread message. </summary>
|
|
</member>
|
|
<member name="P:Azure.AI.OpenAI.Assistants.MessageImageFileContent.FileId">
|
|
<summary> The ID for the file associated with this image. </summary>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.MessageImageFileContent.#ctor(Azure.AI.OpenAI.Assistants.InternalMessageImageFileDetails)">
|
|
<summary> Initializes a new instance of <see cref="T:Azure.AI.OpenAI.Assistants.MessageImageFileContent" />. </summary>
|
|
<param name="internalDetails"> The image file for this thread message content item. </param>
|
|
<exception cref="T:System.ArgumentNullException"> <paramref name="internalDetails" /> is null. </exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.MessageImageFileContent.#ctor(System.String,System.Collections.Generic.IDictionary{System.String,System.BinaryData},Azure.AI.OpenAI.Assistants.InternalMessageImageFileDetails)">
|
|
<summary> Initializes a new instance of <see cref="T:Azure.AI.OpenAI.Assistants.MessageImageFileContent" />. </summary>
|
|
<param name="type"> The object type. </param>
|
|
<param name="serializedAdditionalRawData"> Keeps track of any properties unknown to the library. </param>
|
|
<param name="internalDetails"> The image file for this thread message content item. </param>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.MessageImageFileContent.#ctor">
|
|
<summary> Initializes a new instance of <see cref="T:Azure.AI.OpenAI.Assistants.MessageImageFileContent" /> for deserialization. </summary>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.MessageImageFileContent.FromResponse(Azure.Response)">
|
|
<summary> Deserializes the model from a raw response. </summary>
|
|
<param name="response"> The response to deserialize the model from. </param>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.MessageImageFileContent.ToRequestContent">
|
|
<summary> Convert into a <see cref="T:Azure.Core.RequestContent" />. </summary>
|
|
</member>
|
|
<member name="T:Azure.AI.OpenAI.Assistants.MessageTextContent">
|
|
<summary> A representation of a textual item of thread message content. </summary>
|
|
</member>
|
|
<member name="P:Azure.AI.OpenAI.Assistants.MessageTextContent.Text">
|
|
<summary> The text data. </summary>
|
|
</member>
|
|
<member name="P:Azure.AI.OpenAI.Assistants.MessageTextContent.Annotations">
|
|
<summary>
|
|
A list of annotations associated with this text.
|
|
Please note <see cref="T:Azure.AI.OpenAI.Assistants.MessageTextAnnotation" /> is the base class. According to the scenario, a derived class of the base class might need to be assigned here, or this property needs to be casted to one of the possible derived classes.
|
|
The available derived classes include <see cref="T:Azure.AI.OpenAI.Assistants.MessageTextFileCitationAnnotation" /> and <see cref="T:Azure.AI.OpenAI.Assistants.MessageTextFilePathAnnotation" />.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.MessageTextContent.#ctor(Azure.AI.OpenAI.Assistants.InternalMessageTextDetails)">
|
|
<summary> Initializes a new instance of <see cref="T:Azure.AI.OpenAI.Assistants.MessageTextContent" />. </summary>
|
|
<param name="internalDetails"> The text and associated annotations for this thread message content item. </param>
|
|
<exception cref="T:System.ArgumentNullException"> <paramref name="internalDetails" /> is null. </exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.MessageTextContent.#ctor(System.String,System.Collections.Generic.IDictionary{System.String,System.BinaryData},Azure.AI.OpenAI.Assistants.InternalMessageTextDetails)">
|
|
<summary> Initializes a new instance of <see cref="T:Azure.AI.OpenAI.Assistants.MessageTextContent" />. </summary>
|
|
<param name="type"> The object type. </param>
|
|
<param name="serializedAdditionalRawData"> Keeps track of any properties unknown to the library. </param>
|
|
<param name="internalDetails"> The text and associated annotations for this thread message content item. </param>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.MessageTextContent.#ctor">
|
|
<summary> Initializes a new instance of <see cref="T:Azure.AI.OpenAI.Assistants.MessageTextContent" /> for deserialization. </summary>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.MessageTextContent.FromResponse(Azure.Response)">
|
|
<summary> Deserializes the model from a raw response. </summary>
|
|
<param name="response"> The response to deserialize the model from. </param>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.MessageTextContent.ToRequestContent">
|
|
<summary> Convert into a <see cref="T:Azure.Core.RequestContent" />. </summary>
|
|
</member>
|
|
<member name="T:Azure.AI.OpenAI.Assistants.MessageTextFileCitationAnnotation">
|
|
<summary> A citation within the message that points to a specific quote from a specific File associated with the assistant or the message. Generated when the assistant uses the 'retrieval' tool to search files. </summary>
|
|
</member>
|
|
<member name="P:Azure.AI.OpenAI.Assistants.MessageTextFileCitationAnnotation.FileId">
|
|
<summary> The ID of the file associated with this citation. </summary>
|
|
</member>
|
|
<member name="P:Azure.AI.OpenAI.Assistants.MessageTextFileCitationAnnotation.Quote">
|
|
<summary> The specific quote cited in the associated file. </summary>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.MessageTextFileCitationAnnotation.#ctor(System.String,System.Int32,System.Int32,Azure.AI.OpenAI.Assistants.InternalMessageTextFileCitationDetails)">
|
|
<summary> Initializes a new instance of <see cref="T:Azure.AI.OpenAI.Assistants.MessageTextFileCitationAnnotation" />. </summary>
|
|
<param name="text"> The textual content associated with this text annotation item. </param>
|
|
<param name="startIndex"> The first text index associated with this text annotation. </param>
|
|
<param name="endIndex"> The last text index associated with this text annotation. </param>
|
|
<param name="internalDetails">
|
|
A citation within the message that points to a specific quote from a specific file.
|
|
Generated when the assistant uses the "retrieval" tool to search files.
|
|
</param>
|
|
<exception cref="T:System.ArgumentNullException"> <paramref name="text" /> or <paramref name="internalDetails" /> is null. </exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.MessageTextFileCitationAnnotation.#ctor(System.String,System.String,System.Int32,System.Int32,System.Collections.Generic.IDictionary{System.String,System.BinaryData},Azure.AI.OpenAI.Assistants.InternalMessageTextFileCitationDetails)">
|
|
<summary> Initializes a new instance of <see cref="T:Azure.AI.OpenAI.Assistants.MessageTextFileCitationAnnotation" />. </summary>
|
|
<param name="type"> The object type. </param>
|
|
<param name="text"> The textual content associated with this text annotation item. </param>
|
|
<param name="startIndex"> The first text index associated with this text annotation. </param>
|
|
<param name="endIndex"> The last text index associated with this text annotation. </param>
|
|
<param name="serializedAdditionalRawData"> Keeps track of any properties unknown to the library. </param>
|
|
<param name="internalDetails">
|
|
A citation within the message that points to a specific quote from a specific file.
|
|
Generated when the assistant uses the "retrieval" tool to search files.
|
|
</param>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.MessageTextFileCitationAnnotation.#ctor">
|
|
<summary> Initializes a new instance of <see cref="T:Azure.AI.OpenAI.Assistants.MessageTextFileCitationAnnotation" /> for deserialization. </summary>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.MessageTextFileCitationAnnotation.FromResponse(Azure.Response)">
|
|
<summary> Deserializes the model from a raw response. </summary>
|
|
<param name="response"> The response to deserialize the model from. </param>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.MessageTextFileCitationAnnotation.ToRequestContent">
|
|
<summary> Convert into a <see cref="T:Azure.Core.RequestContent" />. </summary>
|
|
</member>
|
|
<member name="T:Azure.AI.OpenAI.Assistants.MessageTextFilePathAnnotation">
|
|
<summary> A citation within the message that points to a file located at a specific path. </summary>
|
|
</member>
|
|
<member name="P:Azure.AI.OpenAI.Assistants.MessageTextFilePathAnnotation.FileId">
|
|
<summary> The ID of the specific file that the citation is from. </summary>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.MessageTextFilePathAnnotation.#ctor(System.String,System.Int32,System.Int32,Azure.AI.OpenAI.Assistants.InternalMessageTextFilePathDetails)">
|
|
<summary> Initializes a new instance of <see cref="T:Azure.AI.OpenAI.Assistants.MessageTextFilePathAnnotation" />. </summary>
|
|
<param name="text"> The textual content associated with this text annotation item. </param>
|
|
<param name="startIndex"> The first text index associated with this text annotation. </param>
|
|
<param name="endIndex"> The last text index associated with this text annotation. </param>
|
|
<param name="internalDetails"> A URL for the file that's generated when the assistant used the code_interpreter tool to generate a file. </param>
|
|
<exception cref="T:System.ArgumentNullException"> <paramref name="text" /> or <paramref name="internalDetails" /> is null. </exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.MessageTextFilePathAnnotation.#ctor(System.String,System.String,System.Int32,System.Int32,System.Collections.Generic.IDictionary{System.String,System.BinaryData},Azure.AI.OpenAI.Assistants.InternalMessageTextFilePathDetails)">
|
|
<summary> Initializes a new instance of <see cref="T:Azure.AI.OpenAI.Assistants.MessageTextFilePathAnnotation" />. </summary>
|
|
<param name="type"> The object type. </param>
|
|
<param name="text"> The textual content associated with this text annotation item. </param>
|
|
<param name="startIndex"> The first text index associated with this text annotation. </param>
|
|
<param name="endIndex"> The last text index associated with this text annotation. </param>
|
|
<param name="serializedAdditionalRawData"> Keeps track of any properties unknown to the library. </param>
|
|
<param name="internalDetails"> A URL for the file that's generated when the assistant used the code_interpreter tool to generate a file. </param>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.MessageTextFilePathAnnotation.#ctor">
|
|
<summary> Initializes a new instance of <see cref="T:Azure.AI.OpenAI.Assistants.MessageTextFilePathAnnotation" /> for deserialization. </summary>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.MessageTextFilePathAnnotation.FromResponse(Azure.Response)">
|
|
<summary> Deserializes the model from a raw response. </summary>
|
|
<param name="response"> The response to deserialize the model from. </param>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.MessageTextFilePathAnnotation.ToRequestContent">
|
|
<summary> Convert into a <see cref="T:Azure.Core.RequestContent" />. </summary>
|
|
</member>
|
|
<member name="T:Azure.AI.OpenAI.Assistants.OpenAIFile">
|
|
<summary> Represents an assistant that can call the model and use tools. </summary>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.OpenAIFile.#ctor(System.String,System.Int32,System.String,System.DateTimeOffset,Azure.AI.OpenAI.Assistants.OpenAIFilePurpose)">
|
|
<summary> Initializes a new instance of <see cref="T:Azure.AI.OpenAI.Assistants.OpenAIFile" />. </summary>
|
|
<param name="id"> The identifier, which can be referenced in API endpoints. </param>
|
|
<param name="size"> The size of the file, in bytes. </param>
|
|
<param name="filename"> The name of the file. </param>
|
|
<param name="createdAt"> The Unix timestamp, in seconds, representing when this object was created. </param>
|
|
<param name="purpose"> The intended purpose of a file. </param>
|
|
<exception cref="T:System.ArgumentNullException"> <paramref name="id" /> or <paramref name="filename" /> is null. </exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.OpenAIFile.#ctor(System.String,System.String,System.Int32,System.String,System.DateTimeOffset,Azure.AI.OpenAI.Assistants.OpenAIFilePurpose,System.Collections.Generic.IDictionary{System.String,System.BinaryData})">
|
|
<summary> Initializes a new instance of <see cref="T:Azure.AI.OpenAI.Assistants.OpenAIFile" />. </summary>
|
|
<param name="object"> The object type, which is always 'file'. </param>
|
|
<param name="id"> The identifier, which can be referenced in API endpoints. </param>
|
|
<param name="size"> The size of the file, in bytes. </param>
|
|
<param name="filename"> The name of the file. </param>
|
|
<param name="createdAt"> The Unix timestamp, in seconds, representing when this object was created. </param>
|
|
<param name="purpose"> The intended purpose of a file. </param>
|
|
<param name="serializedAdditionalRawData"> Keeps track of any properties unknown to the library. </param>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.OpenAIFile.#ctor">
|
|
<summary> Initializes a new instance of <see cref="T:Azure.AI.OpenAI.Assistants.OpenAIFile" /> for deserialization. </summary>
|
|
</member>
|
|
<member name="P:Azure.AI.OpenAI.Assistants.OpenAIFile.Id">
|
|
<summary> The identifier, which can be referenced in API endpoints. </summary>
|
|
</member>
|
|
<member name="P:Azure.AI.OpenAI.Assistants.OpenAIFile.Size">
|
|
<summary> The size of the file, in bytes. </summary>
|
|
</member>
|
|
<member name="P:Azure.AI.OpenAI.Assistants.OpenAIFile.Filename">
|
|
<summary> The name of the file. </summary>
|
|
</member>
|
|
<member name="P:Azure.AI.OpenAI.Assistants.OpenAIFile.CreatedAt">
|
|
<summary> The Unix timestamp, in seconds, representing when this object was created. </summary>
|
|
</member>
|
|
<member name="P:Azure.AI.OpenAI.Assistants.OpenAIFile.Purpose">
|
|
<summary> The intended purpose of a file. </summary>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.OpenAIFile.FromResponse(Azure.Response)">
|
|
<summary> Deserializes the model from a raw response. </summary>
|
|
<param name="response"> The response to deserialize the model from. </param>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.OpenAIFile.ToRequestContent">
|
|
<summary> Convert into a <see cref="T:Azure.Core.RequestContent" />. </summary>
|
|
</member>
|
|
<member name="T:Azure.AI.OpenAI.Assistants.InternalOpenAIPageableListOfAssistant">
|
|
<summary> The response data for a requested list of items. </summary>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.InternalOpenAIPageableListOfAssistant.#ctor(System.Collections.Generic.IEnumerable{Azure.AI.OpenAI.Assistants.Assistant},System.String,System.String,System.Boolean)">
|
|
<summary> Initializes a new instance of <see cref="T:Azure.AI.OpenAI.Assistants.InternalOpenAIPageableListOfAssistant" />. </summary>
|
|
<param name="data"> The requested list of items. </param>
|
|
<param name="firstId"> The first ID represented in this list. </param>
|
|
<param name="lastId"> The last ID represented in this list. </param>
|
|
<param name="hasMore"> A value indicating whether there are additional values available not captured in this list. </param>
|
|
<exception cref="T:System.ArgumentNullException"> <paramref name="data" />, <paramref name="firstId" /> or <paramref name="lastId" /> is null. </exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.InternalOpenAIPageableListOfAssistant.#ctor(Azure.AI.OpenAI.Assistants.OpenAIPageableListOfAssistantObject,System.Collections.Generic.IReadOnlyList{Azure.AI.OpenAI.Assistants.Assistant},System.String,System.String,System.Boolean,System.Collections.Generic.IDictionary{System.String,System.BinaryData})">
|
|
<summary> Initializes a new instance of <see cref="T:Azure.AI.OpenAI.Assistants.InternalOpenAIPageableListOfAssistant" />. </summary>
|
|
<param name="object"> The object type, which is always list. </param>
|
|
<param name="data"> The requested list of items. </param>
|
|
<param name="firstId"> The first ID represented in this list. </param>
|
|
<param name="lastId"> The last ID represented in this list. </param>
|
|
<param name="hasMore"> A value indicating whether there are additional values available not captured in this list. </param>
|
|
<param name="serializedAdditionalRawData"> Keeps track of any properties unknown to the library. </param>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.InternalOpenAIPageableListOfAssistant.#ctor">
|
|
<summary> Initializes a new instance of <see cref="T:Azure.AI.OpenAI.Assistants.InternalOpenAIPageableListOfAssistant" /> for deserialization. </summary>
|
|
</member>
|
|
<member name="P:Azure.AI.OpenAI.Assistants.InternalOpenAIPageableListOfAssistant.Object">
|
|
<summary> The object type, which is always list. </summary>
|
|
</member>
|
|
<member name="P:Azure.AI.OpenAI.Assistants.InternalOpenAIPageableListOfAssistant.Data">
|
|
<summary> The requested list of items. </summary>
|
|
</member>
|
|
<member name="P:Azure.AI.OpenAI.Assistants.InternalOpenAIPageableListOfAssistant.FirstId">
|
|
<summary> The first ID represented in this list. </summary>
|
|
</member>
|
|
<member name="P:Azure.AI.OpenAI.Assistants.InternalOpenAIPageableListOfAssistant.LastId">
|
|
<summary> The last ID represented in this list. </summary>
|
|
</member>
|
|
<member name="P:Azure.AI.OpenAI.Assistants.InternalOpenAIPageableListOfAssistant.HasMore">
|
|
<summary> A value indicating whether there are additional values available not captured in this list. </summary>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.InternalOpenAIPageableListOfAssistant.FromResponse(Azure.Response)">
|
|
<summary> Deserializes the model from a raw response. </summary>
|
|
<param name="response"> The response to deserialize the model from. </param>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.InternalOpenAIPageableListOfAssistant.ToRequestContent">
|
|
<summary> Convert into a <see cref="T:Azure.Core.RequestContent" />. </summary>
|
|
</member>
|
|
<member name="T:Azure.AI.OpenAI.Assistants.OpenAIPageableListOfAssistantObject">
|
|
<summary> The OpenAIPageableListOfAssistant_object. </summary>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.OpenAIPageableListOfAssistantObject.#ctor(System.String)">
|
|
<summary> Initializes a new instance of <see cref="T:Azure.AI.OpenAI.Assistants.OpenAIPageableListOfAssistantObject" />. </summary>
|
|
<exception cref="T:System.ArgumentNullException"> <paramref name="value" /> is null. </exception>
|
|
</member>
|
|
<member name="P:Azure.AI.OpenAI.Assistants.OpenAIPageableListOfAssistantObject.List">
|
|
<summary> list. </summary>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.OpenAIPageableListOfAssistantObject.op_Equality(Azure.AI.OpenAI.Assistants.OpenAIPageableListOfAssistantObject,Azure.AI.OpenAI.Assistants.OpenAIPageableListOfAssistantObject)">
|
|
<summary> Determines if two <see cref="T:Azure.AI.OpenAI.Assistants.OpenAIPageableListOfAssistantObject" /> values are the same. </summary>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.OpenAIPageableListOfAssistantObject.op_Inequality(Azure.AI.OpenAI.Assistants.OpenAIPageableListOfAssistantObject,Azure.AI.OpenAI.Assistants.OpenAIPageableListOfAssistantObject)">
|
|
<summary> Determines if two <see cref="T:Azure.AI.OpenAI.Assistants.OpenAIPageableListOfAssistantObject" /> values are not the same. </summary>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.OpenAIPageableListOfAssistantObject.op_Implicit(System.String)~Azure.AI.OpenAI.Assistants.OpenAIPageableListOfAssistantObject">
|
|
<summary> Converts a string to a <see cref="T:Azure.AI.OpenAI.Assistants.OpenAIPageableListOfAssistantObject" />. </summary>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.OpenAIPageableListOfAssistantObject.Equals(System.Object)">
|
|
<summary>Indicates whether this instance and a specified object are equal.</summary><param name="obj">The object to compare with the current instance.</param><returns><see langword="true" /> if <paramref name="obj" /> and this instance are the same type and represent the same value; otherwise, <see langword="false" />.</returns>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.OpenAIPageableListOfAssistantObject.Equals(Azure.AI.OpenAI.Assistants.OpenAIPageableListOfAssistantObject)">
|
|
<summary>Indicates whether the current object is equal to another object of the same type.</summary><param name="other">An object to compare with this object.</param><returns><see langword="true" /> if the current object is equal to the <paramref name="other" /> parameter; otherwise, <see langword="false" />.</returns>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.OpenAIPageableListOfAssistantObject.GetHashCode">
|
|
<summary>Returns the hash code for this instance.</summary><returns>A 32-bit signed integer that is the hash code for this instance.</returns>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.OpenAIPageableListOfAssistantObject.ToString">
|
|
<summary>Returns the fully qualified type name of this instance.</summary><returns>The fully qualified type name.</returns>
|
|
</member>
|
|
<member name="T:Azure.AI.OpenAI.Assistants.InternalOpenAIPageableListOfAssistantFile">
|
|
<summary> The response data for a requested list of items. </summary>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.InternalOpenAIPageableListOfAssistantFile.#ctor(System.Collections.Generic.IEnumerable{Azure.AI.OpenAI.Assistants.AssistantFile},System.String,System.String,System.Boolean)">
|
|
<summary> Initializes a new instance of <see cref="T:Azure.AI.OpenAI.Assistants.InternalOpenAIPageableListOfAssistantFile" />. </summary>
|
|
<param name="data"> The requested list of items. </param>
|
|
<param name="firstId"> The first ID represented in this list. </param>
|
|
<param name="lastId"> The last ID represented in this list. </param>
|
|
<param name="hasMore"> A value indicating whether there are additional values available not captured in this list. </param>
|
|
<exception cref="T:System.ArgumentNullException"> <paramref name="data" />, <paramref name="firstId" /> or <paramref name="lastId" /> is null. </exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.InternalOpenAIPageableListOfAssistantFile.#ctor(Azure.AI.OpenAI.Assistants.OpenAIPageableListOfAssistantFileObject,System.Collections.Generic.IReadOnlyList{Azure.AI.OpenAI.Assistants.AssistantFile},System.String,System.String,System.Boolean,System.Collections.Generic.IDictionary{System.String,System.BinaryData})">
|
|
<summary> Initializes a new instance of <see cref="T:Azure.AI.OpenAI.Assistants.InternalOpenAIPageableListOfAssistantFile" />. </summary>
|
|
<param name="object"> The object type, which is always list. </param>
|
|
<param name="data"> The requested list of items. </param>
|
|
<param name="firstId"> The first ID represented in this list. </param>
|
|
<param name="lastId"> The last ID represented in this list. </param>
|
|
<param name="hasMore"> A value indicating whether there are additional values available not captured in this list. </param>
|
|
<param name="serializedAdditionalRawData"> Keeps track of any properties unknown to the library. </param>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.InternalOpenAIPageableListOfAssistantFile.#ctor">
|
|
<summary> Initializes a new instance of <see cref="T:Azure.AI.OpenAI.Assistants.InternalOpenAIPageableListOfAssistantFile" /> for deserialization. </summary>
|
|
</member>
|
|
<member name="P:Azure.AI.OpenAI.Assistants.InternalOpenAIPageableListOfAssistantFile.Object">
|
|
<summary> The object type, which is always list. </summary>
|
|
</member>
|
|
<member name="P:Azure.AI.OpenAI.Assistants.InternalOpenAIPageableListOfAssistantFile.Data">
|
|
<summary> The requested list of items. </summary>
|
|
</member>
|
|
<member name="P:Azure.AI.OpenAI.Assistants.InternalOpenAIPageableListOfAssistantFile.FirstId">
|
|
<summary> The first ID represented in this list. </summary>
|
|
</member>
|
|
<member name="P:Azure.AI.OpenAI.Assistants.InternalOpenAIPageableListOfAssistantFile.LastId">
|
|
<summary> The last ID represented in this list. </summary>
|
|
</member>
|
|
<member name="P:Azure.AI.OpenAI.Assistants.InternalOpenAIPageableListOfAssistantFile.HasMore">
|
|
<summary> A value indicating whether there are additional values available not captured in this list. </summary>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.InternalOpenAIPageableListOfAssistantFile.FromResponse(Azure.Response)">
|
|
<summary> Deserializes the model from a raw response. </summary>
|
|
<param name="response"> The response to deserialize the model from. </param>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.InternalOpenAIPageableListOfAssistantFile.ToRequestContent">
|
|
<summary> Convert into a <see cref="T:Azure.Core.RequestContent" />. </summary>
|
|
</member>
|
|
<member name="T:Azure.AI.OpenAI.Assistants.OpenAIPageableListOfAssistantFileObject">
|
|
<summary> The OpenAIPageableListOfAssistantFile_object. </summary>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.OpenAIPageableListOfAssistantFileObject.#ctor(System.String)">
|
|
<summary> Initializes a new instance of <see cref="T:Azure.AI.OpenAI.Assistants.OpenAIPageableListOfAssistantFileObject" />. </summary>
|
|
<exception cref="T:System.ArgumentNullException"> <paramref name="value" /> is null. </exception>
|
|
</member>
|
|
<member name="P:Azure.AI.OpenAI.Assistants.OpenAIPageableListOfAssistantFileObject.List">
|
|
<summary> list. </summary>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.OpenAIPageableListOfAssistantFileObject.op_Equality(Azure.AI.OpenAI.Assistants.OpenAIPageableListOfAssistantFileObject,Azure.AI.OpenAI.Assistants.OpenAIPageableListOfAssistantFileObject)">
|
|
<summary> Determines if two <see cref="T:Azure.AI.OpenAI.Assistants.OpenAIPageableListOfAssistantFileObject" /> values are the same. </summary>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.OpenAIPageableListOfAssistantFileObject.op_Inequality(Azure.AI.OpenAI.Assistants.OpenAIPageableListOfAssistantFileObject,Azure.AI.OpenAI.Assistants.OpenAIPageableListOfAssistantFileObject)">
|
|
<summary> Determines if two <see cref="T:Azure.AI.OpenAI.Assistants.OpenAIPageableListOfAssistantFileObject" /> values are not the same. </summary>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.OpenAIPageableListOfAssistantFileObject.op_Implicit(System.String)~Azure.AI.OpenAI.Assistants.OpenAIPageableListOfAssistantFileObject">
|
|
<summary> Converts a string to a <see cref="T:Azure.AI.OpenAI.Assistants.OpenAIPageableListOfAssistantFileObject" />. </summary>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.OpenAIPageableListOfAssistantFileObject.Equals(System.Object)">
|
|
<summary>Indicates whether this instance and a specified object are equal.</summary><param name="obj">The object to compare with the current instance.</param><returns><see langword="true" /> if <paramref name="obj" /> and this instance are the same type and represent the same value; otherwise, <see langword="false" />.</returns>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.OpenAIPageableListOfAssistantFileObject.Equals(Azure.AI.OpenAI.Assistants.OpenAIPageableListOfAssistantFileObject)">
|
|
<summary>Indicates whether the current object is equal to another object of the same type.</summary><param name="other">An object to compare with this object.</param><returns><see langword="true" /> if the current object is equal to the <paramref name="other" /> parameter; otherwise, <see langword="false" />.</returns>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.OpenAIPageableListOfAssistantFileObject.GetHashCode">
|
|
<summary>Returns the hash code for this instance.</summary><returns>A 32-bit signed integer that is the hash code for this instance.</returns>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.OpenAIPageableListOfAssistantFileObject.ToString">
|
|
<summary>Returns the fully qualified type name of this instance.</summary><returns>The fully qualified type name.</returns>
|
|
</member>
|
|
<member name="T:Azure.AI.OpenAI.Assistants.InternalOpenAIPageableListOfThreadMessage">
|
|
<summary> The response data for a requested list of items. </summary>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.InternalOpenAIPageableListOfThreadMessage.#ctor(System.Collections.Generic.IEnumerable{Azure.AI.OpenAI.Assistants.ThreadMessage},System.String,System.String,System.Boolean)">
|
|
<summary> Initializes a new instance of <see cref="T:Azure.AI.OpenAI.Assistants.InternalOpenAIPageableListOfThreadMessage" />. </summary>
|
|
<param name="data"> The requested list of items. </param>
|
|
<param name="firstId"> The first ID represented in this list. </param>
|
|
<param name="lastId"> The last ID represented in this list. </param>
|
|
<param name="hasMore"> A value indicating whether there are additional values available not captured in this list. </param>
|
|
<exception cref="T:System.ArgumentNullException"> <paramref name="data" />, <paramref name="firstId" /> or <paramref name="lastId" /> is null. </exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.InternalOpenAIPageableListOfThreadMessage.#ctor(Azure.AI.OpenAI.Assistants.OpenAIPageableListOfThreadMessageObject,System.Collections.Generic.IReadOnlyList{Azure.AI.OpenAI.Assistants.ThreadMessage},System.String,System.String,System.Boolean,System.Collections.Generic.IDictionary{System.String,System.BinaryData})">
|
|
<summary> Initializes a new instance of <see cref="T:Azure.AI.OpenAI.Assistants.InternalOpenAIPageableListOfThreadMessage" />. </summary>
|
|
<param name="object"> The object type, which is always list. </param>
|
|
<param name="data"> The requested list of items. </param>
|
|
<param name="firstId"> The first ID represented in this list. </param>
|
|
<param name="lastId"> The last ID represented in this list. </param>
|
|
<param name="hasMore"> A value indicating whether there are additional values available not captured in this list. </param>
|
|
<param name="serializedAdditionalRawData"> Keeps track of any properties unknown to the library. </param>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.InternalOpenAIPageableListOfThreadMessage.#ctor">
|
|
<summary> Initializes a new instance of <see cref="T:Azure.AI.OpenAI.Assistants.InternalOpenAIPageableListOfThreadMessage" /> for deserialization. </summary>
|
|
</member>
|
|
<member name="P:Azure.AI.OpenAI.Assistants.InternalOpenAIPageableListOfThreadMessage.Object">
|
|
<summary> The object type, which is always list. </summary>
|
|
</member>
|
|
<member name="P:Azure.AI.OpenAI.Assistants.InternalOpenAIPageableListOfThreadMessage.Data">
|
|
<summary> The requested list of items. </summary>
|
|
</member>
|
|
<member name="P:Azure.AI.OpenAI.Assistants.InternalOpenAIPageableListOfThreadMessage.FirstId">
|
|
<summary> The first ID represented in this list. </summary>
|
|
</member>
|
|
<member name="P:Azure.AI.OpenAI.Assistants.InternalOpenAIPageableListOfThreadMessage.LastId">
|
|
<summary> The last ID represented in this list. </summary>
|
|
</member>
|
|
<member name="P:Azure.AI.OpenAI.Assistants.InternalOpenAIPageableListOfThreadMessage.HasMore">
|
|
<summary> A value indicating whether there are additional values available not captured in this list. </summary>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.InternalOpenAIPageableListOfThreadMessage.FromResponse(Azure.Response)">
|
|
<summary> Deserializes the model from a raw response. </summary>
|
|
<param name="response"> The response to deserialize the model from. </param>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.InternalOpenAIPageableListOfThreadMessage.ToRequestContent">
|
|
<summary> Convert into a <see cref="T:Azure.Core.RequestContent" />. </summary>
|
|
</member>
|
|
<member name="T:Azure.AI.OpenAI.Assistants.OpenAIPageableListOfThreadMessageObject">
|
|
<summary> The OpenAIPageableListOfThreadMessage_object. </summary>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.OpenAIPageableListOfThreadMessageObject.#ctor(System.String)">
|
|
<summary> Initializes a new instance of <see cref="T:Azure.AI.OpenAI.Assistants.OpenAIPageableListOfThreadMessageObject" />. </summary>
|
|
<exception cref="T:System.ArgumentNullException"> <paramref name="value" /> is null. </exception>
|
|
</member>
|
|
<member name="P:Azure.AI.OpenAI.Assistants.OpenAIPageableListOfThreadMessageObject.List">
|
|
<summary> list. </summary>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.OpenAIPageableListOfThreadMessageObject.op_Equality(Azure.AI.OpenAI.Assistants.OpenAIPageableListOfThreadMessageObject,Azure.AI.OpenAI.Assistants.OpenAIPageableListOfThreadMessageObject)">
|
|
<summary> Determines if two <see cref="T:Azure.AI.OpenAI.Assistants.OpenAIPageableListOfThreadMessageObject" /> values are the same. </summary>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.OpenAIPageableListOfThreadMessageObject.op_Inequality(Azure.AI.OpenAI.Assistants.OpenAIPageableListOfThreadMessageObject,Azure.AI.OpenAI.Assistants.OpenAIPageableListOfThreadMessageObject)">
|
|
<summary> Determines if two <see cref="T:Azure.AI.OpenAI.Assistants.OpenAIPageableListOfThreadMessageObject" /> values are not the same. </summary>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.OpenAIPageableListOfThreadMessageObject.op_Implicit(System.String)~Azure.AI.OpenAI.Assistants.OpenAIPageableListOfThreadMessageObject">
|
|
<summary> Converts a string to a <see cref="T:Azure.AI.OpenAI.Assistants.OpenAIPageableListOfThreadMessageObject" />. </summary>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.OpenAIPageableListOfThreadMessageObject.Equals(System.Object)">
|
|
<summary>Indicates whether this instance and a specified object are equal.</summary><param name="obj">The object to compare with the current instance.</param><returns><see langword="true" /> if <paramref name="obj" /> and this instance are the same type and represent the same value; otherwise, <see langword="false" />.</returns>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.OpenAIPageableListOfThreadMessageObject.Equals(Azure.AI.OpenAI.Assistants.OpenAIPageableListOfThreadMessageObject)">
|
|
<summary>Indicates whether the current object is equal to another object of the same type.</summary><param name="other">An object to compare with this object.</param><returns><see langword="true" /> if the current object is equal to the <paramref name="other" /> parameter; otherwise, <see langword="false" />.</returns>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.OpenAIPageableListOfThreadMessageObject.GetHashCode">
|
|
<summary>Returns the hash code for this instance.</summary><returns>A 32-bit signed integer that is the hash code for this instance.</returns>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.OpenAIPageableListOfThreadMessageObject.ToString">
|
|
<summary>Returns the fully qualified type name of this instance.</summary><returns>The fully qualified type name.</returns>
|
|
</member>
|
|
<member name="T:Azure.AI.OpenAI.Assistants.InternalOpenAIPageableListOfMessageFile">
|
|
<summary> The response data for a requested list of items. </summary>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.InternalOpenAIPageableListOfMessageFile.#ctor(System.Collections.Generic.IEnumerable{Azure.AI.OpenAI.Assistants.MessageFile},System.String,System.String,System.Boolean)">
|
|
<summary> Initializes a new instance of <see cref="T:Azure.AI.OpenAI.Assistants.InternalOpenAIPageableListOfMessageFile" />. </summary>
|
|
<param name="data"> The requested list of items. </param>
|
|
<param name="firstId"> The first ID represented in this list. </param>
|
|
<param name="lastId"> The last ID represented in this list. </param>
|
|
<param name="hasMore"> A value indicating whether there are additional values available not captured in this list. </param>
|
|
<exception cref="T:System.ArgumentNullException"> <paramref name="data" />, <paramref name="firstId" /> or <paramref name="lastId" /> is null. </exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.InternalOpenAIPageableListOfMessageFile.#ctor(Azure.AI.OpenAI.Assistants.OpenAIPageableListOfMessageFileObject,System.Collections.Generic.IReadOnlyList{Azure.AI.OpenAI.Assistants.MessageFile},System.String,System.String,System.Boolean,System.Collections.Generic.IDictionary{System.String,System.BinaryData})">
|
|
<summary> Initializes a new instance of <see cref="T:Azure.AI.OpenAI.Assistants.InternalOpenAIPageableListOfMessageFile" />. </summary>
|
|
<param name="object"> The object type, which is always list. </param>
|
|
<param name="data"> The requested list of items. </param>
|
|
<param name="firstId"> The first ID represented in this list. </param>
|
|
<param name="lastId"> The last ID represented in this list. </param>
|
|
<param name="hasMore"> A value indicating whether there are additional values available not captured in this list. </param>
|
|
<param name="serializedAdditionalRawData"> Keeps track of any properties unknown to the library. </param>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.InternalOpenAIPageableListOfMessageFile.#ctor">
|
|
<summary> Initializes a new instance of <see cref="T:Azure.AI.OpenAI.Assistants.InternalOpenAIPageableListOfMessageFile" /> for deserialization. </summary>
|
|
</member>
|
|
<member name="P:Azure.AI.OpenAI.Assistants.InternalOpenAIPageableListOfMessageFile.Object">
|
|
<summary> The object type, which is always list. </summary>
|
|
</member>
|
|
<member name="P:Azure.AI.OpenAI.Assistants.InternalOpenAIPageableListOfMessageFile.Data">
|
|
<summary> The requested list of items. </summary>
|
|
</member>
|
|
<member name="P:Azure.AI.OpenAI.Assistants.InternalOpenAIPageableListOfMessageFile.FirstId">
|
|
<summary> The first ID represented in this list. </summary>
|
|
</member>
|
|
<member name="P:Azure.AI.OpenAI.Assistants.InternalOpenAIPageableListOfMessageFile.LastId">
|
|
<summary> The last ID represented in this list. </summary>
|
|
</member>
|
|
<member name="P:Azure.AI.OpenAI.Assistants.InternalOpenAIPageableListOfMessageFile.HasMore">
|
|
<summary> A value indicating whether there are additional values available not captured in this list. </summary>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.InternalOpenAIPageableListOfMessageFile.FromResponse(Azure.Response)">
|
|
<summary> Deserializes the model from a raw response. </summary>
|
|
<param name="response"> The response to deserialize the model from. </param>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.InternalOpenAIPageableListOfMessageFile.ToRequestContent">
|
|
<summary> Convert into a <see cref="T:Azure.Core.RequestContent" />. </summary>
|
|
</member>
|
|
<member name="T:Azure.AI.OpenAI.Assistants.OpenAIPageableListOfMessageFileObject">
|
|
<summary> The OpenAIPageableListOfMessageFile_object. </summary>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.OpenAIPageableListOfMessageFileObject.#ctor(System.String)">
|
|
<summary> Initializes a new instance of <see cref="T:Azure.AI.OpenAI.Assistants.OpenAIPageableListOfMessageFileObject" />. </summary>
|
|
<exception cref="T:System.ArgumentNullException"> <paramref name="value" /> is null. </exception>
|
|
</member>
|
|
<member name="P:Azure.AI.OpenAI.Assistants.OpenAIPageableListOfMessageFileObject.List">
|
|
<summary> list. </summary>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.OpenAIPageableListOfMessageFileObject.op_Equality(Azure.AI.OpenAI.Assistants.OpenAIPageableListOfMessageFileObject,Azure.AI.OpenAI.Assistants.OpenAIPageableListOfMessageFileObject)">
|
|
<summary> Determines if two <see cref="T:Azure.AI.OpenAI.Assistants.OpenAIPageableListOfMessageFileObject" /> values are the same. </summary>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.OpenAIPageableListOfMessageFileObject.op_Inequality(Azure.AI.OpenAI.Assistants.OpenAIPageableListOfMessageFileObject,Azure.AI.OpenAI.Assistants.OpenAIPageableListOfMessageFileObject)">
|
|
<summary> Determines if two <see cref="T:Azure.AI.OpenAI.Assistants.OpenAIPageableListOfMessageFileObject" /> values are not the same. </summary>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.OpenAIPageableListOfMessageFileObject.op_Implicit(System.String)~Azure.AI.OpenAI.Assistants.OpenAIPageableListOfMessageFileObject">
|
|
<summary> Converts a string to a <see cref="T:Azure.AI.OpenAI.Assistants.OpenAIPageableListOfMessageFileObject" />. </summary>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.OpenAIPageableListOfMessageFileObject.Equals(System.Object)">
|
|
<summary>Indicates whether this instance and a specified object are equal.</summary><param name="obj">The object to compare with the current instance.</param><returns><see langword="true" /> if <paramref name="obj" /> and this instance are the same type and represent the same value; otherwise, <see langword="false" />.</returns>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.OpenAIPageableListOfMessageFileObject.Equals(Azure.AI.OpenAI.Assistants.OpenAIPageableListOfMessageFileObject)">
|
|
<summary>Indicates whether the current object is equal to another object of the same type.</summary><param name="other">An object to compare with this object.</param><returns><see langword="true" /> if the current object is equal to the <paramref name="other" /> parameter; otherwise, <see langword="false" />.</returns>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.OpenAIPageableListOfMessageFileObject.GetHashCode">
|
|
<summary>Returns the hash code for this instance.</summary><returns>A 32-bit signed integer that is the hash code for this instance.</returns>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.OpenAIPageableListOfMessageFileObject.ToString">
|
|
<summary>Returns the fully qualified type name of this instance.</summary><returns>The fully qualified type name.</returns>
|
|
</member>
|
|
<member name="T:Azure.AI.OpenAI.Assistants.InternalOpenAIPageableListOfRunStep">
|
|
<summary> The response data for a requested list of items. </summary>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.InternalOpenAIPageableListOfRunStep.#ctor(System.Collections.Generic.IEnumerable{Azure.AI.OpenAI.Assistants.RunStep},System.String,System.String,System.Boolean)">
|
|
<summary> Initializes a new instance of <see cref="T:Azure.AI.OpenAI.Assistants.InternalOpenAIPageableListOfRunStep" />. </summary>
|
|
<param name="data"> The requested list of items. </param>
|
|
<param name="firstId"> The first ID represented in this list. </param>
|
|
<param name="lastId"> The last ID represented in this list. </param>
|
|
<param name="hasMore"> A value indicating whether there are additional values available not captured in this list. </param>
|
|
<exception cref="T:System.ArgumentNullException"> <paramref name="data" />, <paramref name="firstId" /> or <paramref name="lastId" /> is null. </exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.InternalOpenAIPageableListOfRunStep.#ctor(Azure.AI.OpenAI.Assistants.OpenAIPageableListOfRunStepObject,System.Collections.Generic.IReadOnlyList{Azure.AI.OpenAI.Assistants.RunStep},System.String,System.String,System.Boolean,System.Collections.Generic.IDictionary{System.String,System.BinaryData})">
|
|
<summary> Initializes a new instance of <see cref="T:Azure.AI.OpenAI.Assistants.InternalOpenAIPageableListOfRunStep" />. </summary>
|
|
<param name="object"> The object type, which is always list. </param>
|
|
<param name="data"> The requested list of items. </param>
|
|
<param name="firstId"> The first ID represented in this list. </param>
|
|
<param name="lastId"> The last ID represented in this list. </param>
|
|
<param name="hasMore"> A value indicating whether there are additional values available not captured in this list. </param>
|
|
<param name="serializedAdditionalRawData"> Keeps track of any properties unknown to the library. </param>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.InternalOpenAIPageableListOfRunStep.#ctor">
|
|
<summary> Initializes a new instance of <see cref="T:Azure.AI.OpenAI.Assistants.InternalOpenAIPageableListOfRunStep" /> for deserialization. </summary>
|
|
</member>
|
|
<member name="P:Azure.AI.OpenAI.Assistants.InternalOpenAIPageableListOfRunStep.Object">
|
|
<summary> The object type, which is always list. </summary>
|
|
</member>
|
|
<member name="P:Azure.AI.OpenAI.Assistants.InternalOpenAIPageableListOfRunStep.Data">
|
|
<summary> The requested list of items. </summary>
|
|
</member>
|
|
<member name="P:Azure.AI.OpenAI.Assistants.InternalOpenAIPageableListOfRunStep.FirstId">
|
|
<summary> The first ID represented in this list. </summary>
|
|
</member>
|
|
<member name="P:Azure.AI.OpenAI.Assistants.InternalOpenAIPageableListOfRunStep.LastId">
|
|
<summary> The last ID represented in this list. </summary>
|
|
</member>
|
|
<member name="P:Azure.AI.OpenAI.Assistants.InternalOpenAIPageableListOfRunStep.HasMore">
|
|
<summary> A value indicating whether there are additional values available not captured in this list. </summary>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.InternalOpenAIPageableListOfRunStep.FromResponse(Azure.Response)">
|
|
<summary> Deserializes the model from a raw response. </summary>
|
|
<param name="response"> The response to deserialize the model from. </param>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.InternalOpenAIPageableListOfRunStep.ToRequestContent">
|
|
<summary> Convert into a <see cref="T:Azure.Core.RequestContent" />. </summary>
|
|
</member>
|
|
<member name="T:Azure.AI.OpenAI.Assistants.OpenAIPageableListOfRunStepObject">
|
|
<summary> The OpenAIPageableListOfRunStep_object. </summary>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.OpenAIPageableListOfRunStepObject.#ctor(System.String)">
|
|
<summary> Initializes a new instance of <see cref="T:Azure.AI.OpenAI.Assistants.OpenAIPageableListOfRunStepObject" />. </summary>
|
|
<exception cref="T:System.ArgumentNullException"> <paramref name="value" /> is null. </exception>
|
|
</member>
|
|
<member name="P:Azure.AI.OpenAI.Assistants.OpenAIPageableListOfRunStepObject.List">
|
|
<summary> list. </summary>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.OpenAIPageableListOfRunStepObject.op_Equality(Azure.AI.OpenAI.Assistants.OpenAIPageableListOfRunStepObject,Azure.AI.OpenAI.Assistants.OpenAIPageableListOfRunStepObject)">
|
|
<summary> Determines if two <see cref="T:Azure.AI.OpenAI.Assistants.OpenAIPageableListOfRunStepObject" /> values are the same. </summary>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.OpenAIPageableListOfRunStepObject.op_Inequality(Azure.AI.OpenAI.Assistants.OpenAIPageableListOfRunStepObject,Azure.AI.OpenAI.Assistants.OpenAIPageableListOfRunStepObject)">
|
|
<summary> Determines if two <see cref="T:Azure.AI.OpenAI.Assistants.OpenAIPageableListOfRunStepObject" /> values are not the same. </summary>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.OpenAIPageableListOfRunStepObject.op_Implicit(System.String)~Azure.AI.OpenAI.Assistants.OpenAIPageableListOfRunStepObject">
|
|
<summary> Converts a string to a <see cref="T:Azure.AI.OpenAI.Assistants.OpenAIPageableListOfRunStepObject" />. </summary>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.OpenAIPageableListOfRunStepObject.Equals(System.Object)">
|
|
<summary>Indicates whether this instance and a specified object are equal.</summary><param name="obj">The object to compare with the current instance.</param><returns><see langword="true" /> if <paramref name="obj" /> and this instance are the same type and represent the same value; otherwise, <see langword="false" />.</returns>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.OpenAIPageableListOfRunStepObject.Equals(Azure.AI.OpenAI.Assistants.OpenAIPageableListOfRunStepObject)">
|
|
<summary>Indicates whether the current object is equal to another object of the same type.</summary><param name="other">An object to compare with this object.</param><returns><see langword="true" /> if the current object is equal to the <paramref name="other" /> parameter; otherwise, <see langword="false" />.</returns>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.OpenAIPageableListOfRunStepObject.GetHashCode">
|
|
<summary>Returns the hash code for this instance.</summary><returns>A 32-bit signed integer that is the hash code for this instance.</returns>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.OpenAIPageableListOfRunStepObject.ToString">
|
|
<summary>Returns the fully qualified type name of this instance.</summary><returns>The fully qualified type name.</returns>
|
|
</member>
|
|
<member name="T:Azure.AI.OpenAI.Assistants.InternalOpenAIPageableListOfThreadRun">
|
|
<summary> The response data for a requested list of items. </summary>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.InternalOpenAIPageableListOfThreadRun.#ctor(System.Collections.Generic.IEnumerable{Azure.AI.OpenAI.Assistants.ThreadRun},System.String,System.String,System.Boolean)">
|
|
<summary> Initializes a new instance of <see cref="T:Azure.AI.OpenAI.Assistants.InternalOpenAIPageableListOfThreadRun" />. </summary>
|
|
<param name="data"> The requested list of items. </param>
|
|
<param name="firstId"> The first ID represented in this list. </param>
|
|
<param name="lastId"> The last ID represented in this list. </param>
|
|
<param name="hasMore"> A value indicating whether there are additional values available not captured in this list. </param>
|
|
<exception cref="T:System.ArgumentNullException"> <paramref name="data" />, <paramref name="firstId" /> or <paramref name="lastId" /> is null. </exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.InternalOpenAIPageableListOfThreadRun.#ctor(Azure.AI.OpenAI.Assistants.OpenAIPageableListOfThreadRunObject,System.Collections.Generic.IReadOnlyList{Azure.AI.OpenAI.Assistants.ThreadRun},System.String,System.String,System.Boolean,System.Collections.Generic.IDictionary{System.String,System.BinaryData})">
|
|
<summary> Initializes a new instance of <see cref="T:Azure.AI.OpenAI.Assistants.InternalOpenAIPageableListOfThreadRun" />. </summary>
|
|
<param name="object"> The object type, which is always list. </param>
|
|
<param name="data"> The requested list of items. </param>
|
|
<param name="firstId"> The first ID represented in this list. </param>
|
|
<param name="lastId"> The last ID represented in this list. </param>
|
|
<param name="hasMore"> A value indicating whether there are additional values available not captured in this list. </param>
|
|
<param name="serializedAdditionalRawData"> Keeps track of any properties unknown to the library. </param>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.InternalOpenAIPageableListOfThreadRun.#ctor">
|
|
<summary> Initializes a new instance of <see cref="T:Azure.AI.OpenAI.Assistants.InternalOpenAIPageableListOfThreadRun" /> for deserialization. </summary>
|
|
</member>
|
|
<member name="P:Azure.AI.OpenAI.Assistants.InternalOpenAIPageableListOfThreadRun.Object">
|
|
<summary> The object type, which is always list. </summary>
|
|
</member>
|
|
<member name="P:Azure.AI.OpenAI.Assistants.InternalOpenAIPageableListOfThreadRun.Data">
|
|
<summary> The requested list of items. </summary>
|
|
</member>
|
|
<member name="P:Azure.AI.OpenAI.Assistants.InternalOpenAIPageableListOfThreadRun.FirstId">
|
|
<summary> The first ID represented in this list. </summary>
|
|
</member>
|
|
<member name="P:Azure.AI.OpenAI.Assistants.InternalOpenAIPageableListOfThreadRun.LastId">
|
|
<summary> The last ID represented in this list. </summary>
|
|
</member>
|
|
<member name="P:Azure.AI.OpenAI.Assistants.InternalOpenAIPageableListOfThreadRun.HasMore">
|
|
<summary> A value indicating whether there are additional values available not captured in this list. </summary>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.InternalOpenAIPageableListOfThreadRun.FromResponse(Azure.Response)">
|
|
<summary> Deserializes the model from a raw response. </summary>
|
|
<param name="response"> The response to deserialize the model from. </param>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.InternalOpenAIPageableListOfThreadRun.ToRequestContent">
|
|
<summary> Convert into a <see cref="T:Azure.Core.RequestContent" />. </summary>
|
|
</member>
|
|
<member name="T:Azure.AI.OpenAI.Assistants.OpenAIPageableListOfThreadRunObject">
|
|
<summary> The OpenAIPageableListOfThreadRun_object. </summary>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.OpenAIPageableListOfThreadRunObject.#ctor(System.String)">
|
|
<summary> Initializes a new instance of <see cref="T:Azure.AI.OpenAI.Assistants.OpenAIPageableListOfThreadRunObject" />. </summary>
|
|
<exception cref="T:System.ArgumentNullException"> <paramref name="value" /> is null. </exception>
|
|
</member>
|
|
<member name="P:Azure.AI.OpenAI.Assistants.OpenAIPageableListOfThreadRunObject.List">
|
|
<summary> list. </summary>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.OpenAIPageableListOfThreadRunObject.op_Equality(Azure.AI.OpenAI.Assistants.OpenAIPageableListOfThreadRunObject,Azure.AI.OpenAI.Assistants.OpenAIPageableListOfThreadRunObject)">
|
|
<summary> Determines if two <see cref="T:Azure.AI.OpenAI.Assistants.OpenAIPageableListOfThreadRunObject" /> values are the same. </summary>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.OpenAIPageableListOfThreadRunObject.op_Inequality(Azure.AI.OpenAI.Assistants.OpenAIPageableListOfThreadRunObject,Azure.AI.OpenAI.Assistants.OpenAIPageableListOfThreadRunObject)">
|
|
<summary> Determines if two <see cref="T:Azure.AI.OpenAI.Assistants.OpenAIPageableListOfThreadRunObject" /> values are not the same. </summary>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.OpenAIPageableListOfThreadRunObject.op_Implicit(System.String)~Azure.AI.OpenAI.Assistants.OpenAIPageableListOfThreadRunObject">
|
|
<summary> Converts a string to a <see cref="T:Azure.AI.OpenAI.Assistants.OpenAIPageableListOfThreadRunObject" />. </summary>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.OpenAIPageableListOfThreadRunObject.Equals(System.Object)">
|
|
<summary>Indicates whether this instance and a specified object are equal.</summary><param name="obj">The object to compare with the current instance.</param><returns><see langword="true" /> if <paramref name="obj" /> and this instance are the same type and represent the same value; otherwise, <see langword="false" />.</returns>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.OpenAIPageableListOfThreadRunObject.Equals(Azure.AI.OpenAI.Assistants.OpenAIPageableListOfThreadRunObject)">
|
|
<summary>Indicates whether the current object is equal to another object of the same type.</summary><param name="other">An object to compare with this object.</param><returns><see langword="true" /> if the current object is equal to the <paramref name="other" /> parameter; otherwise, <see langword="false" />.</returns>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.OpenAIPageableListOfThreadRunObject.GetHashCode">
|
|
<summary>Returns the hash code for this instance.</summary><returns>A 32-bit signed integer that is the hash code for this instance.</returns>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.OpenAIPageableListOfThreadRunObject.ToString">
|
|
<summary>Returns the fully qualified type name of this instance.</summary><returns>The fully qualified type name.</returns>
|
|
</member>
|
|
<member name="T:Azure.AI.OpenAI.Assistants.RequiredFunctionToolCall">
|
|
<summary> A representation of a requested call to a function tool, needed by the model to continue evaluation of a run. </summary>
|
|
</member>
|
|
<member name="P:Azure.AI.OpenAI.Assistants.RequiredFunctionToolCall.Name">
|
|
<summary> The name of the function. </summary>
|
|
</member>
|
|
<member name="P:Azure.AI.OpenAI.Assistants.RequiredFunctionToolCall.Arguments">
|
|
<summary> The arguments to use when invoking the named function, as provided by the model. Arguments are presented as a JSON document that should be validated and parsed for evaluation. </summary>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.RequiredFunctionToolCall.#ctor(System.String,Azure.AI.OpenAI.Assistants.InternalRequiredFunctionToolCallDetails)">
|
|
<summary> Initializes a new instance of <see cref="T:Azure.AI.OpenAI.Assistants.RequiredFunctionToolCall" />. </summary>
|
|
<param name="id"> The ID of the tool call. This ID must be referenced when submitting tool outputs. </param>
|
|
<param name="internalDetails"> Detailed information about the function to be executed by the tool that includes name and arguments. </param>
|
|
<exception cref="T:System.ArgumentNullException"> <paramref name="id" /> or <paramref name="internalDetails" /> is null. </exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.RequiredFunctionToolCall.#ctor(System.String,System.String,System.Collections.Generic.IDictionary{System.String,System.BinaryData},Azure.AI.OpenAI.Assistants.InternalRequiredFunctionToolCallDetails)">
|
|
<summary> Initializes a new instance of <see cref="T:Azure.AI.OpenAI.Assistants.RequiredFunctionToolCall" />. </summary>
|
|
<param name="type"> The object type for the required tool call. </param>
|
|
<param name="id"> The ID of the tool call. This ID must be referenced when submitting tool outputs. </param>
|
|
<param name="serializedAdditionalRawData"> Keeps track of any properties unknown to the library. </param>
|
|
<param name="internalDetails"> Detailed information about the function to be executed by the tool that includes name and arguments. </param>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.RequiredFunctionToolCall.#ctor">
|
|
<summary> Initializes a new instance of <see cref="T:Azure.AI.OpenAI.Assistants.RequiredFunctionToolCall" /> for deserialization. </summary>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.RequiredFunctionToolCall.FromResponse(Azure.Response)">
|
|
<summary> Deserializes the model from a raw response. </summary>
|
|
<param name="response"> The response to deserialize the model from. </param>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.RequiredFunctionToolCall.ToRequestContent">
|
|
<summary> Convert into a <see cref="T:Azure.Core.RequestContent" />. </summary>
|
|
</member>
|
|
<member name="T:Azure.AI.OpenAI.Assistants.RunStep">
|
|
<summary> Detailed information about a single step of an assistant thread run. </summary>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.RunStep.#ctor(System.String,Azure.AI.OpenAI.Assistants.RunStepType,System.String,System.String,System.String,Azure.AI.OpenAI.Assistants.RunStepStatus,Azure.AI.OpenAI.Assistants.RunStepDetails,Azure.AI.OpenAI.Assistants.RunStepError,System.DateTimeOffset,System.Nullable{System.DateTimeOffset},System.Nullable{System.DateTimeOffset},System.Nullable{System.DateTimeOffset},System.Nullable{System.DateTimeOffset},System.Collections.Generic.IReadOnlyDictionary{System.String,System.String})">
|
|
<summary> Initializes a new instance of <see cref="T:Azure.AI.OpenAI.Assistants.RunStep" />. </summary>
|
|
<param name="id"> The identifier, which can be referenced in API endpoints. </param>
|
|
<param name="type"> The type of run step, which can be either message_creation or tool_calls. </param>
|
|
<param name="assistantId"> The ID of the assistant associated with the run step. </param>
|
|
<param name="threadId"> The ID of the thread that was run. </param>
|
|
<param name="runId"> The ID of the run that this run step is a part of. </param>
|
|
<param name="status"> The status of this run step. </param>
|
|
<param name="stepDetails">
|
|
The details for this run step.
|
|
Please note <see cref="T:Azure.AI.OpenAI.Assistants.RunStepDetails" /> is the base class. According to the scenario, a derived class of the base class might need to be assigned here, or this property needs to be casted to one of the possible derived classes.
|
|
The available derived classes include <see cref="T:Azure.AI.OpenAI.Assistants.RunStepMessageCreationDetails" /> and <see cref="T:Azure.AI.OpenAI.Assistants.RunStepToolCallDetails" />.
|
|
</param>
|
|
<param name="lastError"> If applicable, information about the last error encountered by this run step. </param>
|
|
<param name="createdAt"> The Unix timestamp, in seconds, representing when this object was created. </param>
|
|
<param name="expiredAt"> The Unix timestamp, in seconds, representing when this item expired. </param>
|
|
<param name="completedAt"> The Unix timestamp, in seconds, representing when this completed. </param>
|
|
<param name="cancelledAt"> The Unix timestamp, in seconds, representing when this was cancelled. </param>
|
|
<param name="failedAt"> The Unix timestamp, in seconds, representing when this failed. </param>
|
|
<param name="metadata"> 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. </param>
|
|
<exception cref="T:System.ArgumentNullException"> <paramref name="id" />, <paramref name="assistantId" />, <paramref name="threadId" />, <paramref name="runId" /> or <paramref name="stepDetails" /> is null. </exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.RunStep.#ctor(System.String,System.String,Azure.AI.OpenAI.Assistants.RunStepType,System.String,System.String,System.String,Azure.AI.OpenAI.Assistants.RunStepStatus,Azure.AI.OpenAI.Assistants.RunStepDetails,Azure.AI.OpenAI.Assistants.RunStepError,System.DateTimeOffset,System.Nullable{System.DateTimeOffset},System.Nullable{System.DateTimeOffset},System.Nullable{System.DateTimeOffset},System.Nullable{System.DateTimeOffset},System.Collections.Generic.IReadOnlyDictionary{System.String,System.String},System.Collections.Generic.IDictionary{System.String,System.BinaryData})">
|
|
<summary> Initializes a new instance of <see cref="T:Azure.AI.OpenAI.Assistants.RunStep" />. </summary>
|
|
<param name="id"> The identifier, which can be referenced in API endpoints. </param>
|
|
<param name="object"> The object type, which is always 'thread.run.step'. </param>
|
|
<param name="type"> The type of run step, which can be either message_creation or tool_calls. </param>
|
|
<param name="assistantId"> The ID of the assistant associated with the run step. </param>
|
|
<param name="threadId"> The ID of the thread that was run. </param>
|
|
<param name="runId"> The ID of the run that this run step is a part of. </param>
|
|
<param name="status"> The status of this run step. </param>
|
|
<param name="stepDetails">
|
|
The details for this run step.
|
|
Please note <see cref="T:Azure.AI.OpenAI.Assistants.RunStepDetails" /> is the base class. According to the scenario, a derived class of the base class might need to be assigned here, or this property needs to be casted to one of the possible derived classes.
|
|
The available derived classes include <see cref="T:Azure.AI.OpenAI.Assistants.RunStepMessageCreationDetails" /> and <see cref="T:Azure.AI.OpenAI.Assistants.RunStepToolCallDetails" />.
|
|
</param>
|
|
<param name="lastError"> If applicable, information about the last error encountered by this run step. </param>
|
|
<param name="createdAt"> The Unix timestamp, in seconds, representing when this object was created. </param>
|
|
<param name="expiredAt"> The Unix timestamp, in seconds, representing when this item expired. </param>
|
|
<param name="completedAt"> The Unix timestamp, in seconds, representing when this completed. </param>
|
|
<param name="cancelledAt"> The Unix timestamp, in seconds, representing when this was cancelled. </param>
|
|
<param name="failedAt"> The Unix timestamp, in seconds, representing when this failed. </param>
|
|
<param name="metadata"> 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. </param>
|
|
<param name="serializedAdditionalRawData"> Keeps track of any properties unknown to the library. </param>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.RunStep.#ctor">
|
|
<summary> Initializes a new instance of <see cref="T:Azure.AI.OpenAI.Assistants.RunStep" /> for deserialization. </summary>
|
|
</member>
|
|
<member name="P:Azure.AI.OpenAI.Assistants.RunStep.Id">
|
|
<summary> The identifier, which can be referenced in API endpoints. </summary>
|
|
</member>
|
|
<member name="P:Azure.AI.OpenAI.Assistants.RunStep.Type">
|
|
<summary> The type of run step, which can be either message_creation or tool_calls. </summary>
|
|
</member>
|
|
<member name="P:Azure.AI.OpenAI.Assistants.RunStep.AssistantId">
|
|
<summary> The ID of the assistant associated with the run step. </summary>
|
|
</member>
|
|
<member name="P:Azure.AI.OpenAI.Assistants.RunStep.ThreadId">
|
|
<summary> The ID of the thread that was run. </summary>
|
|
</member>
|
|
<member name="P:Azure.AI.OpenAI.Assistants.RunStep.RunId">
|
|
<summary> The ID of the run that this run step is a part of. </summary>
|
|
</member>
|
|
<member name="P:Azure.AI.OpenAI.Assistants.RunStep.Status">
|
|
<summary> The status of this run step. </summary>
|
|
</member>
|
|
<member name="P:Azure.AI.OpenAI.Assistants.RunStep.StepDetails">
|
|
<summary>
|
|
The details for this run step.
|
|
Please note <see cref="T:Azure.AI.OpenAI.Assistants.RunStepDetails" /> is the base class. According to the scenario, a derived class of the base class might need to be assigned here, or this property needs to be casted to one of the possible derived classes.
|
|
The available derived classes include <see cref="T:Azure.AI.OpenAI.Assistants.RunStepMessageCreationDetails" /> and <see cref="T:Azure.AI.OpenAI.Assistants.RunStepToolCallDetails" />.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Azure.AI.OpenAI.Assistants.RunStep.LastError">
|
|
<summary> If applicable, information about the last error encountered by this run step. </summary>
|
|
</member>
|
|
<member name="P:Azure.AI.OpenAI.Assistants.RunStep.CreatedAt">
|
|
<summary> The Unix timestamp, in seconds, representing when this object was created. </summary>
|
|
</member>
|
|
<member name="P:Azure.AI.OpenAI.Assistants.RunStep.ExpiredAt">
|
|
<summary> The Unix timestamp, in seconds, representing when this item expired. </summary>
|
|
</member>
|
|
<member name="P:Azure.AI.OpenAI.Assistants.RunStep.CompletedAt">
|
|
<summary> The Unix timestamp, in seconds, representing when this completed. </summary>
|
|
</member>
|
|
<member name="P:Azure.AI.OpenAI.Assistants.RunStep.CancelledAt">
|
|
<summary> The Unix timestamp, in seconds, representing when this was cancelled. </summary>
|
|
</member>
|
|
<member name="P:Azure.AI.OpenAI.Assistants.RunStep.FailedAt">
|
|
<summary> The Unix timestamp, in seconds, representing when this failed. </summary>
|
|
</member>
|
|
<member name="P:Azure.AI.OpenAI.Assistants.RunStep.Metadata">
|
|
<summary> 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. </summary>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.RunStep.FromResponse(Azure.Response)">
|
|
<summary> Deserializes the model from a raw response. </summary>
|
|
<param name="response"> The response to deserialize the model from. </param>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.RunStep.ToRequestContent">
|
|
<summary> Convert into a <see cref="T:Azure.Core.RequestContent" />. </summary>
|
|
</member>
|
|
<member name="T:Azure.AI.OpenAI.Assistants.RunStepCodeInterpreterToolCall">
|
|
<summary>
|
|
A record of a call to a code interpreter tool, issued by the model in evaluation of a defined tool, that
|
|
represents inputs and outputs consumed and emitted by the code interpreter.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Azure.AI.OpenAI.Assistants.RunStepCodeInterpreterToolCall.Input">
|
|
<summary> The input provided by the model to the code interpreter tool. </summary>
|
|
</member>
|
|
<member name="P:Azure.AI.OpenAI.Assistants.RunStepCodeInterpreterToolCall.Outputs">
|
|
<summary>
|
|
The outputs produced by the code interpreter tool back to the model in response to the tool call.
|
|
Please note <see cref="T:Azure.AI.OpenAI.Assistants.RunStepCodeInterpreterToolCallOutput" /> is the base class. According to the scenario, a derived class of the base class might need to be assigned here, or this property needs to be casted to one of the possible derived classes.
|
|
The available derived classes include <see cref="T:Azure.AI.OpenAI.Assistants.RunStepCodeInterpreterImageOutput" /> and <see cref="T:Azure.AI.OpenAI.Assistants.RunStepCodeInterpreterLogOutput" />.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.RunStepCodeInterpreterToolCall.#ctor(System.String,Azure.AI.OpenAI.Assistants.InternalCodeInterpreterToolCallDetails)">
|
|
<summary> Initializes a new instance of <see cref="T:Azure.AI.OpenAI.Assistants.RunStepCodeInterpreterToolCall" />. </summary>
|
|
<param name="id"> The ID of the tool call. This ID must be referenced when you submit tool outputs. </param>
|
|
<param name="internalDetails"> The details of the tool call to the code interpreter tool. </param>
|
|
<exception cref="T:System.ArgumentNullException"> <paramref name="id" /> or <paramref name="internalDetails" /> is null. </exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.RunStepCodeInterpreterToolCall.#ctor(System.String,System.String,System.Collections.Generic.IDictionary{System.String,System.BinaryData},Azure.AI.OpenAI.Assistants.InternalCodeInterpreterToolCallDetails)">
|
|
<summary> Initializes a new instance of <see cref="T:Azure.AI.OpenAI.Assistants.RunStepCodeInterpreterToolCall" />. </summary>
|
|
<param name="type"> The object type. </param>
|
|
<param name="id"> The ID of the tool call. This ID must be referenced when you submit tool outputs. </param>
|
|
<param name="serializedAdditionalRawData"> Keeps track of any properties unknown to the library. </param>
|
|
<param name="internalDetails"> The details of the tool call to the code interpreter tool. </param>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.RunStepCodeInterpreterToolCall.#ctor">
|
|
<summary> Initializes a new instance of <see cref="T:Azure.AI.OpenAI.Assistants.RunStepCodeInterpreterToolCall" /> for deserialization. </summary>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.RunStepCodeInterpreterToolCall.FromResponse(Azure.Response)">
|
|
<summary> Deserializes the model from a raw response. </summary>
|
|
<param name="response"> The response to deserialize the model from. </param>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.RunStepCodeInterpreterToolCall.ToRequestContent">
|
|
<summary> Convert into a <see cref="T:Azure.Core.RequestContent" />. </summary>
|
|
</member>
|
|
<member name="T:Azure.AI.OpenAI.Assistants.RunStepFunctionToolCall">
|
|
<summary>
|
|
A record of a call to a function tool, issued by the model in evaluation of a defined tool, that represents the inputs
|
|
and output consumed and emitted by the specified function.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Azure.AI.OpenAI.Assistants.RunStepFunctionToolCall.Name">
|
|
<summary> The name of the function. </summary>
|
|
</member>
|
|
<member name="P:Azure.AI.OpenAI.Assistants.RunStepFunctionToolCall.Arguments">
|
|
<summary> The arguments that the model requires are provided to the named function. </summary>
|
|
</member>
|
|
<member name="P:Azure.AI.OpenAI.Assistants.RunStepFunctionToolCall.Output">
|
|
<summary> The output of the function, only populated for function calls that have already have had their outputs submitted. </summary>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.RunStepFunctionToolCall.#ctor(System.String,Azure.AI.OpenAI.Assistants.InternalRunStepFunctionToolCallDetails)">
|
|
<summary> Initializes a new instance of <see cref="T:Azure.AI.OpenAI.Assistants.RunStepFunctionToolCall" />. </summary>
|
|
<param name="id"> The ID of the tool call. This ID must be referenced when you submit tool outputs. </param>
|
|
<param name="internalDetails"> The detailed information about the function called by the model. </param>
|
|
<exception cref="T:System.ArgumentNullException"> <paramref name="id" /> or <paramref name="internalDetails" /> is null. </exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.RunStepFunctionToolCall.#ctor(System.String,System.String,System.Collections.Generic.IDictionary{System.String,System.BinaryData},Azure.AI.OpenAI.Assistants.InternalRunStepFunctionToolCallDetails)">
|
|
<summary> Initializes a new instance of <see cref="T:Azure.AI.OpenAI.Assistants.RunStepFunctionToolCall" />. </summary>
|
|
<param name="type"> The object type. </param>
|
|
<param name="id"> The ID of the tool call. This ID must be referenced when you submit tool outputs. </param>
|
|
<param name="serializedAdditionalRawData"> Keeps track of any properties unknown to the library. </param>
|
|
<param name="internalDetails"> The detailed information about the function called by the model. </param>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.RunStepFunctionToolCall.#ctor">
|
|
<summary> Initializes a new instance of <see cref="T:Azure.AI.OpenAI.Assistants.RunStepFunctionToolCall" /> for deserialization. </summary>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.RunStepFunctionToolCall.FromResponse(Azure.Response)">
|
|
<summary> Deserializes the model from a raw response. </summary>
|
|
<param name="response"> The response to deserialize the model from. </param>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.RunStepFunctionToolCall.ToRequestContent">
|
|
<summary> Convert into a <see cref="T:Azure.Core.RequestContent" />. </summary>
|
|
</member>
|
|
<member name="T:Azure.AI.OpenAI.Assistants.SubmitToolOutputsAction">
|
|
<summary> The details for required tool calls that must be submitted for an assistant thread run to continue. </summary>
|
|
</member>
|
|
<member name="P:Azure.AI.OpenAI.Assistants.SubmitToolOutputsAction.ToolCalls">
|
|
<summary>
|
|
The list of tool calls that must be resolved for the assistant thread run to continue.
|
|
Please note <see cref="T:Azure.AI.OpenAI.Assistants.RequiredToolCall" /> is the base class. According to the scenario, a derived class of the base class might need to be assigned here, or this property needs to be casted to one of the possible derived classes.
|
|
The available derived classes include <see cref="T:Azure.AI.OpenAI.Assistants.RequiredFunctionToolCall" />.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Azure.AI.OpenAI.Assistants.SubmitToolOutputsAction.InternalDetails">
|
|
<summary> The details describing tools that should be called to submit tool outputs. </summary>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.SubmitToolOutputsAction.#ctor(Azure.AI.OpenAI.Assistants.InternalSubmitToolOutputsDetails)">
|
|
<summary> Initializes a new instance of <see cref="T:Azure.AI.OpenAI.Assistants.SubmitToolOutputsAction" />. </summary>
|
|
<param name="internalDetails"> The details describing tools that should be called to submit tool outputs. </param>
|
|
<exception cref="T:System.ArgumentNullException"> <paramref name="internalDetails" /> is null. </exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.SubmitToolOutputsAction.#ctor(System.String,System.Collections.Generic.IDictionary{System.String,System.BinaryData},Azure.AI.OpenAI.Assistants.InternalSubmitToolOutputsDetails)">
|
|
<summary> Initializes a new instance of <see cref="T:Azure.AI.OpenAI.Assistants.SubmitToolOutputsAction" />. </summary>
|
|
<param name="type"> The object type. </param>
|
|
<param name="serializedAdditionalRawData"> Keeps track of any properties unknown to the library. </param>
|
|
<param name="internalDetails"> The details describing tools that should be called to submit tool outputs. </param>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.SubmitToolOutputsAction.#ctor">
|
|
<summary> Initializes a new instance of <see cref="T:Azure.AI.OpenAI.Assistants.SubmitToolOutputsAction" /> for deserialization. </summary>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.SubmitToolOutputsAction.FromResponse(Azure.Response)">
|
|
<summary> Deserializes the model from a raw response. </summary>
|
|
<param name="response"> The response to deserialize the model from. </param>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.SubmitToolOutputsAction.ToRequestContent">
|
|
<summary> Convert into a <see cref="T:Azure.Core.RequestContent" />. </summary>
|
|
</member>
|
|
<member name="T:Azure.AI.OpenAI.Assistants.ThreadRun">
|
|
<summary> Data representing a single evaluation run of an assistant thread. </summary>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.ThreadRun.#ctor(System.String,System.String,System.String,Azure.AI.OpenAI.Assistants.RunStatus,Azure.AI.OpenAI.Assistants.RunError,System.String,System.String,System.Collections.Generic.IEnumerable{Azure.AI.OpenAI.Assistants.ToolDefinition},System.Collections.Generic.IEnumerable{System.String},System.DateTimeOffset,System.Nullable{System.DateTimeOffset},System.Nullable{System.DateTimeOffset},System.Nullable{System.DateTimeOffset},System.Nullable{System.DateTimeOffset},System.Nullable{System.DateTimeOffset},System.Collections.Generic.IReadOnlyDictionary{System.String,System.String})">
|
|
<summary> Initializes a new instance of <see cref="T:Azure.AI.OpenAI.Assistants.ThreadRun" />. </summary>
|
|
<param name="id"> The identifier, which can be referenced in API endpoints. </param>
|
|
<param name="threadId"> The ID of the thread associated with this run. </param>
|
|
<param name="assistantId"> The ID of the assistant associated with the thread this run was performed against. </param>
|
|
<param name="status"> The status of the assistant thread run. </param>
|
|
<param name="lastError"> The last error, if any, encountered by this assistant thread run. </param>
|
|
<param name="model"> The ID of the model to use. </param>
|
|
<param name="instructions"> The overridden system instructions used for this assistant thread run. </param>
|
|
<param name="tools">
|
|
The overridden enabled tools used for this assistant thread run.
|
|
Please note <see cref="T:Azure.AI.OpenAI.Assistants.ToolDefinition" /> is the base class. According to the scenario, a derived class of the base class might need to be assigned here, or this property needs to be casted to one of the possible derived classes.
|
|
The available derived classes include <see cref="T:Azure.AI.OpenAI.Assistants.CodeInterpreterToolDefinition" />, <see cref="T:Azure.AI.OpenAI.Assistants.FunctionToolDefinition" /> and <see cref="T:Azure.AI.OpenAI.Assistants.RetrievalToolDefinition" />.
|
|
</param>
|
|
<param name="fileIds"> A list of attached file IDs, ordered by creation date in ascending order. </param>
|
|
<param name="createdAt"> The Unix timestamp, in seconds, representing when this object was created. </param>
|
|
<param name="expiresAt"> The Unix timestamp, in seconds, representing when this item expires. </param>
|
|
<param name="startedAt"> The Unix timestamp, in seconds, representing when this item was started. </param>
|
|
<param name="completedAt"> The Unix timestamp, in seconds, representing when this completed. </param>
|
|
<param name="cancelledAt"> The Unix timestamp, in seconds, representing when this was cancelled. </param>
|
|
<param name="failedAt"> The Unix timestamp, in seconds, representing when this failed. </param>
|
|
<param name="metadata"> 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. </param>
|
|
<exception cref="T:System.ArgumentNullException"> <paramref name="id" />, <paramref name="threadId" />, <paramref name="assistantId" />, <paramref name="model" />, <paramref name="instructions" />, <paramref name="tools" /> or <paramref name="fileIds" /> is null. </exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.ThreadRun.#ctor(System.String,System.String,System.String,System.String,Azure.AI.OpenAI.Assistants.RunStatus,Azure.AI.OpenAI.Assistants.RequiredAction,Azure.AI.OpenAI.Assistants.RunError,System.String,System.String,System.Collections.Generic.IReadOnlyList{Azure.AI.OpenAI.Assistants.ToolDefinition},System.Collections.Generic.IReadOnlyList{System.String},System.DateTimeOffset,System.Nullable{System.DateTimeOffset},System.Nullable{System.DateTimeOffset},System.Nullable{System.DateTimeOffset},System.Nullable{System.DateTimeOffset},System.Nullable{System.DateTimeOffset},System.Collections.Generic.IReadOnlyDictionary{System.String,System.String},System.Collections.Generic.IDictionary{System.String,System.BinaryData})">
|
|
<summary> Initializes a new instance of <see cref="T:Azure.AI.OpenAI.Assistants.ThreadRun" />. </summary>
|
|
<param name="id"> The identifier, which can be referenced in API endpoints. </param>
|
|
<param name="object"> The object type, which is always 'thread.run'. </param>
|
|
<param name="threadId"> The ID of the thread associated with this run. </param>
|
|
<param name="assistantId"> The ID of the assistant associated with the thread this run was performed against. </param>
|
|
<param name="status"> The status of the assistant thread run. </param>
|
|
<param name="requiredAction">
|
|
The details of the action required for the assistant thread run to continue.
|
|
Please note <see cref="T:Azure.AI.OpenAI.Assistants.RequiredAction" /> is the base class. According to the scenario, a derived class of the base class might need to be assigned here, or this property needs to be casted to one of the possible derived classes.
|
|
The available derived classes include <see cref="T:Azure.AI.OpenAI.Assistants.SubmitToolOutputsAction" />.
|
|
</param>
|
|
<param name="lastError"> The last error, if any, encountered by this assistant thread run. </param>
|
|
<param name="model"> The ID of the model to use. </param>
|
|
<param name="instructions"> The overridden system instructions used for this assistant thread run. </param>
|
|
<param name="tools">
|
|
The overridden enabled tools used for this assistant thread run.
|
|
Please note <see cref="T:Azure.AI.OpenAI.Assistants.ToolDefinition" /> is the base class. According to the scenario, a derived class of the base class might need to be assigned here, or this property needs to be casted to one of the possible derived classes.
|
|
The available derived classes include <see cref="T:Azure.AI.OpenAI.Assistants.CodeInterpreterToolDefinition" />, <see cref="T:Azure.AI.OpenAI.Assistants.FunctionToolDefinition" /> and <see cref="T:Azure.AI.OpenAI.Assistants.RetrievalToolDefinition" />.
|
|
</param>
|
|
<param name="fileIds"> A list of attached file IDs, ordered by creation date in ascending order. </param>
|
|
<param name="createdAt"> The Unix timestamp, in seconds, representing when this object was created. </param>
|
|
<param name="expiresAt"> The Unix timestamp, in seconds, representing when this item expires. </param>
|
|
<param name="startedAt"> The Unix timestamp, in seconds, representing when this item was started. </param>
|
|
<param name="completedAt"> The Unix timestamp, in seconds, representing when this completed. </param>
|
|
<param name="cancelledAt"> The Unix timestamp, in seconds, representing when this was cancelled. </param>
|
|
<param name="failedAt"> The Unix timestamp, in seconds, representing when this failed. </param>
|
|
<param name="metadata"> 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. </param>
|
|
<param name="serializedAdditionalRawData"> Keeps track of any properties unknown to the library. </param>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.ThreadRun.#ctor">
|
|
<summary> Initializes a new instance of <see cref="T:Azure.AI.OpenAI.Assistants.ThreadRun" /> for deserialization. </summary>
|
|
</member>
|
|
<member name="P:Azure.AI.OpenAI.Assistants.ThreadRun.Id">
|
|
<summary> The identifier, which can be referenced in API endpoints. </summary>
|
|
</member>
|
|
<member name="P:Azure.AI.OpenAI.Assistants.ThreadRun.ThreadId">
|
|
<summary> The ID of the thread associated with this run. </summary>
|
|
</member>
|
|
<member name="P:Azure.AI.OpenAI.Assistants.ThreadRun.AssistantId">
|
|
<summary> The ID of the assistant associated with the thread this run was performed against. </summary>
|
|
</member>
|
|
<member name="P:Azure.AI.OpenAI.Assistants.ThreadRun.Status">
|
|
<summary> The status of the assistant thread run. </summary>
|
|
</member>
|
|
<member name="P:Azure.AI.OpenAI.Assistants.ThreadRun.RequiredAction">
|
|
<summary>
|
|
The details of the action required for the assistant thread run to continue.
|
|
Please note <see cref="T:Azure.AI.OpenAI.Assistants.RequiredAction" /> is the base class. According to the scenario, a derived class of the base class might need to be assigned here, or this property needs to be casted to one of the possible derived classes.
|
|
The available derived classes include <see cref="T:Azure.AI.OpenAI.Assistants.SubmitToolOutputsAction" />.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Azure.AI.OpenAI.Assistants.ThreadRun.LastError">
|
|
<summary> The last error, if any, encountered by this assistant thread run. </summary>
|
|
</member>
|
|
<member name="P:Azure.AI.OpenAI.Assistants.ThreadRun.Model">
|
|
<summary> The ID of the model to use. </summary>
|
|
</member>
|
|
<member name="P:Azure.AI.OpenAI.Assistants.ThreadRun.Instructions">
|
|
<summary> The overridden system instructions used for this assistant thread run. </summary>
|
|
</member>
|
|
<member name="P:Azure.AI.OpenAI.Assistants.ThreadRun.Tools">
|
|
<summary>
|
|
The overridden enabled tools used for this assistant thread run.
|
|
Please note <see cref="T:Azure.AI.OpenAI.Assistants.ToolDefinition" /> is the base class. According to the scenario, a derived class of the base class might need to be assigned here, or this property needs to be casted to one of the possible derived classes.
|
|
The available derived classes include <see cref="T:Azure.AI.OpenAI.Assistants.CodeInterpreterToolDefinition" />, <see cref="T:Azure.AI.OpenAI.Assistants.FunctionToolDefinition" /> and <see cref="T:Azure.AI.OpenAI.Assistants.RetrievalToolDefinition" />.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Azure.AI.OpenAI.Assistants.ThreadRun.FileIds">
|
|
<summary> A list of attached file IDs, ordered by creation date in ascending order. </summary>
|
|
</member>
|
|
<member name="P:Azure.AI.OpenAI.Assistants.ThreadRun.CreatedAt">
|
|
<summary> The Unix timestamp, in seconds, representing when this object was created. </summary>
|
|
</member>
|
|
<member name="P:Azure.AI.OpenAI.Assistants.ThreadRun.ExpiresAt">
|
|
<summary> The Unix timestamp, in seconds, representing when this item expires. </summary>
|
|
</member>
|
|
<member name="P:Azure.AI.OpenAI.Assistants.ThreadRun.StartedAt">
|
|
<summary> The Unix timestamp, in seconds, representing when this item was started. </summary>
|
|
</member>
|
|
<member name="P:Azure.AI.OpenAI.Assistants.ThreadRun.CompletedAt">
|
|
<summary> The Unix timestamp, in seconds, representing when this completed. </summary>
|
|
</member>
|
|
<member name="P:Azure.AI.OpenAI.Assistants.ThreadRun.CancelledAt">
|
|
<summary> The Unix timestamp, in seconds, representing when this was cancelled. </summary>
|
|
</member>
|
|
<member name="P:Azure.AI.OpenAI.Assistants.ThreadRun.FailedAt">
|
|
<summary> The Unix timestamp, in seconds, representing when this failed. </summary>
|
|
</member>
|
|
<member name="P:Azure.AI.OpenAI.Assistants.ThreadRun.Metadata">
|
|
<summary> 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. </summary>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.ThreadRun.FromResponse(Azure.Response)">
|
|
<summary> Deserializes the model from a raw response. </summary>
|
|
<param name="response"> The response to deserialize the model from. </param>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.ThreadRun.ToRequestContent">
|
|
<summary> Convert into a <see cref="T:Azure.Core.RequestContent" />. </summary>
|
|
</member>
|
|
<member name="T:Azure.AI.OpenAI.Assistants.ToolOutput">
|
|
<summary> The data provided during a tool outputs submission to resolve pending tool calls and allow the model to continue. </summary>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.ToolOutput.#ctor(System.String)">
|
|
<summary> Initializes a new instance of <see cref="T:Azure.AI.OpenAI.Assistants.ToolOutput" />. </summary>
|
|
<param name="toolCallId"> The ID of the tool call being resolved, as provided in the tool calls of a required action from a run. </param>
|
|
<remarks>
|
|
When using this constructor, the <see cref="P:Azure.AI.OpenAI.Assistants.ToolOutput.Output" /> property should be set prior to submission.
|
|
</remarks>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.ToolOutput.#ctor(System.String,System.String)">
|
|
<summary> Initializes a new instance of <see cref="T:Azure.AI.OpenAI.Assistants.ToolOutput" />. </summary>
|
|
<param name="toolCallId"> The ID of the tool call being resolved, as provided in the tool calls of a required action from a run. </param>
|
|
<param name="output"> The output from the tool to be submitted. </param>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.ToolOutput.#ctor(Azure.AI.OpenAI.Assistants.RequiredToolCall)">
|
|
<summary> Initializes a new instance of <see cref="T:Azure.AI.OpenAI.Assistants.ToolOutput" />. </summary>
|
|
<param name="toolCall"> The tool call the output will resolve, as provided in a required action from a run. </param>
|
|
<remarks>
|
|
When using this constructor, the <see cref="P:Azure.AI.OpenAI.Assistants.ToolOutput.Output" /> property should be set prior to submission.
|
|
</remarks>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.ToolOutput.#ctor(Azure.AI.OpenAI.Assistants.RequiredToolCall,System.String)">
|
|
<summary> Initializes a new instance of <see cref="T:Azure.AI.OpenAI.Assistants.ToolOutput" />. </summary>
|
|
<param name="toolCall"> The tool call the output will resolve, as provided in a required action from a run. </param>
|
|
<param name="output"> The output from the tool to be submitted. </param>
|
|
<remarks>
|
|
When using this constructor, the <see cref="P:Azure.AI.OpenAI.Assistants.ToolOutput.Output" /> property should be set prior to submission.
|
|
</remarks>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.ToolOutput.#ctor">
|
|
<summary> Initializes a new instance of <see cref="T:Azure.AI.OpenAI.Assistants.ToolOutput" />. </summary>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.ToolOutput.#ctor(System.String,System.String,System.Collections.Generic.IDictionary{System.String,System.BinaryData})">
|
|
<summary> Initializes a new instance of <see cref="T:Azure.AI.OpenAI.Assistants.ToolOutput" />. </summary>
|
|
<param name="toolCallId"> The ID of the tool call being resolved, as provided in the tool calls of a required action from a run. </param>
|
|
<param name="output"> The output from the tool to be submitted. </param>
|
|
<param name="serializedAdditionalRawData"> Keeps track of any properties unknown to the library. </param>
|
|
</member>
|
|
<member name="P:Azure.AI.OpenAI.Assistants.ToolOutput.ToolCallId">
|
|
<summary> The ID of the tool call being resolved, as provided in the tool calls of a required action from a run. </summary>
|
|
</member>
|
|
<member name="P:Azure.AI.OpenAI.Assistants.ToolOutput.Output">
|
|
<summary> The output from the tool to be submitted. </summary>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.ToolOutput.FromResponse(Azure.Response)">
|
|
<summary> Deserializes the model from a raw response. </summary>
|
|
<param name="response"> The response to deserialize the model from. </param>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.ToolOutput.ToRequestContent">
|
|
<summary> Convert into a <see cref="T:Azure.Core.RequestContent" />. </summary>
|
|
</member>
|
|
<member name="T:Azure.AI.OpenAI.Assistants.UploadFileRequest">
|
|
<summary> The UploadFileRequest. </summary>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.UploadFileRequest.#ctor(System.IO.Stream,Azure.AI.OpenAI.Assistants.OpenAIFilePurpose)">
|
|
<summary> Initializes a new instance of <see cref="T:Azure.AI.OpenAI.Assistants.UploadFileRequest" />. </summary>
|
|
<param name="data"> The file data (not filename) to upload. </param>
|
|
<param name="purpose"> The intended purpose of the file. </param>
|
|
<exception cref="T:System.ArgumentNullException"> <paramref name="data" /> is null. </exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.UploadFileRequest.#ctor(System.IO.Stream,Azure.AI.OpenAI.Assistants.OpenAIFilePurpose,System.String,System.Collections.Generic.IDictionary{System.String,System.BinaryData})">
|
|
<summary> Initializes a new instance of <see cref="T:Azure.AI.OpenAI.Assistants.UploadFileRequest" />. </summary>
|
|
<param name="data"> The file data (not filename) to upload. </param>
|
|
<param name="purpose"> The intended purpose of the file. </param>
|
|
<param name="filename"> A filename to associate with the uploaded data. </param>
|
|
<param name="serializedAdditionalRawData"> Keeps track of any properties unknown to the library. </param>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.UploadFileRequest.#ctor">
|
|
<summary> Initializes a new instance of <see cref="T:Azure.AI.OpenAI.Assistants.UploadFileRequest" /> for deserialization. </summary>
|
|
</member>
|
|
<member name="P:Azure.AI.OpenAI.Assistants.UploadFileRequest.Data">
|
|
<summary> The file data (not filename) to upload. </summary>
|
|
</member>
|
|
<member name="P:Azure.AI.OpenAI.Assistants.UploadFileRequest.Purpose">
|
|
<summary> The intended purpose of the file. </summary>
|
|
</member>
|
|
<member name="P:Azure.AI.OpenAI.Assistants.UploadFileRequest.Filename">
|
|
<summary> A filename to associate with the uploaded data. </summary>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.UploadFileRequest.FromResponse(Azure.Response)">
|
|
<summary> Deserializes the model from a raw response. </summary>
|
|
<param name="response"> The response to deserialize the model from. </param>
|
|
</member>
|
|
<member name="T:Azure.AI.OpenAI.Assistants.Assistant">
|
|
<summary> Represents an assistant that can call the model and use tools. </summary>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.Assistant.#ctor(System.String,System.DateTimeOffset,System.String,System.String,System.String,System.String,System.Collections.Generic.IEnumerable{Azure.AI.OpenAI.Assistants.ToolDefinition},System.Collections.Generic.IEnumerable{System.String},System.Collections.Generic.IReadOnlyDictionary{System.String,System.String})">
|
|
<summary> Initializes a new instance of <see cref="T:Azure.AI.OpenAI.Assistants.Assistant" />. </summary>
|
|
<param name="id"> The identifier, which can be referenced in API endpoints. </param>
|
|
<param name="createdAt"> The Unix timestamp, in seconds, representing when this object was created. </param>
|
|
<param name="name"> The name of the assistant. </param>
|
|
<param name="description"> The description of the assistant. </param>
|
|
<param name="model"> The ID of the model to use. </param>
|
|
<param name="instructions"> The system instructions for the assistant to use. </param>
|
|
<param name="tools">
|
|
The collection of tools enabled for the assistant.
|
|
Please note <see cref="T:Azure.AI.OpenAI.Assistants.ToolDefinition" /> is the base class. According to the scenario, a derived class of the base class might need to be assigned here, or this property needs to be casted to one of the possible derived classes.
|
|
The available derived classes include <see cref="T:Azure.AI.OpenAI.Assistants.CodeInterpreterToolDefinition" />, <see cref="T:Azure.AI.OpenAI.Assistants.FunctionToolDefinition" /> and <see cref="T:Azure.AI.OpenAI.Assistants.RetrievalToolDefinition" />.
|
|
</param>
|
|
<param name="fileIds"> A list of attached file IDs, ordered by creation date in ascending order. </param>
|
|
<param name="metadata"> 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. </param>
|
|
<exception cref="T:System.ArgumentNullException"> <paramref name="id" />, <paramref name="model" />, <paramref name="tools" /> or <paramref name="fileIds" /> is null. </exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.Assistant.#ctor(System.String,System.String,System.DateTimeOffset,System.String,System.String,System.String,System.String,System.Collections.Generic.IReadOnlyList{Azure.AI.OpenAI.Assistants.ToolDefinition},System.Collections.Generic.IReadOnlyList{System.String},System.Collections.Generic.IReadOnlyDictionary{System.String,System.String},System.Collections.Generic.IDictionary{System.String,System.BinaryData})">
|
|
<summary> Initializes a new instance of <see cref="T:Azure.AI.OpenAI.Assistants.Assistant" />. </summary>
|
|
<param name="id"> The identifier, which can be referenced in API endpoints. </param>
|
|
<param name="object"> The object type, which is always assistant. </param>
|
|
<param name="createdAt"> The Unix timestamp, in seconds, representing when this object was created. </param>
|
|
<param name="name"> The name of the assistant. </param>
|
|
<param name="description"> The description of the assistant. </param>
|
|
<param name="model"> The ID of the model to use. </param>
|
|
<param name="instructions"> The system instructions for the assistant to use. </param>
|
|
<param name="tools">
|
|
The collection of tools enabled for the assistant.
|
|
Please note <see cref="T:Azure.AI.OpenAI.Assistants.ToolDefinition" /> is the base class. According to the scenario, a derived class of the base class might need to be assigned here, or this property needs to be casted to one of the possible derived classes.
|
|
The available derived classes include <see cref="T:Azure.AI.OpenAI.Assistants.CodeInterpreterToolDefinition" />, <see cref="T:Azure.AI.OpenAI.Assistants.FunctionToolDefinition" /> and <see cref="T:Azure.AI.OpenAI.Assistants.RetrievalToolDefinition" />.
|
|
</param>
|
|
<param name="fileIds"> A list of attached file IDs, ordered by creation date in ascending order. </param>
|
|
<param name="metadata"> 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. </param>
|
|
<param name="serializedAdditionalRawData"> Keeps track of any properties unknown to the library. </param>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.Assistant.#ctor">
|
|
<summary> Initializes a new instance of <see cref="T:Azure.AI.OpenAI.Assistants.Assistant" /> for deserialization. </summary>
|
|
</member>
|
|
<member name="P:Azure.AI.OpenAI.Assistants.Assistant.Id">
|
|
<summary> The identifier, which can be referenced in API endpoints. </summary>
|
|
</member>
|
|
<member name="P:Azure.AI.OpenAI.Assistants.Assistant.CreatedAt">
|
|
<summary> The Unix timestamp, in seconds, representing when this object was created. </summary>
|
|
</member>
|
|
<member name="P:Azure.AI.OpenAI.Assistants.Assistant.Name">
|
|
<summary> The name of the assistant. </summary>
|
|
</member>
|
|
<member name="P:Azure.AI.OpenAI.Assistants.Assistant.Description">
|
|
<summary> The description of the assistant. </summary>
|
|
</member>
|
|
<member name="P:Azure.AI.OpenAI.Assistants.Assistant.Model">
|
|
<summary> The ID of the model to use. </summary>
|
|
</member>
|
|
<member name="P:Azure.AI.OpenAI.Assistants.Assistant.Instructions">
|
|
<summary> The system instructions for the assistant to use. </summary>
|
|
</member>
|
|
<member name="P:Azure.AI.OpenAI.Assistants.Assistant.Tools">
|
|
<summary>
|
|
The collection of tools enabled for the assistant.
|
|
Please note <see cref="T:Azure.AI.OpenAI.Assistants.ToolDefinition" /> is the base class. According to the scenario, a derived class of the base class might need to be assigned here, or this property needs to be casted to one of the possible derived classes.
|
|
The available derived classes include <see cref="T:Azure.AI.OpenAI.Assistants.CodeInterpreterToolDefinition" />, <see cref="T:Azure.AI.OpenAI.Assistants.FunctionToolDefinition" /> and <see cref="T:Azure.AI.OpenAI.Assistants.RetrievalToolDefinition" />.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Azure.AI.OpenAI.Assistants.Assistant.FileIds">
|
|
<summary> A list of attached file IDs, ordered by creation date in ascending order. </summary>
|
|
</member>
|
|
<member name="P:Azure.AI.OpenAI.Assistants.Assistant.Metadata">
|
|
<summary> 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. </summary>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.Assistant.FromResponse(Azure.Response)">
|
|
<summary> Deserializes the model from a raw response. </summary>
|
|
<param name="response"> The response to deserialize the model from. </param>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.Assistant.ToRequestContent">
|
|
<summary> Convert into a <see cref="T:Azure.Core.RequestContent" />. </summary>
|
|
</member>
|
|
<member name="T:Azure.AI.OpenAI.Assistants.AssistantFile">
|
|
<summary> Information about a file attached to an assistant, as used by tools that can read files. </summary>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.AssistantFile.#ctor(System.String,System.DateTimeOffset,System.String)">
|
|
<summary> Initializes a new instance of <see cref="T:Azure.AI.OpenAI.Assistants.AssistantFile" />. </summary>
|
|
<param name="id"> The identifier, which can be referenced in API endpoints. </param>
|
|
<param name="createdAt"> The Unix timestamp, in seconds, representing when this object was created. </param>
|
|
<param name="assistantId"> The assistant ID that the file is attached to. </param>
|
|
<exception cref="T:System.ArgumentNullException"> <paramref name="id" /> or <paramref name="assistantId" /> is null. </exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.AssistantFile.#ctor(System.String,System.String,System.DateTimeOffset,System.String,System.Collections.Generic.IDictionary{System.String,System.BinaryData})">
|
|
<summary> Initializes a new instance of <see cref="T:Azure.AI.OpenAI.Assistants.AssistantFile" />. </summary>
|
|
<param name="id"> The identifier, which can be referenced in API endpoints. </param>
|
|
<param name="object"> The object type, which is always 'assistant.file'. </param>
|
|
<param name="createdAt"> The Unix timestamp, in seconds, representing when this object was created. </param>
|
|
<param name="assistantId"> The assistant ID that the file is attached to. </param>
|
|
<param name="serializedAdditionalRawData"> Keeps track of any properties unknown to the library. </param>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.AssistantFile.#ctor">
|
|
<summary> Initializes a new instance of <see cref="T:Azure.AI.OpenAI.Assistants.AssistantFile" /> for deserialization. </summary>
|
|
</member>
|
|
<member name="P:Azure.AI.OpenAI.Assistants.AssistantFile.Id">
|
|
<summary> The identifier, which can be referenced in API endpoints. </summary>
|
|
</member>
|
|
<member name="P:Azure.AI.OpenAI.Assistants.AssistantFile.CreatedAt">
|
|
<summary> The Unix timestamp, in seconds, representing when this object was created. </summary>
|
|
</member>
|
|
<member name="P:Azure.AI.OpenAI.Assistants.AssistantFile.AssistantId">
|
|
<summary> The assistant ID that the file is attached to. </summary>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.AssistantFile.FromResponse(Azure.Response)">
|
|
<summary> Deserializes the model from a raw response. </summary>
|
|
<param name="response"> The response to deserialize the model from. </param>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.AssistantFile.ToRequestContent">
|
|
<summary> Convert into a <see cref="T:Azure.Core.RequestContent" />. </summary>
|
|
</member>
|
|
<member name="T:Azure.AI.OpenAI.Assistants.AssistantThread">
|
|
<summary> Information about a single thread associated with an assistant. </summary>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.AssistantThread.#ctor(System.String,System.DateTimeOffset,System.Collections.Generic.IReadOnlyDictionary{System.String,System.String})">
|
|
<summary> Initializes a new instance of <see cref="T:Azure.AI.OpenAI.Assistants.AssistantThread" />. </summary>
|
|
<param name="id"> The identifier, which can be referenced in API endpoints. </param>
|
|
<param name="createdAt"> The Unix timestamp, in seconds, representing when this object was created. </param>
|
|
<param name="metadata"> 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. </param>
|
|
<exception cref="T:System.ArgumentNullException"> <paramref name="id" /> is null. </exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.AssistantThread.#ctor(System.String,System.String,System.DateTimeOffset,System.Collections.Generic.IReadOnlyDictionary{System.String,System.String},System.Collections.Generic.IDictionary{System.String,System.BinaryData})">
|
|
<summary> Initializes a new instance of <see cref="T:Azure.AI.OpenAI.Assistants.AssistantThread" />. </summary>
|
|
<param name="id"> The identifier, which can be referenced in API endpoints. </param>
|
|
<param name="object"> The object type, which is always 'thread'. </param>
|
|
<param name="createdAt"> The Unix timestamp, in seconds, representing when this object was created. </param>
|
|
<param name="metadata"> 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. </param>
|
|
<param name="serializedAdditionalRawData"> Keeps track of any properties unknown to the library. </param>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.AssistantThread.#ctor">
|
|
<summary> Initializes a new instance of <see cref="T:Azure.AI.OpenAI.Assistants.AssistantThread" /> for deserialization. </summary>
|
|
</member>
|
|
<member name="P:Azure.AI.OpenAI.Assistants.AssistantThread.Id">
|
|
<summary> The identifier, which can be referenced in API endpoints. </summary>
|
|
</member>
|
|
<member name="P:Azure.AI.OpenAI.Assistants.AssistantThread.CreatedAt">
|
|
<summary> The Unix timestamp, in seconds, representing when this object was created. </summary>
|
|
</member>
|
|
<member name="P:Azure.AI.OpenAI.Assistants.AssistantThread.Metadata">
|
|
<summary> 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. </summary>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.AssistantThread.FromResponse(Azure.Response)">
|
|
<summary> Deserializes the model from a raw response. </summary>
|
|
<param name="response"> The response to deserialize the model from. </param>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.AssistantThread.ToRequestContent">
|
|
<summary> Convert into a <see cref="T:Azure.Core.RequestContent" />. </summary>
|
|
</member>
|
|
<member name="T:Azure.AI.OpenAI.Assistants.InternalAssistantDeletionStatusObject">
|
|
<summary> The InternalAssistantDeletionStatus_object. </summary>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.InternalAssistantDeletionStatusObject.#ctor(System.String)">
|
|
<summary> Initializes a new instance of <see cref="T:Azure.AI.OpenAI.Assistants.InternalAssistantDeletionStatusObject" />. </summary>
|
|
<exception cref="T:System.ArgumentNullException"> <paramref name="value" /> is null. </exception>
|
|
</member>
|
|
<member name="P:Azure.AI.OpenAI.Assistants.InternalAssistantDeletionStatusObject.AssistantDeleted">
|
|
<summary> assistant.deleted. </summary>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.InternalAssistantDeletionStatusObject.op_Equality(Azure.AI.OpenAI.Assistants.InternalAssistantDeletionStatusObject,Azure.AI.OpenAI.Assistants.InternalAssistantDeletionStatusObject)">
|
|
<summary> Determines if two <see cref="T:Azure.AI.OpenAI.Assistants.InternalAssistantDeletionStatusObject" /> values are the same. </summary>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.InternalAssistantDeletionStatusObject.op_Inequality(Azure.AI.OpenAI.Assistants.InternalAssistantDeletionStatusObject,Azure.AI.OpenAI.Assistants.InternalAssistantDeletionStatusObject)">
|
|
<summary> Determines if two <see cref="T:Azure.AI.OpenAI.Assistants.InternalAssistantDeletionStatusObject" /> values are not the same. </summary>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.InternalAssistantDeletionStatusObject.op_Implicit(System.String)~Azure.AI.OpenAI.Assistants.InternalAssistantDeletionStatusObject">
|
|
<summary> Converts a string to a <see cref="T:Azure.AI.OpenAI.Assistants.InternalAssistantDeletionStatusObject" />. </summary>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.InternalAssistantDeletionStatusObject.Equals(System.Object)">
|
|
<summary>Indicates whether this instance and a specified object are equal.</summary><param name="obj">The object to compare with the current instance.</param><returns><see langword="true" /> if <paramref name="obj" /> and this instance are the same type and represent the same value; otherwise, <see langword="false" />.</returns>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.InternalAssistantDeletionStatusObject.Equals(Azure.AI.OpenAI.Assistants.InternalAssistantDeletionStatusObject)">
|
|
<summary>Indicates whether the current object is equal to another object of the same type.</summary><param name="other">An object to compare with this object.</param><returns><see langword="true" /> if the current object is equal to the <paramref name="other" /> parameter; otherwise, <see langword="false" />.</returns>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.InternalAssistantDeletionStatusObject.GetHashCode">
|
|
<summary>Returns the hash code for this instance.</summary><returns>A 32-bit signed integer that is the hash code for this instance.</returns>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.InternalAssistantDeletionStatusObject.ToString">
|
|
<summary>Returns the fully qualified type name of this instance.</summary><returns>The fully qualified type name.</returns>
|
|
</member>
|
|
<member name="T:Azure.AI.OpenAI.Assistants.InternalAssistantFileDeletionStatusObject">
|
|
<summary> The InternalAssistantFileDeletionStatus_object. </summary>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.InternalAssistantFileDeletionStatusObject.#ctor(System.String)">
|
|
<summary> Initializes a new instance of <see cref="T:Azure.AI.OpenAI.Assistants.InternalAssistantFileDeletionStatusObject" />. </summary>
|
|
<exception cref="T:System.ArgumentNullException"> <paramref name="value" /> is null. </exception>
|
|
</member>
|
|
<member name="P:Azure.AI.OpenAI.Assistants.InternalAssistantFileDeletionStatusObject.AssistantFileDeleted">
|
|
<summary> assistant.file.deleted. </summary>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.InternalAssistantFileDeletionStatusObject.op_Equality(Azure.AI.OpenAI.Assistants.InternalAssistantFileDeletionStatusObject,Azure.AI.OpenAI.Assistants.InternalAssistantFileDeletionStatusObject)">
|
|
<summary> Determines if two <see cref="T:Azure.AI.OpenAI.Assistants.InternalAssistantFileDeletionStatusObject" /> values are the same. </summary>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.InternalAssistantFileDeletionStatusObject.op_Inequality(Azure.AI.OpenAI.Assistants.InternalAssistantFileDeletionStatusObject,Azure.AI.OpenAI.Assistants.InternalAssistantFileDeletionStatusObject)">
|
|
<summary> Determines if two <see cref="T:Azure.AI.OpenAI.Assistants.InternalAssistantFileDeletionStatusObject" /> values are not the same. </summary>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.InternalAssistantFileDeletionStatusObject.op_Implicit(System.String)~Azure.AI.OpenAI.Assistants.InternalAssistantFileDeletionStatusObject">
|
|
<summary> Converts a string to a <see cref="T:Azure.AI.OpenAI.Assistants.InternalAssistantFileDeletionStatusObject" />. </summary>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.InternalAssistantFileDeletionStatusObject.Equals(System.Object)">
|
|
<summary>Indicates whether this instance and a specified object are equal.</summary><param name="obj">The object to compare with the current instance.</param><returns><see langword="true" /> if <paramref name="obj" /> and this instance are the same type and represent the same value; otherwise, <see langword="false" />.</returns>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.InternalAssistantFileDeletionStatusObject.Equals(Azure.AI.OpenAI.Assistants.InternalAssistantFileDeletionStatusObject)">
|
|
<summary>Indicates whether the current object is equal to another object of the same type.</summary><param name="other">An object to compare with this object.</param><returns><see langword="true" /> if the current object is equal to the <paramref name="other" /> parameter; otherwise, <see langword="false" />.</returns>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.InternalAssistantFileDeletionStatusObject.GetHashCode">
|
|
<summary>Returns the hash code for this instance.</summary><returns>A 32-bit signed integer that is the hash code for this instance.</returns>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.InternalAssistantFileDeletionStatusObject.ToString">
|
|
<summary>Returns the fully qualified type name of this instance.</summary><returns>The fully qualified type name.</returns>
|
|
</member>
|
|
<member name="T:Azure.AI.OpenAI.Assistants.InternalFileDeletionStatusObject">
|
|
<summary> The InternalFileDeletionStatus_object. </summary>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.InternalFileDeletionStatusObject.#ctor(System.String)">
|
|
<summary> Initializes a new instance of <see cref="T:Azure.AI.OpenAI.Assistants.InternalFileDeletionStatusObject" />. </summary>
|
|
<exception cref="T:System.ArgumentNullException"> <paramref name="value" /> is null. </exception>
|
|
</member>
|
|
<member name="P:Azure.AI.OpenAI.Assistants.InternalFileDeletionStatusObject.File">
|
|
<summary> file. </summary>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.InternalFileDeletionStatusObject.op_Equality(Azure.AI.OpenAI.Assistants.InternalFileDeletionStatusObject,Azure.AI.OpenAI.Assistants.InternalFileDeletionStatusObject)">
|
|
<summary> Determines if two <see cref="T:Azure.AI.OpenAI.Assistants.InternalFileDeletionStatusObject" /> values are the same. </summary>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.InternalFileDeletionStatusObject.op_Inequality(Azure.AI.OpenAI.Assistants.InternalFileDeletionStatusObject,Azure.AI.OpenAI.Assistants.InternalFileDeletionStatusObject)">
|
|
<summary> Determines if two <see cref="T:Azure.AI.OpenAI.Assistants.InternalFileDeletionStatusObject" /> values are not the same. </summary>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.InternalFileDeletionStatusObject.op_Implicit(System.String)~Azure.AI.OpenAI.Assistants.InternalFileDeletionStatusObject">
|
|
<summary> Converts a string to a <see cref="T:Azure.AI.OpenAI.Assistants.InternalFileDeletionStatusObject" />. </summary>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.InternalFileDeletionStatusObject.Equals(System.Object)">
|
|
<summary>Indicates whether this instance and a specified object are equal.</summary><param name="obj">The object to compare with the current instance.</param><returns><see langword="true" /> if <paramref name="obj" /> and this instance are the same type and represent the same value; otherwise, <see langword="false" />.</returns>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.InternalFileDeletionStatusObject.Equals(Azure.AI.OpenAI.Assistants.InternalFileDeletionStatusObject)">
|
|
<summary>Indicates whether the current object is equal to another object of the same type.</summary><param name="other">An object to compare with this object.</param><returns><see langword="true" /> if the current object is equal to the <paramref name="other" /> parameter; otherwise, <see langword="false" />.</returns>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.InternalFileDeletionStatusObject.GetHashCode">
|
|
<summary>Returns the hash code for this instance.</summary><returns>A 32-bit signed integer that is the hash code for this instance.</returns>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.InternalFileDeletionStatusObject.ToString">
|
|
<summary>Returns the fully qualified type name of this instance.</summary><returns>The fully qualified type name.</returns>
|
|
</member>
|
|
<member name="T:Azure.AI.OpenAI.Assistants.InternalFileListResponseObject">
|
|
<summary> The InternalFileListResponse_object. </summary>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.InternalFileListResponseObject.#ctor(System.String)">
|
|
<summary> Initializes a new instance of <see cref="T:Azure.AI.OpenAI.Assistants.InternalFileListResponseObject" />. </summary>
|
|
<exception cref="T:System.ArgumentNullException"> <paramref name="value" /> is null. </exception>
|
|
</member>
|
|
<member name="P:Azure.AI.OpenAI.Assistants.InternalFileListResponseObject.List">
|
|
<summary> list. </summary>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.InternalFileListResponseObject.op_Equality(Azure.AI.OpenAI.Assistants.InternalFileListResponseObject,Azure.AI.OpenAI.Assistants.InternalFileListResponseObject)">
|
|
<summary> Determines if two <see cref="T:Azure.AI.OpenAI.Assistants.InternalFileListResponseObject" /> values are the same. </summary>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.InternalFileListResponseObject.op_Inequality(Azure.AI.OpenAI.Assistants.InternalFileListResponseObject,Azure.AI.OpenAI.Assistants.InternalFileListResponseObject)">
|
|
<summary> Determines if two <see cref="T:Azure.AI.OpenAI.Assistants.InternalFileListResponseObject" /> values are not the same. </summary>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.InternalFileListResponseObject.op_Implicit(System.String)~Azure.AI.OpenAI.Assistants.InternalFileListResponseObject">
|
|
<summary> Converts a string to a <see cref="T:Azure.AI.OpenAI.Assistants.InternalFileListResponseObject" />. </summary>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.InternalFileListResponseObject.Equals(System.Object)">
|
|
<summary>Indicates whether this instance and a specified object are equal.</summary><param name="obj">The object to compare with the current instance.</param><returns><see langword="true" /> if <paramref name="obj" /> and this instance are the same type and represent the same value; otherwise, <see langword="false" />.</returns>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.InternalFileListResponseObject.Equals(Azure.AI.OpenAI.Assistants.InternalFileListResponseObject)">
|
|
<summary>Indicates whether the current object is equal to another object of the same type.</summary><param name="other">An object to compare with this object.</param><returns><see langword="true" /> if the current object is equal to the <paramref name="other" /> parameter; otherwise, <see langword="false" />.</returns>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.InternalFileListResponseObject.GetHashCode">
|
|
<summary>Returns the hash code for this instance.</summary><returns>A 32-bit signed integer that is the hash code for this instance.</returns>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.InternalFileListResponseObject.ToString">
|
|
<summary>Returns the fully qualified type name of this instance.</summary><returns>The fully qualified type name.</returns>
|
|
</member>
|
|
<member name="T:Azure.AI.OpenAI.Assistants.MessageFile">
|
|
<summary> Information about a file attached to an assistant thread message. </summary>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.MessageFile.#ctor(System.String,System.DateTimeOffset,System.String)">
|
|
<summary> Initializes a new instance of <see cref="T:Azure.AI.OpenAI.Assistants.MessageFile" />. </summary>
|
|
<param name="id"> The identifier, which can be referenced in API endpoints. </param>
|
|
<param name="createdAt"> The Unix timestamp, in seconds, representing when this object was created. </param>
|
|
<param name="messageId"> The ID of the message that this file is attached to. </param>
|
|
<exception cref="T:System.ArgumentNullException"> <paramref name="id" /> or <paramref name="messageId" /> is null. </exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.MessageFile.#ctor(System.String,System.String,System.DateTimeOffset,System.String,System.Collections.Generic.IDictionary{System.String,System.BinaryData})">
|
|
<summary> Initializes a new instance of <see cref="T:Azure.AI.OpenAI.Assistants.MessageFile" />. </summary>
|
|
<param name="id"> The identifier, which can be referenced in API endpoints. </param>
|
|
<param name="object"> The object type, which is always 'thread.message.file'. </param>
|
|
<param name="createdAt"> The Unix timestamp, in seconds, representing when this object was created. </param>
|
|
<param name="messageId"> The ID of the message that this file is attached to. </param>
|
|
<param name="serializedAdditionalRawData"> Keeps track of any properties unknown to the library. </param>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.MessageFile.#ctor">
|
|
<summary> Initializes a new instance of <see cref="T:Azure.AI.OpenAI.Assistants.MessageFile" /> for deserialization. </summary>
|
|
</member>
|
|
<member name="P:Azure.AI.OpenAI.Assistants.MessageFile.Id">
|
|
<summary> The identifier, which can be referenced in API endpoints. </summary>
|
|
</member>
|
|
<member name="P:Azure.AI.OpenAI.Assistants.MessageFile.CreatedAt">
|
|
<summary> The Unix timestamp, in seconds, representing when this object was created. </summary>
|
|
</member>
|
|
<member name="P:Azure.AI.OpenAI.Assistants.MessageFile.MessageId">
|
|
<summary> The ID of the message that this file is attached to. </summary>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.MessageFile.FromResponse(Azure.Response)">
|
|
<summary> Deserializes the model from a raw response. </summary>
|
|
<param name="response"> The response to deserialize the model from. </param>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.MessageFile.ToRequestContent">
|
|
<summary> Convert into a <see cref="T:Azure.Core.RequestContent" />. </summary>
|
|
</member>
|
|
<member name="T:Azure.AI.OpenAI.Assistants.ThreadMessage">
|
|
<summary> A single, existing message within an assistant thread. </summary>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.ThreadMessage.#ctor(System.String,System.DateTimeOffset,System.String,Azure.AI.OpenAI.Assistants.MessageRole,System.Collections.Generic.IEnumerable{Azure.AI.OpenAI.Assistants.MessageContent},System.Collections.Generic.IEnumerable{System.String},System.Collections.Generic.IReadOnlyDictionary{System.String,System.String})">
|
|
<summary> Initializes a new instance of <see cref="T:Azure.AI.OpenAI.Assistants.ThreadMessage" />. </summary>
|
|
<param name="id"> The identifier, which can be referenced in API endpoints. </param>
|
|
<param name="createdAt"> The Unix timestamp, in seconds, representing when this object was created. </param>
|
|
<param name="threadId"> The ID of the thread that this message belongs to. </param>
|
|
<param name="role"> The role associated with the assistant thread message. </param>
|
|
<param name="contentItems">
|
|
The list of content items associated with the assistant thread message.
|
|
Please note <see cref="T:Azure.AI.OpenAI.Assistants.MessageContent" /> is the base class. According to the scenario, a derived class of the base class might need to be assigned here, or this property needs to be casted to one of the possible derived classes.
|
|
The available derived classes include <see cref="T:Azure.AI.OpenAI.Assistants.MessageImageFileContent" /> and <see cref="T:Azure.AI.OpenAI.Assistants.MessageTextContent" />.
|
|
</param>
|
|
<param name="fileIds">
|
|
A list of file IDs that the assistant should use. Useful for tools like retrieval and code_interpreter that can
|
|
access files.
|
|
</param>
|
|
<param name="metadata"> 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. </param>
|
|
<exception cref="T:System.ArgumentNullException"> <paramref name="id" />, <paramref name="threadId" />, <paramref name="contentItems" /> or <paramref name="fileIds" /> is null. </exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.ThreadMessage.#ctor(System.String,System.String,System.DateTimeOffset,System.String,Azure.AI.OpenAI.Assistants.MessageRole,System.Collections.Generic.IReadOnlyList{Azure.AI.OpenAI.Assistants.MessageContent},System.String,System.String,System.Collections.Generic.IReadOnlyList{System.String},System.Collections.Generic.IReadOnlyDictionary{System.String,System.String},System.Collections.Generic.IDictionary{System.String,System.BinaryData})">
|
|
<summary> Initializes a new instance of <see cref="T:Azure.AI.OpenAI.Assistants.ThreadMessage" />. </summary>
|
|
<param name="id"> The identifier, which can be referenced in API endpoints. </param>
|
|
<param name="object"> The object type, which is always 'thread.message'. </param>
|
|
<param name="createdAt"> The Unix timestamp, in seconds, representing when this object was created. </param>
|
|
<param name="threadId"> The ID of the thread that this message belongs to. </param>
|
|
<param name="role"> The role associated with the assistant thread message. </param>
|
|
<param name="contentItems">
|
|
The list of content items associated with the assistant thread message.
|
|
Please note <see cref="T:Azure.AI.OpenAI.Assistants.MessageContent" /> is the base class. According to the scenario, a derived class of the base class might need to be assigned here, or this property needs to be casted to one of the possible derived classes.
|
|
The available derived classes include <see cref="T:Azure.AI.OpenAI.Assistants.MessageImageFileContent" /> and <see cref="T:Azure.AI.OpenAI.Assistants.MessageTextContent" />.
|
|
</param>
|
|
<param name="assistantId"> If applicable, the ID of the assistant that authored this message. </param>
|
|
<param name="runId"> If applicable, the ID of the run associated with the authoring of this message. </param>
|
|
<param name="fileIds">
|
|
A list of file IDs that the assistant should use. Useful for tools like retrieval and code_interpreter that can
|
|
access files.
|
|
</param>
|
|
<param name="metadata"> 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. </param>
|
|
<param name="serializedAdditionalRawData"> Keeps track of any properties unknown to the library. </param>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.ThreadMessage.#ctor">
|
|
<summary> Initializes a new instance of <see cref="T:Azure.AI.OpenAI.Assistants.ThreadMessage" /> for deserialization. </summary>
|
|
</member>
|
|
<member name="P:Azure.AI.OpenAI.Assistants.ThreadMessage.Id">
|
|
<summary> The identifier, which can be referenced in API endpoints. </summary>
|
|
</member>
|
|
<member name="P:Azure.AI.OpenAI.Assistants.ThreadMessage.CreatedAt">
|
|
<summary> The Unix timestamp, in seconds, representing when this object was created. </summary>
|
|
</member>
|
|
<member name="P:Azure.AI.OpenAI.Assistants.ThreadMessage.ThreadId">
|
|
<summary> The ID of the thread that this message belongs to. </summary>
|
|
</member>
|
|
<member name="P:Azure.AI.OpenAI.Assistants.ThreadMessage.Role">
|
|
<summary> The role associated with the assistant thread message. </summary>
|
|
</member>
|
|
<member name="P:Azure.AI.OpenAI.Assistants.ThreadMessage.ContentItems">
|
|
<summary>
|
|
The list of content items associated with the assistant thread message.
|
|
Please note <see cref="T:Azure.AI.OpenAI.Assistants.MessageContent" /> is the base class. According to the scenario, a derived class of the base class might need to be assigned here, or this property needs to be casted to one of the possible derived classes.
|
|
The available derived classes include <see cref="T:Azure.AI.OpenAI.Assistants.MessageImageFileContent" /> and <see cref="T:Azure.AI.OpenAI.Assistants.MessageTextContent" />.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Azure.AI.OpenAI.Assistants.ThreadMessage.AssistantId">
|
|
<summary> If applicable, the ID of the assistant that authored this message. </summary>
|
|
</member>
|
|
<member name="P:Azure.AI.OpenAI.Assistants.ThreadMessage.RunId">
|
|
<summary> If applicable, the ID of the run associated with the authoring of this message. </summary>
|
|
</member>
|
|
<member name="P:Azure.AI.OpenAI.Assistants.ThreadMessage.FileIds">
|
|
<summary>
|
|
A list of file IDs that the assistant should use. Useful for tools like retrieval and code_interpreter that can
|
|
access files.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Azure.AI.OpenAI.Assistants.ThreadMessage.Metadata">
|
|
<summary> 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. </summary>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.ThreadMessage.FromResponse(Azure.Response)">
|
|
<summary> Deserializes the model from a raw response. </summary>
|
|
<param name="response"> The response to deserialize the model from. </param>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.ThreadMessage.ToRequestContent">
|
|
<summary> Convert into a <see cref="T:Azure.Core.RequestContent" />. </summary>
|
|
</member>
|
|
<member name="T:Azure.AI.OpenAI.Assistants.AssistantCreationOptions">
|
|
<summary> The request details to use when creating a new assistant. </summary>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.AssistantCreationOptions.#ctor(System.String)">
|
|
<summary> Initializes a new instance of <see cref="T:Azure.AI.OpenAI.Assistants.AssistantCreationOptions" />. </summary>
|
|
<param name="model"> The ID of the model to use. </param>
|
|
<exception cref="T:System.ArgumentNullException"> <paramref name="model" /> is null. </exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.AssistantCreationOptions.#ctor(System.String,System.String,System.String,System.String,System.Collections.Generic.IList{Azure.AI.OpenAI.Assistants.ToolDefinition},System.Collections.Generic.IList{System.String},System.Collections.Generic.IDictionary{System.String,System.String},System.Collections.Generic.IDictionary{System.String,System.BinaryData})">
|
|
<summary> Initializes a new instance of <see cref="T:Azure.AI.OpenAI.Assistants.AssistantCreationOptions" />. </summary>
|
|
<param name="model"> The ID of the model to use. </param>
|
|
<param name="name"> The name of the new assistant. </param>
|
|
<param name="description"> The description of the new assistant. </param>
|
|
<param name="instructions"> The system instructions for the new assistant to use. </param>
|
|
<param name="tools">
|
|
The collection of tools to enable for the new assistant.
|
|
Please note <see cref="T:Azure.AI.OpenAI.Assistants.ToolDefinition" /> is the base class. According to the scenario, a derived class of the base class might need to be assigned here, or this property needs to be casted to one of the possible derived classes.
|
|
The available derived classes include <see cref="T:Azure.AI.OpenAI.Assistants.CodeInterpreterToolDefinition" />, <see cref="T:Azure.AI.OpenAI.Assistants.FunctionToolDefinition" /> and <see cref="T:Azure.AI.OpenAI.Assistants.RetrievalToolDefinition" />.
|
|
</param>
|
|
<param name="fileIds"> A list of previously uploaded file IDs to attach to the assistant. </param>
|
|
<param name="metadata"> 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. </param>
|
|
<param name="serializedAdditionalRawData"> Keeps track of any properties unknown to the library. </param>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.AssistantCreationOptions.#ctor">
|
|
<summary> Initializes a new instance of <see cref="T:Azure.AI.OpenAI.Assistants.AssistantCreationOptions" /> for deserialization. </summary>
|
|
</member>
|
|
<member name="P:Azure.AI.OpenAI.Assistants.AssistantCreationOptions.Model">
|
|
<summary> The ID of the model to use. </summary>
|
|
</member>
|
|
<member name="P:Azure.AI.OpenAI.Assistants.AssistantCreationOptions.Name">
|
|
<summary> The name of the new assistant. </summary>
|
|
</member>
|
|
<member name="P:Azure.AI.OpenAI.Assistants.AssistantCreationOptions.Description">
|
|
<summary> The description of the new assistant. </summary>
|
|
</member>
|
|
<member name="P:Azure.AI.OpenAI.Assistants.AssistantCreationOptions.Instructions">
|
|
<summary> The system instructions for the new assistant to use. </summary>
|
|
</member>
|
|
<member name="P:Azure.AI.OpenAI.Assistants.AssistantCreationOptions.Tools">
|
|
<summary>
|
|
The collection of tools to enable for the new assistant.
|
|
Please note <see cref="T:Azure.AI.OpenAI.Assistants.ToolDefinition" /> is the base class. According to the scenario, a derived class of the base class might need to be assigned here, or this property needs to be casted to one of the possible derived classes.
|
|
The available derived classes include <see cref="T:Azure.AI.OpenAI.Assistants.CodeInterpreterToolDefinition" />, <see cref="T:Azure.AI.OpenAI.Assistants.FunctionToolDefinition" /> and <see cref="T:Azure.AI.OpenAI.Assistants.RetrievalToolDefinition" />.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Azure.AI.OpenAI.Assistants.AssistantCreationOptions.FileIds">
|
|
<summary> A list of previously uploaded file IDs to attach to the assistant. </summary>
|
|
</member>
|
|
<member name="P:Azure.AI.OpenAI.Assistants.AssistantCreationOptions.Metadata">
|
|
<summary> 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. </summary>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.AssistantCreationOptions.FromResponse(Azure.Response)">
|
|
<summary> Deserializes the model from a raw response. </summary>
|
|
<param name="response"> The response to deserialize the model from. </param>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.AssistantCreationOptions.ToRequestContent">
|
|
<summary> Convert into a <see cref="T:Azure.Core.RequestContent" />. </summary>
|
|
</member>
|
|
<member name="T:Azure.AI.OpenAI.Assistants.AssistantsClientOptions">
|
|
<summary> Client options for AssistantsClient. </summary>
|
|
</member>
|
|
<member name="T:Azure.AI.OpenAI.Assistants.AssistantsClientOptions.ServiceVersion">
|
|
<summary> The version of the service to use. </summary>
|
|
</member>
|
|
<member name="F:Azure.AI.OpenAI.Assistants.AssistantsClientOptions.ServiceVersion.V2024_02_15_Preview">
|
|
<summary> Service version "2024-02-15-preview". </summary>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.AssistantsClientOptions.#ctor(Azure.AI.OpenAI.Assistants.AssistantsClientOptions.ServiceVersion)">
|
|
<summary> Initializes new instance of AssistantsClientOptions. </summary>
|
|
</member>
|
|
<member name="T:Azure.AI.OpenAI.Assistants.AssistantThreadCreationOptions">
|
|
<summary> The details used to create a new assistant thread. </summary>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.AssistantThreadCreationOptions.#ctor">
|
|
<summary> Initializes a new instance of <see cref="T:Azure.AI.OpenAI.Assistants.AssistantThreadCreationOptions" />. </summary>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.AssistantThreadCreationOptions.#ctor(System.Collections.Generic.IList{Azure.AI.OpenAI.Assistants.ThreadInitializationMessage},System.Collections.Generic.IDictionary{System.String,System.String},System.Collections.Generic.IDictionary{System.String,System.BinaryData})">
|
|
<summary> Initializes a new instance of <see cref="T:Azure.AI.OpenAI.Assistants.AssistantThreadCreationOptions" />. </summary>
|
|
<param name="messages"> The initial messages to associate with the new thread. </param>
|
|
<param name="metadata"> 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. </param>
|
|
<param name="serializedAdditionalRawData"> Keeps track of any properties unknown to the library. </param>
|
|
</member>
|
|
<member name="P:Azure.AI.OpenAI.Assistants.AssistantThreadCreationOptions.Messages">
|
|
<summary> The initial messages to associate with the new thread. </summary>
|
|
</member>
|
|
<member name="P:Azure.AI.OpenAI.Assistants.AssistantThreadCreationOptions.Metadata">
|
|
<summary> 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. </summary>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.AssistantThreadCreationOptions.FromResponse(Azure.Response)">
|
|
<summary> Deserializes the model from a raw response. </summary>
|
|
<param name="response"> The response to deserialize the model from. </param>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.AssistantThreadCreationOptions.ToRequestContent">
|
|
<summary> Convert into a <see cref="T:Azure.Core.RequestContent" />. </summary>
|
|
</member>
|
|
<member name="T:Azure.AI.OpenAI.Assistants.CodeInterpreterToolDefinition">
|
|
<summary> The input definition information for a code interpreter tool as used to configure an assistant. </summary>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.CodeInterpreterToolDefinition.#ctor">
|
|
<summary> Initializes a new instance of <see cref="T:Azure.AI.OpenAI.Assistants.CodeInterpreterToolDefinition" />. </summary>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.CodeInterpreterToolDefinition.#ctor(System.String,System.Collections.Generic.IDictionary{System.String,System.BinaryData})">
|
|
<summary> Initializes a new instance of <see cref="T:Azure.AI.OpenAI.Assistants.CodeInterpreterToolDefinition" />. </summary>
|
|
<param name="type"> The object type. </param>
|
|
<param name="serializedAdditionalRawData"> Keeps track of any properties unknown to the library. </param>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.CodeInterpreterToolDefinition.FromResponse(Azure.Response)">
|
|
<summary> Deserializes the model from a raw response. </summary>
|
|
<param name="response"> The response to deserialize the model from. </param>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.CodeInterpreterToolDefinition.ToRequestContent">
|
|
<summary> Convert into a <see cref="T:Azure.Core.RequestContent" />. </summary>
|
|
</member>
|
|
<member name="T:Azure.AI.OpenAI.Assistants.CreateAndRunThreadOptions">
|
|
<summary> The details used when creating and immediately running a new assistant thread. </summary>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.CreateAndRunThreadOptions.#ctor(System.String)">
|
|
<summary> Initializes a new instance of <see cref="T:Azure.AI.OpenAI.Assistants.CreateAndRunThreadOptions" />. </summary>
|
|
<param name="assistantId"> The ID of the assistant for which the thread should be created. </param>
|
|
<exception cref="T:System.ArgumentNullException"> <paramref name="assistantId" /> is null. </exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.CreateAndRunThreadOptions.#ctor(System.String,Azure.AI.OpenAI.Assistants.AssistantThreadCreationOptions,System.String,System.String,System.Collections.Generic.IList{Azure.AI.OpenAI.Assistants.ToolDefinition},System.Collections.Generic.IDictionary{System.String,System.String},System.Collections.Generic.IDictionary{System.String,System.BinaryData})">
|
|
<summary> Initializes a new instance of <see cref="T:Azure.AI.OpenAI.Assistants.CreateAndRunThreadOptions" />. </summary>
|
|
<param name="assistantId"> The ID of the assistant for which the thread should be created. </param>
|
|
<param name="thread"> The details used to create the new thread. </param>
|
|
<param name="overrideModelName"> The overridden model that the assistant should use to run the thread. </param>
|
|
<param name="overrideInstructions"> The overridden system instructions the assistant should use to run the thread. </param>
|
|
<param name="overrideTools">
|
|
The overridden list of enabled tools the assistant should use to run the thread.
|
|
Please note <see cref="T:Azure.AI.OpenAI.Assistants.ToolDefinition" /> is the base class. According to the scenario, a derived class of the base class might need to be assigned here, or this property needs to be casted to one of the possible derived classes.
|
|
The available derived classes include <see cref="T:Azure.AI.OpenAI.Assistants.CodeInterpreterToolDefinition" />, <see cref="T:Azure.AI.OpenAI.Assistants.FunctionToolDefinition" /> and <see cref="T:Azure.AI.OpenAI.Assistants.RetrievalToolDefinition" />.
|
|
</param>
|
|
<param name="metadata"> 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. </param>
|
|
<param name="serializedAdditionalRawData"> Keeps track of any properties unknown to the library. </param>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.CreateAndRunThreadOptions.#ctor">
|
|
<summary> Initializes a new instance of <see cref="T:Azure.AI.OpenAI.Assistants.CreateAndRunThreadOptions" /> for deserialization. </summary>
|
|
</member>
|
|
<member name="P:Azure.AI.OpenAI.Assistants.CreateAndRunThreadOptions.AssistantId">
|
|
<summary> The ID of the assistant for which the thread should be created. </summary>
|
|
</member>
|
|
<member name="P:Azure.AI.OpenAI.Assistants.CreateAndRunThreadOptions.Thread">
|
|
<summary> The details used to create the new thread. </summary>
|
|
</member>
|
|
<member name="P:Azure.AI.OpenAI.Assistants.CreateAndRunThreadOptions.OverrideModelName">
|
|
<summary> The overridden model that the assistant should use to run the thread. </summary>
|
|
</member>
|
|
<member name="P:Azure.AI.OpenAI.Assistants.CreateAndRunThreadOptions.OverrideInstructions">
|
|
<summary> The overridden system instructions the assistant should use to run the thread. </summary>
|
|
</member>
|
|
<member name="P:Azure.AI.OpenAI.Assistants.CreateAndRunThreadOptions.OverrideTools">
|
|
<summary>
|
|
The overridden list of enabled tools the assistant should use to run the thread.
|
|
Please note <see cref="T:Azure.AI.OpenAI.Assistants.ToolDefinition" /> is the base class. According to the scenario, a derived class of the base class might need to be assigned here, or this property needs to be casted to one of the possible derived classes.
|
|
The available derived classes include <see cref="T:Azure.AI.OpenAI.Assistants.CodeInterpreterToolDefinition" />, <see cref="T:Azure.AI.OpenAI.Assistants.FunctionToolDefinition" /> and <see cref="T:Azure.AI.OpenAI.Assistants.RetrievalToolDefinition" />.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Azure.AI.OpenAI.Assistants.CreateAndRunThreadOptions.Metadata">
|
|
<summary> 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. </summary>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.CreateAndRunThreadOptions.FromResponse(Azure.Response)">
|
|
<summary> Deserializes the model from a raw response. </summary>
|
|
<param name="response"> The response to deserialize the model from. </param>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.CreateAndRunThreadOptions.ToRequestContent">
|
|
<summary> Convert into a <see cref="T:Azure.Core.RequestContent" />. </summary>
|
|
</member>
|
|
<member name="T:Azure.AI.OpenAI.Assistants.CreateAssistantFileRequest">
|
|
<summary> The CreateAssistantFileRequest. </summary>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.CreateAssistantFileRequest.#ctor(System.String)">
|
|
<summary> Initializes a new instance of <see cref="T:Azure.AI.OpenAI.Assistants.CreateAssistantFileRequest" />. </summary>
|
|
<param name="fileId"> The ID of the previously uploaded file to attach. </param>
|
|
<exception cref="T:System.ArgumentNullException"> <paramref name="fileId" /> is null. </exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.CreateAssistantFileRequest.#ctor(System.String,System.Collections.Generic.IDictionary{System.String,System.BinaryData})">
|
|
<summary> Initializes a new instance of <see cref="T:Azure.AI.OpenAI.Assistants.CreateAssistantFileRequest" />. </summary>
|
|
<param name="fileId"> The ID of the previously uploaded file to attach. </param>
|
|
<param name="serializedAdditionalRawData"> Keeps track of any properties unknown to the library. </param>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.CreateAssistantFileRequest.#ctor">
|
|
<summary> Initializes a new instance of <see cref="T:Azure.AI.OpenAI.Assistants.CreateAssistantFileRequest" /> for deserialization. </summary>
|
|
</member>
|
|
<member name="P:Azure.AI.OpenAI.Assistants.CreateAssistantFileRequest.FileId">
|
|
<summary> The ID of the previously uploaded file to attach. </summary>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.CreateAssistantFileRequest.FromResponse(Azure.Response)">
|
|
<summary> Deserializes the model from a raw response. </summary>
|
|
<param name="response"> The response to deserialize the model from. </param>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.CreateAssistantFileRequest.ToRequestContent">
|
|
<summary> Convert into a <see cref="T:Azure.Core.RequestContent" />. </summary>
|
|
</member>
|
|
<member name="T:Azure.AI.OpenAI.Assistants.CreateMessageRequest">
|
|
<summary> The CreateMessageRequest. </summary>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.CreateMessageRequest.#ctor(Azure.AI.OpenAI.Assistants.MessageRole,System.String)">
|
|
<summary> Initializes a new instance of <see cref="T:Azure.AI.OpenAI.Assistants.CreateMessageRequest" />. </summary>
|
|
<param name="role"> The role to associate with the new message. </param>
|
|
<param name="content"> The textual content for the new message. </param>
|
|
<exception cref="T:System.ArgumentNullException"> <paramref name="content" /> is null. </exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.CreateMessageRequest.#ctor(Azure.AI.OpenAI.Assistants.MessageRole,System.String,System.Collections.Generic.IList{System.String},System.Collections.Generic.IDictionary{System.String,System.String},System.Collections.Generic.IDictionary{System.String,System.BinaryData})">
|
|
<summary> Initializes a new instance of <see cref="T:Azure.AI.OpenAI.Assistants.CreateMessageRequest" />. </summary>
|
|
<param name="role"> The role to associate with the new message. </param>
|
|
<param name="content"> The textual content for the new message. </param>
|
|
<param name="fileIds"> A list of up to 10 file IDs to associate with the message, as used by tools like 'code_interpreter' or 'retrieval' that can read files. </param>
|
|
<param name="metadata"> 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. </param>
|
|
<param name="serializedAdditionalRawData"> Keeps track of any properties unknown to the library. </param>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.CreateMessageRequest.#ctor">
|
|
<summary> Initializes a new instance of <see cref="T:Azure.AI.OpenAI.Assistants.CreateMessageRequest" /> for deserialization. </summary>
|
|
</member>
|
|
<member name="P:Azure.AI.OpenAI.Assistants.CreateMessageRequest.Role">
|
|
<summary> The role to associate with the new message. </summary>
|
|
</member>
|
|
<member name="P:Azure.AI.OpenAI.Assistants.CreateMessageRequest.Content">
|
|
<summary> The textual content for the new message. </summary>
|
|
</member>
|
|
<member name="P:Azure.AI.OpenAI.Assistants.CreateMessageRequest.FileIds">
|
|
<summary> A list of up to 10 file IDs to associate with the message, as used by tools like 'code_interpreter' or 'retrieval' that can read files. </summary>
|
|
</member>
|
|
<member name="P:Azure.AI.OpenAI.Assistants.CreateMessageRequest.Metadata">
|
|
<summary> 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. </summary>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.CreateMessageRequest.FromResponse(Azure.Response)">
|
|
<summary> Deserializes the model from a raw response. </summary>
|
|
<param name="response"> The response to deserialize the model from. </param>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.CreateMessageRequest.ToRequestContent">
|
|
<summary> Convert into a <see cref="T:Azure.Core.RequestContent" />. </summary>
|
|
</member>
|
|
<member name="T:Azure.AI.OpenAI.Assistants.CreateRunOptions">
|
|
<summary> The details used when creating a new run of an assistant thread. </summary>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.CreateRunOptions.#ctor(System.String)">
|
|
<summary> Initializes a new instance of <see cref="T:Azure.AI.OpenAI.Assistants.CreateRunOptions" />. </summary>
|
|
<param name="assistantId"> The ID of the assistant that should run the thread. </param>
|
|
<exception cref="T:System.ArgumentNullException"> <paramref name="assistantId" /> is null. </exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.CreateRunOptions.#ctor(System.String,System.String,System.String,System.String,System.Collections.Generic.IList{Azure.AI.OpenAI.Assistants.ToolDefinition},System.Collections.Generic.IDictionary{System.String,System.String},System.Collections.Generic.IDictionary{System.String,System.BinaryData})">
|
|
<summary> Initializes a new instance of <see cref="T:Azure.AI.OpenAI.Assistants.CreateRunOptions" />. </summary>
|
|
<param name="assistantId"> The ID of the assistant that should run the thread. </param>
|
|
<param name="overrideModelName"> The overridden model name that the assistant should use to run the thread. </param>
|
|
<param name="overrideInstructions"> The overridden system instructions that the assistant should use to run the thread. </param>
|
|
<param name="additionalInstructions">
|
|
Additional instructions to append at the end of the instructions for the run. This is useful for modifying the behavior
|
|
on a per-run basis without overriding other instructions.
|
|
</param>
|
|
<param name="overrideTools">
|
|
The overridden list of enabled tools that the assistant should use to run the thread.
|
|
Please note <see cref="T:Azure.AI.OpenAI.Assistants.ToolDefinition" /> is the base class. According to the scenario, a derived class of the base class might need to be assigned here, or this property needs to be casted to one of the possible derived classes.
|
|
The available derived classes include <see cref="T:Azure.AI.OpenAI.Assistants.CodeInterpreterToolDefinition" />, <see cref="T:Azure.AI.OpenAI.Assistants.FunctionToolDefinition" /> and <see cref="T:Azure.AI.OpenAI.Assistants.RetrievalToolDefinition" />.
|
|
</param>
|
|
<param name="metadata"> 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. </param>
|
|
<param name="serializedAdditionalRawData"> Keeps track of any properties unknown to the library. </param>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.CreateRunOptions.#ctor">
|
|
<summary> Initializes a new instance of <see cref="T:Azure.AI.OpenAI.Assistants.CreateRunOptions" /> for deserialization. </summary>
|
|
</member>
|
|
<member name="P:Azure.AI.OpenAI.Assistants.CreateRunOptions.AssistantId">
|
|
<summary> The ID of the assistant that should run the thread. </summary>
|
|
</member>
|
|
<member name="P:Azure.AI.OpenAI.Assistants.CreateRunOptions.OverrideModelName">
|
|
<summary> The overridden model name that the assistant should use to run the thread. </summary>
|
|
</member>
|
|
<member name="P:Azure.AI.OpenAI.Assistants.CreateRunOptions.OverrideInstructions">
|
|
<summary> The overridden system instructions that the assistant should use to run the thread. </summary>
|
|
</member>
|
|
<member name="P:Azure.AI.OpenAI.Assistants.CreateRunOptions.AdditionalInstructions">
|
|
<summary>
|
|
Additional instructions to append at the end of the instructions for the run. This is useful for modifying the behavior
|
|
on a per-run basis without overriding other instructions.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Azure.AI.OpenAI.Assistants.CreateRunOptions.OverrideTools">
|
|
<summary>
|
|
The overridden list of enabled tools that the assistant should use to run the thread.
|
|
Please note <see cref="T:Azure.AI.OpenAI.Assistants.ToolDefinition" /> is the base class. According to the scenario, a derived class of the base class might need to be assigned here, or this property needs to be casted to one of the possible derived classes.
|
|
The available derived classes include <see cref="T:Azure.AI.OpenAI.Assistants.CodeInterpreterToolDefinition" />, <see cref="T:Azure.AI.OpenAI.Assistants.FunctionToolDefinition" /> and <see cref="T:Azure.AI.OpenAI.Assistants.RetrievalToolDefinition" />.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Azure.AI.OpenAI.Assistants.CreateRunOptions.Metadata">
|
|
<summary> 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. </summary>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.CreateRunOptions.FromResponse(Azure.Response)">
|
|
<summary> Deserializes the model from a raw response. </summary>
|
|
<param name="response"> The response to deserialize the model from. </param>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.CreateRunOptions.ToRequestContent">
|
|
<summary> Convert into a <see cref="T:Azure.Core.RequestContent" />. </summary>
|
|
</member>
|
|
<member name="T:Azure.AI.OpenAI.Assistants.InternalAssistantDeletionStatus">
|
|
<summary> The status of an assistant deletion operation. </summary>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.InternalAssistantDeletionStatus.#ctor(System.String,System.Boolean)">
|
|
<summary> Initializes a new instance of <see cref="T:Azure.AI.OpenAI.Assistants.InternalAssistantDeletionStatus" />. </summary>
|
|
<param name="id"> The ID of the resource specified for deletion. </param>
|
|
<param name="deleted"> A value indicating whether deletion was successful. </param>
|
|
<exception cref="T:System.ArgumentNullException"> <paramref name="id" /> is null. </exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.InternalAssistantDeletionStatus.#ctor(System.String,System.Boolean,Azure.AI.OpenAI.Assistants.InternalAssistantDeletionStatusObject,System.Collections.Generic.IDictionary{System.String,System.BinaryData})">
|
|
<summary> Initializes a new instance of <see cref="T:Azure.AI.OpenAI.Assistants.InternalAssistantDeletionStatus" />. </summary>
|
|
<param name="id"> The ID of the resource specified for deletion. </param>
|
|
<param name="deleted"> A value indicating whether deletion was successful. </param>
|
|
<param name="object"> The object type, which is always 'assistant.deleted'. </param>
|
|
<param name="serializedAdditionalRawData"> Keeps track of any properties unknown to the library. </param>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.InternalAssistantDeletionStatus.#ctor">
|
|
<summary> Initializes a new instance of <see cref="T:Azure.AI.OpenAI.Assistants.InternalAssistantDeletionStatus" /> for deserialization. </summary>
|
|
</member>
|
|
<member name="P:Azure.AI.OpenAI.Assistants.InternalAssistantDeletionStatus.Id">
|
|
<summary> The ID of the resource specified for deletion. </summary>
|
|
</member>
|
|
<member name="P:Azure.AI.OpenAI.Assistants.InternalAssistantDeletionStatus.Deleted">
|
|
<summary> A value indicating whether deletion was successful. </summary>
|
|
</member>
|
|
<member name="P:Azure.AI.OpenAI.Assistants.InternalAssistantDeletionStatus.Object">
|
|
<summary> The object type, which is always 'assistant.deleted'. </summary>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.InternalAssistantDeletionStatus.FromResponse(Azure.Response)">
|
|
<summary> Deserializes the model from a raw response. </summary>
|
|
<param name="response"> The response to deserialize the model from. </param>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.InternalAssistantDeletionStatus.ToRequestContent">
|
|
<summary> Convert into a <see cref="T:Azure.Core.RequestContent" />. </summary>
|
|
</member>
|
|
<member name="T:Azure.AI.OpenAI.Assistants.InternalAssistantFileDeletionStatus">
|
|
<summary> The status of an assistant file deletion operation. </summary>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.InternalAssistantFileDeletionStatus.#ctor(System.String,System.Boolean)">
|
|
<summary> Initializes a new instance of <see cref="T:Azure.AI.OpenAI.Assistants.InternalAssistantFileDeletionStatus" />. </summary>
|
|
<param name="id"> The ID of the resource specified for deletion. </param>
|
|
<param name="deleted"> A value indicating whether deletion was successful. </param>
|
|
<exception cref="T:System.ArgumentNullException"> <paramref name="id" /> is null. </exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.InternalAssistantFileDeletionStatus.#ctor(System.String,System.Boolean,Azure.AI.OpenAI.Assistants.InternalAssistantFileDeletionStatusObject,System.Collections.Generic.IDictionary{System.String,System.BinaryData})">
|
|
<summary> Initializes a new instance of <see cref="T:Azure.AI.OpenAI.Assistants.InternalAssistantFileDeletionStatus" />. </summary>
|
|
<param name="id"> The ID of the resource specified for deletion. </param>
|
|
<param name="deleted"> A value indicating whether deletion was successful. </param>
|
|
<param name="object"> The object type, which is always 'assistant.file.deleted'. </param>
|
|
<param name="serializedAdditionalRawData"> Keeps track of any properties unknown to the library. </param>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.InternalAssistantFileDeletionStatus.#ctor">
|
|
<summary> Initializes a new instance of <see cref="T:Azure.AI.OpenAI.Assistants.InternalAssistantFileDeletionStatus" /> for deserialization. </summary>
|
|
</member>
|
|
<member name="P:Azure.AI.OpenAI.Assistants.InternalAssistantFileDeletionStatus.Id">
|
|
<summary> The ID of the resource specified for deletion. </summary>
|
|
</member>
|
|
<member name="P:Azure.AI.OpenAI.Assistants.InternalAssistantFileDeletionStatus.Deleted">
|
|
<summary> A value indicating whether deletion was successful. </summary>
|
|
</member>
|
|
<member name="P:Azure.AI.OpenAI.Assistants.InternalAssistantFileDeletionStatus.Object">
|
|
<summary> The object type, which is always 'assistant.file.deleted'. </summary>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.InternalAssistantFileDeletionStatus.FromResponse(Azure.Response)">
|
|
<summary> Deserializes the model from a raw response. </summary>
|
|
<param name="response"> The response to deserialize the model from. </param>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.InternalAssistantFileDeletionStatus.ToRequestContent">
|
|
<summary> Convert into a <see cref="T:Azure.Core.RequestContent" />. </summary>
|
|
</member>
|
|
<member name="T:Azure.AI.OpenAI.Assistants.InternalCodeInterpreterToolCallDetails">
|
|
<summary> The detailed information about a code interpreter invocation by the model. </summary>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.InternalCodeInterpreterToolCallDetails.#ctor(System.String,System.Collections.Generic.IEnumerable{Azure.AI.OpenAI.Assistants.RunStepCodeInterpreterToolCallOutput})">
|
|
<summary> Initializes a new instance of <see cref="T:Azure.AI.OpenAI.Assistants.InternalCodeInterpreterToolCallDetails" />. </summary>
|
|
<param name="input"> The input provided by the model to the code interpreter tool. </param>
|
|
<param name="outputs">
|
|
The outputs produced by the code interpreter tool back to the model in response to the tool call.
|
|
Please note <see cref="T:Azure.AI.OpenAI.Assistants.RunStepCodeInterpreterToolCallOutput" /> is the base class. According to the scenario, a derived class of the base class might need to be assigned here, or this property needs to be casted to one of the possible derived classes.
|
|
The available derived classes include <see cref="T:Azure.AI.OpenAI.Assistants.RunStepCodeInterpreterImageOutput" /> and <see cref="T:Azure.AI.OpenAI.Assistants.RunStepCodeInterpreterLogOutput" />.
|
|
</param>
|
|
<exception cref="T:System.ArgumentNullException"> <paramref name="input" /> or <paramref name="outputs" /> is null. </exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.InternalCodeInterpreterToolCallDetails.#ctor(System.String,System.Collections.Generic.IReadOnlyList{Azure.AI.OpenAI.Assistants.RunStepCodeInterpreterToolCallOutput},System.Collections.Generic.IDictionary{System.String,System.BinaryData})">
|
|
<summary> Initializes a new instance of <see cref="T:Azure.AI.OpenAI.Assistants.InternalCodeInterpreterToolCallDetails" />. </summary>
|
|
<param name="input"> The input provided by the model to the code interpreter tool. </param>
|
|
<param name="outputs">
|
|
The outputs produced by the code interpreter tool back to the model in response to the tool call.
|
|
Please note <see cref="T:Azure.AI.OpenAI.Assistants.RunStepCodeInterpreterToolCallOutput" /> is the base class. According to the scenario, a derived class of the base class might need to be assigned here, or this property needs to be casted to one of the possible derived classes.
|
|
The available derived classes include <see cref="T:Azure.AI.OpenAI.Assistants.RunStepCodeInterpreterImageOutput" /> and <see cref="T:Azure.AI.OpenAI.Assistants.RunStepCodeInterpreterLogOutput" />.
|
|
</param>
|
|
<param name="serializedAdditionalRawData"> Keeps track of any properties unknown to the library. </param>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.InternalCodeInterpreterToolCallDetails.#ctor">
|
|
<summary> Initializes a new instance of <see cref="T:Azure.AI.OpenAI.Assistants.InternalCodeInterpreterToolCallDetails" /> for deserialization. </summary>
|
|
</member>
|
|
<member name="P:Azure.AI.OpenAI.Assistants.InternalCodeInterpreterToolCallDetails.Input">
|
|
<summary> The input provided by the model to the code interpreter tool. </summary>
|
|
</member>
|
|
<member name="P:Azure.AI.OpenAI.Assistants.InternalCodeInterpreterToolCallDetails.Outputs">
|
|
<summary>
|
|
The outputs produced by the code interpreter tool back to the model in response to the tool call.
|
|
Please note <see cref="T:Azure.AI.OpenAI.Assistants.RunStepCodeInterpreterToolCallOutput" /> is the base class. According to the scenario, a derived class of the base class might need to be assigned here, or this property needs to be casted to one of the possible derived classes.
|
|
The available derived classes include <see cref="T:Azure.AI.OpenAI.Assistants.RunStepCodeInterpreterImageOutput" /> and <see cref="T:Azure.AI.OpenAI.Assistants.RunStepCodeInterpreterLogOutput" />.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.InternalCodeInterpreterToolCallDetails.FromResponse(Azure.Response)">
|
|
<summary> Deserializes the model from a raw response. </summary>
|
|
<param name="response"> The response to deserialize the model from. </param>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.InternalCodeInterpreterToolCallDetails.ToRequestContent">
|
|
<summary> Convert into a <see cref="T:Azure.Core.RequestContent" />. </summary>
|
|
</member>
|
|
<member name="T:Azure.AI.OpenAI.Assistants.InternalFileDeletionStatus">
|
|
<summary> A status response from a file deletion operation. </summary>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.InternalFileDeletionStatus.#ctor(System.String,System.Boolean)">
|
|
<summary> Initializes a new instance of <see cref="T:Azure.AI.OpenAI.Assistants.InternalFileDeletionStatus" />. </summary>
|
|
<param name="id"> The ID of the resource specified for deletion. </param>
|
|
<param name="deleted"> A value indicating whether deletion was successful. </param>
|
|
<exception cref="T:System.ArgumentNullException"> <paramref name="id" /> is null. </exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.InternalFileDeletionStatus.#ctor(System.String,System.Boolean,Azure.AI.OpenAI.Assistants.InternalFileDeletionStatusObject,System.Collections.Generic.IDictionary{System.String,System.BinaryData})">
|
|
<summary> Initializes a new instance of <see cref="T:Azure.AI.OpenAI.Assistants.InternalFileDeletionStatus" />. </summary>
|
|
<param name="id"> The ID of the resource specified for deletion. </param>
|
|
<param name="deleted"> A value indicating whether deletion was successful. </param>
|
|
<param name="object"> The object type, which is always 'file'. </param>
|
|
<param name="serializedAdditionalRawData"> Keeps track of any properties unknown to the library. </param>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.InternalFileDeletionStatus.#ctor">
|
|
<summary> Initializes a new instance of <see cref="T:Azure.AI.OpenAI.Assistants.InternalFileDeletionStatus" /> for deserialization. </summary>
|
|
</member>
|
|
<member name="P:Azure.AI.OpenAI.Assistants.InternalFileDeletionStatus.Id">
|
|
<summary> The ID of the resource specified for deletion. </summary>
|
|
</member>
|
|
<member name="P:Azure.AI.OpenAI.Assistants.InternalFileDeletionStatus.Deleted">
|
|
<summary> A value indicating whether deletion was successful. </summary>
|
|
</member>
|
|
<member name="P:Azure.AI.OpenAI.Assistants.InternalFileDeletionStatus.Object">
|
|
<summary> The object type, which is always 'file'. </summary>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.InternalFileDeletionStatus.FromResponse(Azure.Response)">
|
|
<summary> Deserializes the model from a raw response. </summary>
|
|
<param name="response"> The response to deserialize the model from. </param>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.InternalFileDeletionStatus.ToRequestContent">
|
|
<summary> Convert into a <see cref="T:Azure.Core.RequestContent" />. </summary>
|
|
</member>
|
|
<member name="T:Azure.AI.OpenAI.Assistants.InternalFileListResponse">
|
|
<summary> The response data from a file list operation. </summary>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.InternalFileListResponse.#ctor(System.Collections.Generic.IEnumerable{Azure.AI.OpenAI.Assistants.OpenAIFile})">
|
|
<summary> Initializes a new instance of <see cref="T:Azure.AI.OpenAI.Assistants.InternalFileListResponse" />. </summary>
|
|
<param name="data"> The files returned for the request. </param>
|
|
<exception cref="T:System.ArgumentNullException"> <paramref name="data" /> is null. </exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.InternalFileListResponse.#ctor(Azure.AI.OpenAI.Assistants.InternalFileListResponseObject,System.Collections.Generic.IReadOnlyList{Azure.AI.OpenAI.Assistants.OpenAIFile},System.Collections.Generic.IDictionary{System.String,System.BinaryData})">
|
|
<summary> Initializes a new instance of <see cref="T:Azure.AI.OpenAI.Assistants.InternalFileListResponse" />. </summary>
|
|
<param name="object"> The object type, which is always 'list'. </param>
|
|
<param name="data"> The files returned for the request. </param>
|
|
<param name="serializedAdditionalRawData"> Keeps track of any properties unknown to the library. </param>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.InternalFileListResponse.#ctor">
|
|
<summary> Initializes a new instance of <see cref="T:Azure.AI.OpenAI.Assistants.InternalFileListResponse" /> for deserialization. </summary>
|
|
</member>
|
|
<member name="P:Azure.AI.OpenAI.Assistants.InternalFileListResponse.Object">
|
|
<summary> The object type, which is always 'list'. </summary>
|
|
</member>
|
|
<member name="P:Azure.AI.OpenAI.Assistants.InternalFileListResponse.Data">
|
|
<summary> The files returned for the request. </summary>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.InternalFileListResponse.FromResponse(Azure.Response)">
|
|
<summary> Deserializes the model from a raw response. </summary>
|
|
<param name="response"> The response to deserialize the model from. </param>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.InternalFileListResponse.ToRequestContent">
|
|
<summary> Convert into a <see cref="T:Azure.Core.RequestContent" />. </summary>
|
|
</member>
|
|
<member name="T:Azure.AI.OpenAI.Assistants.InternalFunctionDefinition">
|
|
<summary> The input definition information for a function. </summary>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.InternalFunctionDefinition.#ctor(System.String,System.BinaryData)">
|
|
<summary> Initializes a new instance of <see cref="T:Azure.AI.OpenAI.Assistants.InternalFunctionDefinition" />. </summary>
|
|
<param name="name"> The name of the function to be called. </param>
|
|
<param name="parameters"> The parameters the functions accepts, described as a JSON Schema object. </param>
|
|
<exception cref="T:System.ArgumentNullException"> <paramref name="name" /> or <paramref name="parameters" /> is null. </exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.InternalFunctionDefinition.#ctor(System.String,System.String,System.BinaryData,System.Collections.Generic.IDictionary{System.String,System.BinaryData})">
|
|
<summary> Initializes a new instance of <see cref="T:Azure.AI.OpenAI.Assistants.InternalFunctionDefinition" />. </summary>
|
|
<param name="name"> The name of the function to be called. </param>
|
|
<param name="description"> A description of what the function does, used by the model to choose when and how to call the function. </param>
|
|
<param name="parameters"> The parameters the functions accepts, described as a JSON Schema object. </param>
|
|
<param name="serializedAdditionalRawData"> Keeps track of any properties unknown to the library. </param>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.InternalFunctionDefinition.#ctor">
|
|
<summary> Initializes a new instance of <see cref="T:Azure.AI.OpenAI.Assistants.InternalFunctionDefinition" /> for deserialization. </summary>
|
|
</member>
|
|
<member name="P:Azure.AI.OpenAI.Assistants.InternalFunctionDefinition.Name">
|
|
<summary> The name of the function to be called. </summary>
|
|
</member>
|
|
<member name="P:Azure.AI.OpenAI.Assistants.InternalFunctionDefinition.Description">
|
|
<summary> A description of what the function does, used by the model to choose when and how to call the function. </summary>
|
|
</member>
|
|
<member name="P:Azure.AI.OpenAI.Assistants.InternalFunctionDefinition.Parameters">
|
|
<summary>
|
|
The parameters the functions accepts, described as a JSON Schema object.
|
|
<para>
|
|
To assign an object to this property use <see cref="M:System.BinaryData.FromObjectAsJson``1(``0,System.Text.Json.JsonSerializerOptions)" />.
|
|
</para>
|
|
<para>
|
|
To assign an already formatted json string to this property use <see cref="M:System.BinaryData.FromString(System.String)" />.
|
|
</para>
|
|
<para>
|
|
Examples:
|
|
<list type="bullet">
|
|
<item>
|
|
<term>BinaryData.FromObjectAsJson("foo")</term>
|
|
<description>Creates a payload of "foo".</description>
|
|
</item>
|
|
<item>
|
|
<term>BinaryData.FromString("\"foo\"")</term>
|
|
<description>Creates a payload of "foo".</description>
|
|
</item>
|
|
<item>
|
|
<term>BinaryData.FromObjectAsJson(new { key = "value" })</term>
|
|
<description>Creates a payload of { "key": "value" }.</description>
|
|
</item>
|
|
<item>
|
|
<term>BinaryData.FromString("{\"key\": \"value\"}")</term>
|
|
<description>Creates a payload of { "key": "value" }.</description>
|
|
</item>
|
|
</list>
|
|
</para>
|
|
</summary>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.InternalFunctionDefinition.FromResponse(Azure.Response)">
|
|
<summary> Deserializes the model from a raw response. </summary>
|
|
<param name="response"> The response to deserialize the model from. </param>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.InternalFunctionDefinition.ToRequestContent">
|
|
<summary> Convert into a <see cref="T:Azure.Core.RequestContent" />. </summary>
|
|
</member>
|
|
<member name="T:Azure.AI.OpenAI.Assistants.InternalMessageImageFileDetails">
|
|
<summary> An image reference, as represented in thread message content. </summary>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.InternalMessageImageFileDetails.#ctor(System.String)">
|
|
<summary> Initializes a new instance of <see cref="T:Azure.AI.OpenAI.Assistants.InternalMessageImageFileDetails" />. </summary>
|
|
<param name="internalDetails"> The ID for the file associated with this image. </param>
|
|
<exception cref="T:System.ArgumentNullException"> <paramref name="internalDetails" /> is null. </exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.InternalMessageImageFileDetails.#ctor(System.String,System.Collections.Generic.IDictionary{System.String,System.BinaryData})">
|
|
<summary> Initializes a new instance of <see cref="T:Azure.AI.OpenAI.Assistants.InternalMessageImageFileDetails" />. </summary>
|
|
<param name="internalDetails"> The ID for the file associated with this image. </param>
|
|
<param name="serializedAdditionalRawData"> Keeps track of any properties unknown to the library. </param>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.InternalMessageImageFileDetails.#ctor">
|
|
<summary> Initializes a new instance of <see cref="T:Azure.AI.OpenAI.Assistants.InternalMessageImageFileDetails" /> for deserialization. </summary>
|
|
</member>
|
|
<member name="P:Azure.AI.OpenAI.Assistants.InternalMessageImageFileDetails.InternalDetails">
|
|
<summary> The ID for the file associated with this image. </summary>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.InternalMessageImageFileDetails.FromResponse(Azure.Response)">
|
|
<summary> Deserializes the model from a raw response. </summary>
|
|
<param name="response"> The response to deserialize the model from. </param>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.InternalMessageImageFileDetails.ToRequestContent">
|
|
<summary> Convert into a <see cref="T:Azure.Core.RequestContent" />. </summary>
|
|
</member>
|
|
<member name="T:Azure.AI.OpenAI.Assistants.InternalMessageTextDetails">
|
|
<summary> The text and associated annotations for a single item of assistant thread message content. </summary>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.InternalMessageTextDetails.#ctor(System.String,System.Collections.Generic.IEnumerable{Azure.AI.OpenAI.Assistants.MessageTextAnnotation})">
|
|
<summary> Initializes a new instance of <see cref="T:Azure.AI.OpenAI.Assistants.InternalMessageTextDetails" />. </summary>
|
|
<param name="text"> The text data. </param>
|
|
<param name="annotations">
|
|
A list of annotations associated with this text.
|
|
Please note <see cref="T:Azure.AI.OpenAI.Assistants.MessageTextAnnotation" /> is the base class. According to the scenario, a derived class of the base class might need to be assigned here, or this property needs to be casted to one of the possible derived classes.
|
|
The available derived classes include <see cref="T:Azure.AI.OpenAI.Assistants.MessageTextFileCitationAnnotation" /> and <see cref="T:Azure.AI.OpenAI.Assistants.MessageTextFilePathAnnotation" />.
|
|
</param>
|
|
<exception cref="T:System.ArgumentNullException"> <paramref name="text" /> or <paramref name="annotations" /> is null. </exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.InternalMessageTextDetails.#ctor(System.String,System.Collections.Generic.IReadOnlyList{Azure.AI.OpenAI.Assistants.MessageTextAnnotation},System.Collections.Generic.IDictionary{System.String,System.BinaryData})">
|
|
<summary> Initializes a new instance of <see cref="T:Azure.AI.OpenAI.Assistants.InternalMessageTextDetails" />. </summary>
|
|
<param name="text"> The text data. </param>
|
|
<param name="annotations">
|
|
A list of annotations associated with this text.
|
|
Please note <see cref="T:Azure.AI.OpenAI.Assistants.MessageTextAnnotation" /> is the base class. According to the scenario, a derived class of the base class might need to be assigned here, or this property needs to be casted to one of the possible derived classes.
|
|
The available derived classes include <see cref="T:Azure.AI.OpenAI.Assistants.MessageTextFileCitationAnnotation" /> and <see cref="T:Azure.AI.OpenAI.Assistants.MessageTextFilePathAnnotation" />.
|
|
</param>
|
|
<param name="serializedAdditionalRawData"> Keeps track of any properties unknown to the library. </param>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.InternalMessageTextDetails.#ctor">
|
|
<summary> Initializes a new instance of <see cref="T:Azure.AI.OpenAI.Assistants.InternalMessageTextDetails" /> for deserialization. </summary>
|
|
</member>
|
|
<member name="P:Azure.AI.OpenAI.Assistants.InternalMessageTextDetails.Text">
|
|
<summary> The text data. </summary>
|
|
</member>
|
|
<member name="P:Azure.AI.OpenAI.Assistants.InternalMessageTextDetails.Annotations">
|
|
<summary>
|
|
A list of annotations associated with this text.
|
|
Please note <see cref="T:Azure.AI.OpenAI.Assistants.MessageTextAnnotation" /> is the base class. According to the scenario, a derived class of the base class might need to be assigned here, or this property needs to be casted to one of the possible derived classes.
|
|
The available derived classes include <see cref="T:Azure.AI.OpenAI.Assistants.MessageTextFileCitationAnnotation" /> and <see cref="T:Azure.AI.OpenAI.Assistants.MessageTextFilePathAnnotation" />.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.InternalMessageTextDetails.FromResponse(Azure.Response)">
|
|
<summary> Deserializes the model from a raw response. </summary>
|
|
<param name="response"> The response to deserialize the model from. </param>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.InternalMessageTextDetails.ToRequestContent">
|
|
<summary> Convert into a <see cref="T:Azure.Core.RequestContent" />. </summary>
|
|
</member>
|
|
<member name="T:Azure.AI.OpenAI.Assistants.InternalMessageTextFileCitationDetails">
|
|
<summary> A representation of a file-based text citation, as used in a file-based annotation of text thread message content. </summary>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.InternalMessageTextFileCitationDetails.#ctor(System.String,System.String)">
|
|
<summary> Initializes a new instance of <see cref="T:Azure.AI.OpenAI.Assistants.InternalMessageTextFileCitationDetails" />. </summary>
|
|
<param name="fileId"> The ID of the file associated with this citation. </param>
|
|
<param name="quote"> The specific quote cited in the associated file. </param>
|
|
<exception cref="T:System.ArgumentNullException"> <paramref name="fileId" /> or <paramref name="quote" /> is null. </exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.InternalMessageTextFileCitationDetails.#ctor(System.String,System.String,System.Collections.Generic.IDictionary{System.String,System.BinaryData})">
|
|
<summary> Initializes a new instance of <see cref="T:Azure.AI.OpenAI.Assistants.InternalMessageTextFileCitationDetails" />. </summary>
|
|
<param name="fileId"> The ID of the file associated with this citation. </param>
|
|
<param name="quote"> The specific quote cited in the associated file. </param>
|
|
<param name="serializedAdditionalRawData"> Keeps track of any properties unknown to the library. </param>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.InternalMessageTextFileCitationDetails.#ctor">
|
|
<summary> Initializes a new instance of <see cref="T:Azure.AI.OpenAI.Assistants.InternalMessageTextFileCitationDetails" /> for deserialization. </summary>
|
|
</member>
|
|
<member name="P:Azure.AI.OpenAI.Assistants.InternalMessageTextFileCitationDetails.FileId">
|
|
<summary> The ID of the file associated with this citation. </summary>
|
|
</member>
|
|
<member name="P:Azure.AI.OpenAI.Assistants.InternalMessageTextFileCitationDetails.Quote">
|
|
<summary> The specific quote cited in the associated file. </summary>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.InternalMessageTextFileCitationDetails.FromResponse(Azure.Response)">
|
|
<summary> Deserializes the model from a raw response. </summary>
|
|
<param name="response"> The response to deserialize the model from. </param>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.InternalMessageTextFileCitationDetails.ToRequestContent">
|
|
<summary> Convert into a <see cref="T:Azure.Core.RequestContent" />. </summary>
|
|
</member>
|
|
<member name="T:Azure.AI.OpenAI.Assistants.InternalMessageTextFilePathDetails">
|
|
<summary> An encapsulation of an image file ID, as used by message image content. </summary>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.InternalMessageTextFilePathDetails.#ctor(System.String)">
|
|
<summary> Initializes a new instance of <see cref="T:Azure.AI.OpenAI.Assistants.InternalMessageTextFilePathDetails" />. </summary>
|
|
<param name="fileId"> The ID of the specific file that the citation is from. </param>
|
|
<exception cref="T:System.ArgumentNullException"> <paramref name="fileId" /> is null. </exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.InternalMessageTextFilePathDetails.#ctor(System.String,System.Collections.Generic.IDictionary{System.String,System.BinaryData})">
|
|
<summary> Initializes a new instance of <see cref="T:Azure.AI.OpenAI.Assistants.InternalMessageTextFilePathDetails" />. </summary>
|
|
<param name="fileId"> The ID of the specific file that the citation is from. </param>
|
|
<param name="serializedAdditionalRawData"> Keeps track of any properties unknown to the library. </param>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.InternalMessageTextFilePathDetails.#ctor">
|
|
<summary> Initializes a new instance of <see cref="T:Azure.AI.OpenAI.Assistants.InternalMessageTextFilePathDetails" /> for deserialization. </summary>
|
|
</member>
|
|
<member name="P:Azure.AI.OpenAI.Assistants.InternalMessageTextFilePathDetails.FileId">
|
|
<summary> The ID of the specific file that the citation is from. </summary>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.InternalMessageTextFilePathDetails.FromResponse(Azure.Response)">
|
|
<summary> Deserializes the model from a raw response. </summary>
|
|
<param name="response"> The response to deserialize the model from. </param>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.InternalMessageTextFilePathDetails.ToRequestContent">
|
|
<summary> Convert into a <see cref="T:Azure.Core.RequestContent" />. </summary>
|
|
</member>
|
|
<member name="T:Azure.AI.OpenAI.Assistants.InternalRequiredFunctionToolCallDetails">
|
|
<summary> The detailed information for a function invocation, as provided by a required action invoking a function tool, that includes the name of and arguments to the function. </summary>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.InternalRequiredFunctionToolCallDetails.#ctor(System.String,System.String)">
|
|
<summary> Initializes a new instance of <see cref="T:Azure.AI.OpenAI.Assistants.InternalRequiredFunctionToolCallDetails" />. </summary>
|
|
<param name="name"> The name of the function. </param>
|
|
<param name="arguments"> The arguments to use when invoking the named function, as provided by the model. Arguments are presented as a JSON document that should be validated and parsed for evaluation. </param>
|
|
<exception cref="T:System.ArgumentNullException"> <paramref name="name" /> or <paramref name="arguments" /> is null. </exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.InternalRequiredFunctionToolCallDetails.#ctor(System.String,System.String,System.Collections.Generic.IDictionary{System.String,System.BinaryData})">
|
|
<summary> Initializes a new instance of <see cref="T:Azure.AI.OpenAI.Assistants.InternalRequiredFunctionToolCallDetails" />. </summary>
|
|
<param name="name"> The name of the function. </param>
|
|
<param name="arguments"> The arguments to use when invoking the named function, as provided by the model. Arguments are presented as a JSON document that should be validated and parsed for evaluation. </param>
|
|
<param name="serializedAdditionalRawData"> Keeps track of any properties unknown to the library. </param>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.InternalRequiredFunctionToolCallDetails.#ctor">
|
|
<summary> Initializes a new instance of <see cref="T:Azure.AI.OpenAI.Assistants.InternalRequiredFunctionToolCallDetails" /> for deserialization. </summary>
|
|
</member>
|
|
<member name="P:Azure.AI.OpenAI.Assistants.InternalRequiredFunctionToolCallDetails.Name">
|
|
<summary> The name of the function. </summary>
|
|
</member>
|
|
<member name="P:Azure.AI.OpenAI.Assistants.InternalRequiredFunctionToolCallDetails.Arguments">
|
|
<summary> The arguments to use when invoking the named function, as provided by the model. Arguments are presented as a JSON document that should be validated and parsed for evaluation. </summary>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.InternalRequiredFunctionToolCallDetails.FromResponse(Azure.Response)">
|
|
<summary> Deserializes the model from a raw response. </summary>
|
|
<param name="response"> The response to deserialize the model from. </param>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.InternalRequiredFunctionToolCallDetails.ToRequestContent">
|
|
<summary> Convert into a <see cref="T:Azure.Core.RequestContent" />. </summary>
|
|
</member>
|
|
<member name="T:Azure.AI.OpenAI.Assistants.InternalRunStepFunctionToolCallDetails">
|
|
<summary> The detailed information about the function called by the model. </summary>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.InternalRunStepFunctionToolCallDetails.#ctor(System.String,System.String,System.String)">
|
|
<summary> Initializes a new instance of <see cref="T:Azure.AI.OpenAI.Assistants.InternalRunStepFunctionToolCallDetails" />. </summary>
|
|
<param name="name"> The name of the function. </param>
|
|
<param name="arguments"> The arguments that the model requires are provided to the named function. </param>
|
|
<param name="output"> The output of the function, only populated for function calls that have already have had their outputs submitted. </param>
|
|
<exception cref="T:System.ArgumentNullException"> <paramref name="name" /> or <paramref name="arguments" /> is null. </exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.InternalRunStepFunctionToolCallDetails.#ctor(System.String,System.String,System.String,System.Collections.Generic.IDictionary{System.String,System.BinaryData})">
|
|
<summary> Initializes a new instance of <see cref="T:Azure.AI.OpenAI.Assistants.InternalRunStepFunctionToolCallDetails" />. </summary>
|
|
<param name="name"> The name of the function. </param>
|
|
<param name="arguments"> The arguments that the model requires are provided to the named function. </param>
|
|
<param name="output"> The output of the function, only populated for function calls that have already have had their outputs submitted. </param>
|
|
<param name="serializedAdditionalRawData"> Keeps track of any properties unknown to the library. </param>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.InternalRunStepFunctionToolCallDetails.#ctor">
|
|
<summary> Initializes a new instance of <see cref="T:Azure.AI.OpenAI.Assistants.InternalRunStepFunctionToolCallDetails" /> for deserialization. </summary>
|
|
</member>
|
|
<member name="P:Azure.AI.OpenAI.Assistants.InternalRunStepFunctionToolCallDetails.Name">
|
|
<summary> The name of the function. </summary>
|
|
</member>
|
|
<member name="P:Azure.AI.OpenAI.Assistants.InternalRunStepFunctionToolCallDetails.Arguments">
|
|
<summary> The arguments that the model requires are provided to the named function. </summary>
|
|
</member>
|
|
<member name="P:Azure.AI.OpenAI.Assistants.InternalRunStepFunctionToolCallDetails.Output">
|
|
<summary> The output of the function, only populated for function calls that have already have had their outputs submitted. </summary>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.InternalRunStepFunctionToolCallDetails.FromResponse(Azure.Response)">
|
|
<summary> Deserializes the model from a raw response. </summary>
|
|
<param name="response"> The response to deserialize the model from. </param>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.InternalRunStepFunctionToolCallDetails.ToRequestContent">
|
|
<summary> Convert into a <see cref="T:Azure.Core.RequestContent" />. </summary>
|
|
</member>
|
|
<member name="T:Azure.AI.OpenAI.Assistants.InternalSubmitToolOutputsDetails">
|
|
<summary> The details describing tools that should be called to submit tool outputs. </summary>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.InternalSubmitToolOutputsDetails.#ctor(System.Collections.Generic.IEnumerable{Azure.AI.OpenAI.Assistants.RequiredToolCall})">
|
|
<summary> Initializes a new instance of <see cref="T:Azure.AI.OpenAI.Assistants.InternalSubmitToolOutputsDetails" />. </summary>
|
|
<param name="toolCalls">
|
|
The list of tool calls that must be resolved for the assistant thread run to continue.
|
|
Please note <see cref="T:Azure.AI.OpenAI.Assistants.RequiredToolCall" /> is the base class. According to the scenario, a derived class of the base class might need to be assigned here, or this property needs to be casted to one of the possible derived classes.
|
|
The available derived classes include <see cref="T:Azure.AI.OpenAI.Assistants.RequiredFunctionToolCall" />.
|
|
</param>
|
|
<exception cref="T:System.ArgumentNullException"> <paramref name="toolCalls" /> is null. </exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.InternalSubmitToolOutputsDetails.#ctor(System.Collections.Generic.IReadOnlyList{Azure.AI.OpenAI.Assistants.RequiredToolCall},System.Collections.Generic.IDictionary{System.String,System.BinaryData})">
|
|
<summary> Initializes a new instance of <see cref="T:Azure.AI.OpenAI.Assistants.InternalSubmitToolOutputsDetails" />. </summary>
|
|
<param name="toolCalls">
|
|
The list of tool calls that must be resolved for the assistant thread run to continue.
|
|
Please note <see cref="T:Azure.AI.OpenAI.Assistants.RequiredToolCall" /> is the base class. According to the scenario, a derived class of the base class might need to be assigned here, or this property needs to be casted to one of the possible derived classes.
|
|
The available derived classes include <see cref="T:Azure.AI.OpenAI.Assistants.RequiredFunctionToolCall" />.
|
|
</param>
|
|
<param name="serializedAdditionalRawData"> Keeps track of any properties unknown to the library. </param>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.InternalSubmitToolOutputsDetails.#ctor">
|
|
<summary> Initializes a new instance of <see cref="T:Azure.AI.OpenAI.Assistants.InternalSubmitToolOutputsDetails" /> for deserialization. </summary>
|
|
</member>
|
|
<member name="P:Azure.AI.OpenAI.Assistants.InternalSubmitToolOutputsDetails.ToolCalls">
|
|
<summary>
|
|
The list of tool calls that must be resolved for the assistant thread run to continue.
|
|
Please note <see cref="T:Azure.AI.OpenAI.Assistants.RequiredToolCall" /> is the base class. According to the scenario, a derived class of the base class might need to be assigned here, or this property needs to be casted to one of the possible derived classes.
|
|
The available derived classes include <see cref="T:Azure.AI.OpenAI.Assistants.RequiredFunctionToolCall" />.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.InternalSubmitToolOutputsDetails.FromResponse(Azure.Response)">
|
|
<summary> Deserializes the model from a raw response. </summary>
|
|
<param name="response"> The response to deserialize the model from. </param>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.InternalSubmitToolOutputsDetails.ToRequestContent">
|
|
<summary> Convert into a <see cref="T:Azure.Core.RequestContent" />. </summary>
|
|
</member>
|
|
<member name="T:Azure.AI.OpenAI.Assistants.ListSortOrder">
|
|
<summary> The available sorting options when requesting a list of response objects. </summary>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.ListSortOrder.#ctor(System.String)">
|
|
<summary> Initializes a new instance of <see cref="T:Azure.AI.OpenAI.Assistants.ListSortOrder" />. </summary>
|
|
<exception cref="T:System.ArgumentNullException"> <paramref name="value" /> is null. </exception>
|
|
</member>
|
|
<member name="P:Azure.AI.OpenAI.Assistants.ListSortOrder.Ascending">
|
|
<summary> Specifies an ascending sort order. </summary>
|
|
</member>
|
|
<member name="P:Azure.AI.OpenAI.Assistants.ListSortOrder.Descending">
|
|
<summary> Specifies a descending sort order. </summary>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.ListSortOrder.op_Equality(Azure.AI.OpenAI.Assistants.ListSortOrder,Azure.AI.OpenAI.Assistants.ListSortOrder)">
|
|
<summary> Determines if two <see cref="T:Azure.AI.OpenAI.Assistants.ListSortOrder" /> values are the same. </summary>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.ListSortOrder.op_Inequality(Azure.AI.OpenAI.Assistants.ListSortOrder,Azure.AI.OpenAI.Assistants.ListSortOrder)">
|
|
<summary> Determines if two <see cref="T:Azure.AI.OpenAI.Assistants.ListSortOrder" /> values are not the same. </summary>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.ListSortOrder.op_Implicit(System.String)~Azure.AI.OpenAI.Assistants.ListSortOrder">
|
|
<summary> Converts a string to a <see cref="T:Azure.AI.OpenAI.Assistants.ListSortOrder" />. </summary>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.ListSortOrder.Equals(System.Object)">
|
|
<summary>Indicates whether this instance and a specified object are equal.</summary><param name="obj">The object to compare with the current instance.</param><returns><see langword="true" /> if <paramref name="obj" /> and this instance are the same type and represent the same value; otherwise, <see langword="false" />.</returns>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.ListSortOrder.Equals(Azure.AI.OpenAI.Assistants.ListSortOrder)">
|
|
<summary>Indicates whether the current object is equal to another object of the same type.</summary><param name="other">An object to compare with this object.</param><returns><see langword="true" /> if the current object is equal to the <paramref name="other" /> parameter; otherwise, <see langword="false" />.</returns>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.ListSortOrder.GetHashCode">
|
|
<summary>Returns the hash code for this instance.</summary><returns>A 32-bit signed integer that is the hash code for this instance.</returns>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.ListSortOrder.ToString">
|
|
<summary>Returns the fully qualified type name of this instance.</summary><returns>The fully qualified type name.</returns>
|
|
</member>
|
|
<member name="T:Azure.AI.OpenAI.Assistants.MessageContent">
|
|
<summary>
|
|
An abstract representation of a single item of thread message content.
|
|
Please note <see cref="T:Azure.AI.OpenAI.Assistants.MessageContent" /> is the base class. According to the scenario, a derived class of the base class might need to be assigned here, or this property needs to be casted to one of the possible derived classes.
|
|
The available derived classes include <see cref="T:Azure.AI.OpenAI.Assistants.MessageImageFileContent" /> and <see cref="T:Azure.AI.OpenAI.Assistants.MessageTextContent" />.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Azure.AI.OpenAI.Assistants.MessageContent._serializedAdditionalRawData">
|
|
<summary>
|
|
Keeps track of any properties unknown to the library.
|
|
<para>
|
|
To assign an object to the value of this property use <see cref="M:System.BinaryData.FromObjectAsJson``1(``0,System.Text.Json.JsonSerializerOptions)" />.
|
|
</para>
|
|
<para>
|
|
To assign an already formatted json string to this property use <see cref="M:System.BinaryData.FromString(System.String)" />.
|
|
</para>
|
|
<para>
|
|
Examples:
|
|
<list type="bullet">
|
|
<item>
|
|
<term>BinaryData.FromObjectAsJson("foo")</term>
|
|
<description>Creates a payload of "foo".</description>
|
|
</item>
|
|
<item>
|
|
<term>BinaryData.FromString("\"foo\"")</term>
|
|
<description>Creates a payload of "foo".</description>
|
|
</item>
|
|
<item>
|
|
<term>BinaryData.FromObjectAsJson(new { key = "value" })</term>
|
|
<description>Creates a payload of { "key": "value" }.</description>
|
|
</item>
|
|
<item>
|
|
<term>BinaryData.FromString("{\"key\": \"value\"}")</term>
|
|
<description>Creates a payload of { "key": "value" }.</description>
|
|
</item>
|
|
</list>
|
|
</para>
|
|
</summary>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.MessageContent.#ctor">
|
|
<summary> Initializes a new instance of <see cref="T:Azure.AI.OpenAI.Assistants.MessageContent" />. </summary>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.MessageContent.#ctor(System.String,System.Collections.Generic.IDictionary{System.String,System.BinaryData})">
|
|
<summary> Initializes a new instance of <see cref="T:Azure.AI.OpenAI.Assistants.MessageContent" />. </summary>
|
|
<param name="type"> The object type. </param>
|
|
<param name="serializedAdditionalRawData"> Keeps track of any properties unknown to the library. </param>
|
|
</member>
|
|
<member name="P:Azure.AI.OpenAI.Assistants.MessageContent.Type">
|
|
<summary> The object type. </summary>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.MessageContent.FromResponse(Azure.Response)">
|
|
<summary> Deserializes the model from a raw response. </summary>
|
|
<param name="response"> The response to deserialize the model from. </param>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.MessageContent.ToRequestContent">
|
|
<summary> Convert into a <see cref="T:Azure.Core.RequestContent" />. </summary>
|
|
</member>
|
|
<member name="T:Azure.AI.OpenAI.Assistants.MessageRole">
|
|
<summary> The possible values for roles attributed to messages in a thread. </summary>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.MessageRole.#ctor(System.String)">
|
|
<summary> Initializes a new instance of <see cref="T:Azure.AI.OpenAI.Assistants.MessageRole" />. </summary>
|
|
<exception cref="T:System.ArgumentNullException"> <paramref name="value" /> is null. </exception>
|
|
</member>
|
|
<member name="P:Azure.AI.OpenAI.Assistants.MessageRole.User">
|
|
<summary> The role representing the end-user. </summary>
|
|
</member>
|
|
<member name="P:Azure.AI.OpenAI.Assistants.MessageRole.Assistant">
|
|
<summary> The role representing the assistant. </summary>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.MessageRole.op_Equality(Azure.AI.OpenAI.Assistants.MessageRole,Azure.AI.OpenAI.Assistants.MessageRole)">
|
|
<summary> Determines if two <see cref="T:Azure.AI.OpenAI.Assistants.MessageRole" /> values are the same. </summary>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.MessageRole.op_Inequality(Azure.AI.OpenAI.Assistants.MessageRole,Azure.AI.OpenAI.Assistants.MessageRole)">
|
|
<summary> Determines if two <see cref="T:Azure.AI.OpenAI.Assistants.MessageRole" /> values are not the same. </summary>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.MessageRole.op_Implicit(System.String)~Azure.AI.OpenAI.Assistants.MessageRole">
|
|
<summary> Converts a string to a <see cref="T:Azure.AI.OpenAI.Assistants.MessageRole" />. </summary>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.MessageRole.Equals(System.Object)">
|
|
<summary>Indicates whether this instance and a specified object are equal.</summary><param name="obj">The object to compare with the current instance.</param><returns><see langword="true" /> if <paramref name="obj" /> and this instance are the same type and represent the same value; otherwise, <see langword="false" />.</returns>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.MessageRole.Equals(Azure.AI.OpenAI.Assistants.MessageRole)">
|
|
<summary>Indicates whether the current object is equal to another object of the same type.</summary><param name="other">An object to compare with this object.</param><returns><see langword="true" /> if the current object is equal to the <paramref name="other" /> parameter; otherwise, <see langword="false" />.</returns>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.MessageRole.GetHashCode">
|
|
<summary>Returns the hash code for this instance.</summary><returns>A 32-bit signed integer that is the hash code for this instance.</returns>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.MessageRole.ToString">
|
|
<summary>Returns the fully qualified type name of this instance.</summary><returns>The fully qualified type name.</returns>
|
|
</member>
|
|
<member name="T:Azure.AI.OpenAI.Assistants.MessageTextAnnotation">
|
|
<summary>
|
|
An abstract representation of an annotation to text thread message content.
|
|
Please note <see cref="T:Azure.AI.OpenAI.Assistants.MessageTextAnnotation" /> is the base class. According to the scenario, a derived class of the base class might need to be assigned here, or this property needs to be casted to one of the possible derived classes.
|
|
The available derived classes include <see cref="T:Azure.AI.OpenAI.Assistants.MessageTextFileCitationAnnotation" /> and <see cref="T:Azure.AI.OpenAI.Assistants.MessageTextFilePathAnnotation" />.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Azure.AI.OpenAI.Assistants.MessageTextAnnotation._serializedAdditionalRawData">
|
|
<summary>
|
|
Keeps track of any properties unknown to the library.
|
|
<para>
|
|
To assign an object to the value of this property use <see cref="M:System.BinaryData.FromObjectAsJson``1(``0,System.Text.Json.JsonSerializerOptions)" />.
|
|
</para>
|
|
<para>
|
|
To assign an already formatted json string to this property use <see cref="M:System.BinaryData.FromString(System.String)" />.
|
|
</para>
|
|
<para>
|
|
Examples:
|
|
<list type="bullet">
|
|
<item>
|
|
<term>BinaryData.FromObjectAsJson("foo")</term>
|
|
<description>Creates a payload of "foo".</description>
|
|
</item>
|
|
<item>
|
|
<term>BinaryData.FromString("\"foo\"")</term>
|
|
<description>Creates a payload of "foo".</description>
|
|
</item>
|
|
<item>
|
|
<term>BinaryData.FromObjectAsJson(new { key = "value" })</term>
|
|
<description>Creates a payload of { "key": "value" }.</description>
|
|
</item>
|
|
<item>
|
|
<term>BinaryData.FromString("{\"key\": \"value\"}")</term>
|
|
<description>Creates a payload of { "key": "value" }.</description>
|
|
</item>
|
|
</list>
|
|
</para>
|
|
</summary>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.MessageTextAnnotation.#ctor(System.String,System.Int32,System.Int32)">
|
|
<summary> Initializes a new instance of <see cref="T:Azure.AI.OpenAI.Assistants.MessageTextAnnotation" />. </summary>
|
|
<param name="text"> The textual content associated with this text annotation item. </param>
|
|
<param name="startIndex"> The first text index associated with this text annotation. </param>
|
|
<param name="endIndex"> The last text index associated with this text annotation. </param>
|
|
<exception cref="T:System.ArgumentNullException"> <paramref name="text" /> is null. </exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.MessageTextAnnotation.#ctor(System.String,System.String,System.Int32,System.Int32,System.Collections.Generic.IDictionary{System.String,System.BinaryData})">
|
|
<summary> Initializes a new instance of <see cref="T:Azure.AI.OpenAI.Assistants.MessageTextAnnotation" />. </summary>
|
|
<param name="type"> The object type. </param>
|
|
<param name="text"> The textual content associated with this text annotation item. </param>
|
|
<param name="startIndex"> The first text index associated with this text annotation. </param>
|
|
<param name="endIndex"> The last text index associated with this text annotation. </param>
|
|
<param name="serializedAdditionalRawData"> Keeps track of any properties unknown to the library. </param>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.MessageTextAnnotation.#ctor">
|
|
<summary> Initializes a new instance of <see cref="T:Azure.AI.OpenAI.Assistants.MessageTextAnnotation" /> for deserialization. </summary>
|
|
</member>
|
|
<member name="P:Azure.AI.OpenAI.Assistants.MessageTextAnnotation.Type">
|
|
<summary> The object type. </summary>
|
|
</member>
|
|
<member name="P:Azure.AI.OpenAI.Assistants.MessageTextAnnotation.Text">
|
|
<summary> The textual content associated with this text annotation item. </summary>
|
|
</member>
|
|
<member name="P:Azure.AI.OpenAI.Assistants.MessageTextAnnotation.StartIndex">
|
|
<summary> The first text index associated with this text annotation. </summary>
|
|
</member>
|
|
<member name="P:Azure.AI.OpenAI.Assistants.MessageTextAnnotation.EndIndex">
|
|
<summary> The last text index associated with this text annotation. </summary>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.MessageTextAnnotation.FromResponse(Azure.Response)">
|
|
<summary> Deserializes the model from a raw response. </summary>
|
|
<param name="response"> The response to deserialize the model from. </param>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.MessageTextAnnotation.ToRequestContent">
|
|
<summary> Convert into a <see cref="T:Azure.Core.RequestContent" />. </summary>
|
|
</member>
|
|
<member name="T:Azure.AI.OpenAI.Assistants.OpenAIFilePurpose">
|
|
<summary> The possible values denoting the intended usage of a file. </summary>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.OpenAIFilePurpose.#ctor(System.String)">
|
|
<summary> Initializes a new instance of <see cref="T:Azure.AI.OpenAI.Assistants.OpenAIFilePurpose" />. </summary>
|
|
<exception cref="T:System.ArgumentNullException"> <paramref name="value" /> is null. </exception>
|
|
</member>
|
|
<member name="P:Azure.AI.OpenAI.Assistants.OpenAIFilePurpose.FineTune">
|
|
<summary> Indicates a file is used for fine tuning input. </summary>
|
|
</member>
|
|
<member name="P:Azure.AI.OpenAI.Assistants.OpenAIFilePurpose.FineTuneResults">
|
|
<summary> Indicates a file is used for fine tuning results. </summary>
|
|
</member>
|
|
<member name="P:Azure.AI.OpenAI.Assistants.OpenAIFilePurpose.Assistants">
|
|
<summary> Indicates a file is used as input to assistants. </summary>
|
|
</member>
|
|
<member name="P:Azure.AI.OpenAI.Assistants.OpenAIFilePurpose.AssistantsOutput">
|
|
<summary> Indicates a file is used as output by assistants. </summary>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.OpenAIFilePurpose.op_Equality(Azure.AI.OpenAI.Assistants.OpenAIFilePurpose,Azure.AI.OpenAI.Assistants.OpenAIFilePurpose)">
|
|
<summary> Determines if two <see cref="T:Azure.AI.OpenAI.Assistants.OpenAIFilePurpose" /> values are the same. </summary>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.OpenAIFilePurpose.op_Inequality(Azure.AI.OpenAI.Assistants.OpenAIFilePurpose,Azure.AI.OpenAI.Assistants.OpenAIFilePurpose)">
|
|
<summary> Determines if two <see cref="T:Azure.AI.OpenAI.Assistants.OpenAIFilePurpose" /> values are not the same. </summary>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.OpenAIFilePurpose.op_Implicit(System.String)~Azure.AI.OpenAI.Assistants.OpenAIFilePurpose">
|
|
<summary> Converts a string to a <see cref="T:Azure.AI.OpenAI.Assistants.OpenAIFilePurpose" />. </summary>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.OpenAIFilePurpose.Equals(System.Object)">
|
|
<summary>Indicates whether this instance and a specified object are equal.</summary><param name="obj">The object to compare with the current instance.</param><returns><see langword="true" /> if <paramref name="obj" /> and this instance are the same type and represent the same value; otherwise, <see langword="false" />.</returns>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.OpenAIFilePurpose.Equals(Azure.AI.OpenAI.Assistants.OpenAIFilePurpose)">
|
|
<summary>Indicates whether the current object is equal to another object of the same type.</summary><param name="other">An object to compare with this object.</param><returns><see langword="true" /> if the current object is equal to the <paramref name="other" /> parameter; otherwise, <see langword="false" />.</returns>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.OpenAIFilePurpose.GetHashCode">
|
|
<summary>Returns the hash code for this instance.</summary><returns>A 32-bit signed integer that is the hash code for this instance.</returns>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.OpenAIFilePurpose.ToString">
|
|
<summary>Returns the fully qualified type name of this instance.</summary><returns>The fully qualified type name.</returns>
|
|
</member>
|
|
<member name="T:Azure.AI.OpenAI.Assistants.RequiredAction">
|
|
<summary>
|
|
An abstract representation of a required action for an assistant thread run to continue.
|
|
Please note <see cref="T:Azure.AI.OpenAI.Assistants.RequiredAction" /> is the base class. According to the scenario, a derived class of the base class might need to be assigned here, or this property needs to be casted to one of the possible derived classes.
|
|
The available derived classes include <see cref="T:Azure.AI.OpenAI.Assistants.SubmitToolOutputsAction" />.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Azure.AI.OpenAI.Assistants.RequiredAction._serializedAdditionalRawData">
|
|
<summary>
|
|
Keeps track of any properties unknown to the library.
|
|
<para>
|
|
To assign an object to the value of this property use <see cref="M:System.BinaryData.FromObjectAsJson``1(``0,System.Text.Json.JsonSerializerOptions)" />.
|
|
</para>
|
|
<para>
|
|
To assign an already formatted json string to this property use <see cref="M:System.BinaryData.FromString(System.String)" />.
|
|
</para>
|
|
<para>
|
|
Examples:
|
|
<list type="bullet">
|
|
<item>
|
|
<term>BinaryData.FromObjectAsJson("foo")</term>
|
|
<description>Creates a payload of "foo".</description>
|
|
</item>
|
|
<item>
|
|
<term>BinaryData.FromString("\"foo\"")</term>
|
|
<description>Creates a payload of "foo".</description>
|
|
</item>
|
|
<item>
|
|
<term>BinaryData.FromObjectAsJson(new { key = "value" })</term>
|
|
<description>Creates a payload of { "key": "value" }.</description>
|
|
</item>
|
|
<item>
|
|
<term>BinaryData.FromString("{\"key\": \"value\"}")</term>
|
|
<description>Creates a payload of { "key": "value" }.</description>
|
|
</item>
|
|
</list>
|
|
</para>
|
|
</summary>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.RequiredAction.#ctor">
|
|
<summary> Initializes a new instance of <see cref="T:Azure.AI.OpenAI.Assistants.RequiredAction" />. </summary>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.RequiredAction.#ctor(System.String,System.Collections.Generic.IDictionary{System.String,System.BinaryData})">
|
|
<summary> Initializes a new instance of <see cref="T:Azure.AI.OpenAI.Assistants.RequiredAction" />. </summary>
|
|
<param name="type"> The object type. </param>
|
|
<param name="serializedAdditionalRawData"> Keeps track of any properties unknown to the library. </param>
|
|
</member>
|
|
<member name="P:Azure.AI.OpenAI.Assistants.RequiredAction.Type">
|
|
<summary> The object type. </summary>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.RequiredAction.FromResponse(Azure.Response)">
|
|
<summary> Deserializes the model from a raw response. </summary>
|
|
<param name="response"> The response to deserialize the model from. </param>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.RequiredAction.ToRequestContent">
|
|
<summary> Convert into a <see cref="T:Azure.Core.RequestContent" />. </summary>
|
|
</member>
|
|
<member name="T:Azure.AI.OpenAI.Assistants.RequiredToolCall">
|
|
<summary>
|
|
An abstract representation a a tool invocation needed by the model to continue a run.
|
|
Please note <see cref="T:Azure.AI.OpenAI.Assistants.RequiredToolCall" /> is the base class. According to the scenario, a derived class of the base class might need to be assigned here, or this property needs to be casted to one of the possible derived classes.
|
|
The available derived classes include <see cref="T:Azure.AI.OpenAI.Assistants.RequiredFunctionToolCall" />.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Azure.AI.OpenAI.Assistants.RequiredToolCall._serializedAdditionalRawData">
|
|
<summary>
|
|
Keeps track of any properties unknown to the library.
|
|
<para>
|
|
To assign an object to the value of this property use <see cref="M:System.BinaryData.FromObjectAsJson``1(``0,System.Text.Json.JsonSerializerOptions)" />.
|
|
</para>
|
|
<para>
|
|
To assign an already formatted json string to this property use <see cref="M:System.BinaryData.FromString(System.String)" />.
|
|
</para>
|
|
<para>
|
|
Examples:
|
|
<list type="bullet">
|
|
<item>
|
|
<term>BinaryData.FromObjectAsJson("foo")</term>
|
|
<description>Creates a payload of "foo".</description>
|
|
</item>
|
|
<item>
|
|
<term>BinaryData.FromString("\"foo\"")</term>
|
|
<description>Creates a payload of "foo".</description>
|
|
</item>
|
|
<item>
|
|
<term>BinaryData.FromObjectAsJson(new { key = "value" })</term>
|
|
<description>Creates a payload of { "key": "value" }.</description>
|
|
</item>
|
|
<item>
|
|
<term>BinaryData.FromString("{\"key\": \"value\"}")</term>
|
|
<description>Creates a payload of { "key": "value" }.</description>
|
|
</item>
|
|
</list>
|
|
</para>
|
|
</summary>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.RequiredToolCall.#ctor(System.String)">
|
|
<summary> Initializes a new instance of <see cref="T:Azure.AI.OpenAI.Assistants.RequiredToolCall" />. </summary>
|
|
<param name="id"> The ID of the tool call. This ID must be referenced when submitting tool outputs. </param>
|
|
<exception cref="T:System.ArgumentNullException"> <paramref name="id" /> is null. </exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.RequiredToolCall.#ctor(System.String,System.String,System.Collections.Generic.IDictionary{System.String,System.BinaryData})">
|
|
<summary> Initializes a new instance of <see cref="T:Azure.AI.OpenAI.Assistants.RequiredToolCall" />. </summary>
|
|
<param name="type"> The object type for the required tool call. </param>
|
|
<param name="id"> The ID of the tool call. This ID must be referenced when submitting tool outputs. </param>
|
|
<param name="serializedAdditionalRawData"> Keeps track of any properties unknown to the library. </param>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.RequiredToolCall.#ctor">
|
|
<summary> Initializes a new instance of <see cref="T:Azure.AI.OpenAI.Assistants.RequiredToolCall" /> for deserialization. </summary>
|
|
</member>
|
|
<member name="P:Azure.AI.OpenAI.Assistants.RequiredToolCall.Type">
|
|
<summary> The object type for the required tool call. </summary>
|
|
</member>
|
|
<member name="P:Azure.AI.OpenAI.Assistants.RequiredToolCall.Id">
|
|
<summary> The ID of the tool call. This ID must be referenced when submitting tool outputs. </summary>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.RequiredToolCall.FromResponse(Azure.Response)">
|
|
<summary> Deserializes the model from a raw response. </summary>
|
|
<param name="response"> The response to deserialize the model from. </param>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.RequiredToolCall.ToRequestContent">
|
|
<summary> Convert into a <see cref="T:Azure.Core.RequestContent" />. </summary>
|
|
</member>
|
|
<member name="T:Azure.AI.OpenAI.Assistants.RetrievalToolDefinition">
|
|
<summary> The input definition information for a retrieval tool as used to configure an assistant. </summary>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.RetrievalToolDefinition.#ctor">
|
|
<summary> Initializes a new instance of <see cref="T:Azure.AI.OpenAI.Assistants.RetrievalToolDefinition" />. </summary>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.RetrievalToolDefinition.#ctor(System.String,System.Collections.Generic.IDictionary{System.String,System.BinaryData})">
|
|
<summary> Initializes a new instance of <see cref="T:Azure.AI.OpenAI.Assistants.RetrievalToolDefinition" />. </summary>
|
|
<param name="type"> The object type. </param>
|
|
<param name="serializedAdditionalRawData"> Keeps track of any properties unknown to the library. </param>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.RetrievalToolDefinition.FromResponse(Azure.Response)">
|
|
<summary> Deserializes the model from a raw response. </summary>
|
|
<param name="response"> The response to deserialize the model from. </param>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.RetrievalToolDefinition.ToRequestContent">
|
|
<summary> Convert into a <see cref="T:Azure.Core.RequestContent" />. </summary>
|
|
</member>
|
|
<member name="T:Azure.AI.OpenAI.Assistants.RunError">
|
|
<summary> The details of an error as encountered by an assistant thread run. </summary>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.RunError.#ctor(System.String,System.String)">
|
|
<summary> Initializes a new instance of <see cref="T:Azure.AI.OpenAI.Assistants.RunError" />. </summary>
|
|
<param name="code"> The status for the error. </param>
|
|
<param name="message"> The human-readable text associated with the error. </param>
|
|
<exception cref="T:System.ArgumentNullException"> <paramref name="code" /> or <paramref name="message" /> is null. </exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.RunError.#ctor(System.String,System.String,System.Collections.Generic.IDictionary{System.String,System.BinaryData})">
|
|
<summary> Initializes a new instance of <see cref="T:Azure.AI.OpenAI.Assistants.RunError" />. </summary>
|
|
<param name="code"> The status for the error. </param>
|
|
<param name="message"> The human-readable text associated with the error. </param>
|
|
<param name="serializedAdditionalRawData"> Keeps track of any properties unknown to the library. </param>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.RunError.#ctor">
|
|
<summary> Initializes a new instance of <see cref="T:Azure.AI.OpenAI.Assistants.RunError" /> for deserialization. </summary>
|
|
</member>
|
|
<member name="P:Azure.AI.OpenAI.Assistants.RunError.Code">
|
|
<summary> The status for the error. </summary>
|
|
</member>
|
|
<member name="P:Azure.AI.OpenAI.Assistants.RunError.Message">
|
|
<summary> The human-readable text associated with the error. </summary>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.RunError.FromResponse(Azure.Response)">
|
|
<summary> Deserializes the model from a raw response. </summary>
|
|
<param name="response"> The response to deserialize the model from. </param>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.RunError.ToRequestContent">
|
|
<summary> Convert into a <see cref="T:Azure.Core.RequestContent" />. </summary>
|
|
</member>
|
|
<member name="T:Azure.AI.OpenAI.Assistants.RunStatus">
|
|
<summary> Possible values for the status of an assistant thread run. </summary>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.RunStatus.#ctor(System.String)">
|
|
<summary> Initializes a new instance of <see cref="T:Azure.AI.OpenAI.Assistants.RunStatus" />. </summary>
|
|
<exception cref="T:System.ArgumentNullException"> <paramref name="value" /> is null. </exception>
|
|
</member>
|
|
<member name="P:Azure.AI.OpenAI.Assistants.RunStatus.Queued">
|
|
<summary> Represents a run that is queued to start. </summary>
|
|
</member>
|
|
<member name="P:Azure.AI.OpenAI.Assistants.RunStatus.InProgress">
|
|
<summary> Represents a run that is in progress. </summary>
|
|
</member>
|
|
<member name="P:Azure.AI.OpenAI.Assistants.RunStatus.RequiresAction">
|
|
<summary> Represents a run that needs another operation, such as tool output submission, to continue. </summary>
|
|
</member>
|
|
<member name="P:Azure.AI.OpenAI.Assistants.RunStatus.Cancelling">
|
|
<summary> Represents a run that is in the process of cancellation. </summary>
|
|
</member>
|
|
<member name="P:Azure.AI.OpenAI.Assistants.RunStatus.Cancelled">
|
|
<summary> Represents a run that has been cancelled. </summary>
|
|
</member>
|
|
<member name="P:Azure.AI.OpenAI.Assistants.RunStatus.Failed">
|
|
<summary> Represents a run that failed. </summary>
|
|
</member>
|
|
<member name="P:Azure.AI.OpenAI.Assistants.RunStatus.Completed">
|
|
<summary> Represents a run that successfully completed. </summary>
|
|
</member>
|
|
<member name="P:Azure.AI.OpenAI.Assistants.RunStatus.Expired">
|
|
<summary> Represents a run that expired before it could otherwise finish. </summary>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.RunStatus.op_Equality(Azure.AI.OpenAI.Assistants.RunStatus,Azure.AI.OpenAI.Assistants.RunStatus)">
|
|
<summary> Determines if two <see cref="T:Azure.AI.OpenAI.Assistants.RunStatus" /> values are the same. </summary>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.RunStatus.op_Inequality(Azure.AI.OpenAI.Assistants.RunStatus,Azure.AI.OpenAI.Assistants.RunStatus)">
|
|
<summary> Determines if two <see cref="T:Azure.AI.OpenAI.Assistants.RunStatus" /> values are not the same. </summary>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.RunStatus.op_Implicit(System.String)~Azure.AI.OpenAI.Assistants.RunStatus">
|
|
<summary> Converts a string to a <see cref="T:Azure.AI.OpenAI.Assistants.RunStatus" />. </summary>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.RunStatus.Equals(System.Object)">
|
|
<summary>Indicates whether this instance and a specified object are equal.</summary><param name="obj">The object to compare with the current instance.</param><returns><see langword="true" /> if <paramref name="obj" /> and this instance are the same type and represent the same value; otherwise, <see langword="false" />.</returns>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.RunStatus.Equals(Azure.AI.OpenAI.Assistants.RunStatus)">
|
|
<summary>Indicates whether the current object is equal to another object of the same type.</summary><param name="other">An object to compare with this object.</param><returns><see langword="true" /> if the current object is equal to the <paramref name="other" /> parameter; otherwise, <see langword="false" />.</returns>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.RunStatus.GetHashCode">
|
|
<summary>Returns the hash code for this instance.</summary><returns>A 32-bit signed integer that is the hash code for this instance.</returns>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.RunStatus.ToString">
|
|
<summary>Returns the fully qualified type name of this instance.</summary><returns>The fully qualified type name.</returns>
|
|
</member>
|
|
<member name="T:Azure.AI.OpenAI.Assistants.RunStepCodeInterpreterImageOutput">
|
|
<summary> A representation of an image output emitted by a code interpreter tool in response to a tool call by the model. </summary>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.RunStepCodeInterpreterImageOutput.#ctor(Azure.AI.OpenAI.Assistants.RunStepCodeInterpreterImageReference)">
|
|
<summary> Initializes a new instance of <see cref="T:Azure.AI.OpenAI.Assistants.RunStepCodeInterpreterImageOutput" />. </summary>
|
|
<param name="image"> Referential information for the image associated with this output. </param>
|
|
<exception cref="T:System.ArgumentNullException"> <paramref name="image" /> is null. </exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.RunStepCodeInterpreterImageOutput.#ctor(System.String,System.Collections.Generic.IDictionary{System.String,System.BinaryData},Azure.AI.OpenAI.Assistants.RunStepCodeInterpreterImageReference)">
|
|
<summary> Initializes a new instance of <see cref="T:Azure.AI.OpenAI.Assistants.RunStepCodeInterpreterImageOutput" />. </summary>
|
|
<param name="type"> The object type. </param>
|
|
<param name="serializedAdditionalRawData"> Keeps track of any properties unknown to the library. </param>
|
|
<param name="image"> Referential information for the image associated with this output. </param>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.RunStepCodeInterpreterImageOutput.#ctor">
|
|
<summary> Initializes a new instance of <see cref="T:Azure.AI.OpenAI.Assistants.RunStepCodeInterpreterImageOutput" /> for deserialization. </summary>
|
|
</member>
|
|
<member name="P:Azure.AI.OpenAI.Assistants.RunStepCodeInterpreterImageOutput.Image">
|
|
<summary> Referential information for the image associated with this output. </summary>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.RunStepCodeInterpreterImageOutput.FromResponse(Azure.Response)">
|
|
<summary> Deserializes the model from a raw response. </summary>
|
|
<param name="response"> The response to deserialize the model from. </param>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.RunStepCodeInterpreterImageOutput.ToRequestContent">
|
|
<summary> Convert into a <see cref="T:Azure.Core.RequestContent" />. </summary>
|
|
</member>
|
|
<member name="T:Azure.AI.OpenAI.Assistants.RunStepCodeInterpreterImageReference">
|
|
<summary> An image reference emitted by a code interpreter tool in response to a tool call by the model. </summary>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.RunStepCodeInterpreterImageReference.#ctor(System.String)">
|
|
<summary> Initializes a new instance of <see cref="T:Azure.AI.OpenAI.Assistants.RunStepCodeInterpreterImageReference" />. </summary>
|
|
<param name="fileId"> The ID of the file associated with this image. </param>
|
|
<exception cref="T:System.ArgumentNullException"> <paramref name="fileId" /> is null. </exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.RunStepCodeInterpreterImageReference.#ctor(System.String,System.Collections.Generic.IDictionary{System.String,System.BinaryData})">
|
|
<summary> Initializes a new instance of <see cref="T:Azure.AI.OpenAI.Assistants.RunStepCodeInterpreterImageReference" />. </summary>
|
|
<param name="fileId"> The ID of the file associated with this image. </param>
|
|
<param name="serializedAdditionalRawData"> Keeps track of any properties unknown to the library. </param>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.RunStepCodeInterpreterImageReference.#ctor">
|
|
<summary> Initializes a new instance of <see cref="T:Azure.AI.OpenAI.Assistants.RunStepCodeInterpreterImageReference" /> for deserialization. </summary>
|
|
</member>
|
|
<member name="P:Azure.AI.OpenAI.Assistants.RunStepCodeInterpreterImageReference.FileId">
|
|
<summary> The ID of the file associated with this image. </summary>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.RunStepCodeInterpreterImageReference.FromResponse(Azure.Response)">
|
|
<summary> Deserializes the model from a raw response. </summary>
|
|
<param name="response"> The response to deserialize the model from. </param>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.RunStepCodeInterpreterImageReference.ToRequestContent">
|
|
<summary> Convert into a <see cref="T:Azure.Core.RequestContent" />. </summary>
|
|
</member>
|
|
<member name="T:Azure.AI.OpenAI.Assistants.RunStepCodeInterpreterLogOutput">
|
|
<summary> A representation of a log output emitted by a code interpreter tool in response to a tool call by the model. </summary>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.RunStepCodeInterpreterLogOutput.#ctor(System.String)">
|
|
<summary> Initializes a new instance of <see cref="T:Azure.AI.OpenAI.Assistants.RunStepCodeInterpreterLogOutput" />. </summary>
|
|
<param name="logs"> The serialized log output emitted by the code interpreter. </param>
|
|
<exception cref="T:System.ArgumentNullException"> <paramref name="logs" /> is null. </exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.RunStepCodeInterpreterLogOutput.#ctor(System.String,System.Collections.Generic.IDictionary{System.String,System.BinaryData},System.String)">
|
|
<summary> Initializes a new instance of <see cref="T:Azure.AI.OpenAI.Assistants.RunStepCodeInterpreterLogOutput" />. </summary>
|
|
<param name="type"> The object type. </param>
|
|
<param name="serializedAdditionalRawData"> Keeps track of any properties unknown to the library. </param>
|
|
<param name="logs"> The serialized log output emitted by the code interpreter. </param>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.RunStepCodeInterpreterLogOutput.#ctor">
|
|
<summary> Initializes a new instance of <see cref="T:Azure.AI.OpenAI.Assistants.RunStepCodeInterpreterLogOutput" /> for deserialization. </summary>
|
|
</member>
|
|
<member name="P:Azure.AI.OpenAI.Assistants.RunStepCodeInterpreterLogOutput.Logs">
|
|
<summary> The serialized log output emitted by the code interpreter. </summary>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.RunStepCodeInterpreterLogOutput.FromResponse(Azure.Response)">
|
|
<summary> Deserializes the model from a raw response. </summary>
|
|
<param name="response"> The response to deserialize the model from. </param>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.RunStepCodeInterpreterLogOutput.ToRequestContent">
|
|
<summary> Convert into a <see cref="T:Azure.Core.RequestContent" />. </summary>
|
|
</member>
|
|
<member name="T:Azure.AI.OpenAI.Assistants.RunStepCodeInterpreterToolCallOutput">
|
|
<summary>
|
|
An abstract representation of an emitted output from a code interpreter tool.
|
|
Please note <see cref="T:Azure.AI.OpenAI.Assistants.RunStepCodeInterpreterToolCallOutput" /> is the base class. According to the scenario, a derived class of the base class might need to be assigned here, or this property needs to be casted to one of the possible derived classes.
|
|
The available derived classes include <see cref="T:Azure.AI.OpenAI.Assistants.RunStepCodeInterpreterImageOutput" /> and <see cref="T:Azure.AI.OpenAI.Assistants.RunStepCodeInterpreterLogOutput" />.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Azure.AI.OpenAI.Assistants.RunStepCodeInterpreterToolCallOutput._serializedAdditionalRawData">
|
|
<summary>
|
|
Keeps track of any properties unknown to the library.
|
|
<para>
|
|
To assign an object to the value of this property use <see cref="M:System.BinaryData.FromObjectAsJson``1(``0,System.Text.Json.JsonSerializerOptions)" />.
|
|
</para>
|
|
<para>
|
|
To assign an already formatted json string to this property use <see cref="M:System.BinaryData.FromString(System.String)" />.
|
|
</para>
|
|
<para>
|
|
Examples:
|
|
<list type="bullet">
|
|
<item>
|
|
<term>BinaryData.FromObjectAsJson("foo")</term>
|
|
<description>Creates a payload of "foo".</description>
|
|
</item>
|
|
<item>
|
|
<term>BinaryData.FromString("\"foo\"")</term>
|
|
<description>Creates a payload of "foo".</description>
|
|
</item>
|
|
<item>
|
|
<term>BinaryData.FromObjectAsJson(new { key = "value" })</term>
|
|
<description>Creates a payload of { "key": "value" }.</description>
|
|
</item>
|
|
<item>
|
|
<term>BinaryData.FromString("{\"key\": \"value\"}")</term>
|
|
<description>Creates a payload of { "key": "value" }.</description>
|
|
</item>
|
|
</list>
|
|
</para>
|
|
</summary>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.RunStepCodeInterpreterToolCallOutput.#ctor">
|
|
<summary> Initializes a new instance of <see cref="T:Azure.AI.OpenAI.Assistants.RunStepCodeInterpreterToolCallOutput" />. </summary>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.RunStepCodeInterpreterToolCallOutput.#ctor(System.String,System.Collections.Generic.IDictionary{System.String,System.BinaryData})">
|
|
<summary> Initializes a new instance of <see cref="T:Azure.AI.OpenAI.Assistants.RunStepCodeInterpreterToolCallOutput" />. </summary>
|
|
<param name="type"> The object type. </param>
|
|
<param name="serializedAdditionalRawData"> Keeps track of any properties unknown to the library. </param>
|
|
</member>
|
|
<member name="P:Azure.AI.OpenAI.Assistants.RunStepCodeInterpreterToolCallOutput.Type">
|
|
<summary> The object type. </summary>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.RunStepCodeInterpreterToolCallOutput.FromResponse(Azure.Response)">
|
|
<summary> Deserializes the model from a raw response. </summary>
|
|
<param name="response"> The response to deserialize the model from. </param>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.RunStepCodeInterpreterToolCallOutput.ToRequestContent">
|
|
<summary> Convert into a <see cref="T:Azure.Core.RequestContent" />. </summary>
|
|
</member>
|
|
<member name="T:Azure.AI.OpenAI.Assistants.RunStepDetails">
|
|
<summary>
|
|
An abstract representation of the details for a run step.
|
|
Please note <see cref="T:Azure.AI.OpenAI.Assistants.RunStepDetails" /> is the base class. According to the scenario, a derived class of the base class might need to be assigned here, or this property needs to be casted to one of the possible derived classes.
|
|
The available derived classes include <see cref="T:Azure.AI.OpenAI.Assistants.RunStepMessageCreationDetails" /> and <see cref="T:Azure.AI.OpenAI.Assistants.RunStepToolCallDetails" />.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Azure.AI.OpenAI.Assistants.RunStepDetails._serializedAdditionalRawData">
|
|
<summary>
|
|
Keeps track of any properties unknown to the library.
|
|
<para>
|
|
To assign an object to the value of this property use <see cref="M:System.BinaryData.FromObjectAsJson``1(``0,System.Text.Json.JsonSerializerOptions)" />.
|
|
</para>
|
|
<para>
|
|
To assign an already formatted json string to this property use <see cref="M:System.BinaryData.FromString(System.String)" />.
|
|
</para>
|
|
<para>
|
|
Examples:
|
|
<list type="bullet">
|
|
<item>
|
|
<term>BinaryData.FromObjectAsJson("foo")</term>
|
|
<description>Creates a payload of "foo".</description>
|
|
</item>
|
|
<item>
|
|
<term>BinaryData.FromString("\"foo\"")</term>
|
|
<description>Creates a payload of "foo".</description>
|
|
</item>
|
|
<item>
|
|
<term>BinaryData.FromObjectAsJson(new { key = "value" })</term>
|
|
<description>Creates a payload of { "key": "value" }.</description>
|
|
</item>
|
|
<item>
|
|
<term>BinaryData.FromString("{\"key\": \"value\"}")</term>
|
|
<description>Creates a payload of { "key": "value" }.</description>
|
|
</item>
|
|
</list>
|
|
</para>
|
|
</summary>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.RunStepDetails.#ctor">
|
|
<summary> Initializes a new instance of <see cref="T:Azure.AI.OpenAI.Assistants.RunStepDetails" />. </summary>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.RunStepDetails.#ctor(Azure.AI.OpenAI.Assistants.RunStepType,System.Collections.Generic.IDictionary{System.String,System.BinaryData})">
|
|
<summary> Initializes a new instance of <see cref="T:Azure.AI.OpenAI.Assistants.RunStepDetails" />. </summary>
|
|
<param name="type"> The object type. </param>
|
|
<param name="serializedAdditionalRawData"> Keeps track of any properties unknown to the library. </param>
|
|
</member>
|
|
<member name="P:Azure.AI.OpenAI.Assistants.RunStepDetails.Type">
|
|
<summary> The object type. </summary>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.RunStepDetails.FromResponse(Azure.Response)">
|
|
<summary> Deserializes the model from a raw response. </summary>
|
|
<param name="response"> The response to deserialize the model from. </param>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.RunStepDetails.ToRequestContent">
|
|
<summary> Convert into a <see cref="T:Azure.Core.RequestContent" />. </summary>
|
|
</member>
|
|
<member name="T:Azure.AI.OpenAI.Assistants.RunStepError">
|
|
<summary> The error information associated with a failed run step. </summary>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.RunStepError.#ctor(Azure.AI.OpenAI.Assistants.RunStepErrorCode,System.String)">
|
|
<summary> Initializes a new instance of <see cref="T:Azure.AI.OpenAI.Assistants.RunStepError" />. </summary>
|
|
<param name="code"> The error code for this error. </param>
|
|
<param name="message"> The human-readable text associated with this error. </param>
|
|
<exception cref="T:System.ArgumentNullException"> <paramref name="message" /> is null. </exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.RunStepError.#ctor(Azure.AI.OpenAI.Assistants.RunStepErrorCode,System.String,System.Collections.Generic.IDictionary{System.String,System.BinaryData})">
|
|
<summary> Initializes a new instance of <see cref="T:Azure.AI.OpenAI.Assistants.RunStepError" />. </summary>
|
|
<param name="code"> The error code for this error. </param>
|
|
<param name="message"> The human-readable text associated with this error. </param>
|
|
<param name="serializedAdditionalRawData"> Keeps track of any properties unknown to the library. </param>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.RunStepError.#ctor">
|
|
<summary> Initializes a new instance of <see cref="T:Azure.AI.OpenAI.Assistants.RunStepError" /> for deserialization. </summary>
|
|
</member>
|
|
<member name="P:Azure.AI.OpenAI.Assistants.RunStepError.Code">
|
|
<summary> The error code for this error. </summary>
|
|
</member>
|
|
<member name="P:Azure.AI.OpenAI.Assistants.RunStepError.Message">
|
|
<summary> The human-readable text associated with this error. </summary>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.RunStepError.FromResponse(Azure.Response)">
|
|
<summary> Deserializes the model from a raw response. </summary>
|
|
<param name="response"> The response to deserialize the model from. </param>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.RunStepError.ToRequestContent">
|
|
<summary> Convert into a <see cref="T:Azure.Core.RequestContent" />. </summary>
|
|
</member>
|
|
<member name="T:Azure.AI.OpenAI.Assistants.RunStepErrorCode">
|
|
<summary> Possible error code values attributable to a failed run step. </summary>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.RunStepErrorCode.#ctor(System.String)">
|
|
<summary> Initializes a new instance of <see cref="T:Azure.AI.OpenAI.Assistants.RunStepErrorCode" />. </summary>
|
|
<exception cref="T:System.ArgumentNullException"> <paramref name="value" /> is null. </exception>
|
|
</member>
|
|
<member name="P:Azure.AI.OpenAI.Assistants.RunStepErrorCode.ServerError">
|
|
<summary> Represents a server error. </summary>
|
|
</member>
|
|
<member name="P:Azure.AI.OpenAI.Assistants.RunStepErrorCode.RateLimitExceeded">
|
|
<summary> Represents an error indicating configured rate limits were exceeded. </summary>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.RunStepErrorCode.op_Equality(Azure.AI.OpenAI.Assistants.RunStepErrorCode,Azure.AI.OpenAI.Assistants.RunStepErrorCode)">
|
|
<summary> Determines if two <see cref="T:Azure.AI.OpenAI.Assistants.RunStepErrorCode" /> values are the same. </summary>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.RunStepErrorCode.op_Inequality(Azure.AI.OpenAI.Assistants.RunStepErrorCode,Azure.AI.OpenAI.Assistants.RunStepErrorCode)">
|
|
<summary> Determines if two <see cref="T:Azure.AI.OpenAI.Assistants.RunStepErrorCode" /> values are not the same. </summary>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.RunStepErrorCode.op_Implicit(System.String)~Azure.AI.OpenAI.Assistants.RunStepErrorCode">
|
|
<summary> Converts a string to a <see cref="T:Azure.AI.OpenAI.Assistants.RunStepErrorCode" />. </summary>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.RunStepErrorCode.Equals(System.Object)">
|
|
<summary>Indicates whether this instance and a specified object are equal.</summary><param name="obj">The object to compare with the current instance.</param><returns><see langword="true" /> if <paramref name="obj" /> and this instance are the same type and represent the same value; otherwise, <see langword="false" />.</returns>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.RunStepErrorCode.Equals(Azure.AI.OpenAI.Assistants.RunStepErrorCode)">
|
|
<summary>Indicates whether the current object is equal to another object of the same type.</summary><param name="other">An object to compare with this object.</param><returns><see langword="true" /> if the current object is equal to the <paramref name="other" /> parameter; otherwise, <see langword="false" />.</returns>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.RunStepErrorCode.GetHashCode">
|
|
<summary>Returns the hash code for this instance.</summary><returns>A 32-bit signed integer that is the hash code for this instance.</returns>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.RunStepErrorCode.ToString">
|
|
<summary>Returns the fully qualified type name of this instance.</summary><returns>The fully qualified type name.</returns>
|
|
</member>
|
|
<member name="T:Azure.AI.OpenAI.Assistants.RunStepMessageCreationDetails">
|
|
<summary> The detailed information associated with a message creation run step. </summary>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.RunStepMessageCreationDetails.#ctor(Azure.AI.OpenAI.Assistants.RunStepMessageCreationReference)">
|
|
<summary> Initializes a new instance of <see cref="T:Azure.AI.OpenAI.Assistants.RunStepMessageCreationDetails" />. </summary>
|
|
<param name="messageCreation"> Information about the message creation associated with this run step. </param>
|
|
<exception cref="T:System.ArgumentNullException"> <paramref name="messageCreation" /> is null. </exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.RunStepMessageCreationDetails.#ctor(Azure.AI.OpenAI.Assistants.RunStepType,System.Collections.Generic.IDictionary{System.String,System.BinaryData},Azure.AI.OpenAI.Assistants.RunStepMessageCreationReference)">
|
|
<summary> Initializes a new instance of <see cref="T:Azure.AI.OpenAI.Assistants.RunStepMessageCreationDetails" />. </summary>
|
|
<param name="type"> The object type. </param>
|
|
<param name="serializedAdditionalRawData"> Keeps track of any properties unknown to the library. </param>
|
|
<param name="messageCreation"> Information about the message creation associated with this run step. </param>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.RunStepMessageCreationDetails.#ctor">
|
|
<summary> Initializes a new instance of <see cref="T:Azure.AI.OpenAI.Assistants.RunStepMessageCreationDetails" /> for deserialization. </summary>
|
|
</member>
|
|
<member name="P:Azure.AI.OpenAI.Assistants.RunStepMessageCreationDetails.MessageCreation">
|
|
<summary> Information about the message creation associated with this run step. </summary>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.RunStepMessageCreationDetails.FromResponse(Azure.Response)">
|
|
<summary> Deserializes the model from a raw response. </summary>
|
|
<param name="response"> The response to deserialize the model from. </param>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.RunStepMessageCreationDetails.ToRequestContent">
|
|
<summary> Convert into a <see cref="T:Azure.Core.RequestContent" />. </summary>
|
|
</member>
|
|
<member name="T:Azure.AI.OpenAI.Assistants.RunStepMessageCreationReference">
|
|
<summary> The details of a message created as a part of a run step. </summary>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.RunStepMessageCreationReference.#ctor(System.String)">
|
|
<summary> Initializes a new instance of <see cref="T:Azure.AI.OpenAI.Assistants.RunStepMessageCreationReference" />. </summary>
|
|
<param name="messageId"> The ID of the message created by this run step. </param>
|
|
<exception cref="T:System.ArgumentNullException"> <paramref name="messageId" /> is null. </exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.RunStepMessageCreationReference.#ctor(System.String,System.Collections.Generic.IDictionary{System.String,System.BinaryData})">
|
|
<summary> Initializes a new instance of <see cref="T:Azure.AI.OpenAI.Assistants.RunStepMessageCreationReference" />. </summary>
|
|
<param name="messageId"> The ID of the message created by this run step. </param>
|
|
<param name="serializedAdditionalRawData"> Keeps track of any properties unknown to the library. </param>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.RunStepMessageCreationReference.#ctor">
|
|
<summary> Initializes a new instance of <see cref="T:Azure.AI.OpenAI.Assistants.RunStepMessageCreationReference" /> for deserialization. </summary>
|
|
</member>
|
|
<member name="P:Azure.AI.OpenAI.Assistants.RunStepMessageCreationReference.MessageId">
|
|
<summary> The ID of the message created by this run step. </summary>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.RunStepMessageCreationReference.FromResponse(Azure.Response)">
|
|
<summary> Deserializes the model from a raw response. </summary>
|
|
<param name="response"> The response to deserialize the model from. </param>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.RunStepMessageCreationReference.ToRequestContent">
|
|
<summary> Convert into a <see cref="T:Azure.Core.RequestContent" />. </summary>
|
|
</member>
|
|
<member name="T:Azure.AI.OpenAI.Assistants.RunStepRetrievalToolCall">
|
|
<summary>
|
|
A record of a call to a retrieval tool, issued by the model in evaluation of a defined tool, that represents
|
|
executed retrieval actions.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.RunStepRetrievalToolCall.#ctor(System.String,System.Collections.Generic.IReadOnlyDictionary{System.String,System.String})">
|
|
<summary> Initializes a new instance of <see cref="T:Azure.AI.OpenAI.Assistants.RunStepRetrievalToolCall" />. </summary>
|
|
<param name="id"> The ID of the tool call. This ID must be referenced when you submit tool outputs. </param>
|
|
<param name="retrieval"> The key/value pairs produced by the retrieval tool. </param>
|
|
<exception cref="T:System.ArgumentNullException"> <paramref name="id" /> or <paramref name="retrieval" /> is null. </exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.RunStepRetrievalToolCall.#ctor(System.String,System.String,System.Collections.Generic.IDictionary{System.String,System.BinaryData},System.Collections.Generic.IReadOnlyDictionary{System.String,System.String})">
|
|
<summary> Initializes a new instance of <see cref="T:Azure.AI.OpenAI.Assistants.RunStepRetrievalToolCall" />. </summary>
|
|
<param name="type"> The object type. </param>
|
|
<param name="id"> The ID of the tool call. This ID must be referenced when you submit tool outputs. </param>
|
|
<param name="serializedAdditionalRawData"> Keeps track of any properties unknown to the library. </param>
|
|
<param name="retrieval"> The key/value pairs produced by the retrieval tool. </param>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.RunStepRetrievalToolCall.#ctor">
|
|
<summary> Initializes a new instance of <see cref="T:Azure.AI.OpenAI.Assistants.RunStepRetrievalToolCall" /> for deserialization. </summary>
|
|
</member>
|
|
<member name="P:Azure.AI.OpenAI.Assistants.RunStepRetrievalToolCall.Retrieval">
|
|
<summary> The key/value pairs produced by the retrieval tool. </summary>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.RunStepRetrievalToolCall.FromResponse(Azure.Response)">
|
|
<summary> Deserializes the model from a raw response. </summary>
|
|
<param name="response"> The response to deserialize the model from. </param>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.RunStepRetrievalToolCall.ToRequestContent">
|
|
<summary> Convert into a <see cref="T:Azure.Core.RequestContent" />. </summary>
|
|
</member>
|
|
<member name="T:Azure.AI.OpenAI.Assistants.RunStepStatus">
|
|
<summary> Possible values for the status of a run step. </summary>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.RunStepStatus.#ctor(System.String)">
|
|
<summary> Initializes a new instance of <see cref="T:Azure.AI.OpenAI.Assistants.RunStepStatus" />. </summary>
|
|
<exception cref="T:System.ArgumentNullException"> <paramref name="value" /> is null. </exception>
|
|
</member>
|
|
<member name="P:Azure.AI.OpenAI.Assistants.RunStepStatus.InProgress">
|
|
<summary> Represents a run step still in progress. </summary>
|
|
</member>
|
|
<member name="P:Azure.AI.OpenAI.Assistants.RunStepStatus.Cancelled">
|
|
<summary> Represents a run step that was cancelled. </summary>
|
|
</member>
|
|
<member name="P:Azure.AI.OpenAI.Assistants.RunStepStatus.Failed">
|
|
<summary> Represents a run step that failed. </summary>
|
|
</member>
|
|
<member name="P:Azure.AI.OpenAI.Assistants.RunStepStatus.Completed">
|
|
<summary> Represents a run step that successfully completed. </summary>
|
|
</member>
|
|
<member name="P:Azure.AI.OpenAI.Assistants.RunStepStatus.Expired">
|
|
<summary> Represents a run step that expired before otherwise finishing. </summary>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.RunStepStatus.op_Equality(Azure.AI.OpenAI.Assistants.RunStepStatus,Azure.AI.OpenAI.Assistants.RunStepStatus)">
|
|
<summary> Determines if two <see cref="T:Azure.AI.OpenAI.Assistants.RunStepStatus" /> values are the same. </summary>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.RunStepStatus.op_Inequality(Azure.AI.OpenAI.Assistants.RunStepStatus,Azure.AI.OpenAI.Assistants.RunStepStatus)">
|
|
<summary> Determines if two <see cref="T:Azure.AI.OpenAI.Assistants.RunStepStatus" /> values are not the same. </summary>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.RunStepStatus.op_Implicit(System.String)~Azure.AI.OpenAI.Assistants.RunStepStatus">
|
|
<summary> Converts a string to a <see cref="T:Azure.AI.OpenAI.Assistants.RunStepStatus" />. </summary>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.RunStepStatus.Equals(System.Object)">
|
|
<summary>Indicates whether this instance and a specified object are equal.</summary><param name="obj">The object to compare with the current instance.</param><returns><see langword="true" /> if <paramref name="obj" /> and this instance are the same type and represent the same value; otherwise, <see langword="false" />.</returns>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.RunStepStatus.Equals(Azure.AI.OpenAI.Assistants.RunStepStatus)">
|
|
<summary>Indicates whether the current object is equal to another object of the same type.</summary><param name="other">An object to compare with this object.</param><returns><see langword="true" /> if the current object is equal to the <paramref name="other" /> parameter; otherwise, <see langword="false" />.</returns>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.RunStepStatus.GetHashCode">
|
|
<summary>Returns the hash code for this instance.</summary><returns>A 32-bit signed integer that is the hash code for this instance.</returns>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.RunStepStatus.ToString">
|
|
<summary>Returns the fully qualified type name of this instance.</summary><returns>The fully qualified type name.</returns>
|
|
</member>
|
|
<member name="T:Azure.AI.OpenAI.Assistants.RunStepToolCall">
|
|
<summary>
|
|
An abstract representation of a detailed tool call as recorded within a run step for an existing run.
|
|
Please note <see cref="T:Azure.AI.OpenAI.Assistants.RunStepToolCall" /> is the base class. According to the scenario, a derived class of the base class might need to be assigned here, or this property needs to be casted to one of the possible derived classes.
|
|
The available derived classes include <see cref="T:Azure.AI.OpenAI.Assistants.RunStepCodeInterpreterToolCall" />, <see cref="T:Azure.AI.OpenAI.Assistants.RunStepFunctionToolCall" /> and <see cref="T:Azure.AI.OpenAI.Assistants.RunStepRetrievalToolCall" />.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Azure.AI.OpenAI.Assistants.RunStepToolCall._serializedAdditionalRawData">
|
|
<summary>
|
|
Keeps track of any properties unknown to the library.
|
|
<para>
|
|
To assign an object to the value of this property use <see cref="M:System.BinaryData.FromObjectAsJson``1(``0,System.Text.Json.JsonSerializerOptions)" />.
|
|
</para>
|
|
<para>
|
|
To assign an already formatted json string to this property use <see cref="M:System.BinaryData.FromString(System.String)" />.
|
|
</para>
|
|
<para>
|
|
Examples:
|
|
<list type="bullet">
|
|
<item>
|
|
<term>BinaryData.FromObjectAsJson("foo")</term>
|
|
<description>Creates a payload of "foo".</description>
|
|
</item>
|
|
<item>
|
|
<term>BinaryData.FromString("\"foo\"")</term>
|
|
<description>Creates a payload of "foo".</description>
|
|
</item>
|
|
<item>
|
|
<term>BinaryData.FromObjectAsJson(new { key = "value" })</term>
|
|
<description>Creates a payload of { "key": "value" }.</description>
|
|
</item>
|
|
<item>
|
|
<term>BinaryData.FromString("{\"key\": \"value\"}")</term>
|
|
<description>Creates a payload of { "key": "value" }.</description>
|
|
</item>
|
|
</list>
|
|
</para>
|
|
</summary>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.RunStepToolCall.#ctor(System.String)">
|
|
<summary> Initializes a new instance of <see cref="T:Azure.AI.OpenAI.Assistants.RunStepToolCall" />. </summary>
|
|
<param name="id"> The ID of the tool call. This ID must be referenced when you submit tool outputs. </param>
|
|
<exception cref="T:System.ArgumentNullException"> <paramref name="id" /> is null. </exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.RunStepToolCall.#ctor(System.String,System.String,System.Collections.Generic.IDictionary{System.String,System.BinaryData})">
|
|
<summary> Initializes a new instance of <see cref="T:Azure.AI.OpenAI.Assistants.RunStepToolCall" />. </summary>
|
|
<param name="type"> The object type. </param>
|
|
<param name="id"> The ID of the tool call. This ID must be referenced when you submit tool outputs. </param>
|
|
<param name="serializedAdditionalRawData"> Keeps track of any properties unknown to the library. </param>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.RunStepToolCall.#ctor">
|
|
<summary> Initializes a new instance of <see cref="T:Azure.AI.OpenAI.Assistants.RunStepToolCall" /> for deserialization. </summary>
|
|
</member>
|
|
<member name="P:Azure.AI.OpenAI.Assistants.RunStepToolCall.Type">
|
|
<summary> The object type. </summary>
|
|
</member>
|
|
<member name="P:Azure.AI.OpenAI.Assistants.RunStepToolCall.Id">
|
|
<summary> The ID of the tool call. This ID must be referenced when you submit tool outputs. </summary>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.RunStepToolCall.FromResponse(Azure.Response)">
|
|
<summary> Deserializes the model from a raw response. </summary>
|
|
<param name="response"> The response to deserialize the model from. </param>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.RunStepToolCall.ToRequestContent">
|
|
<summary> Convert into a <see cref="T:Azure.Core.RequestContent" />. </summary>
|
|
</member>
|
|
<member name="T:Azure.AI.OpenAI.Assistants.RunStepToolCallDetails">
|
|
<summary> The detailed information associated with a run step calling tools. </summary>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.RunStepToolCallDetails.#ctor(System.Collections.Generic.IEnumerable{Azure.AI.OpenAI.Assistants.RunStepToolCall})">
|
|
<summary> Initializes a new instance of <see cref="T:Azure.AI.OpenAI.Assistants.RunStepToolCallDetails" />. </summary>
|
|
<param name="toolCalls">
|
|
A list of tool call details for this run step.
|
|
Please note <see cref="T:Azure.AI.OpenAI.Assistants.RunStepToolCall" /> is the base class. According to the scenario, a derived class of the base class might need to be assigned here, or this property needs to be casted to one of the possible derived classes.
|
|
The available derived classes include <see cref="T:Azure.AI.OpenAI.Assistants.RunStepCodeInterpreterToolCall" />, <see cref="T:Azure.AI.OpenAI.Assistants.RunStepFunctionToolCall" /> and <see cref="T:Azure.AI.OpenAI.Assistants.RunStepRetrievalToolCall" />.
|
|
</param>
|
|
<exception cref="T:System.ArgumentNullException"> <paramref name="toolCalls" /> is null. </exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.RunStepToolCallDetails.#ctor(Azure.AI.OpenAI.Assistants.RunStepType,System.Collections.Generic.IDictionary{System.String,System.BinaryData},System.Collections.Generic.IReadOnlyList{Azure.AI.OpenAI.Assistants.RunStepToolCall})">
|
|
<summary> Initializes a new instance of <see cref="T:Azure.AI.OpenAI.Assistants.RunStepToolCallDetails" />. </summary>
|
|
<param name="type"> The object type. </param>
|
|
<param name="serializedAdditionalRawData"> Keeps track of any properties unknown to the library. </param>
|
|
<param name="toolCalls">
|
|
A list of tool call details for this run step.
|
|
Please note <see cref="T:Azure.AI.OpenAI.Assistants.RunStepToolCall" /> is the base class. According to the scenario, a derived class of the base class might need to be assigned here, or this property needs to be casted to one of the possible derived classes.
|
|
The available derived classes include <see cref="T:Azure.AI.OpenAI.Assistants.RunStepCodeInterpreterToolCall" />, <see cref="T:Azure.AI.OpenAI.Assistants.RunStepFunctionToolCall" /> and <see cref="T:Azure.AI.OpenAI.Assistants.RunStepRetrievalToolCall" />.
|
|
</param>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.RunStepToolCallDetails.#ctor">
|
|
<summary> Initializes a new instance of <see cref="T:Azure.AI.OpenAI.Assistants.RunStepToolCallDetails" /> for deserialization. </summary>
|
|
</member>
|
|
<member name="P:Azure.AI.OpenAI.Assistants.RunStepToolCallDetails.ToolCalls">
|
|
<summary>
|
|
A list of tool call details for this run step.
|
|
Please note <see cref="T:Azure.AI.OpenAI.Assistants.RunStepToolCall" /> is the base class. According to the scenario, a derived class of the base class might need to be assigned here, or this property needs to be casted to one of the possible derived classes.
|
|
The available derived classes include <see cref="T:Azure.AI.OpenAI.Assistants.RunStepCodeInterpreterToolCall" />, <see cref="T:Azure.AI.OpenAI.Assistants.RunStepFunctionToolCall" /> and <see cref="T:Azure.AI.OpenAI.Assistants.RunStepRetrievalToolCall" />.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.RunStepToolCallDetails.FromResponse(Azure.Response)">
|
|
<summary> Deserializes the model from a raw response. </summary>
|
|
<param name="response"> The response to deserialize the model from. </param>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.RunStepToolCallDetails.ToRequestContent">
|
|
<summary> Convert into a <see cref="T:Azure.Core.RequestContent" />. </summary>
|
|
</member>
|
|
<member name="T:Azure.AI.OpenAI.Assistants.RunStepType">
|
|
<summary> The possible types of run steps. </summary>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.RunStepType.#ctor(System.String)">
|
|
<summary> Initializes a new instance of <see cref="T:Azure.AI.OpenAI.Assistants.RunStepType" />. </summary>
|
|
<exception cref="T:System.ArgumentNullException"> <paramref name="value" /> is null. </exception>
|
|
</member>
|
|
<member name="P:Azure.AI.OpenAI.Assistants.RunStepType.MessageCreation">
|
|
<summary> Represents a run step to create a message. </summary>
|
|
</member>
|
|
<member name="P:Azure.AI.OpenAI.Assistants.RunStepType.ToolCalls">
|
|
<summary> Represents a run step that calls tools. </summary>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.RunStepType.op_Equality(Azure.AI.OpenAI.Assistants.RunStepType,Azure.AI.OpenAI.Assistants.RunStepType)">
|
|
<summary> Determines if two <see cref="T:Azure.AI.OpenAI.Assistants.RunStepType" /> values are the same. </summary>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.RunStepType.op_Inequality(Azure.AI.OpenAI.Assistants.RunStepType,Azure.AI.OpenAI.Assistants.RunStepType)">
|
|
<summary> Determines if two <see cref="T:Azure.AI.OpenAI.Assistants.RunStepType" /> values are not the same. </summary>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.RunStepType.op_Implicit(System.String)~Azure.AI.OpenAI.Assistants.RunStepType">
|
|
<summary> Converts a string to a <see cref="T:Azure.AI.OpenAI.Assistants.RunStepType" />. </summary>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.RunStepType.Equals(System.Object)">
|
|
<summary>Indicates whether this instance and a specified object are equal.</summary><param name="obj">The object to compare with the current instance.</param><returns><see langword="true" /> if <paramref name="obj" /> and this instance are the same type and represent the same value; otherwise, <see langword="false" />.</returns>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.RunStepType.Equals(Azure.AI.OpenAI.Assistants.RunStepType)">
|
|
<summary>Indicates whether the current object is equal to another object of the same type.</summary><param name="other">An object to compare with this object.</param><returns><see langword="true" /> if the current object is equal to the <paramref name="other" /> parameter; otherwise, <see langword="false" />.</returns>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.RunStepType.GetHashCode">
|
|
<summary>Returns the hash code for this instance.</summary><returns>A 32-bit signed integer that is the hash code for this instance.</returns>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.RunStepType.ToString">
|
|
<summary>Returns the fully qualified type name of this instance.</summary><returns>The fully qualified type name.</returns>
|
|
</member>
|
|
<member name="T:Azure.AI.OpenAI.Assistants.SubmitToolOutputsToRunRequest">
|
|
<summary> The SubmitToolOutputsToRunRequest. </summary>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.SubmitToolOutputsToRunRequest.#ctor(System.Collections.Generic.IEnumerable{Azure.AI.OpenAI.Assistants.ToolOutput})">
|
|
<summary> Initializes a new instance of <see cref="T:Azure.AI.OpenAI.Assistants.SubmitToolOutputsToRunRequest" />. </summary>
|
|
<param name="toolOutputs"> The list of tool outputs requested by tool calls from the specified run. </param>
|
|
<exception cref="T:System.ArgumentNullException"> <paramref name="toolOutputs" /> is null. </exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.SubmitToolOutputsToRunRequest.#ctor(System.Collections.Generic.IList{Azure.AI.OpenAI.Assistants.ToolOutput},System.Collections.Generic.IDictionary{System.String,System.BinaryData})">
|
|
<summary> Initializes a new instance of <see cref="T:Azure.AI.OpenAI.Assistants.SubmitToolOutputsToRunRequest" />. </summary>
|
|
<param name="toolOutputs"> The list of tool outputs requested by tool calls from the specified run. </param>
|
|
<param name="serializedAdditionalRawData"> Keeps track of any properties unknown to the library. </param>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.SubmitToolOutputsToRunRequest.#ctor">
|
|
<summary> Initializes a new instance of <see cref="T:Azure.AI.OpenAI.Assistants.SubmitToolOutputsToRunRequest" /> for deserialization. </summary>
|
|
</member>
|
|
<member name="P:Azure.AI.OpenAI.Assistants.SubmitToolOutputsToRunRequest.ToolOutputs">
|
|
<summary> The list of tool outputs requested by tool calls from the specified run. </summary>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.SubmitToolOutputsToRunRequest.FromResponse(Azure.Response)">
|
|
<summary> Deserializes the model from a raw response. </summary>
|
|
<param name="response"> The response to deserialize the model from. </param>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.SubmitToolOutputsToRunRequest.ToRequestContent">
|
|
<summary> Convert into a <see cref="T:Azure.Core.RequestContent" />. </summary>
|
|
</member>
|
|
<member name="T:Azure.AI.OpenAI.Assistants.ThreadDeletionStatus">
|
|
<summary> The status of a thread deletion operation. </summary>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.ThreadDeletionStatus.#ctor(System.String,System.Boolean)">
|
|
<summary> Initializes a new instance of <see cref="T:Azure.AI.OpenAI.Assistants.ThreadDeletionStatus" />. </summary>
|
|
<param name="id"> The ID of the resource specified for deletion. </param>
|
|
<param name="deleted"> A value indicating whether deletion was successful. </param>
|
|
<exception cref="T:System.ArgumentNullException"> <paramref name="id" /> is null. </exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.ThreadDeletionStatus.#ctor(System.String,System.Boolean,Azure.AI.OpenAI.Assistants.ThreadDeletionStatusObject,System.Collections.Generic.IDictionary{System.String,System.BinaryData})">
|
|
<summary> Initializes a new instance of <see cref="T:Azure.AI.OpenAI.Assistants.ThreadDeletionStatus" />. </summary>
|
|
<param name="id"> The ID of the resource specified for deletion. </param>
|
|
<param name="deleted"> A value indicating whether deletion was successful. </param>
|
|
<param name="object"> The object type, which is always 'thread.deleted'. </param>
|
|
<param name="serializedAdditionalRawData"> Keeps track of any properties unknown to the library. </param>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.ThreadDeletionStatus.#ctor">
|
|
<summary> Initializes a new instance of <see cref="T:Azure.AI.OpenAI.Assistants.ThreadDeletionStatus" /> for deserialization. </summary>
|
|
</member>
|
|
<member name="P:Azure.AI.OpenAI.Assistants.ThreadDeletionStatus.Id">
|
|
<summary> The ID of the resource specified for deletion. </summary>
|
|
</member>
|
|
<member name="P:Azure.AI.OpenAI.Assistants.ThreadDeletionStatus.Deleted">
|
|
<summary> A value indicating whether deletion was successful. </summary>
|
|
</member>
|
|
<member name="P:Azure.AI.OpenAI.Assistants.ThreadDeletionStatus.Object">
|
|
<summary> The object type, which is always 'thread.deleted'. </summary>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.ThreadDeletionStatus.FromResponse(Azure.Response)">
|
|
<summary> Deserializes the model from a raw response. </summary>
|
|
<param name="response"> The response to deserialize the model from. </param>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.ThreadDeletionStatus.ToRequestContent">
|
|
<summary> Convert into a <see cref="T:Azure.Core.RequestContent" />. </summary>
|
|
</member>
|
|
<member name="T:Azure.AI.OpenAI.Assistants.ThreadDeletionStatusObject">
|
|
<summary> The ThreadDeletionStatus_object. </summary>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.ThreadDeletionStatusObject.#ctor(System.String)">
|
|
<summary> Initializes a new instance of <see cref="T:Azure.AI.OpenAI.Assistants.ThreadDeletionStatusObject" />. </summary>
|
|
<exception cref="T:System.ArgumentNullException"> <paramref name="value" /> is null. </exception>
|
|
</member>
|
|
<member name="P:Azure.AI.OpenAI.Assistants.ThreadDeletionStatusObject.ThreadDeleted">
|
|
<summary> thread.deleted. </summary>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.ThreadDeletionStatusObject.op_Equality(Azure.AI.OpenAI.Assistants.ThreadDeletionStatusObject,Azure.AI.OpenAI.Assistants.ThreadDeletionStatusObject)">
|
|
<summary> Determines if two <see cref="T:Azure.AI.OpenAI.Assistants.ThreadDeletionStatusObject" /> values are the same. </summary>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.ThreadDeletionStatusObject.op_Inequality(Azure.AI.OpenAI.Assistants.ThreadDeletionStatusObject,Azure.AI.OpenAI.Assistants.ThreadDeletionStatusObject)">
|
|
<summary> Determines if two <see cref="T:Azure.AI.OpenAI.Assistants.ThreadDeletionStatusObject" /> values are not the same. </summary>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.ThreadDeletionStatusObject.op_Implicit(System.String)~Azure.AI.OpenAI.Assistants.ThreadDeletionStatusObject">
|
|
<summary> Converts a string to a <see cref="T:Azure.AI.OpenAI.Assistants.ThreadDeletionStatusObject" />. </summary>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.ThreadDeletionStatusObject.Equals(System.Object)">
|
|
<summary>Indicates whether this instance and a specified object are equal.</summary><param name="obj">The object to compare with the current instance.</param><returns><see langword="true" /> if <paramref name="obj" /> and this instance are the same type and represent the same value; otherwise, <see langword="false" />.</returns>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.ThreadDeletionStatusObject.Equals(Azure.AI.OpenAI.Assistants.ThreadDeletionStatusObject)">
|
|
<summary>Indicates whether the current object is equal to another object of the same type.</summary><param name="other">An object to compare with this object.</param><returns><see langword="true" /> if the current object is equal to the <paramref name="other" /> parameter; otherwise, <see langword="false" />.</returns>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.ThreadDeletionStatusObject.GetHashCode">
|
|
<summary>Returns the hash code for this instance.</summary><returns>A 32-bit signed integer that is the hash code for this instance.</returns>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.ThreadDeletionStatusObject.ToString">
|
|
<summary>Returns the fully qualified type name of this instance.</summary><returns>The fully qualified type name.</returns>
|
|
</member>
|
|
<member name="T:Azure.AI.OpenAI.Assistants.ThreadInitializationMessage">
|
|
<summary> A single message within an assistant thread, as provided during that thread's creation for its initial state. </summary>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.ThreadInitializationMessage.#ctor(Azure.AI.OpenAI.Assistants.MessageRole,System.String)">
|
|
<summary> Initializes a new instance of <see cref="T:Azure.AI.OpenAI.Assistants.ThreadInitializationMessage" />. </summary>
|
|
<param name="role"> The role associated with the assistant thread message. Currently, only 'user' is supported when providing initial messages to a new thread. </param>
|
|
<param name="content"> The textual content of the initial message. Currently, robust input including images and annotated text may only be provided via a separate call to the create message API. </param>
|
|
<exception cref="T:System.ArgumentNullException"> <paramref name="content" /> is null. </exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.ThreadInitializationMessage.#ctor(Azure.AI.OpenAI.Assistants.MessageRole,System.String,System.Collections.Generic.IList{System.String},System.Collections.Generic.IDictionary{System.String,System.String},System.Collections.Generic.IDictionary{System.String,System.BinaryData})">
|
|
<summary> Initializes a new instance of <see cref="T:Azure.AI.OpenAI.Assistants.ThreadInitializationMessage" />. </summary>
|
|
<param name="role"> The role associated with the assistant thread message. Currently, only 'user' is supported when providing initial messages to a new thread. </param>
|
|
<param name="content"> The textual content of the initial message. Currently, robust input including images and annotated text may only be provided via a separate call to the create message API. </param>
|
|
<param name="fileIds">
|
|
A list of file IDs that the assistant should use. Useful for tools like retrieval and code_interpreter that can
|
|
access files.
|
|
</param>
|
|
<param name="metadata"> 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. </param>
|
|
<param name="serializedAdditionalRawData"> Keeps track of any properties unknown to the library. </param>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.ThreadInitializationMessage.#ctor">
|
|
<summary> Initializes a new instance of <see cref="T:Azure.AI.OpenAI.Assistants.ThreadInitializationMessage" /> for deserialization. </summary>
|
|
</member>
|
|
<member name="P:Azure.AI.OpenAI.Assistants.ThreadInitializationMessage.Role">
|
|
<summary> The role associated with the assistant thread message. Currently, only 'user' is supported when providing initial messages to a new thread. </summary>
|
|
</member>
|
|
<member name="P:Azure.AI.OpenAI.Assistants.ThreadInitializationMessage.Content">
|
|
<summary> The textual content of the initial message. Currently, robust input including images and annotated text may only be provided via a separate call to the create message API. </summary>
|
|
</member>
|
|
<member name="P:Azure.AI.OpenAI.Assistants.ThreadInitializationMessage.FileIds">
|
|
<summary>
|
|
A list of file IDs that the assistant should use. Useful for tools like retrieval and code_interpreter that can
|
|
access files.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Azure.AI.OpenAI.Assistants.ThreadInitializationMessage.Metadata">
|
|
<summary> 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. </summary>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.ThreadInitializationMessage.FromResponse(Azure.Response)">
|
|
<summary> Deserializes the model from a raw response. </summary>
|
|
<param name="response"> The response to deserialize the model from. </param>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.ThreadInitializationMessage.ToRequestContent">
|
|
<summary> Convert into a <see cref="T:Azure.Core.RequestContent" />. </summary>
|
|
</member>
|
|
<member name="T:Azure.AI.OpenAI.Assistants.ToolDefinition">
|
|
<summary>
|
|
An abstract representation of an input tool definition that an assistant can use.
|
|
Please note <see cref="T:Azure.AI.OpenAI.Assistants.ToolDefinition" /> is the base class. According to the scenario, a derived class of the base class might need to be assigned here, or this property needs to be casted to one of the possible derived classes.
|
|
The available derived classes include <see cref="T:Azure.AI.OpenAI.Assistants.CodeInterpreterToolDefinition" />, <see cref="T:Azure.AI.OpenAI.Assistants.FunctionToolDefinition" /> and <see cref="T:Azure.AI.OpenAI.Assistants.RetrievalToolDefinition" />.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Azure.AI.OpenAI.Assistants.ToolDefinition._serializedAdditionalRawData">
|
|
<summary>
|
|
Keeps track of any properties unknown to the library.
|
|
<para>
|
|
To assign an object to the value of this property use <see cref="M:System.BinaryData.FromObjectAsJson``1(``0,System.Text.Json.JsonSerializerOptions)" />.
|
|
</para>
|
|
<para>
|
|
To assign an already formatted json string to this property use <see cref="M:System.BinaryData.FromString(System.String)" />.
|
|
</para>
|
|
<para>
|
|
Examples:
|
|
<list type="bullet">
|
|
<item>
|
|
<term>BinaryData.FromObjectAsJson("foo")</term>
|
|
<description>Creates a payload of "foo".</description>
|
|
</item>
|
|
<item>
|
|
<term>BinaryData.FromString("\"foo\"")</term>
|
|
<description>Creates a payload of "foo".</description>
|
|
</item>
|
|
<item>
|
|
<term>BinaryData.FromObjectAsJson(new { key = "value" })</term>
|
|
<description>Creates a payload of { "key": "value" }.</description>
|
|
</item>
|
|
<item>
|
|
<term>BinaryData.FromString("{\"key\": \"value\"}")</term>
|
|
<description>Creates a payload of { "key": "value" }.</description>
|
|
</item>
|
|
</list>
|
|
</para>
|
|
</summary>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.ToolDefinition.#ctor">
|
|
<summary> Initializes a new instance of <see cref="T:Azure.AI.OpenAI.Assistants.ToolDefinition" />. </summary>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.ToolDefinition.#ctor(System.String,System.Collections.Generic.IDictionary{System.String,System.BinaryData})">
|
|
<summary> Initializes a new instance of <see cref="T:Azure.AI.OpenAI.Assistants.ToolDefinition" />. </summary>
|
|
<param name="type"> The object type. </param>
|
|
<param name="serializedAdditionalRawData"> Keeps track of any properties unknown to the library. </param>
|
|
</member>
|
|
<member name="P:Azure.AI.OpenAI.Assistants.ToolDefinition.Type">
|
|
<summary> The object type. </summary>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.ToolDefinition.FromResponse(Azure.Response)">
|
|
<summary> Deserializes the model from a raw response. </summary>
|
|
<param name="response"> The response to deserialize the model from. </param>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.ToolDefinition.ToRequestContent">
|
|
<summary> Convert into a <see cref="T:Azure.Core.RequestContent" />. </summary>
|
|
</member>
|
|
<member name="T:Azure.AI.OpenAI.Assistants.UnknownMessageContent">
|
|
<summary> Unknown version of MessageContent. </summary>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.UnknownMessageContent.#ctor(System.String,System.Collections.Generic.IDictionary{System.String,System.BinaryData})">
|
|
<summary> Initializes a new instance of <see cref="T:Azure.AI.OpenAI.Assistants.UnknownMessageContent" />. </summary>
|
|
<param name="type"> The object type. </param>
|
|
<param name="serializedAdditionalRawData"> Keeps track of any properties unknown to the library. </param>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.UnknownMessageContent.#ctor">
|
|
<summary> Initializes a new instance of <see cref="T:Azure.AI.OpenAI.Assistants.UnknownMessageContent" /> for deserialization. </summary>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.UnknownMessageContent.FromResponse(Azure.Response)">
|
|
<summary> Deserializes the model from a raw response. </summary>
|
|
<param name="response"> The response to deserialize the model from. </param>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.UnknownMessageContent.ToRequestContent">
|
|
<summary> Convert into a <see cref="T:Azure.Core.RequestContent" />. </summary>
|
|
</member>
|
|
<member name="T:Azure.AI.OpenAI.Assistants.UnknownMessageTextAnnotation">
|
|
<summary> Unknown version of MessageTextAnnotation. </summary>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.UnknownMessageTextAnnotation.#ctor(System.String,System.String,System.Int32,System.Int32,System.Collections.Generic.IDictionary{System.String,System.BinaryData})">
|
|
<summary> Initializes a new instance of <see cref="T:Azure.AI.OpenAI.Assistants.UnknownMessageTextAnnotation" />. </summary>
|
|
<param name="type"> The object type. </param>
|
|
<param name="text"> The textual content associated with this text annotation item. </param>
|
|
<param name="startIndex"> The first text index associated with this text annotation. </param>
|
|
<param name="endIndex"> The last text index associated with this text annotation. </param>
|
|
<param name="serializedAdditionalRawData"> Keeps track of any properties unknown to the library. </param>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.UnknownMessageTextAnnotation.#ctor">
|
|
<summary> Initializes a new instance of <see cref="T:Azure.AI.OpenAI.Assistants.UnknownMessageTextAnnotation" /> for deserialization. </summary>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.UnknownMessageTextAnnotation.FromResponse(Azure.Response)">
|
|
<summary> Deserializes the model from a raw response. </summary>
|
|
<param name="response"> The response to deserialize the model from. </param>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.UnknownMessageTextAnnotation.ToRequestContent">
|
|
<summary> Convert into a <see cref="T:Azure.Core.RequestContent" />. </summary>
|
|
</member>
|
|
<member name="T:Azure.AI.OpenAI.Assistants.UnknownRequiredAction">
|
|
<summary> Unknown version of RequiredAction. </summary>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.UnknownRequiredAction.#ctor(System.String,System.Collections.Generic.IDictionary{System.String,System.BinaryData})">
|
|
<summary> Initializes a new instance of <see cref="T:Azure.AI.OpenAI.Assistants.UnknownRequiredAction" />. </summary>
|
|
<param name="type"> The object type. </param>
|
|
<param name="serializedAdditionalRawData"> Keeps track of any properties unknown to the library. </param>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.UnknownRequiredAction.#ctor">
|
|
<summary> Initializes a new instance of <see cref="T:Azure.AI.OpenAI.Assistants.UnknownRequiredAction" /> for deserialization. </summary>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.UnknownRequiredAction.FromResponse(Azure.Response)">
|
|
<summary> Deserializes the model from a raw response. </summary>
|
|
<param name="response"> The response to deserialize the model from. </param>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.UnknownRequiredAction.ToRequestContent">
|
|
<summary> Convert into a <see cref="T:Azure.Core.RequestContent" />. </summary>
|
|
</member>
|
|
<member name="T:Azure.AI.OpenAI.Assistants.UnknownRequiredToolCall">
|
|
<summary> Unknown version of RequiredToolCall. </summary>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.UnknownRequiredToolCall.#ctor(System.String,System.String,System.Collections.Generic.IDictionary{System.String,System.BinaryData})">
|
|
<summary> Initializes a new instance of <see cref="T:Azure.AI.OpenAI.Assistants.UnknownRequiredToolCall" />. </summary>
|
|
<param name="type"> The object type for the required tool call. </param>
|
|
<param name="id"> The ID of the tool call. This ID must be referenced when submitting tool outputs. </param>
|
|
<param name="serializedAdditionalRawData"> Keeps track of any properties unknown to the library. </param>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.UnknownRequiredToolCall.#ctor">
|
|
<summary> Initializes a new instance of <see cref="T:Azure.AI.OpenAI.Assistants.UnknownRequiredToolCall" /> for deserialization. </summary>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.UnknownRequiredToolCall.FromResponse(Azure.Response)">
|
|
<summary> Deserializes the model from a raw response. </summary>
|
|
<param name="response"> The response to deserialize the model from. </param>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.UnknownRequiredToolCall.ToRequestContent">
|
|
<summary> Convert into a <see cref="T:Azure.Core.RequestContent" />. </summary>
|
|
</member>
|
|
<member name="T:Azure.AI.OpenAI.Assistants.UnknownRunStepCodeInterpreterToolCallOutput">
|
|
<summary> Unknown version of RunStepCodeInterpreterToolCallOutput. </summary>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.UnknownRunStepCodeInterpreterToolCallOutput.#ctor(System.String,System.Collections.Generic.IDictionary{System.String,System.BinaryData})">
|
|
<summary> Initializes a new instance of <see cref="T:Azure.AI.OpenAI.Assistants.UnknownRunStepCodeInterpreterToolCallOutput" />. </summary>
|
|
<param name="type"> The object type. </param>
|
|
<param name="serializedAdditionalRawData"> Keeps track of any properties unknown to the library. </param>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.UnknownRunStepCodeInterpreterToolCallOutput.#ctor">
|
|
<summary> Initializes a new instance of <see cref="T:Azure.AI.OpenAI.Assistants.UnknownRunStepCodeInterpreterToolCallOutput" /> for deserialization. </summary>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.UnknownRunStepCodeInterpreterToolCallOutput.FromResponse(Azure.Response)">
|
|
<summary> Deserializes the model from a raw response. </summary>
|
|
<param name="response"> The response to deserialize the model from. </param>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.UnknownRunStepCodeInterpreterToolCallOutput.ToRequestContent">
|
|
<summary> Convert into a <see cref="T:Azure.Core.RequestContent" />. </summary>
|
|
</member>
|
|
<member name="T:Azure.AI.OpenAI.Assistants.UnknownRunStepDetails">
|
|
<summary> Unknown version of RunStepDetails. </summary>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.UnknownRunStepDetails.#ctor(Azure.AI.OpenAI.Assistants.RunStepType,System.Collections.Generic.IDictionary{System.String,System.BinaryData})">
|
|
<summary> Initializes a new instance of <see cref="T:Azure.AI.OpenAI.Assistants.UnknownRunStepDetails" />. </summary>
|
|
<param name="type"> The object type. </param>
|
|
<param name="serializedAdditionalRawData"> Keeps track of any properties unknown to the library. </param>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.UnknownRunStepDetails.#ctor">
|
|
<summary> Initializes a new instance of <see cref="T:Azure.AI.OpenAI.Assistants.UnknownRunStepDetails" /> for deserialization. </summary>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.UnknownRunStepDetails.FromResponse(Azure.Response)">
|
|
<summary> Deserializes the model from a raw response. </summary>
|
|
<param name="response"> The response to deserialize the model from. </param>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.UnknownRunStepDetails.ToRequestContent">
|
|
<summary> Convert into a <see cref="T:Azure.Core.RequestContent" />. </summary>
|
|
</member>
|
|
<member name="T:Azure.AI.OpenAI.Assistants.UnknownRunStepToolCall">
|
|
<summary> Unknown version of RunStepToolCall. </summary>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.UnknownRunStepToolCall.#ctor(System.String,System.String,System.Collections.Generic.IDictionary{System.String,System.BinaryData})">
|
|
<summary> Initializes a new instance of <see cref="T:Azure.AI.OpenAI.Assistants.UnknownRunStepToolCall" />. </summary>
|
|
<param name="type"> The object type. </param>
|
|
<param name="id"> The ID of the tool call. This ID must be referenced when you submit tool outputs. </param>
|
|
<param name="serializedAdditionalRawData"> Keeps track of any properties unknown to the library. </param>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.UnknownRunStepToolCall.#ctor">
|
|
<summary> Initializes a new instance of <see cref="T:Azure.AI.OpenAI.Assistants.UnknownRunStepToolCall" /> for deserialization. </summary>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.UnknownRunStepToolCall.FromResponse(Azure.Response)">
|
|
<summary> Deserializes the model from a raw response. </summary>
|
|
<param name="response"> The response to deserialize the model from. </param>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.UnknownRunStepToolCall.ToRequestContent">
|
|
<summary> Convert into a <see cref="T:Azure.Core.RequestContent" />. </summary>
|
|
</member>
|
|
<member name="T:Azure.AI.OpenAI.Assistants.UnknownToolDefinition">
|
|
<summary> Unknown version of ToolDefinition. </summary>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.UnknownToolDefinition.#ctor(System.String,System.Collections.Generic.IDictionary{System.String,System.BinaryData})">
|
|
<summary> Initializes a new instance of <see cref="T:Azure.AI.OpenAI.Assistants.UnknownToolDefinition" />. </summary>
|
|
<param name="type"> The object type. </param>
|
|
<param name="serializedAdditionalRawData"> Keeps track of any properties unknown to the library. </param>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.UnknownToolDefinition.#ctor">
|
|
<summary> Initializes a new instance of <see cref="T:Azure.AI.OpenAI.Assistants.UnknownToolDefinition" /> for deserialization. </summary>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.UnknownToolDefinition.FromResponse(Azure.Response)">
|
|
<summary> Deserializes the model from a raw response. </summary>
|
|
<param name="response"> The response to deserialize the model from. </param>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.UnknownToolDefinition.ToRequestContent">
|
|
<summary> Convert into a <see cref="T:Azure.Core.RequestContent" />. </summary>
|
|
</member>
|
|
<member name="T:Azure.AI.OpenAI.Assistants.UpdateAssistantOptions">
|
|
<summary> The request details to use when modifying an existing assistant. </summary>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.UpdateAssistantOptions.#ctor">
|
|
<summary> Initializes a new instance of <see cref="T:Azure.AI.OpenAI.Assistants.UpdateAssistantOptions" />. </summary>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.UpdateAssistantOptions.#ctor(System.String,System.String,System.String,System.String,System.Collections.Generic.IList{Azure.AI.OpenAI.Assistants.ToolDefinition},System.Collections.Generic.IList{System.String},System.Collections.Generic.IDictionary{System.String,System.String},System.Collections.Generic.IDictionary{System.String,System.BinaryData})">
|
|
<summary> Initializes a new instance of <see cref="T:Azure.AI.OpenAI.Assistants.UpdateAssistantOptions" />. </summary>
|
|
<param name="model"> The ID of the model to use. </param>
|
|
<param name="name"> The modified name for the assistant to use. </param>
|
|
<param name="description"> The modified description for the assistant to use. </param>
|
|
<param name="instructions"> The modified system instructions for the new assistant to use. </param>
|
|
<param name="tools">
|
|
The modified collection of tools to enable for the assistant.
|
|
Please note <see cref="T:Azure.AI.OpenAI.Assistants.ToolDefinition" /> is the base class. According to the scenario, a derived class of the base class might need to be assigned here, or this property needs to be casted to one of the possible derived classes.
|
|
The available derived classes include <see cref="T:Azure.AI.OpenAI.Assistants.CodeInterpreterToolDefinition" />, <see cref="T:Azure.AI.OpenAI.Assistants.FunctionToolDefinition" /> and <see cref="T:Azure.AI.OpenAI.Assistants.RetrievalToolDefinition" />.
|
|
</param>
|
|
<param name="fileIds"> The modified list of previously uploaded fileIDs to attach to the assistant. </param>
|
|
<param name="metadata"> 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. </param>
|
|
<param name="serializedAdditionalRawData"> Keeps track of any properties unknown to the library. </param>
|
|
</member>
|
|
<member name="P:Azure.AI.OpenAI.Assistants.UpdateAssistantOptions.Model">
|
|
<summary> The ID of the model to use. </summary>
|
|
</member>
|
|
<member name="P:Azure.AI.OpenAI.Assistants.UpdateAssistantOptions.Name">
|
|
<summary> The modified name for the assistant to use. </summary>
|
|
</member>
|
|
<member name="P:Azure.AI.OpenAI.Assistants.UpdateAssistantOptions.Description">
|
|
<summary> The modified description for the assistant to use. </summary>
|
|
</member>
|
|
<member name="P:Azure.AI.OpenAI.Assistants.UpdateAssistantOptions.Instructions">
|
|
<summary> The modified system instructions for the new assistant to use. </summary>
|
|
</member>
|
|
<member name="P:Azure.AI.OpenAI.Assistants.UpdateAssistantOptions.Tools">
|
|
<summary>
|
|
The modified collection of tools to enable for the assistant.
|
|
Please note <see cref="T:Azure.AI.OpenAI.Assistants.ToolDefinition" /> is the base class. According to the scenario, a derived class of the base class might need to be assigned here, or this property needs to be casted to one of the possible derived classes.
|
|
The available derived classes include <see cref="T:Azure.AI.OpenAI.Assistants.CodeInterpreterToolDefinition" />, <see cref="T:Azure.AI.OpenAI.Assistants.FunctionToolDefinition" /> and <see cref="T:Azure.AI.OpenAI.Assistants.RetrievalToolDefinition" />.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Azure.AI.OpenAI.Assistants.UpdateAssistantOptions.FileIds">
|
|
<summary> The modified list of previously uploaded fileIDs to attach to the assistant. </summary>
|
|
</member>
|
|
<member name="P:Azure.AI.OpenAI.Assistants.UpdateAssistantOptions.Metadata">
|
|
<summary> 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. </summary>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.UpdateAssistantOptions.FromResponse(Azure.Response)">
|
|
<summary> Deserializes the model from a raw response. </summary>
|
|
<param name="response"> The response to deserialize the model from. </param>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.UpdateAssistantOptions.ToRequestContent">
|
|
<summary> Convert into a <see cref="T:Azure.Core.RequestContent" />. </summary>
|
|
</member>
|
|
<member name="T:Azure.AI.OpenAI.Assistants.UpdateMessageRequest">
|
|
<summary> The UpdateMessageRequest. </summary>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.UpdateMessageRequest.#ctor">
|
|
<summary> Initializes a new instance of <see cref="T:Azure.AI.OpenAI.Assistants.UpdateMessageRequest" />. </summary>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.UpdateMessageRequest.#ctor(System.Collections.Generic.IDictionary{System.String,System.String},System.Collections.Generic.IDictionary{System.String,System.BinaryData})">
|
|
<summary> Initializes a new instance of <see cref="T:Azure.AI.OpenAI.Assistants.UpdateMessageRequest" />. </summary>
|
|
<param name="metadata"> 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. </param>
|
|
<param name="serializedAdditionalRawData"> Keeps track of any properties unknown to the library. </param>
|
|
</member>
|
|
<member name="P:Azure.AI.OpenAI.Assistants.UpdateMessageRequest.Metadata">
|
|
<summary> 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. </summary>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.UpdateMessageRequest.FromResponse(Azure.Response)">
|
|
<summary> Deserializes the model from a raw response. </summary>
|
|
<param name="response"> The response to deserialize the model from. </param>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.UpdateMessageRequest.ToRequestContent">
|
|
<summary> Convert into a <see cref="T:Azure.Core.RequestContent" />. </summary>
|
|
</member>
|
|
<member name="T:Azure.AI.OpenAI.Assistants.UpdateRunRequest">
|
|
<summary> The UpdateRunRequest. </summary>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.UpdateRunRequest.#ctor">
|
|
<summary> Initializes a new instance of <see cref="T:Azure.AI.OpenAI.Assistants.UpdateRunRequest" />. </summary>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.UpdateRunRequest.#ctor(System.Collections.Generic.IDictionary{System.String,System.String},System.Collections.Generic.IDictionary{System.String,System.BinaryData})">
|
|
<summary> Initializes a new instance of <see cref="T:Azure.AI.OpenAI.Assistants.UpdateRunRequest" />. </summary>
|
|
<param name="metadata"> 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. </param>
|
|
<param name="serializedAdditionalRawData"> Keeps track of any properties unknown to the library. </param>
|
|
</member>
|
|
<member name="P:Azure.AI.OpenAI.Assistants.UpdateRunRequest.Metadata">
|
|
<summary> 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. </summary>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.UpdateRunRequest.FromResponse(Azure.Response)">
|
|
<summary> Deserializes the model from a raw response. </summary>
|
|
<param name="response"> The response to deserialize the model from. </param>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.UpdateRunRequest.ToRequestContent">
|
|
<summary> Convert into a <see cref="T:Azure.Core.RequestContent" />. </summary>
|
|
</member>
|
|
<member name="T:Azure.AI.OpenAI.Assistants.UpdateThreadRequest">
|
|
<summary> The UpdateThreadRequest. </summary>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.UpdateThreadRequest.#ctor">
|
|
<summary> Initializes a new instance of <see cref="T:Azure.AI.OpenAI.Assistants.UpdateThreadRequest" />. </summary>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.UpdateThreadRequest.#ctor(System.Collections.Generic.IDictionary{System.String,System.String},System.Collections.Generic.IDictionary{System.String,System.BinaryData})">
|
|
<summary> Initializes a new instance of <see cref="T:Azure.AI.OpenAI.Assistants.UpdateThreadRequest" />. </summary>
|
|
<param name="metadata"> 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. </param>
|
|
<param name="serializedAdditionalRawData"> Keeps track of any properties unknown to the library. </param>
|
|
</member>
|
|
<member name="P:Azure.AI.OpenAI.Assistants.UpdateThreadRequest.Metadata">
|
|
<summary> 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. </summary>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.UpdateThreadRequest.FromResponse(Azure.Response)">
|
|
<summary> Deserializes the model from a raw response. </summary>
|
|
<param name="response"> The response to deserialize the model from. </param>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.UpdateThreadRequest.ToRequestContent">
|
|
<summary> Convert into a <see cref="T:Azure.Core.RequestContent" />. </summary>
|
|
</member>
|
|
<member name="T:Azure.Core.ArrayBufferWriter`1">
|
|
<summary>
|
|
Represents a heap-based, array-backed output sink into which <typeparam name="T" /> data can be written.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Azure.Core.ArrayBufferWriter`1.#ctor">
|
|
<summary>
|
|
Creates an instance of an <see cref="T:Azure.Core.ArrayBufferWriter`1" />, in which data can be written to,
|
|
with the default initial capacity.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Azure.Core.ArrayBufferWriter`1.#ctor(System.Int32)">
|
|
<summary>
|
|
Creates an instance of an <see cref="T:Azure.Core.ArrayBufferWriter`1" />, in which data can be written to,
|
|
with an initial capacity specified.
|
|
</summary>
|
|
<param name="initialCapacity">The minimum capacity with which to initialize the underlying buffer.</param>
|
|
<exception cref="T:System.ArgumentException">
|
|
Thrown when <paramref name="initialCapacity" /> is not positive (i.e. less than or equal to 0).
|
|
</exception>
|
|
</member>
|
|
<member name="P:Azure.Core.ArrayBufferWriter`1.WrittenMemory">
|
|
<summary>
|
|
Returns the data written to the underlying buffer so far, as a <see cref="T:System.ReadOnlyMemory`1" />.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Azure.Core.ArrayBufferWriter`1.WrittenSpan">
|
|
<summary>
|
|
Returns the data written to the underlying buffer so far, as a <see cref="T:System.ReadOnlySpan`1" />.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Azure.Core.ArrayBufferWriter`1.WrittenCount">
|
|
<summary>
|
|
Returns the amount of data written to the underlying buffer so far.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Azure.Core.ArrayBufferWriter`1.Capacity">
|
|
<summary>
|
|
Returns the total amount of space within the underlying buffer.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Azure.Core.ArrayBufferWriter`1.FreeCapacity">
|
|
<summary>
|
|
Returns the amount of space available that can still be written into without forcing the underlying buffer to grow.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Azure.Core.ArrayBufferWriter`1.Clear">
|
|
<summary>
|
|
Clears the data written to the underlying buffer.
|
|
</summary>
|
|
<remarks>
|
|
You must clear the <see cref="T:Azure.Core.ArrayBufferWriter`1" /> before trying to re-use it.
|
|
</remarks>
|
|
</member>
|
|
<member name="M:Azure.Core.ArrayBufferWriter`1.Advance(System.Int32)">
|
|
<summary>
|
|
Notifies <see cref="T:System.Buffers.IBufferWriter`1" /> that <paramref name="count" /> amount of data was written to the output <see cref="T:System.Span`1" />/<see cref="T:System.Memory`1" />.
|
|
</summary>
|
|
<exception cref="T:System.ArgumentException">
|
|
Thrown when <paramref name="count" /> is negative.
|
|
</exception>
|
|
<exception cref="T:System.InvalidOperationException">
|
|
Thrown when attempting to advance past the end of the underlying buffer.
|
|
</exception>
|
|
<remarks>
|
|
You must request a new buffer after calling Advance to continue writing more data and cannot write to a previously acquired buffer.
|
|
</remarks>
|
|
</member>
|
|
<member name="M:Azure.Core.ArrayBufferWriter`1.GetMemory(System.Int32)">
|
|
<summary>
|
|
Returns a <see cref="T:System.Memory`1" /> to write to that is at least the requested length (specified by <paramref name="sizeHint" />).
|
|
If no <paramref name="sizeHint" /> is provided (or it's equal to <code>0</code>), some non-empty buffer is returned.
|
|
</summary>
|
|
<exception cref="T:System.ArgumentException">
|
|
Thrown when <paramref name="sizeHint" /> is negative.
|
|
</exception>
|
|
<remarks>
|
|
This will never return an empty <see cref="T:System.Memory`1" />.
|
|
</remarks>
|
|
<remarks>
|
|
There is no guarantee that successive calls will return the same buffer or the same-sized buffer.
|
|
</remarks>
|
|
<remarks>
|
|
You must request a new buffer after calling Advance to continue writing more data and cannot write to a previously acquired buffer.
|
|
</remarks>
|
|
</member>
|
|
<member name="M:Azure.Core.ArrayBufferWriter`1.GetSpan(System.Int32)">
|
|
<summary>
|
|
Returns a <see cref="T:System.Span`1" /> to write to that is at least the requested length (specified by <paramref name="sizeHint" />).
|
|
If no <paramref name="sizeHint" /> is provided (or it's equal to <code>0</code>), some non-empty buffer is returned.
|
|
</summary>
|
|
<exception cref="T:System.ArgumentException">
|
|
Thrown when <paramref name="sizeHint" /> is negative.
|
|
</exception>
|
|
<remarks>
|
|
This will never return an empty <see cref="T:System.Span`1" />.
|
|
</remarks>
|
|
<remarks>
|
|
There is no guarantee that successive calls will return the same buffer or the same-sized buffer.
|
|
</remarks>
|
|
<remarks>
|
|
You must request a new buffer after calling Advance to continue writing more data and cannot write to a previously acquired buffer.
|
|
</remarks>
|
|
</member>
|
|
<member name="M:Azure.Core.AzureKeyCredentialPolicy.#ctor(Azure.AzureKeyCredential,System.String,System.String)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Azure.Core.AzureKeyCredentialPolicy" /> class.
|
|
</summary>
|
|
<param name="credential">The <see cref="T:Azure.AzureKeyCredential" /> used to authenticate requests.</param>
|
|
<param name="name">The name of the key header used for the credential.</param>
|
|
<param name="prefix">The prefix to apply before the credential key. For example, a prefix of "SharedAccessKey" would result in
|
|
a value of "SharedAccessKey {credential.Key}" being stamped on the request header with header key of <paramref name="name" />.</param>
|
|
</member>
|
|
<member name="M:Azure.Core.AzureKeyCredentialPolicy.OnSendingRequest(Azure.Core.HttpMessage)">
|
|
<summary>
|
|
Method is invoked before the request is sent.
|
|
</summary><param name="message">The <see cref="T:Azure.Core.HttpMessage" /> containing the request.</param>
|
|
</member>
|
|
<member name="T:Azure.Core.AzureResourceProviderNamespaceAttribute">
|
|
<summary>
|
|
This attribute should be set on all client assemblies with value of one of the resource providers
|
|
from the https://docs.microsoft.com/azure/azure-resource-manager/management/azure-services-resource-providers list.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Azure.Core.MultipartContent">
|
|
<summary>
|
|
Provides a container for content encoded using multipart/form-data MIME type.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Azure.Core.MultipartContent.#ctor(System.String,System.String)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Azure.Core.MultipartContent" /> class.
|
|
</summary>
|
|
<param name="subtype">The multipart sub type.</param>
|
|
<param name="boundary">The boundary string for the multipart form data content.</param>
|
|
</member>
|
|
<member name="M:Azure.Core.MultipartContent.ApplyToRequest(Azure.Core.Request)">
|
|
<summary>
|
|
Add content type header to the request.
|
|
</summary>
|
|
<param name="request">The request.</param>
|
|
</member>
|
|
<member name="M:Azure.Core.MultipartContent.Add(Azure.Core.RequestContent)">
|
|
<summary>
|
|
Add HTTP content to a collection of RequestContent objects that
|
|
get serialized to multipart/form-data MIME type.
|
|
</summary>
|
|
<param name="content">The Request content to add to the collection.</param>
|
|
</member>
|
|
<member name="M:Azure.Core.MultipartContent.Add(Azure.Core.RequestContent,System.Collections.Generic.Dictionary{System.String,System.String})">
|
|
<summary>
|
|
Add HTTP content to a collection of RequestContent objects that
|
|
get serialized to multipart/form-data MIME type.
|
|
</summary>
|
|
<param name="content">The Request content to add to the collection.</param>
|
|
<param name="headers">The headers to add to the collection.</param>
|
|
</member>
|
|
<member name="M:Azure.Core.MultipartContent.Dispose">
|
|
<summary>
|
|
Frees resources held by the <see cref="T:Azure.Core.MultipartContent" /> object.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Azure.Core.MultipartContent.WriteTo(System.IO.Stream,System.Threading.CancellationToken)">
|
|
<summary>
|
|
|
|
</summary>
|
|
<param name="stream"></param>
|
|
<param name="cancellationToken"></param>
|
|
|
|
</member>
|
|
<member name="M:Azure.Core.MultipartContent.WriteToAsync(System.IO.Stream,System.Threading.CancellationToken)">
|
|
<summary>
|
|
|
|
</summary>
|
|
<param name="stream"></param>
|
|
<param name="cancellation"></param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:Azure.Core.MultipartContent.TryComputeLength(System.Int64@)">
|
|
<summary>
|
|
Attempts to compute the length of the underlying content, if available.
|
|
</summary>
|
|
<param name="length">The length of the underlying data.</param>
|
|
</member>
|
|
<member name="T:Azure.Core.MultipartFormDataContent">
|
|
<summary>
|
|
Provides a container for content encoded using multipart/form-data MIME type.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Azure.Core.MultipartFormDataContent.#ctor">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Azure.Core.MultipartFormDataContent" /> class.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Azure.Core.MultipartFormDataContent.#ctor(System.String)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Azure.Core.MultipartFormDataContent" /> class.
|
|
</summary>
|
|
<param name="boundary">The boundary string for the multipart form data content.</param>
|
|
</member>
|
|
<member name="M:Azure.Core.MultipartFormDataContent.Add(Azure.Core.RequestContent)">
|
|
<summary>
|
|
Add HTTP content to a collection of RequestContent objects that
|
|
get serialized to multipart/form-data MIME type.
|
|
</summary>
|
|
<param name="content">The Request content to add to the collection.</param>
|
|
</member>
|
|
<member name="M:Azure.Core.MultipartFormDataContent.Add(Azure.Core.RequestContent,System.Collections.Generic.Dictionary{System.String,System.String})">
|
|
<summary>
|
|
Add HTTP content to a collection of RequestContent objects that
|
|
get serialized to multipart/form-data MIME type.
|
|
</summary>
|
|
<param name="content">The Request content to add to the collection.</param>
|
|
<param name="headers">The headers to add to the collection.</param>
|
|
</member>
|
|
<member name="M:Azure.Core.MultipartFormDataContent.Add(Azure.Core.RequestContent,System.String,System.Collections.Generic.Dictionary{System.String,System.String})">
|
|
<summary>
|
|
Add HTTP content to a collection of RequestContent objects that
|
|
get serialized to multipart/form-data MIME type.
|
|
</summary>
|
|
<param name="content">The Request content to add to the collection.</param>
|
|
<param name="name">The name for the request content to add.</param>
|
|
<param name="headers">The headers to add to the collection.</param>
|
|
</member>
|
|
<member name="M:Azure.Core.MultipartFormDataContent.Add(Azure.Core.RequestContent,System.String,System.String,System.Collections.Generic.Dictionary{System.String,System.String})">
|
|
<summary>
|
|
Add HTTP content to a collection of RequestContent objects that
|
|
get serialized to multipart/form-data MIME type.
|
|
</summary>
|
|
<param name="content">The Request content to add to the collection.</param>
|
|
<param name="name">The name for the request content to add.</param>
|
|
<param name="fileName">The file name for the request content to add to the collection.</param>
|
|
<param name="headers">The headers to add to the collection.</param>
|
|
</member>
|
|
<member name="P:Azure.Core.CodeGenModelAttribute.Usage">
|
|
<summary>
|
|
Gets or sets a coma separated list of additional model usage modes. Allowed values: model, error, intput, output.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Azure.Core.CodeGenModelAttribute.Formats">
|
|
<summary>
|
|
Gets or sets a coma separated list of additional model serialization formats.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Azure.Core.CodeGenSerializationAttribute.PropertyName">
|
|
<summary>
|
|
Gets or sets the property name which these hooks should apply to
|
|
</summary>
|
|
</member>
|
|
<member name="P:Azure.Core.CodeGenSerializationAttribute.SerializationPath">
|
|
<summary>
|
|
Gets or sets the serialization path of the property in the JSON
|
|
</summary>
|
|
</member>
|
|
<member name="P:Azure.Core.CodeGenSerializationAttribute.SerializationValueHook">
|
|
<summary>
|
|
Gets or sets the method name to use when serializing the property value (property name excluded)
|
|
The signature of the serialization hook method must be or compatible with when invoking:
|
|
private void SerializeHook(Utf8JsonWriter writer);
|
|
</summary>
|
|
</member>
|
|
<member name="P:Azure.Core.CodeGenSerializationAttribute.DeserializationValueHook">
|
|
<summary>
|
|
Gets or sets the method name to use when deserializing the property value from the JSON
|
|
private static void DeserializationHook(JsonProperty property, ref TypeOfTheProperty propertyValue); // if the property is required
|
|
private static void DeserializationHook(JsonProperty property, ref Optional<TypeOfTheProperty> propertyValue); // if the property is optional
|
|
</summary>
|
|
</member>
|
|
<member name="P:Azure.Core.CodeGenSerializationAttribute.BicepSerializationValueHook">
|
|
<summary>
|
|
Gets or sets the method name to use when serializing the property value (property name excluded)
|
|
The signature of the serialization hook method must be or compatible with when invoking:
|
|
private void SerializeHook(StringBuilder builder);
|
|
</summary>
|
|
</member>
|
|
<member name="T:Azure.Core.AppContextSwitchHelper">
|
|
<summary>
|
|
Helper for interacting with AppConfig settings and their related Environment variable settings.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Azure.Core.AppContextSwitchHelper.GetConfigValue(System.String,System.String)">
|
|
<summary>
|
|
Determines if either an AppContext switch or its corresponding Environment Variable is set
|
|
</summary>
|
|
<param name="appContexSwitchName">Name of the AppContext switch.</param>
|
|
<param name="environmentVariableName">Name of the Environment variable.</param>
|
|
<returns>If the AppContext switch has been set, returns the value of the switch.
|
|
If the AppContext switch has not been set, returns the value of the environment variable.
|
|
False if neither is set.
|
|
</returns>
|
|
</member>
|
|
<member name="T:Azure.Core.AsyncLockWithValue`1">
|
|
<summary>
|
|
Primitive that combines async lock and value cache
|
|
</summary>
|
|
<typeparam name="T"></typeparam>
|
|
</member>
|
|
<member name="M:Azure.Core.AsyncLockWithValue`1.GetLockOrValueAsync(System.Boolean,System.Threading.CancellationToken)">
|
|
<summary>
|
|
Method that either returns cached value or acquire a lock.
|
|
If one caller has acquired a lock, other callers will be waiting for the lock to be released.
|
|
If value is set, lock is released and all waiters get that value.
|
|
If value isn't set, the next waiter in the queue will get the lock.
|
|
</summary>
|
|
<param name="async"></param>
|
|
<param name="cancellationToken"></param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="P:Azure.Core.AsyncLockWithValue`1.LockOrValue.HasValue">
|
|
<summary>
|
|
Returns true if lock contains the cached value. Otherwise false.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Azure.Core.AsyncLockWithValue`1.LockOrValue.Value">
|
|
<summary>
|
|
Returns cached value if it was set when lock has been created. Throws exception otherwise.
|
|
</summary>
|
|
<exception cref="T:System.InvalidOperationException">Value isn't set.</exception>
|
|
</member>
|
|
<member name="M:Azure.Core.AsyncLockWithValue`1.LockOrValue.SetValue(`0)">
|
|
<summary>
|
|
Set value to the cache and to all the waiters.
|
|
</summary>
|
|
<param name="value"></param>
|
|
<exception cref="T:System.InvalidOperationException">Value is set already.</exception>
|
|
</member>
|
|
<member name="M:Azure.Core.Pipeline.ClientDiagnostics.#ctor(Azure.Core.ClientOptions,System.Nullable{System.Boolean})">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Azure.Core.Pipeline.ClientDiagnostics" /> class.
|
|
</summary>
|
|
<param name="options">The customer provided client options object.</param>
|
|
<param name="suppressNestedClientActivities">Flag controlling if <see cref="T:System.Diagnostics.Activity" />
|
|
created by this <see cref="T:Azure.Core.Pipeline.ClientDiagnostics" /> for client method calls should be suppressed when called
|
|
by other Azure SDK client methods. It's recommended to set it to true for new clients; use default (null)
|
|
for backward compatibility reasons, or set it to false to explicitly disable suppression for specific cases.
|
|
The default value could change in the future, the flag should be only set to false if suppression for the client
|
|
should never be enabled.</param>
|
|
</member>
|
|
<member name="M:Azure.Core.Pipeline.ClientDiagnostics.#ctor(System.String,System.String,Azure.Core.DiagnosticsOptions,System.Nullable{System.Boolean})">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Azure.Core.Pipeline.ClientDiagnostics" /> class.
|
|
</summary>
|
|
<param name="optionsNamespace">Namespace of the client class, such as Azure.Storage or Azure.AppConfiguration.</param>
|
|
<param name="providerNamespace">Azure Resource Provider namespace of the Azure service SDK is primarily used for.</param>
|
|
<param name="diagnosticsOptions">The customer provided client diagnostics options.</param>
|
|
<param name="suppressNestedClientActivities">Flag controlling if <see cref="T:System.Diagnostics.Activity" />
|
|
created by this <see cref="T:Azure.Core.Pipeline.ClientDiagnostics" /> for client method calls should be suppressed when called
|
|
by other Azure SDK client methods. It's recommended to set it to true for new clients, use default (null) for old clients
|
|
for backward compatibility reasons, or set it to false to explicitly disable suppression for specific cases.
|
|
The default value could change in the future, the flag should be only set to false if suppression for the client
|
|
should never be enabled.</param>
|
|
</member>
|
|
<member name="M:Azure.Core.Pipeline.DiagnosticScope.AddLink(System.String,System.String,System.Collections.Generic.IDictionary{System.String,System.Object})">
|
|
<summary>
|
|
Adds a link to the scope. This must be called before <see cref="M:Azure.Core.Pipeline.DiagnosticScope.Start" /> has been called for the DiagnosticScope.
|
|
</summary>
|
|
<param name="traceparent">The traceparent for the link.</param>
|
|
<param name="tracestate">The tracestate for the link.</param>
|
|
<param name="attributes">Optional attributes to associate with the link.</param>
|
|
</member>
|
|
<member name="M:Azure.Core.Pipeline.DiagnosticScope.SetTraceContext(System.String,System.String)">
|
|
<summary>
|
|
Sets the trace context for the current scope.
|
|
</summary>
|
|
<param name="traceparent">The trace parent to set for the current scope.</param>
|
|
<param name="tracestate">The trace state to set for the current scope.</param>
|
|
</member>
|
|
<member name="M:Azure.Core.Pipeline.DiagnosticScope.Failed(System.Exception)">
|
|
<summary>
|
|
Marks the scope as failed.
|
|
</summary>
|
|
<param name="exception">The exception to associate with the failed scope.</param>
|
|
</member>
|
|
<member name="M:Azure.Core.Pipeline.DiagnosticScope.Failed(System.String)">
|
|
<summary>
|
|
Marks the scope as failed with low-cardinality error.type attribute.
|
|
</summary>
|
|
<param name="errorCode">Error code to associate with the failed scope.</param>
|
|
</member>
|
|
<member name="T:Azure.Core.Pipeline.ActivityExtensions">
|
|
<summary>
|
|
Until Activity Source is no longer considered experimental.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Azure.Core.Pipeline.DiagnosticScopeFactory.#ctor(System.String,System.String,System.Boolean,System.Boolean,System.Boolean)">
|
|
<summary>
|
|
Creates diagnostic scope factory.
|
|
</summary>
|
|
<param name="clientNamespace">The namespace which is used as a prefix for all ActivitySources created by the factory and the name of DiagnosticSource (when used).</param>
|
|
<param name="resourceProviderNamespace">Azure resource provider namespace.</param>
|
|
<param name="isActivityEnabled">Flag indicating if distributed tracing is enabled.</param>
|
|
<param name="suppressNestedClientActivities">Flag indicating if nested Azure SDK activities describing public API calls should be suppressed.</param>
|
|
<param name="isStable">Whether instrumentation is considered stable. When false, experimental feature flag controls if tracing is enabled.</param>
|
|
</member>
|
|
<member name="T:Azure.Core.Pipeline.TaskExtensions.Enumerable`1">
|
|
<summary>
|
|
Both <see cref="T:Azure.Core.Pipeline.TaskExtensions.Enumerable`1" /> and <see cref="T:Azure.Core.Pipeline.TaskExtensions.Enumerator`1" /> are defined as public structs so that foreach can use duck typing
|
|
to call <see cref="M:Azure.Core.Pipeline.TaskExtensions.Enumerable`1.GetEnumerator" /> and avoid heap memory allocation.
|
|
Please don't delete this method and don't make these types private.
|
|
</summary>
|
|
<typeparam name="T"></typeparam>
|
|
</member>
|
|
<member name="T:Azure.Core.FixedDelayWithNoJitterStrategy">
|
|
<summary>
|
|
A delay strategy that uses a fixed delay with no jitter applied. This is used by data plane LROs.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Azure.Core.OperationInternal">
|
|
<summary>
|
|
A helper class used to build long-running operation instances. In order to use this helper:
|
|
<list type="number">
|
|
<item>Make sure your LRO implements the <see cref="T:Azure.Core.IOperation" /> interface.</item>
|
|
<item>Add a private <see cref="T:Azure.Core.OperationInternal" /> field to your LRO, and instantiate it during construction.</item>
|
|
<item>Delegate method calls to the <see cref="T:Azure.Core.OperationInternal" /> implementations.</item>
|
|
</list>
|
|
Supported members:
|
|
<list type="bullet">
|
|
<item>
|
|
<description><see cref="P:Azure.Core.OperationInternalBase.HasCompleted" /></description>
|
|
</item>
|
|
<item>
|
|
<description><see cref="P:Azure.Core.OperationInternalBase.RawResponse" />, used for <see cref="M:Azure.Operation.GetRawResponse" /></description>
|
|
</item>
|
|
<item>
|
|
<description><see cref="M:Azure.Core.OperationInternalBase.UpdateStatus(System.Threading.CancellationToken)" /></description>
|
|
</item>
|
|
<item>
|
|
<description><see cref="M:Azure.Core.OperationInternalBase.UpdateStatusAsync(System.Threading.CancellationToken)" /></description>
|
|
</item>
|
|
<item>
|
|
<description><see cref="M:Azure.Core.OperationInternalBase.WaitForCompletionResponseAsync(System.Threading.CancellationToken)" /></description>
|
|
</item>
|
|
<item>
|
|
<description><see cref="M:Azure.Core.OperationInternalBase.WaitForCompletionResponseAsync(System.TimeSpan,System.Threading.CancellationToken)" /></description>
|
|
</item>
|
|
</list>
|
|
</summary>
|
|
</member>
|
|
<member name="M:Azure.Core.OperationInternal.Succeeded(Azure.Response)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Azure.Core.OperationInternal" /> class in a final successful state.
|
|
</summary>
|
|
<param name="rawResponse">The final value of <see cref="P:Azure.Core.OperationInternalBase.RawResponse" />.</param>
|
|
</member>
|
|
<member name="M:Azure.Core.OperationInternal.Failed(Azure.Response,Azure.RequestFailedException)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Azure.Core.OperationInternal" /> class in a final failed state.
|
|
</summary>
|
|
<param name="rawResponse">The final value of <see cref="P:Azure.Core.OperationInternalBase.RawResponse" />.</param>
|
|
<param name="operationFailedException">The exception that will be thrown by <c>UpdateStatusAsync</c>.</param>
|
|
</member>
|
|
<member name="M:Azure.Core.OperationInternal.#ctor(Azure.Core.IOperation,Azure.Core.Pipeline.ClientDiagnostics,Azure.Response,System.String,System.Collections.Generic.IEnumerable{System.Collections.Generic.KeyValuePair{System.String,System.String}},Azure.Core.DelayStrategy)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Azure.Core.OperationInternal" /> class.
|
|
</summary>
|
|
<param name="operation">The long-running operation making use of this class. Passing "<c>this</c>" is expected.</param>
|
|
<param name="clientDiagnostics">Used for diagnostic scope and exception creation. This is expected to be the instance created during the construction of your main client.</param>
|
|
<param name="rawResponse">
|
|
The initial value of <see cref="P:Azure.Core.OperationInternalBase.RawResponse" />. Usually, long-running operation objects can be instantiated in two ways:
|
|
<list type="bullet">
|
|
<item>
|
|
When calling a client's "<c>Start<OperationName></c>" method, a service call is made to start the operation, and an <see cref="T:Azure.Operation" /> instance is returned.
|
|
In this case, the response received from this service call can be passed here.
|
|
</item>
|
|
<item>
|
|
When a user instantiates an <see cref="T:Azure.Operation" /> directly using a public constructor, there's no previous service call. In this case, passing <c>null</c> is expected.
|
|
</item>
|
|
</list>
|
|
</param>
|
|
<param name="operationTypeName">
|
|
The type name of the long-running operation making use of this class. Used when creating diagnostic scopes. If left <c>null</c>, the type name will be inferred based on the
|
|
parameter <paramref name="operation" />.
|
|
</param>
|
|
<param name="scopeAttributes">The attributes to use during diagnostic scope creation.</param>
|
|
<param name="fallbackStrategy"> The delay strategy to use. Default is <see cref="T:Azure.Core.FixedDelayWithNoJitterStrategy" />.</param>
|
|
</member>
|
|
<member name="T:Azure.Core.IOperation">
|
|
<summary>
|
|
An interface used by <see cref="T:Azure.Core.OperationInternal" /> for making service calls and updating state. It's expected that
|
|
your long-running operation classes implement this interface.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Azure.Core.IOperation.UpdateStateAsync(System.Boolean,System.Threading.CancellationToken)">
|
|
<summary>
|
|
Calls the service and updates the state of the long-running operation. Properties directly handled by the
|
|
<see cref="T:Azure.Core.OperationInternal" /> class, such as <see cref="P:Azure.Core.OperationInternalBase.RawResponse" />
|
|
don't need to be updated. Operation-specific properties, such as "<c>CreateOn</c>" or "<c>LastModified</c>",
|
|
must be manually updated by the operation implementing this method.
|
|
<example>Usage example:
|
|
<code>
|
|
async ValueTask<OperationState> IOperation.UpdateStateAsync(bool async, CancellationToken cancellationToken)<br />
|
|
{<br />
|
|
Response<R> response = async ? <async service call> : <sync service call>;<br />
|
|
if (<operation succeeded>) return OperationState.Success(response.GetRawResponse(), <parse response>);<br />
|
|
if (<operation failed>) return OperationState.Failure(response.GetRawResponse());<br />
|
|
return OperationState.Pending(response.GetRawResponse());<br />
|
|
}
|
|
</code>
|
|
</example>
|
|
</summary>
|
|
<param name="async"><c>true</c> if the call should be executed asynchronously. Otherwise, <c>false</c>.</param>
|
|
<param name="cancellationToken">A <see cref="T:System.Threading.CancellationToken" /> controlling the request lifetime.</param>
|
|
<returns>
|
|
A structure indicating the current operation state. The <see cref="T:Azure.Core.OperationState" /> structure must be instantiated by one of
|
|
its static methods:
|
|
<list type="bullet">
|
|
<item>Use <see cref="M:Azure.Core.OperationState.Success(Azure.Response)" /> when the operation has completed successfully.</item>
|
|
<item>Use <see cref="M:Azure.Core.OperationState.Failure(Azure.Response,Azure.RequestFailedException)" /> when the operation has completed with failures.</item>
|
|
<item>Use <see cref="M:Azure.Core.OperationState.Pending(Azure.Response)" /> when the operation has not completed yet.</item>
|
|
</list>
|
|
</returns>
|
|
</member>
|
|
<member name="T:Azure.Core.OperationState">
|
|
<summary>
|
|
A helper structure passed to <see cref="T:Azure.Core.OperationInternal" /> to indicate the current operation state. This structure must be
|
|
instantiated by one of its static methods, depending on the operation state:
|
|
<list type="bullet">
|
|
<item>Use <see cref="M:Azure.Core.OperationState.Success(Azure.Response)" /> when the operation has completed successfully.</item>
|
|
<item>Use <see cref="M:Azure.Core.OperationState.Failure(Azure.Response,Azure.RequestFailedException)" /> when the operation has completed with failures.</item>
|
|
<item>Use <see cref="M:Azure.Core.OperationState.Pending(Azure.Response)" /> when the operation has not completed yet.</item>
|
|
</list>
|
|
</summary>
|
|
</member>
|
|
<member name="M:Azure.Core.OperationState.Success(Azure.Response)">
|
|
<summary>
|
|
Instantiates an <see cref="T:Azure.Core.OperationState" /> indicating the operation has completed successfully.
|
|
</summary>
|
|
<param name="rawResponse">The HTTP response obtained during the status update.</param>
|
|
<returns>A new <see cref="T:Azure.Core.OperationState" /> instance.</returns>
|
|
<exception cref="T:System.ArgumentNullException">Thrown if <paramref name="rawResponse" /> is <c>null</c>.</exception>
|
|
</member>
|
|
<member name="M:Azure.Core.OperationState.Failure(Azure.Response,Azure.RequestFailedException)">
|
|
<summary>
|
|
Instantiates an <see cref="T:Azure.Core.OperationState" /> indicating the operation has completed with failures.
|
|
</summary>
|
|
<param name="rawResponse">The HTTP response obtained during the status update.</param>
|
|
<param name="operationFailedException">
|
|
The exception to throw from <c>UpdateStatus</c> because of the operation failure. If left <c>null</c>,
|
|
a default exception is created based on the <paramref name="rawResponse" /> parameter.
|
|
</param>
|
|
<returns>A new <see cref="T:Azure.Core.OperationState" /> instance.</returns>
|
|
<exception cref="T:System.ArgumentNullException">Thrown if <paramref name="rawResponse" /> is <c>null</c>.</exception>
|
|
</member>
|
|
<member name="M:Azure.Core.OperationState.Pending(Azure.Response)">
|
|
<summary>
|
|
Instantiates an <see cref="T:Azure.Core.OperationState" /> indicating the operation has not completed yet.
|
|
</summary>
|
|
<param name="rawResponse">The HTTP response obtained during the status update.</param>
|
|
<returns>A new <see cref="T:Azure.Core.OperationState" /> instance.</returns>
|
|
<exception cref="T:System.ArgumentNullException">Thrown if <paramref name="rawResponse" /> is <c>null</c>.</exception>
|
|
</member>
|
|
<member name="P:Azure.Core.OperationInternalBase.RawResponse">
|
|
<summary>
|
|
The last HTTP response received from the server. Its update already handled in calls to "<c>UpdateStatus</c>" and
|
|
"<c>WaitForCompletionAsync</c>", but custom methods not supported by this class, such as "<c>CancelOperation</c>",
|
|
must update it as well.
|
|
<example>Usage example:
|
|
<code>
|
|
public Response GetRawResponse() => _operationInternal.RawResponse;
|
|
</code>
|
|
</example>
|
|
</summary>
|
|
</member>
|
|
<member name="P:Azure.Core.OperationInternalBase.HasCompleted">
|
|
<summary>
|
|
Returns <c>true</c> if the long-running operation has completed.
|
|
<example>Usage example:
|
|
<code>
|
|
public bool HasCompleted => _operationInternal.HasCompleted;
|
|
</code>
|
|
</example>
|
|
</summary>
|
|
</member>
|
|
<member name="M:Azure.Core.OperationInternalBase.UpdateStatusAsync(System.Threading.CancellationToken)">
|
|
<summary>
|
|
Calls the server to get the latest status of the long-running operation, handling diagnostic scope creation for distributed
|
|
tracing. The default scope name can be changed with the "<c>operationTypeName</c>" parameter passed to the constructor.
|
|
<example>Usage example:
|
|
<code>
|
|
public async ValueTask<Response> UpdateStatusAsync(CancellationToken cancellationToken) =>
|
|
await _operationInternal.UpdateStatusAsync(cancellationToken).ConfigureAwait(false);
|
|
</code>
|
|
</example>
|
|
</summary>
|
|
<param name="cancellationToken">A <see cref="T:System.Threading.CancellationToken" /> controlling the request lifetime.</param>
|
|
<returns>The HTTP response received from the server.</returns>
|
|
<remarks>
|
|
After a successful run, this method will update <see cref="P:Azure.Core.OperationInternalBase.RawResponse" /> and might update <see cref="P:Azure.Core.OperationInternalBase.HasCompleted" />.
|
|
</remarks>
|
|
<exception cref="T:Azure.RequestFailedException">Thrown if there's been any issues during the connection, or if the operation has completed with failures.</exception>
|
|
</member>
|
|
<member name="M:Azure.Core.OperationInternalBase.UpdateStatus(System.Threading.CancellationToken)">
|
|
<summary>
|
|
Calls the server to get the latest status of the long-running operation, handling diagnostic scope creation for distributed
|
|
tracing. The default scope name can be changed with the "<c>operationTypeName</c>" parameter passed to the constructor.
|
|
<example>Usage example:
|
|
<code>
|
|
public Response UpdateStatus(CancellationToken cancellationToken) => _operationInternal.UpdateStatus(cancellationToken);
|
|
</code>
|
|
</example>
|
|
</summary>
|
|
<param name="cancellationToken">A <see cref="T:System.Threading.CancellationToken" /> controlling the request lifetime.</param>
|
|
<returns>The HTTP response received from the server.</returns>
|
|
<remarks>
|
|
After a successful run, this method will update <see cref="P:Azure.Core.OperationInternalBase.RawResponse" /> and might update <see cref="P:Azure.Core.OperationInternalBase.HasCompleted" />.
|
|
</remarks>
|
|
<exception cref="T:Azure.RequestFailedException">Thrown if there's been any issues during the connection, or if the operation has completed with failures.</exception>
|
|
</member>
|
|
<member name="M:Azure.Core.OperationInternalBase.WaitForCompletionResponseAsync(System.Threading.CancellationToken)">
|
|
<summary>
|
|
Periodically calls <see cref="M:Azure.Core.OperationInternalBase.UpdateStatusAsync(System.Threading.CancellationToken)" /> until the long-running operation completes.
|
|
After each service call, a retry-after header may be returned to communicate that there is no reason to poll
|
|
for status change until the specified time has passed. The maximum of the retry after value and the fallback strategy
|
|
is then used as the wait interval.
|
|
Headers supported are: "Retry-After", "retry-after-ms", and "x-ms-retry-after-ms",
|
|
<example>Usage example:
|
|
<code>
|
|
public async ValueTask<Response<T>> WaitForCompletionAsync(CancellationToken cancellationToken) =>
|
|
await _operationInternal.WaitForCompletionAsync(cancellationToken).ConfigureAwait(false);
|
|
</code>
|
|
</example>
|
|
</summary>
|
|
<param name="cancellationToken">A <see cref="T:System.Threading.CancellationToken" /> controlling the request lifetime.</param>
|
|
<returns>The last HTTP response received from the server, including the final result of the long-running operation.</returns>
|
|
<exception cref="T:Azure.RequestFailedException">Thrown if there's been any issues during the connection, or if the operation has completed with failures.</exception>
|
|
</member>
|
|
<member name="M:Azure.Core.OperationInternalBase.WaitForCompletionResponseAsync(System.TimeSpan,System.Threading.CancellationToken)">
|
|
<summary>
|
|
Periodically calls <see cref="M:Azure.Core.OperationInternalBase.UpdateStatusAsync(System.Threading.CancellationToken)" /> until the long-running operation completes. The interval
|
|
between calls is defined by the parameter <paramref name="pollingInterval" />, but it can change based on information returned
|
|
from the server. After each service call, a retry-after header may be returned to communicate that there is no reason to poll
|
|
for status change until the specified time has passed. In this case, the maximum value between the <paramref name="pollingInterval" />
|
|
parameter and the retry-after header is chosen as the wait interval. Headers supported are: "Retry-After", "retry-after-ms",
|
|
and "x-ms-retry-after-ms".
|
|
<example>Usage example:
|
|
<code>
|
|
public async ValueTask<Response<T>> WaitForCompletionAsync(TimeSpan pollingInterval, CancellationToken cancellationToken) =>
|
|
await _operationInternal.WaitForCompletionAsync(pollingInterval, cancellationToken).ConfigureAwait(false);
|
|
</code>
|
|
</example>
|
|
</summary>
|
|
<param name="pollingInterval">The interval between status requests to the server. <strong></strong></param>
|
|
<param name="cancellationToken">A <see cref="T:System.Threading.CancellationToken" /> controlling the request lifetime.</param>
|
|
<returns>The last HTTP response received from the server, including the final result of the long-running operation.</returns>
|
|
<exception cref="T:Azure.RequestFailedException">Thrown if there's been any issues during the connection, or if the operation has completed with failures.</exception>
|
|
</member>
|
|
<member name="M:Azure.Core.OperationInternalBase.WaitForCompletionResponse(System.Threading.CancellationToken)">
|
|
<summary>
|
|
Periodically calls <see cref="M:Azure.Core.OperationInternalBase.UpdateStatus(System.Threading.CancellationToken)" /> until the long-running operation completes.
|
|
After each service call, a retry-after header may be returned to communicate that there is no reason to poll
|
|
for status change until the specified time has passed. The maximum of the retry after value and the fallback strategy
|
|
is then used as the wait interval.
|
|
Headers supported are: "Retry-After", "retry-after-ms", and "x-ms-retry-after-ms",
|
|
and "x-ms-retry-after-ms".
|
|
<example>Usage example:
|
|
<code>
|
|
public async ValueTask<Response<T>> WaitForCompletionAsync(TimeSpan pollingInterval, CancellationToken cancellationToken) =>
|
|
await _operationInternal.WaitForCompletionAsync(pollingInterval, cancellationToken).ConfigureAwait(false);
|
|
</code>
|
|
</example>
|
|
</summary>
|
|
<param name="cancellationToken">A <see cref="T:System.Threading.CancellationToken" /> controlling the request lifetime.</param>
|
|
<returns>The last HTTP response received from the server, including the final result of the long-running operation.</returns>
|
|
<exception cref="T:Azure.RequestFailedException">Thrown if there's been any issues during the connection, or if the operation has completed with failures.</exception>
|
|
</member>
|
|
<member name="M:Azure.Core.OperationInternalBase.WaitForCompletionResponse(System.TimeSpan,System.Threading.CancellationToken)">
|
|
<summary>
|
|
Periodically calls <see cref="M:Azure.Core.OperationInternalBase.UpdateStatus(System.Threading.CancellationToken)" /> until the long-running operation completes. The interval
|
|
between calls is defined by the parameter <paramref name="pollingInterval" />, but it can change based on information returned
|
|
from the server. After each service call, a retry-after header may be returned to communicate that there is no reason to poll
|
|
for status change until the specified time has passed. In this case, the maximum value between the <paramref name="pollingInterval" />
|
|
parameter and the retry-after header is chosen as the wait interval. Headers supported are: "Retry-After", "retry-after-ms",
|
|
and "x-ms-retry-after-ms".
|
|
<example>Usage example:
|
|
<code>
|
|
public async ValueTask<Response<T>> WaitForCompletionAsync(TimeSpan pollingInterval, CancellationToken cancellationToken) =>
|
|
await _operationInternal.WaitForCompletionAsync(pollingInterval, cancellationToken).ConfigureAwait(false);
|
|
</code>
|
|
</example>
|
|
</summary>
|
|
<param name="pollingInterval">The interval between status requests to the server.</param>
|
|
<param name="cancellationToken">A <see cref="T:System.Threading.CancellationToken" /> controlling the request lifetime.</param>
|
|
<returns>The last HTTP response received from the server, including the final result of the long-running operation.</returns>
|
|
<exception cref="T:Azure.RequestFailedException">Thrown if there's been any issues during the connection, or if the operation has completed with failures.</exception>
|
|
</member>
|
|
<member name="T:Azure.Core.OperationInternal`1">
|
|
<summary>
|
|
A helper class used to build long-running operation instances. In order to use this helper:
|
|
<list type="number">
|
|
<item>Make sure your LRO implements the <see cref="T:Azure.Core.IOperation`1" /> interface.</item>
|
|
<item>Add a private <see cref="T:Azure.Core.OperationInternal`1" /> field to your LRO, and instantiate it during construction.</item>
|
|
<item>Delegate method calls to the <see cref="T:Azure.Core.OperationInternal`1" /> implementations.</item>
|
|
</list>
|
|
Supported members:
|
|
<list type="bullet">
|
|
<item>
|
|
<description><see cref="P:Azure.Core.OperationInternal`1.HasValue" /></description>
|
|
</item>
|
|
<item>
|
|
<description><see cref="P:Azure.Core.OperationInternalBase.HasCompleted" /></description>
|
|
</item>
|
|
<item>
|
|
<description><see cref="P:Azure.Core.OperationInternal`1.Value" /></description>
|
|
</item>
|
|
<item>
|
|
<description><see cref="P:Azure.Core.OperationInternalBase.RawResponse" />, used for <see cref="M:Azure.Operation.GetRawResponse" /></description>
|
|
</item>
|
|
<item>
|
|
<description><see cref="M:Azure.Core.OperationInternalBase.UpdateStatus(System.Threading.CancellationToken)" /></description>
|
|
</item>
|
|
<item>
|
|
<description><see cref="M:Azure.Core.OperationInternalBase.UpdateStatusAsync(System.Threading.CancellationToken)" /></description>
|
|
</item>
|
|
<item>
|
|
<description><see cref="M:Azure.Core.OperationInternal`1.WaitForCompletionAsync(System.Threading.CancellationToken)" /></description>
|
|
</item>
|
|
<item>
|
|
<description><see cref="M:Azure.Core.OperationInternal`1.WaitForCompletionAsync(System.TimeSpan,System.Threading.CancellationToken)" /></description>
|
|
</item>
|
|
</list>
|
|
</summary>
|
|
<typeparam name="T">The final result of the long-running operation. Must match the type used in <see cref="T:Azure.Operation`1" />.</typeparam>
|
|
</member>
|
|
<member name="M:Azure.Core.OperationInternal`1.Succeeded(Azure.Response,`0)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Azure.Core.OperationInternal" /> class in a final successful state.
|
|
</summary>
|
|
<param name="rawResponse">The final value of <see cref="P:Azure.Core.OperationInternalBase.RawResponse" />.</param>
|
|
<param name="value">The final result of the long-running operation.</param>
|
|
</member>
|
|
<member name="M:Azure.Core.OperationInternal`1.Failed(Azure.Response,Azure.RequestFailedException)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Azure.Core.OperationInternal" /> class in a final failed state.
|
|
</summary>
|
|
<param name="rawResponse">The final value of <see cref="P:Azure.Core.OperationInternalBase.RawResponse" />.</param>
|
|
<param name="operationFailedException">The exception that will be thrown by <c>UpdateStatusAsync</c>.</param>
|
|
</member>
|
|
<member name="M:Azure.Core.OperationInternal`1.#ctor(Azure.Core.IOperation{`0},Azure.Core.Pipeline.ClientDiagnostics,Azure.Response,System.String,System.Collections.Generic.IEnumerable{System.Collections.Generic.KeyValuePair{System.String,System.String}},Azure.Core.DelayStrategy)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Azure.Core.OperationInternal`1" /> class.
|
|
</summary>
|
|
<param name="operation">The long-running operation making use of this class. Passing "<c>this</c>" is expected.</param>
|
|
<param name="clientDiagnostics">Used for diagnostic scope and exception creation. This is expected to be the instance created during the construction of your main client.</param>
|
|
<param name="rawResponse">
|
|
The initial value of <see cref="P:Azure.Core.OperationInternalBase.RawResponse" />. Usually, long-running operation objects can be instantiated in two ways:
|
|
<list type="bullet">
|
|
<item>
|
|
When calling a client's "<c>Start<OperationName></c>" method, a service call is made to start the operation, and an <see cref="T:Azure.Operation`1" /> instance is returned.
|
|
In this case, the response received from this service call can be passed here.
|
|
</item>
|
|
<item>
|
|
When a user instantiates an <see cref="T:Azure.Operation`1" /> directly using a public constructor, there's no previous service call. In this case, passing <c>null</c> is expected.
|
|
</item>
|
|
</list>
|
|
</param>
|
|
<param name="operationTypeName">
|
|
The type name of the long-running operation making use of this class. Used when creating diagnostic scopes. If left <c>null</c>, the type name will be inferred based on the
|
|
parameter <paramref name="operation" />.
|
|
</param>
|
|
<param name="scopeAttributes">The attributes to use during diagnostic scope creation.</param>
|
|
<param name="fallbackStrategy">The delay strategy when Retry-After header is not present. When it is present, the longer of the two delays will be used.
|
|
Default is <see cref="T:Azure.Core.FixedDelayWithNoJitterStrategy" />.</param>
|
|
</member>
|
|
<member name="P:Azure.Core.OperationInternal`1.HasValue">
|
|
<summary>
|
|
Returns <c>true</c> if the long-running operation completed successfully and has produced a final result.
|
|
<example>Usage example:
|
|
<code>
|
|
public bool HasValue => _operationInternal.HasValue;
|
|
</code>
|
|
</example>
|
|
</summary>
|
|
</member>
|
|
<member name="P:Azure.Core.OperationInternal`1.Value">
|
|
<summary>
|
|
The final result of the long-running operation.
|
|
<example>Usage example:
|
|
<code>
|
|
public T Value => _operationInternal.Value;
|
|
</code>
|
|
</example>
|
|
</summary>
|
|
<exception cref="T:System.InvalidOperationException">Thrown when the operation has not completed yet.</exception>
|
|
<exception cref="T:Azure.RequestFailedException">Thrown when the operation has completed with failures.</exception>
|
|
</member>
|
|
<member name="M:Azure.Core.OperationInternal`1.WaitForCompletionAsync(System.Threading.CancellationToken)">
|
|
<summary>
|
|
Periodically calls <see cref="M:Azure.Core.OperationInternalBase.UpdateStatusAsync(System.Threading.CancellationToken)" /> until the long-running operation completes.
|
|
After each service call, a retry-after header may be returned to communicate that there is no reason to poll
|
|
for status change until the specified time has passed.
|
|
Headers supported are: "Retry-After", "retry-after-ms", and "x-ms-retry-after-ms",
|
|
<example>Usage example:
|
|
<code>
|
|
public async ValueTask<Response<T>> WaitForCompletionAsync(CancellationToken cancellationToken) =>
|
|
await _operationInternal.WaitForCompletionAsync(cancellationToken).ConfigureAwait(false);
|
|
</code>
|
|
</example>
|
|
</summary>
|
|
<param name="cancellationToken">A <see cref="T:System.Threading.CancellationToken" /> controlling the request lifetime.</param>
|
|
<returns>The last HTTP response received from the server, including the final result of the long-running operation.</returns>
|
|
<exception cref="T:Azure.RequestFailedException">Thrown if there's been any issues during the connection, or if the operation has completed with failures.</exception>
|
|
</member>
|
|
<member name="M:Azure.Core.OperationInternal`1.WaitForCompletionAsync(System.TimeSpan,System.Threading.CancellationToken)">
|
|
<summary>
|
|
Periodically calls <see cref="M:Azure.Core.OperationInternalBase.UpdateStatusAsync(System.Threading.CancellationToken)" /> until the long-running operation completes. The interval
|
|
between calls is defined by the parameter <paramref name="pollingInterval" />, but it can change based on information returned
|
|
from the server. After each service call, a retry-after header may be returned to communicate that there is no reason to poll
|
|
for status change until the specified time has passed. In this case, the maximum value between the <paramref name="pollingInterval" />
|
|
parameter and the retry-after header is chosen as the wait interval. Headers supported are: "Retry-After", "retry-after-ms",
|
|
and "x-ms-retry-after-ms".
|
|
<example>Usage example:
|
|
<code>
|
|
public async ValueTask<Response<T>> WaitForCompletionAsync(TimeSpan pollingInterval, CancellationToken cancellationToken) =>
|
|
await _operationInternal.WaitForCompletionAsync(pollingInterval, cancellationToken).ConfigureAwait(false);
|
|
</code>
|
|
</example>
|
|
</summary>
|
|
<param name="pollingInterval">The interval between status requests to the server.</param>
|
|
<param name="cancellationToken">A <see cref="T:System.Threading.CancellationToken" /> controlling the request lifetime.</param>
|
|
<returns>The last HTTP response received from the server, including the final result of the long-running operation.</returns>
|
|
<exception cref="T:Azure.RequestFailedException">Thrown if there's been any issues during the connection, or if the operation has completed with failures.</exception>
|
|
</member>
|
|
<member name="M:Azure.Core.OperationInternal`1.WaitForCompletion(System.Threading.CancellationToken)">
|
|
<summary>
|
|
Periodically calls <see cref="M:Azure.Core.OperationInternalBase.UpdateStatus(System.Threading.CancellationToken)" /> until the long-running operation completes.
|
|
After each service call, a retry-after header may be returned to communicate that there is no reason to poll
|
|
for status change until the specified time has passed.
|
|
Headers supported are: "Retry-After", "retry-after-ms", and "x-ms-retry-after-ms",
|
|
<example>Usage example:
|
|
<code>
|
|
public async ValueTask<Response<T>> WaitForCompletionAsync(CancellationToken cancellationToken) =>
|
|
await _operationInternal.WaitForCompletionAsync(cancellationToken).ConfigureAwait(false);
|
|
</code>
|
|
</example>
|
|
</summary>
|
|
<param name="cancellationToken">A <see cref="T:System.Threading.CancellationToken" /> controlling the request lifetime.</param>
|
|
<returns>The last HTTP response received from the server, including the final result of the long-running operation.</returns>
|
|
<exception cref="T:Azure.RequestFailedException">Thrown if there's been any issues during the connection, or if the operation has completed with failures.</exception>
|
|
</member>
|
|
<member name="M:Azure.Core.OperationInternal`1.WaitForCompletion(System.TimeSpan,System.Threading.CancellationToken)">
|
|
<summary>
|
|
Periodically calls <see cref="M:Azure.Core.OperationInternalBase.UpdateStatus(System.Threading.CancellationToken)" /> until the long-running operation completes. The interval
|
|
between calls is defined by the <see cref="T:Azure.Core.FixedDelayWithNoJitterStrategy" />, which takes into account any retry-after header that is returned
|
|
from the server.
|
|
<example>Usage example:
|
|
<code>
|
|
public async ValueTask<Response<T>> WaitForCompletionAsync(CancellationToken cancellationToken) =>
|
|
await _operationInternal.WaitForCompletionAsync(cancellationToken).ConfigureAwait(false);
|
|
</code>
|
|
</example>
|
|
</summary>
|
|
<param name="pollingInterval">The interval between status requests to the server.</param>
|
|
<param name="cancellationToken">A <see cref="T:System.Threading.CancellationToken" /> controlling the request lifetime.</param>
|
|
<returns>The last HTTP response received from the server, including the final result of the long-running operation.</returns>
|
|
<exception cref="T:Azure.RequestFailedException">Thrown if there's been any issues during the connection, or if the operation has completed with failures.</exception>
|
|
</member>
|
|
<member name="T:Azure.Core.IOperation`1">
|
|
<summary>
|
|
An interface used by <see cref="T:Azure.Core.OperationInternal`1" /> for making service calls and updating state. It's expected that
|
|
your long-running operation classes implement this interface.
|
|
</summary>
|
|
<typeparam name="T">The final result of the long-running operation. Must match the type used in <see cref="T:Azure.Operation`1" />.</typeparam>
|
|
</member>
|
|
<member name="M:Azure.Core.IOperation`1.UpdateStateAsync(System.Boolean,System.Threading.CancellationToken)">
|
|
<summary>
|
|
Calls the service and updates the state of the long-running operation. Properties directly handled by the
|
|
<see cref="T:Azure.Core.OperationInternal`1" /> class, such as <see cref="P:Azure.Core.OperationInternalBase.RawResponse" /> or
|
|
<see cref="P:Azure.Core.OperationInternal`1.Value" />, don't need to be updated. Operation-specific properties, such
|
|
as "<c>CreateOn</c>" or "<c>LastModified</c>", must be manually updated by the operation implementing this
|
|
method.
|
|
<example>Usage example:
|
|
<code>
|
|
async ValueTask<OperationState<T>> IOperation<T>.UpdateStateAsync(bool async, CancellationToken cancellationToken)<br />
|
|
{<br />
|
|
Response<R> response = async ? <async service call> : <sync service call>;<br />
|
|
if (<operation succeeded>) return OperationState<T>.Success(response.GetRawResponse(), <parse response>);<br />
|
|
if (<operation failed>) return OperationState<T>.Failure(response.GetRawResponse());<br />
|
|
return OperationState<T>.Pending(response.GetRawResponse());<br />
|
|
}
|
|
</code>
|
|
</example>
|
|
</summary>
|
|
<param name="async"><c>true</c> if the call should be executed asynchronously. Otherwise, <c>false</c>.</param>
|
|
<param name="cancellationToken">A <see cref="T:System.Threading.CancellationToken" /> controlling the request lifetime.</param>
|
|
<returns>
|
|
A structure indicating the current operation state. The <see cref="T:Azure.Core.OperationState`1" /> structure must be instantiated by one of
|
|
its static methods:
|
|
<list type="bullet">
|
|
<item>Use <see cref="M:Azure.Core.OperationState`1.Success(Azure.Response,`0)" /> when the operation has completed successfully.</item>
|
|
<item>Use <see cref="M:Azure.Core.OperationState`1.Failure(Azure.Response,Azure.RequestFailedException)" /> when the operation has completed with failures.</item>
|
|
<item>Use <see cref="M:Azure.Core.OperationState`1.Pending(Azure.Response)" /> when the operation has not completed yet.</item>
|
|
</list>
|
|
</returns>
|
|
</member>
|
|
<member name="T:Azure.Core.OperationState`1">
|
|
<summary>
|
|
A helper structure passed to <see cref="T:Azure.Core.OperationInternal`1" /> to indicate the current operation state. This structure must be
|
|
instantiated by one of its static methods, depending on the operation state:
|
|
<list type="bullet">
|
|
<item>Use <see cref="M:Azure.Core.OperationState`1.Success(Azure.Response,`0)" /> when the operation has completed successfully.</item>
|
|
<item>Use <see cref="M:Azure.Core.OperationState`1.Failure(Azure.Response,Azure.RequestFailedException)" /> when the operation has completed with failures.</item>
|
|
<item>Use <see cref="M:Azure.Core.OperationState`1.Pending(Azure.Response)" /> when the operation has not completed yet.</item>
|
|
</list>
|
|
</summary>
|
|
<typeparam name="T">The final result of the long-running operation. Must match the type used in <see cref="T:Azure.Operation`1" />.</typeparam>
|
|
</member>
|
|
<member name="M:Azure.Core.OperationState`1.Success(Azure.Response,`0)">
|
|
<summary>
|
|
Instantiates an <see cref="T:Azure.Core.OperationState`1" /> indicating the operation has completed successfully.
|
|
</summary>
|
|
<param name="rawResponse">The HTTP response obtained during the status update.</param>
|
|
<param name="value">The final result of the long-running operation.</param>
|
|
<returns>A new <see cref="T:Azure.Core.OperationState`1" /> instance.</returns>
|
|
<exception cref="T:System.ArgumentNullException">Thrown if <paramref name="rawResponse" /> or <paramref name="value" /> is <c>null</c>.</exception>
|
|
</member>
|
|
<member name="M:Azure.Core.OperationState`1.Failure(Azure.Response,Azure.RequestFailedException)">
|
|
<summary>
|
|
Instantiates an <see cref="T:Azure.Core.OperationState`1" /> indicating the operation has completed with failures.
|
|
</summary>
|
|
<param name="rawResponse">The HTTP response obtained during the status update.</param>
|
|
<param name="operationFailedException">
|
|
The exception to throw from <c>UpdateStatus</c> because of the operation failure. The same exception will be thrown when
|
|
<see cref="P:Azure.Core.OperationInternal`1.Value" /> is called. If left <c>null</c>, a default exception is created based on the
|
|
<paramref name="rawResponse" /> parameter.
|
|
</param>
|
|
<returns>A new <see cref="T:Azure.Core.OperationState`1" /> instance.</returns>
|
|
<exception cref="T:System.ArgumentNullException">Thrown if <paramref name="rawResponse" /> is <c>null</c>.</exception>
|
|
</member>
|
|
<member name="M:Azure.Core.OperationState`1.Pending(Azure.Response)">
|
|
<summary>
|
|
Instantiates an <see cref="T:Azure.Core.OperationState`1" /> indicating the operation has not completed yet.
|
|
</summary>
|
|
<param name="rawResponse">The HTTP response obtained during the status update.</param>
|
|
<returns>A new <see cref="T:Azure.Core.OperationState`1" /> instance.</returns>
|
|
<exception cref="T:System.ArgumentNullException">Thrown if <paramref name="rawResponse" /> is <c>null</c>.</exception>
|
|
</member>
|
|
<member name="T:Azure.Core.OperationPoller">
|
|
<summary>
|
|
Implementation of LRO polling logic.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Azure.Core.ProtocolOperation`1.Id">
|
|
<summary>
|
|
Gets an ID representing the operation that can be used to poll for
|
|
the status of the long-running operation.
|
|
There are cases that operation id is not available, we return "NOT_SET" for unavailable operation id.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Azure.Core.ProtocolOperation`1.Value">
|
|
<summary>
|
|
Final result of the long-running operation.
|
|
</summary><remarks>
|
|
This property can be accessed only after the operation completes successfully (HasValue is true).
|
|
</remarks>
|
|
</member>
|
|
<member name="P:Azure.Core.ProtocolOperation`1.HasCompleted">
|
|
<summary>
|
|
Returns true if the long-running operation completed.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Azure.Core.ProtocolOperation`1.HasValue">
|
|
<summary>
|
|
Returns true if the long-running operation completed successfully and has produced final result (accessible by Value property).
|
|
</summary>
|
|
</member>
|
|
<member name="M:Azure.Core.ProtocolOperation`1.GetRawResponse">
|
|
<summary>
|
|
The last HTTP response received from the server.
|
|
</summary><remarks>
|
|
The last response returned from the server during the lifecycle of this instance.
|
|
An instance of <see cref="T:Azure.Operation`1" /> sends requests to a server in UpdateStatusAsync, UpdateStatus, and other methods.
|
|
Responses from these requests can be accessed using GetRawResponse.
|
|
</remarks>
|
|
</member>
|
|
<member name="M:Azure.Core.ProtocolOperation`1.UpdateStatus(System.Threading.CancellationToken)">
|
|
<summary>
|
|
Calls the server to get updated status of the long-running operation.
|
|
</summary><param name="cancellationToken">A <see cref="T:System.Threading.CancellationToken" /> used for the service call.</param><returns>The HTTP response received from the server.</returns><remarks>
|
|
This operation will update the value returned from GetRawResponse and might update HasCompleted.
|
|
</remarks>
|
|
</member>
|
|
<member name="M:Azure.Core.ProtocolOperation`1.UpdateStatusAsync(System.Threading.CancellationToken)">
|
|
<summary>
|
|
Calls the server to get updated status of the long-running operation.
|
|
</summary><param name="cancellationToken">A <see cref="T:System.Threading.CancellationToken" /> used for the service call.</param><returns>The HTTP response received from the server.</returns><remarks>
|
|
This operation will update the value returned from GetRawResponse and might update HasCompleted.
|
|
</remarks>
|
|
</member>
|
|
<member name="M:Azure.Core.ProtocolOperation`1.WaitForCompletionAsync(System.Threading.CancellationToken)">
|
|
<summary>
|
|
Periodically calls the server till the long-running operation completes.
|
|
</summary><param name="cancellationToken">A <see cref="T:System.Threading.CancellationToken" /> used for the periodical service calls.</param><returns>The last HTTP response received from the server.</returns><remarks>
|
|
This method will periodically call UpdateStatusAsync till HasCompleted is true, then return the final result of the operation.
|
|
</remarks>
|
|
</member>
|
|
<member name="M:Azure.Core.ProtocolOperation`1.WaitForCompletionAsync(System.TimeSpan,System.Threading.CancellationToken)">
|
|
<summary>
|
|
Periodically calls the server till the long-running operation completes.
|
|
</summary><param name="pollingInterval">
|
|
The interval between status requests to the server.
|
|
The interval can change based on information returned from the server.
|
|
For example, the server might communicate to the client that there is not reason to poll for status change sooner than some time.
|
|
</param><param name="cancellationToken">A <see cref="T:System.Threading.CancellationToken" /> used for the periodical service calls.</param><returns>The last HTTP response received from the server.</returns><remarks>
|
|
This method will periodically call UpdateStatusAsync till HasCompleted is true, then return the final result of the operation.
|
|
</remarks>
|
|
</member>
|
|
<member name="T:Azure.Core.SequentialDelayStrategy">
|
|
<summary>
|
|
A delay strategy that uses a fixed sequence of delays with no jitter applied. This is used by management LROs.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Microsoft.Extensions.Azure.AIOpenAIAssistantsClientBuilderExtensions">
|
|
<summary> Extension methods to add <see cref="T:Azure.AI.OpenAI.Assistants.AssistantsClient" /> to client builder. </summary>
|
|
</member>
|
|
<member name="M:Microsoft.Extensions.Azure.AIOpenAIAssistantsClientBuilderExtensions.AddAssistantsClient``1(``0,System.Uri,Azure.AzureKeyCredential)">
|
|
<summary> Registers a <see cref="T:Azure.AI.OpenAI.Assistants.AssistantsClient" /> instance. </summary>
|
|
<param name="builder"> The builder to register with. </param>
|
|
<param name="endpoint"> An OpenAI endpoint supporting assistants functionality. </param>
|
|
<param name="credential"> A credential used to authenticate to an Azure Service. </param>
|
|
</member>
|
|
<member name="M:Microsoft.Extensions.Azure.AIOpenAIAssistantsClientBuilderExtensions.AddAssistantsClient``1(``0,System.Uri)">
|
|
<summary> Registers a <see cref="T:Azure.AI.OpenAI.Assistants.AssistantsClient" /> instance. </summary>
|
|
<param name="builder"> The builder to register with. </param>
|
|
<param name="endpoint"> An OpenAI endpoint supporting assistants functionality. </param>
|
|
</member>
|
|
<member name="M:Microsoft.Extensions.Azure.AIOpenAIAssistantsClientBuilderExtensions.AddAssistantsClient``2(``0,``1)">
|
|
<summary> Registers a <see cref="T:Azure.AI.OpenAI.Assistants.AssistantsClient" /> instance. </summary>
|
|
<param name="builder"> The builder to register with. </param>
|
|
<param name="configuration"> The configuration values. </param>
|
|
</member>
|
|
<member name="T:System.Diagnostics.CodeAnalysis.RequiresDynamicCodeAttribute">
|
|
<summary>
|
|
Indicates that the specified method requires the ability to generate new code at runtime,
|
|
for example through <see cref="N:System.Reflection" />.
|
|
</summary>
|
|
<remarks>
|
|
This allows tools to understand which methods are unsafe to call when compiling ahead of time.
|
|
</remarks>
|
|
</member>
|
|
<member name="M:System.Diagnostics.CodeAnalysis.RequiresDynamicCodeAttribute.#ctor(System.String)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:System.Diagnostics.CodeAnalysis.RequiresDynamicCodeAttribute" /> class
|
|
with the specified message.
|
|
</summary>
|
|
<param name="message">
|
|
A message that contains information about the usage of dynamic code.
|
|
</param>
|
|
</member>
|
|
<member name="P:System.Diagnostics.CodeAnalysis.RequiresDynamicCodeAttribute.Message">
|
|
<summary>
|
|
Gets a message that contains information about the usage of dynamic code.
|
|
</summary>
|
|
</member>
|
|
<member name="P:System.Diagnostics.CodeAnalysis.RequiresDynamicCodeAttribute.Url">
|
|
<summary>
|
|
Gets or sets an optional URL that contains more information about the method,
|
|
why it requires dynamic code, and what options a consumer has to deal with it.
|
|
</summary>
|
|
</member>
|
|
<member name="T:System.Diagnostics.CodeAnalysis.RequiresUnreferencedCodeAttribute">
|
|
<summary>
|
|
Indicates that the specified method requires dynamic access to code that is not referenced
|
|
statically, for example through <see cref="N:System.Reflection" />.
|
|
</summary>
|
|
<remarks>
|
|
This allows tools to understand which methods are unsafe to call when removing unreferenced
|
|
code from an application.
|
|
</remarks>
|
|
</member>
|
|
<member name="M:System.Diagnostics.CodeAnalysis.RequiresUnreferencedCodeAttribute.#ctor(System.String)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:System.Diagnostics.CodeAnalysis.RequiresUnreferencedCodeAttribute" /> class
|
|
with the specified message.
|
|
</summary>
|
|
<param name="message">
|
|
A message that contains information about the usage of unreferenced code.
|
|
</param>
|
|
</member>
|
|
<member name="P:System.Diagnostics.CodeAnalysis.RequiresUnreferencedCodeAttribute.Message">
|
|
<summary>
|
|
Gets a message that contains information about the usage of unreferenced code.
|
|
</summary>
|
|
</member>
|
|
<member name="P:System.Diagnostics.CodeAnalysis.RequiresUnreferencedCodeAttribute.Url">
|
|
<summary>
|
|
Gets or sets an optional URL that contains more information about the method,
|
|
why it requires unreferenced code, and what options a consumer has to deal with it.
|
|
</summary>
|
|
</member>
|
|
<member name="T:System.Diagnostics.CodeAnalysis.UnconditionalSuppressMessageAttribute">
|
|
<summary>
|
|
Suppresses reporting of a specific rule violation, allowing multiple suppressions on a
|
|
single code artifact.
|
|
</summary>
|
|
<remarks>
|
|
<see cref="T:System.Diagnostics.CodeAnalysis.UnconditionalSuppressMessageAttribute" /> is different than
|
|
<see cref="T:System.Diagnostics.CodeAnalysis.SuppressMessageAttribute" /> in that it doesn't have a
|
|
<see cref="T:System.Diagnostics.ConditionalAttribute" />. So it is always preserved in the compiled assembly.
|
|
</remarks>
|
|
</member>
|
|
<member name="M:System.Diagnostics.CodeAnalysis.UnconditionalSuppressMessageAttribute.#ctor(System.String,System.String)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:System.Diagnostics.CodeAnalysis.UnconditionalSuppressMessageAttribute" />
|
|
class, specifying the category of the tool and the identifier for an analysis rule.
|
|
</summary>
|
|
<param name="category">The category for the attribute.</param>
|
|
<param name="checkId">The identifier of the analysis rule the attribute applies to.</param>
|
|
</member>
|
|
<member name="P:System.Diagnostics.CodeAnalysis.UnconditionalSuppressMessageAttribute.Category">
|
|
<summary>
|
|
Gets the category identifying the classification of the attribute.
|
|
</summary>
|
|
<remarks>
|
|
The <see cref="P:System.Diagnostics.CodeAnalysis.UnconditionalSuppressMessageAttribute.Category" /> property describes the tool or tool analysis category
|
|
for which a message suppression attribute applies.
|
|
</remarks>
|
|
</member>
|
|
<member name="P:System.Diagnostics.CodeAnalysis.UnconditionalSuppressMessageAttribute.CheckId">
|
|
<summary>
|
|
Gets the identifier of the analysis tool rule to be suppressed.
|
|
</summary>
|
|
<remarks>
|
|
Concatenated together, the <see cref="P:System.Diagnostics.CodeAnalysis.UnconditionalSuppressMessageAttribute.Category" /> and <see cref="P:System.Diagnostics.CodeAnalysis.UnconditionalSuppressMessageAttribute.CheckId" />
|
|
properties form a unique check identifier.
|
|
</remarks>
|
|
</member>
|
|
<member name="P:System.Diagnostics.CodeAnalysis.UnconditionalSuppressMessageAttribute.Scope">
|
|
<summary>
|
|
Gets or sets the scope of the code that is relevant for the attribute.
|
|
</summary>
|
|
<remarks>
|
|
The Scope property is an optional argument that specifies the metadata scope for which
|
|
the attribute is relevant.
|
|
</remarks>
|
|
</member>
|
|
<member name="P:System.Diagnostics.CodeAnalysis.UnconditionalSuppressMessageAttribute.Target">
|
|
<summary>
|
|
Gets or sets a fully qualified path that represents the target of the attribute.
|
|
</summary>
|
|
<remarks>
|
|
The <see cref="P:System.Diagnostics.CodeAnalysis.UnconditionalSuppressMessageAttribute.Target" /> property is an optional argument identifying the analysis target
|
|
of the attribute. An example value is "System.IO.Stream.ctor():System.Void".
|
|
Because it is fully qualified, it can be long, particularly for targets such as parameters.
|
|
The analysis tool user interface should be capable of automatically formatting the parameter.
|
|
</remarks>
|
|
</member>
|
|
<member name="P:System.Diagnostics.CodeAnalysis.UnconditionalSuppressMessageAttribute.MessageId">
|
|
<summary>
|
|
Gets or sets an optional argument expanding on exclusion criteria.
|
|
</summary>
|
|
<remarks>
|
|
The <see cref="P:System.Diagnostics.CodeAnalysis.UnconditionalSuppressMessageAttribute.MessageId" /> property is an optional argument that specifies additional
|
|
exclusion where the literal metadata target is not sufficiently precise. For example,
|
|
the <see cref="T:System.Diagnostics.CodeAnalysis.UnconditionalSuppressMessageAttribute" /> cannot be applied within a method,
|
|
and it may be desirable to suppress a violation against a statement in the method that will
|
|
give a rule violation, but not against all statements in the method.
|
|
</remarks>
|
|
</member>
|
|
<member name="P:System.Diagnostics.CodeAnalysis.UnconditionalSuppressMessageAttribute.Justification">
|
|
<summary>
|
|
Gets or sets the justification for suppressing the code analysis message.
|
|
</summary>
|
|
</member>
|
|
<member name="T:System.Diagnostics.CodeAnalysis.DynamicDependencyAttribute">
|
|
<summary>
|
|
States a dependency that one member has on another.
|
|
</summary>
|
|
<remarks>
|
|
This can be used to inform tooling of a dependency that is otherwise not evident purely from
|
|
metadata and IL, for example a member relied on via reflection.
|
|
</remarks>
|
|
</member>
|
|
<member name="M:System.Diagnostics.CodeAnalysis.DynamicDependencyAttribute.#ctor(System.String)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:System.Diagnostics.CodeAnalysis.DynamicDependencyAttribute" /> class
|
|
with the specified signature of a member on the same type as the consumer.
|
|
</summary>
|
|
<param name="memberSignature">The signature of the member depended on.</param>
|
|
</member>
|
|
<member name="M:System.Diagnostics.CodeAnalysis.DynamicDependencyAttribute.#ctor(System.String,System.Type)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:System.Diagnostics.CodeAnalysis.DynamicDependencyAttribute" /> class
|
|
with the specified signature of a member on a <see cref="T:System.Type" />.
|
|
</summary>
|
|
<param name="memberSignature">The signature of the member depended on.</param>
|
|
<param name="type">The <see cref="T:System.Type" /> containing <paramref name="memberSignature" />.</param>
|
|
</member>
|
|
<member name="M:System.Diagnostics.CodeAnalysis.DynamicDependencyAttribute.#ctor(System.String,System.String,System.String)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:System.Diagnostics.CodeAnalysis.DynamicDependencyAttribute" /> class
|
|
with the specified signature of a member on a type in an assembly.
|
|
</summary>
|
|
<param name="memberSignature">The signature of the member depended on.</param>
|
|
<param name="typeName">The full name of the type containing the specified member.</param>
|
|
<param name="assemblyName">The assembly name of the type containing the specified member.</param>
|
|
</member>
|
|
<member name="M:System.Diagnostics.CodeAnalysis.DynamicDependencyAttribute.#ctor(System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes,System.Type)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:System.Diagnostics.CodeAnalysis.DynamicDependencyAttribute" /> class
|
|
with the specified types of members on a <see cref="T:System.Type" />.
|
|
</summary>
|
|
<param name="memberTypes">The types of members depended on.</param>
|
|
<param name="type">The <see cref="T:System.Type" /> containing the specified members.</param>
|
|
</member>
|
|
<member name="M:System.Diagnostics.CodeAnalysis.DynamicDependencyAttribute.#ctor(System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes,System.String,System.String)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:System.Diagnostics.CodeAnalysis.DynamicDependencyAttribute" /> class
|
|
with the specified types of members on a type in an assembly.
|
|
</summary>
|
|
<param name="memberTypes">The types of members depended on.</param>
|
|
<param name="typeName">The full name of the type containing the specified members.</param>
|
|
<param name="assemblyName">The assembly name of the type containing the specified members.</param>
|
|
</member>
|
|
<member name="P:System.Diagnostics.CodeAnalysis.DynamicDependencyAttribute.MemberSignature">
|
|
<summary>
|
|
Gets the signature of the member depended on.
|
|
</summary>
|
|
<remarks>
|
|
Either <see cref="P:System.Diagnostics.CodeAnalysis.DynamicDependencyAttribute.MemberSignature" /> must be a valid string or <see cref="P:System.Diagnostics.CodeAnalysis.DynamicDependencyAttribute.MemberTypes" />
|
|
must not equal <see cref="F:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.None" />, but not both.
|
|
</remarks>
|
|
</member>
|
|
<member name="P:System.Diagnostics.CodeAnalysis.DynamicDependencyAttribute.MemberTypes">
|
|
<summary>
|
|
Gets the <see cref="T:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes" /> which specifies the type
|
|
of members depended on.
|
|
</summary>
|
|
<remarks>
|
|
Either <see cref="P:System.Diagnostics.CodeAnalysis.DynamicDependencyAttribute.MemberSignature" /> must be a valid string or <see cref="P:System.Diagnostics.CodeAnalysis.DynamicDependencyAttribute.MemberTypes" />
|
|
must not equal <see cref="F:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.None" />, but not both.
|
|
</remarks>
|
|
</member>
|
|
<member name="P:System.Diagnostics.CodeAnalysis.DynamicDependencyAttribute.Type">
|
|
<summary>
|
|
Gets the <see cref="T:System.Type" /> containing the specified member.
|
|
</summary>
|
|
<remarks>
|
|
If neither <see cref="P:System.Diagnostics.CodeAnalysis.DynamicDependencyAttribute.Type" /> nor <see cref="P:System.Diagnostics.CodeAnalysis.DynamicDependencyAttribute.TypeName" /> are specified,
|
|
the type of the consumer is assumed.
|
|
</remarks>
|
|
</member>
|
|
<member name="P:System.Diagnostics.CodeAnalysis.DynamicDependencyAttribute.TypeName">
|
|
<summary>
|
|
Gets the full name of the type containing the specified member.
|
|
</summary>
|
|
<remarks>
|
|
If neither <see cref="P:System.Diagnostics.CodeAnalysis.DynamicDependencyAttribute.Type" /> nor <see cref="P:System.Diagnostics.CodeAnalysis.DynamicDependencyAttribute.TypeName" /> are specified,
|
|
the type of the consumer is assumed.
|
|
</remarks>
|
|
</member>
|
|
<member name="P:System.Diagnostics.CodeAnalysis.DynamicDependencyAttribute.AssemblyName">
|
|
<summary>
|
|
Gets the assembly name of the specified type.
|
|
</summary>
|
|
<remarks>
|
|
<see cref="P:System.Diagnostics.CodeAnalysis.DynamicDependencyAttribute.AssemblyName" /> is only valid when <see cref="P:System.Diagnostics.CodeAnalysis.DynamicDependencyAttribute.TypeName" /> is specified.
|
|
</remarks>
|
|
</member>
|
|
<member name="P:System.Diagnostics.CodeAnalysis.DynamicDependencyAttribute.Condition">
|
|
<summary>
|
|
Gets or sets the condition in which the dependency is applicable, e.g. "DEBUG".
|
|
</summary>
|
|
</member>
|
|
<member name="T:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMembersAttribute">
|
|
<summary>
|
|
Indicates that certain members on a specified <see cref="T:System.Type" /> are accessed dynamically,
|
|
for example through <see cref="N:System.Reflection" />.
|
|
</summary>
|
|
<remarks>
|
|
This allows tools to understand which members are being accessed during the execution
|
|
of a program.
|
|
|
|
This attribute is valid on members whose type is <see cref="T:System.Type" /> or <see cref="T:System.String" />.
|
|
|
|
When this attribute is applied to a location of type <see cref="T:System.String" />, the assumption is
|
|
that the string represents a fully qualified type name.
|
|
|
|
When this attribute is applied to a class, interface, or struct, the members specified
|
|
can be accessed dynamically on <see cref="T:System.Type" /> instances returned from calling
|
|
<see cref="M:System.Object.GetType" /> on instances of that class, interface, or struct.
|
|
|
|
If the attribute is applied to a method it's treated as a special case and it implies
|
|
the attribute should be applied to the "this" parameter of the method. As such the attribute
|
|
should only be used on instance methods of types assignable to System.Type (or string, but no methods
|
|
will use it there).
|
|
</remarks>
|
|
</member>
|
|
<member name="M:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMembersAttribute.#ctor(System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMembersAttribute" /> class
|
|
with the specified member types.
|
|
</summary>
|
|
<param name="memberTypes">The types of members dynamically accessed.</param>
|
|
</member>
|
|
<member name="P:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMembersAttribute.MemberTypes">
|
|
<summary>
|
|
Gets the <see cref="T:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes" /> which specifies the type
|
|
of members dynamically accessed.
|
|
</summary>
|
|
</member>
|
|
<member name="T:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes">
|
|
<summary>
|
|
Specifies the types of members that are dynamically accessed.
|
|
|
|
This enumeration has a <see cref="T:System.FlagsAttribute" /> attribute that allows a
|
|
bitwise combination of its member values.
|
|
</summary>
|
|
</member>
|
|
<member name="F:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.None">
|
|
<summary>
|
|
Specifies no members.
|
|
</summary>
|
|
</member>
|
|
<member name="F:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.PublicParameterlessConstructor">
|
|
<summary>
|
|
Specifies the default, parameterless public constructor.
|
|
</summary>
|
|
</member>
|
|
<member name="F:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.PublicConstructors">
|
|
<summary>
|
|
Specifies all public constructors.
|
|
</summary>
|
|
</member>
|
|
<member name="F:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.NonPublicConstructors">
|
|
<summary>
|
|
Specifies all non-public constructors.
|
|
</summary>
|
|
</member>
|
|
<member name="F:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.PublicMethods">
|
|
<summary>
|
|
Specifies all public methods.
|
|
</summary>
|
|
</member>
|
|
<member name="F:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.NonPublicMethods">
|
|
<summary>
|
|
Specifies all non-public methods.
|
|
</summary>
|
|
</member>
|
|
<member name="F:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.PublicFields">
|
|
<summary>
|
|
Specifies all public fields.
|
|
</summary>
|
|
</member>
|
|
<member name="F:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.NonPublicFields">
|
|
<summary>
|
|
Specifies all non-public fields.
|
|
</summary>
|
|
</member>
|
|
<member name="F:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.PublicNestedTypes">
|
|
<summary>
|
|
Specifies all public nested types.
|
|
</summary>
|
|
</member>
|
|
<member name="F:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.NonPublicNestedTypes">
|
|
<summary>
|
|
Specifies all non-public nested types.
|
|
</summary>
|
|
</member>
|
|
<member name="F:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.PublicProperties">
|
|
<summary>
|
|
Specifies all public properties.
|
|
</summary>
|
|
</member>
|
|
<member name="F:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.NonPublicProperties">
|
|
<summary>
|
|
Specifies all non-public properties.
|
|
</summary>
|
|
</member>
|
|
<member name="F:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.PublicEvents">
|
|
<summary>
|
|
Specifies all public events.
|
|
</summary>
|
|
</member>
|
|
<member name="F:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.NonPublicEvents">
|
|
<summary>
|
|
Specifies all non-public events.
|
|
</summary>
|
|
</member>
|
|
<member name="F:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.Interfaces">
|
|
<summary>
|
|
Specifies all interfaces implemented by the type.
|
|
</summary>
|
|
</member>
|
|
<member name="F:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.All">
|
|
<summary>
|
|
Specifies all members.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.FunctionToolDefinition.System#ClientModel#Primitives#IJsonModel{Azure#AI#OpenAI#Assistants#FunctionToolDefinition}#Write(System.Text.Json.Utf8JsonWriter,System.ClientModel.Primitives.ModelReaderWriterOptions)">
|
|
<summary>
|
|
Writes the model to the provided <see cref="T:System.Text.Json.Utf8JsonWriter" />.
|
|
</summary><param name="writer">The <see cref="T:System.Text.Json.Utf8JsonWriter" /> to write into.</param><param name="options">The <see cref="T:System.ClientModel.Primitives.ModelReaderWriterOptions" /> to use.</param><exception cref="T:System.FormatException">If the model does not support the requested <see cref="P:System.ClientModel.Primitives.ModelReaderWriterOptions.Format" />.</exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.FunctionToolDefinition.System#ClientModel#Primitives#IJsonModel{Azure#AI#OpenAI#Assistants#FunctionToolDefinition}#Create(System.Text.Json.Utf8JsonReader@,System.ClientModel.Primitives.ModelReaderWriterOptions)">
|
|
<summary>
|
|
Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model.
|
|
</summary><param name="reader">The <see cref="T:System.Text.Json.Utf8JsonReader" /> to read.</param><param name="options">The <see cref="T:System.ClientModel.Primitives.ModelReaderWriterOptions" /> to use.</param><returns>A <typeparamref name="T" /> representation of the JSON value.</returns><exception cref="T:System.FormatException">If the model does not support the requested <see cref="P:System.ClientModel.Primitives.ModelReaderWriterOptions.Format" />.</exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.FunctionToolDefinition.System#ClientModel#Primitives#IPersistableModel{Azure#AI#OpenAI#Assistants#FunctionToolDefinition}#Write(System.ClientModel.Primitives.ModelReaderWriterOptions)">
|
|
<summary>
|
|
Writes the model into a <see cref="T:System.BinaryData" />.
|
|
</summary><param name="options">The <see cref="T:System.ClientModel.Primitives.ModelReaderWriterOptions" /> to use.</param><returns>A binary representation of the written model.</returns><exception cref="T:System.FormatException">If the model does not support the requested <see cref="P:System.ClientModel.Primitives.ModelReaderWriterOptions.Format" />.</exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.FunctionToolDefinition.System#ClientModel#Primitives#IPersistableModel{Azure#AI#OpenAI#Assistants#FunctionToolDefinition}#Create(System.BinaryData,System.ClientModel.Primitives.ModelReaderWriterOptions)">
|
|
<summary>
|
|
Converts the provided <see cref="T:System.BinaryData" /> into a model.
|
|
</summary><param name="data">The <see cref="T:System.BinaryData" /> to parse.</param><param name="options">The <see cref="T:System.ClientModel.Primitives.ModelReaderWriterOptions" /> to use.</param><returns>A <typeparamref name="T" /> representation of the data.</returns><exception cref="T:System.FormatException">If the model does not support the requested <see cref="P:System.ClientModel.Primitives.ModelReaderWriterOptions.Format" />.</exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.FunctionToolDefinition.System#ClientModel#Primitives#IPersistableModel{Azure#AI#OpenAI#Assistants#FunctionToolDefinition}#GetFormatFromOptions(System.ClientModel.Primitives.ModelReaderWriterOptions)">
|
|
<summary>
|
|
Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service.
|
|
<param name="options">The <see cref="T:System.ClientModel.Primitives.ModelReaderWriterOptions" /> to use.</param></summary><returns>The format that the model uses when communicating with the serivce.</returns>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.MessageImageFileContent.System#ClientModel#Primitives#IJsonModel{Azure#AI#OpenAI#Assistants#MessageImageFileContent}#Write(System.Text.Json.Utf8JsonWriter,System.ClientModel.Primitives.ModelReaderWriterOptions)">
|
|
<summary>
|
|
Writes the model to the provided <see cref="T:System.Text.Json.Utf8JsonWriter" />.
|
|
</summary><param name="writer">The <see cref="T:System.Text.Json.Utf8JsonWriter" /> to write into.</param><param name="options">The <see cref="T:System.ClientModel.Primitives.ModelReaderWriterOptions" /> to use.</param><exception cref="T:System.FormatException">If the model does not support the requested <see cref="P:System.ClientModel.Primitives.ModelReaderWriterOptions.Format" />.</exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.MessageImageFileContent.System#ClientModel#Primitives#IJsonModel{Azure#AI#OpenAI#Assistants#MessageImageFileContent}#Create(System.Text.Json.Utf8JsonReader@,System.ClientModel.Primitives.ModelReaderWriterOptions)">
|
|
<summary>
|
|
Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model.
|
|
</summary><param name="reader">The <see cref="T:System.Text.Json.Utf8JsonReader" /> to read.</param><param name="options">The <see cref="T:System.ClientModel.Primitives.ModelReaderWriterOptions" /> to use.</param><returns>A <typeparamref name="T" /> representation of the JSON value.</returns><exception cref="T:System.FormatException">If the model does not support the requested <see cref="P:System.ClientModel.Primitives.ModelReaderWriterOptions.Format" />.</exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.MessageImageFileContent.System#ClientModel#Primitives#IPersistableModel{Azure#AI#OpenAI#Assistants#MessageImageFileContent}#Write(System.ClientModel.Primitives.ModelReaderWriterOptions)">
|
|
<summary>
|
|
Writes the model into a <see cref="T:System.BinaryData" />.
|
|
</summary><param name="options">The <see cref="T:System.ClientModel.Primitives.ModelReaderWriterOptions" /> to use.</param><returns>A binary representation of the written model.</returns><exception cref="T:System.FormatException">If the model does not support the requested <see cref="P:System.ClientModel.Primitives.ModelReaderWriterOptions.Format" />.</exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.MessageImageFileContent.System#ClientModel#Primitives#IPersistableModel{Azure#AI#OpenAI#Assistants#MessageImageFileContent}#Create(System.BinaryData,System.ClientModel.Primitives.ModelReaderWriterOptions)">
|
|
<summary>
|
|
Converts the provided <see cref="T:System.BinaryData" /> into a model.
|
|
</summary><param name="data">The <see cref="T:System.BinaryData" /> to parse.</param><param name="options">The <see cref="T:System.ClientModel.Primitives.ModelReaderWriterOptions" /> to use.</param><returns>A <typeparamref name="T" /> representation of the data.</returns><exception cref="T:System.FormatException">If the model does not support the requested <see cref="P:System.ClientModel.Primitives.ModelReaderWriterOptions.Format" />.</exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.MessageImageFileContent.System#ClientModel#Primitives#IPersistableModel{Azure#AI#OpenAI#Assistants#MessageImageFileContent}#GetFormatFromOptions(System.ClientModel.Primitives.ModelReaderWriterOptions)">
|
|
<summary>
|
|
Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service.
|
|
<param name="options">The <see cref="T:System.ClientModel.Primitives.ModelReaderWriterOptions" /> to use.</param></summary><returns>The format that the model uses when communicating with the serivce.</returns>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.MessageTextContent.System#ClientModel#Primitives#IJsonModel{Azure#AI#OpenAI#Assistants#MessageTextContent}#Write(System.Text.Json.Utf8JsonWriter,System.ClientModel.Primitives.ModelReaderWriterOptions)">
|
|
<summary>
|
|
Writes the model to the provided <see cref="T:System.Text.Json.Utf8JsonWriter" />.
|
|
</summary><param name="writer">The <see cref="T:System.Text.Json.Utf8JsonWriter" /> to write into.</param><param name="options">The <see cref="T:System.ClientModel.Primitives.ModelReaderWriterOptions" /> to use.</param><exception cref="T:System.FormatException">If the model does not support the requested <see cref="P:System.ClientModel.Primitives.ModelReaderWriterOptions.Format" />.</exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.MessageTextContent.System#ClientModel#Primitives#IJsonModel{Azure#AI#OpenAI#Assistants#MessageTextContent}#Create(System.Text.Json.Utf8JsonReader@,System.ClientModel.Primitives.ModelReaderWriterOptions)">
|
|
<summary>
|
|
Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model.
|
|
</summary><param name="reader">The <see cref="T:System.Text.Json.Utf8JsonReader" /> to read.</param><param name="options">The <see cref="T:System.ClientModel.Primitives.ModelReaderWriterOptions" /> to use.</param><returns>A <typeparamref name="T" /> representation of the JSON value.</returns><exception cref="T:System.FormatException">If the model does not support the requested <see cref="P:System.ClientModel.Primitives.ModelReaderWriterOptions.Format" />.</exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.MessageTextContent.System#ClientModel#Primitives#IPersistableModel{Azure#AI#OpenAI#Assistants#MessageTextContent}#Write(System.ClientModel.Primitives.ModelReaderWriterOptions)">
|
|
<summary>
|
|
Writes the model into a <see cref="T:System.BinaryData" />.
|
|
</summary><param name="options">The <see cref="T:System.ClientModel.Primitives.ModelReaderWriterOptions" /> to use.</param><returns>A binary representation of the written model.</returns><exception cref="T:System.FormatException">If the model does not support the requested <see cref="P:System.ClientModel.Primitives.ModelReaderWriterOptions.Format" />.</exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.MessageTextContent.System#ClientModel#Primitives#IPersistableModel{Azure#AI#OpenAI#Assistants#MessageTextContent}#Create(System.BinaryData,System.ClientModel.Primitives.ModelReaderWriterOptions)">
|
|
<summary>
|
|
Converts the provided <see cref="T:System.BinaryData" /> into a model.
|
|
</summary><param name="data">The <see cref="T:System.BinaryData" /> to parse.</param><param name="options">The <see cref="T:System.ClientModel.Primitives.ModelReaderWriterOptions" /> to use.</param><returns>A <typeparamref name="T" /> representation of the data.</returns><exception cref="T:System.FormatException">If the model does not support the requested <see cref="P:System.ClientModel.Primitives.ModelReaderWriterOptions.Format" />.</exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.MessageTextContent.System#ClientModel#Primitives#IPersistableModel{Azure#AI#OpenAI#Assistants#MessageTextContent}#GetFormatFromOptions(System.ClientModel.Primitives.ModelReaderWriterOptions)">
|
|
<summary>
|
|
Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service.
|
|
<param name="options">The <see cref="T:System.ClientModel.Primitives.ModelReaderWriterOptions" /> to use.</param></summary><returns>The format that the model uses when communicating with the serivce.</returns>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.MessageTextFileCitationAnnotation.System#ClientModel#Primitives#IJsonModel{Azure#AI#OpenAI#Assistants#MessageTextFileCitationAnnotation}#Write(System.Text.Json.Utf8JsonWriter,System.ClientModel.Primitives.ModelReaderWriterOptions)">
|
|
<summary>
|
|
Writes the model to the provided <see cref="T:System.Text.Json.Utf8JsonWriter" />.
|
|
</summary><param name="writer">The <see cref="T:System.Text.Json.Utf8JsonWriter" /> to write into.</param><param name="options">The <see cref="T:System.ClientModel.Primitives.ModelReaderWriterOptions" /> to use.</param><exception cref="T:System.FormatException">If the model does not support the requested <see cref="P:System.ClientModel.Primitives.ModelReaderWriterOptions.Format" />.</exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.MessageTextFileCitationAnnotation.System#ClientModel#Primitives#IJsonModel{Azure#AI#OpenAI#Assistants#MessageTextFileCitationAnnotation}#Create(System.Text.Json.Utf8JsonReader@,System.ClientModel.Primitives.ModelReaderWriterOptions)">
|
|
<summary>
|
|
Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model.
|
|
</summary><param name="reader">The <see cref="T:System.Text.Json.Utf8JsonReader" /> to read.</param><param name="options">The <see cref="T:System.ClientModel.Primitives.ModelReaderWriterOptions" /> to use.</param><returns>A <typeparamref name="T" /> representation of the JSON value.</returns><exception cref="T:System.FormatException">If the model does not support the requested <see cref="P:System.ClientModel.Primitives.ModelReaderWriterOptions.Format" />.</exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.MessageTextFileCitationAnnotation.System#ClientModel#Primitives#IPersistableModel{Azure#AI#OpenAI#Assistants#MessageTextFileCitationAnnotation}#Write(System.ClientModel.Primitives.ModelReaderWriterOptions)">
|
|
<summary>
|
|
Writes the model into a <see cref="T:System.BinaryData" />.
|
|
</summary><param name="options">The <see cref="T:System.ClientModel.Primitives.ModelReaderWriterOptions" /> to use.</param><returns>A binary representation of the written model.</returns><exception cref="T:System.FormatException">If the model does not support the requested <see cref="P:System.ClientModel.Primitives.ModelReaderWriterOptions.Format" />.</exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.MessageTextFileCitationAnnotation.System#ClientModel#Primitives#IPersistableModel{Azure#AI#OpenAI#Assistants#MessageTextFileCitationAnnotation}#Create(System.BinaryData,System.ClientModel.Primitives.ModelReaderWriterOptions)">
|
|
<summary>
|
|
Converts the provided <see cref="T:System.BinaryData" /> into a model.
|
|
</summary><param name="data">The <see cref="T:System.BinaryData" /> to parse.</param><param name="options">The <see cref="T:System.ClientModel.Primitives.ModelReaderWriterOptions" /> to use.</param><returns>A <typeparamref name="T" /> representation of the data.</returns><exception cref="T:System.FormatException">If the model does not support the requested <see cref="P:System.ClientModel.Primitives.ModelReaderWriterOptions.Format" />.</exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.MessageTextFileCitationAnnotation.System#ClientModel#Primitives#IPersistableModel{Azure#AI#OpenAI#Assistants#MessageTextFileCitationAnnotation}#GetFormatFromOptions(System.ClientModel.Primitives.ModelReaderWriterOptions)">
|
|
<summary>
|
|
Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service.
|
|
<param name="options">The <see cref="T:System.ClientModel.Primitives.ModelReaderWriterOptions" /> to use.</param></summary><returns>The format that the model uses when communicating with the serivce.</returns>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.MessageTextFilePathAnnotation.System#ClientModel#Primitives#IJsonModel{Azure#AI#OpenAI#Assistants#MessageTextFilePathAnnotation}#Write(System.Text.Json.Utf8JsonWriter,System.ClientModel.Primitives.ModelReaderWriterOptions)">
|
|
<summary>
|
|
Writes the model to the provided <see cref="T:System.Text.Json.Utf8JsonWriter" />.
|
|
</summary><param name="writer">The <see cref="T:System.Text.Json.Utf8JsonWriter" /> to write into.</param><param name="options">The <see cref="T:System.ClientModel.Primitives.ModelReaderWriterOptions" /> to use.</param><exception cref="T:System.FormatException">If the model does not support the requested <see cref="P:System.ClientModel.Primitives.ModelReaderWriterOptions.Format" />.</exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.MessageTextFilePathAnnotation.System#ClientModel#Primitives#IJsonModel{Azure#AI#OpenAI#Assistants#MessageTextFilePathAnnotation}#Create(System.Text.Json.Utf8JsonReader@,System.ClientModel.Primitives.ModelReaderWriterOptions)">
|
|
<summary>
|
|
Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model.
|
|
</summary><param name="reader">The <see cref="T:System.Text.Json.Utf8JsonReader" /> to read.</param><param name="options">The <see cref="T:System.ClientModel.Primitives.ModelReaderWriterOptions" /> to use.</param><returns>A <typeparamref name="T" /> representation of the JSON value.</returns><exception cref="T:System.FormatException">If the model does not support the requested <see cref="P:System.ClientModel.Primitives.ModelReaderWriterOptions.Format" />.</exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.MessageTextFilePathAnnotation.System#ClientModel#Primitives#IPersistableModel{Azure#AI#OpenAI#Assistants#MessageTextFilePathAnnotation}#Write(System.ClientModel.Primitives.ModelReaderWriterOptions)">
|
|
<summary>
|
|
Writes the model into a <see cref="T:System.BinaryData" />.
|
|
</summary><param name="options">The <see cref="T:System.ClientModel.Primitives.ModelReaderWriterOptions" /> to use.</param><returns>A binary representation of the written model.</returns><exception cref="T:System.FormatException">If the model does not support the requested <see cref="P:System.ClientModel.Primitives.ModelReaderWriterOptions.Format" />.</exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.MessageTextFilePathAnnotation.System#ClientModel#Primitives#IPersistableModel{Azure#AI#OpenAI#Assistants#MessageTextFilePathAnnotation}#Create(System.BinaryData,System.ClientModel.Primitives.ModelReaderWriterOptions)">
|
|
<summary>
|
|
Converts the provided <see cref="T:System.BinaryData" /> into a model.
|
|
</summary><param name="data">The <see cref="T:System.BinaryData" /> to parse.</param><param name="options">The <see cref="T:System.ClientModel.Primitives.ModelReaderWriterOptions" /> to use.</param><returns>A <typeparamref name="T" /> representation of the data.</returns><exception cref="T:System.FormatException">If the model does not support the requested <see cref="P:System.ClientModel.Primitives.ModelReaderWriterOptions.Format" />.</exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.MessageTextFilePathAnnotation.System#ClientModel#Primitives#IPersistableModel{Azure#AI#OpenAI#Assistants#MessageTextFilePathAnnotation}#GetFormatFromOptions(System.ClientModel.Primitives.ModelReaderWriterOptions)">
|
|
<summary>
|
|
Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service.
|
|
<param name="options">The <see cref="T:System.ClientModel.Primitives.ModelReaderWriterOptions" /> to use.</param></summary><returns>The format that the model uses when communicating with the serivce.</returns>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.OpenAIFile.System#ClientModel#Primitives#IJsonModel{Azure#AI#OpenAI#Assistants#OpenAIFile}#Write(System.Text.Json.Utf8JsonWriter,System.ClientModel.Primitives.ModelReaderWriterOptions)">
|
|
<summary>
|
|
Writes the model to the provided <see cref="T:System.Text.Json.Utf8JsonWriter" />.
|
|
</summary><param name="writer">The <see cref="T:System.Text.Json.Utf8JsonWriter" /> to write into.</param><param name="options">The <see cref="T:System.ClientModel.Primitives.ModelReaderWriterOptions" /> to use.</param><exception cref="T:System.FormatException">If the model does not support the requested <see cref="P:System.ClientModel.Primitives.ModelReaderWriterOptions.Format" />.</exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.OpenAIFile.System#ClientModel#Primitives#IJsonModel{Azure#AI#OpenAI#Assistants#OpenAIFile}#Create(System.Text.Json.Utf8JsonReader@,System.ClientModel.Primitives.ModelReaderWriterOptions)">
|
|
<summary>
|
|
Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model.
|
|
</summary><param name="reader">The <see cref="T:System.Text.Json.Utf8JsonReader" /> to read.</param><param name="options">The <see cref="T:System.ClientModel.Primitives.ModelReaderWriterOptions" /> to use.</param><returns>A <typeparamref name="T" /> representation of the JSON value.</returns><exception cref="T:System.FormatException">If the model does not support the requested <see cref="P:System.ClientModel.Primitives.ModelReaderWriterOptions.Format" />.</exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.OpenAIFile.System#ClientModel#Primitives#IPersistableModel{Azure#AI#OpenAI#Assistants#OpenAIFile}#Write(System.ClientModel.Primitives.ModelReaderWriterOptions)">
|
|
<summary>
|
|
Writes the model into a <see cref="T:System.BinaryData" />.
|
|
</summary><param name="options">The <see cref="T:System.ClientModel.Primitives.ModelReaderWriterOptions" /> to use.</param><returns>A binary representation of the written model.</returns><exception cref="T:System.FormatException">If the model does not support the requested <see cref="P:System.ClientModel.Primitives.ModelReaderWriterOptions.Format" />.</exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.OpenAIFile.System#ClientModel#Primitives#IPersistableModel{Azure#AI#OpenAI#Assistants#OpenAIFile}#Create(System.BinaryData,System.ClientModel.Primitives.ModelReaderWriterOptions)">
|
|
<summary>
|
|
Converts the provided <see cref="T:System.BinaryData" /> into a model.
|
|
</summary><param name="data">The <see cref="T:System.BinaryData" /> to parse.</param><param name="options">The <see cref="T:System.ClientModel.Primitives.ModelReaderWriterOptions" /> to use.</param><returns>A <typeparamref name="T" /> representation of the data.</returns><exception cref="T:System.FormatException">If the model does not support the requested <see cref="P:System.ClientModel.Primitives.ModelReaderWriterOptions.Format" />.</exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.OpenAIFile.System#ClientModel#Primitives#IPersistableModel{Azure#AI#OpenAI#Assistants#OpenAIFile}#GetFormatFromOptions(System.ClientModel.Primitives.ModelReaderWriterOptions)">
|
|
<summary>
|
|
Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service.
|
|
<param name="options">The <see cref="T:System.ClientModel.Primitives.ModelReaderWriterOptions" /> to use.</param></summary><returns>The format that the model uses when communicating with the serivce.</returns>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.InternalOpenAIPageableListOfAssistant.System#ClientModel#Primitives#IJsonModel{Azure#AI#OpenAI#Assistants#InternalOpenAIPageableListOfAssistant}#Write(System.Text.Json.Utf8JsonWriter,System.ClientModel.Primitives.ModelReaderWriterOptions)">
|
|
<summary>
|
|
Writes the model to the provided <see cref="T:System.Text.Json.Utf8JsonWriter" />.
|
|
</summary><param name="writer">The <see cref="T:System.Text.Json.Utf8JsonWriter" /> to write into.</param><param name="options">The <see cref="T:System.ClientModel.Primitives.ModelReaderWriterOptions" /> to use.</param><exception cref="T:System.FormatException">If the model does not support the requested <see cref="P:System.ClientModel.Primitives.ModelReaderWriterOptions.Format" />.</exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.InternalOpenAIPageableListOfAssistant.System#ClientModel#Primitives#IJsonModel{Azure#AI#OpenAI#Assistants#InternalOpenAIPageableListOfAssistant}#Create(System.Text.Json.Utf8JsonReader@,System.ClientModel.Primitives.ModelReaderWriterOptions)">
|
|
<summary>
|
|
Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model.
|
|
</summary><param name="reader">The <see cref="T:System.Text.Json.Utf8JsonReader" /> to read.</param><param name="options">The <see cref="T:System.ClientModel.Primitives.ModelReaderWriterOptions" /> to use.</param><returns>A <typeparamref name="T" /> representation of the JSON value.</returns><exception cref="T:System.FormatException">If the model does not support the requested <see cref="P:System.ClientModel.Primitives.ModelReaderWriterOptions.Format" />.</exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.InternalOpenAIPageableListOfAssistant.System#ClientModel#Primitives#IPersistableModel{Azure#AI#OpenAI#Assistants#InternalOpenAIPageableListOfAssistant}#Write(System.ClientModel.Primitives.ModelReaderWriterOptions)">
|
|
<summary>
|
|
Writes the model into a <see cref="T:System.BinaryData" />.
|
|
</summary><param name="options">The <see cref="T:System.ClientModel.Primitives.ModelReaderWriterOptions" /> to use.</param><returns>A binary representation of the written model.</returns><exception cref="T:System.FormatException">If the model does not support the requested <see cref="P:System.ClientModel.Primitives.ModelReaderWriterOptions.Format" />.</exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.InternalOpenAIPageableListOfAssistant.System#ClientModel#Primitives#IPersistableModel{Azure#AI#OpenAI#Assistants#InternalOpenAIPageableListOfAssistant}#Create(System.BinaryData,System.ClientModel.Primitives.ModelReaderWriterOptions)">
|
|
<summary>
|
|
Converts the provided <see cref="T:System.BinaryData" /> into a model.
|
|
</summary><param name="data">The <see cref="T:System.BinaryData" /> to parse.</param><param name="options">The <see cref="T:System.ClientModel.Primitives.ModelReaderWriterOptions" /> to use.</param><returns>A <typeparamref name="T" /> representation of the data.</returns><exception cref="T:System.FormatException">If the model does not support the requested <see cref="P:System.ClientModel.Primitives.ModelReaderWriterOptions.Format" />.</exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.InternalOpenAIPageableListOfAssistant.System#ClientModel#Primitives#IPersistableModel{Azure#AI#OpenAI#Assistants#InternalOpenAIPageableListOfAssistant}#GetFormatFromOptions(System.ClientModel.Primitives.ModelReaderWriterOptions)">
|
|
<summary>
|
|
Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service.
|
|
<param name="options">The <see cref="T:System.ClientModel.Primitives.ModelReaderWriterOptions" /> to use.</param></summary><returns>The format that the model uses when communicating with the serivce.</returns>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.InternalOpenAIPageableListOfAssistantFile.System#ClientModel#Primitives#IJsonModel{Azure#AI#OpenAI#Assistants#InternalOpenAIPageableListOfAssistantFile}#Write(System.Text.Json.Utf8JsonWriter,System.ClientModel.Primitives.ModelReaderWriterOptions)">
|
|
<summary>
|
|
Writes the model to the provided <see cref="T:System.Text.Json.Utf8JsonWriter" />.
|
|
</summary><param name="writer">The <see cref="T:System.Text.Json.Utf8JsonWriter" /> to write into.</param><param name="options">The <see cref="T:System.ClientModel.Primitives.ModelReaderWriterOptions" /> to use.</param><exception cref="T:System.FormatException">If the model does not support the requested <see cref="P:System.ClientModel.Primitives.ModelReaderWriterOptions.Format" />.</exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.InternalOpenAIPageableListOfAssistantFile.System#ClientModel#Primitives#IJsonModel{Azure#AI#OpenAI#Assistants#InternalOpenAIPageableListOfAssistantFile}#Create(System.Text.Json.Utf8JsonReader@,System.ClientModel.Primitives.ModelReaderWriterOptions)">
|
|
<summary>
|
|
Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model.
|
|
</summary><param name="reader">The <see cref="T:System.Text.Json.Utf8JsonReader" /> to read.</param><param name="options">The <see cref="T:System.ClientModel.Primitives.ModelReaderWriterOptions" /> to use.</param><returns>A <typeparamref name="T" /> representation of the JSON value.</returns><exception cref="T:System.FormatException">If the model does not support the requested <see cref="P:System.ClientModel.Primitives.ModelReaderWriterOptions.Format" />.</exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.InternalOpenAIPageableListOfAssistantFile.System#ClientModel#Primitives#IPersistableModel{Azure#AI#OpenAI#Assistants#InternalOpenAIPageableListOfAssistantFile}#Write(System.ClientModel.Primitives.ModelReaderWriterOptions)">
|
|
<summary>
|
|
Writes the model into a <see cref="T:System.BinaryData" />.
|
|
</summary><param name="options">The <see cref="T:System.ClientModel.Primitives.ModelReaderWriterOptions" /> to use.</param><returns>A binary representation of the written model.</returns><exception cref="T:System.FormatException">If the model does not support the requested <see cref="P:System.ClientModel.Primitives.ModelReaderWriterOptions.Format" />.</exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.InternalOpenAIPageableListOfAssistantFile.System#ClientModel#Primitives#IPersistableModel{Azure#AI#OpenAI#Assistants#InternalOpenAIPageableListOfAssistantFile}#Create(System.BinaryData,System.ClientModel.Primitives.ModelReaderWriterOptions)">
|
|
<summary>
|
|
Converts the provided <see cref="T:System.BinaryData" /> into a model.
|
|
</summary><param name="data">The <see cref="T:System.BinaryData" /> to parse.</param><param name="options">The <see cref="T:System.ClientModel.Primitives.ModelReaderWriterOptions" /> to use.</param><returns>A <typeparamref name="T" /> representation of the data.</returns><exception cref="T:System.FormatException">If the model does not support the requested <see cref="P:System.ClientModel.Primitives.ModelReaderWriterOptions.Format" />.</exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.InternalOpenAIPageableListOfAssistantFile.System#ClientModel#Primitives#IPersistableModel{Azure#AI#OpenAI#Assistants#InternalOpenAIPageableListOfAssistantFile}#GetFormatFromOptions(System.ClientModel.Primitives.ModelReaderWriterOptions)">
|
|
<summary>
|
|
Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service.
|
|
<param name="options">The <see cref="T:System.ClientModel.Primitives.ModelReaderWriterOptions" /> to use.</param></summary><returns>The format that the model uses when communicating with the serivce.</returns>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.InternalOpenAIPageableListOfThreadMessage.System#ClientModel#Primitives#IJsonModel{Azure#AI#OpenAI#Assistants#InternalOpenAIPageableListOfThreadMessage}#Write(System.Text.Json.Utf8JsonWriter,System.ClientModel.Primitives.ModelReaderWriterOptions)">
|
|
<summary>
|
|
Writes the model to the provided <see cref="T:System.Text.Json.Utf8JsonWriter" />.
|
|
</summary><param name="writer">The <see cref="T:System.Text.Json.Utf8JsonWriter" /> to write into.</param><param name="options">The <see cref="T:System.ClientModel.Primitives.ModelReaderWriterOptions" /> to use.</param><exception cref="T:System.FormatException">If the model does not support the requested <see cref="P:System.ClientModel.Primitives.ModelReaderWriterOptions.Format" />.</exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.InternalOpenAIPageableListOfThreadMessage.System#ClientModel#Primitives#IJsonModel{Azure#AI#OpenAI#Assistants#InternalOpenAIPageableListOfThreadMessage}#Create(System.Text.Json.Utf8JsonReader@,System.ClientModel.Primitives.ModelReaderWriterOptions)">
|
|
<summary>
|
|
Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model.
|
|
</summary><param name="reader">The <see cref="T:System.Text.Json.Utf8JsonReader" /> to read.</param><param name="options">The <see cref="T:System.ClientModel.Primitives.ModelReaderWriterOptions" /> to use.</param><returns>A <typeparamref name="T" /> representation of the JSON value.</returns><exception cref="T:System.FormatException">If the model does not support the requested <see cref="P:System.ClientModel.Primitives.ModelReaderWriterOptions.Format" />.</exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.InternalOpenAIPageableListOfThreadMessage.System#ClientModel#Primitives#IPersistableModel{Azure#AI#OpenAI#Assistants#InternalOpenAIPageableListOfThreadMessage}#Write(System.ClientModel.Primitives.ModelReaderWriterOptions)">
|
|
<summary>
|
|
Writes the model into a <see cref="T:System.BinaryData" />.
|
|
</summary><param name="options">The <see cref="T:System.ClientModel.Primitives.ModelReaderWriterOptions" /> to use.</param><returns>A binary representation of the written model.</returns><exception cref="T:System.FormatException">If the model does not support the requested <see cref="P:System.ClientModel.Primitives.ModelReaderWriterOptions.Format" />.</exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.InternalOpenAIPageableListOfThreadMessage.System#ClientModel#Primitives#IPersistableModel{Azure#AI#OpenAI#Assistants#InternalOpenAIPageableListOfThreadMessage}#Create(System.BinaryData,System.ClientModel.Primitives.ModelReaderWriterOptions)">
|
|
<summary>
|
|
Converts the provided <see cref="T:System.BinaryData" /> into a model.
|
|
</summary><param name="data">The <see cref="T:System.BinaryData" /> to parse.</param><param name="options">The <see cref="T:System.ClientModel.Primitives.ModelReaderWriterOptions" /> to use.</param><returns>A <typeparamref name="T" /> representation of the data.</returns><exception cref="T:System.FormatException">If the model does not support the requested <see cref="P:System.ClientModel.Primitives.ModelReaderWriterOptions.Format" />.</exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.InternalOpenAIPageableListOfThreadMessage.System#ClientModel#Primitives#IPersistableModel{Azure#AI#OpenAI#Assistants#InternalOpenAIPageableListOfThreadMessage}#GetFormatFromOptions(System.ClientModel.Primitives.ModelReaderWriterOptions)">
|
|
<summary>
|
|
Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service.
|
|
<param name="options">The <see cref="T:System.ClientModel.Primitives.ModelReaderWriterOptions" /> to use.</param></summary><returns>The format that the model uses when communicating with the serivce.</returns>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.InternalOpenAIPageableListOfMessageFile.System#ClientModel#Primitives#IJsonModel{Azure#AI#OpenAI#Assistants#InternalOpenAIPageableListOfMessageFile}#Write(System.Text.Json.Utf8JsonWriter,System.ClientModel.Primitives.ModelReaderWriterOptions)">
|
|
<summary>
|
|
Writes the model to the provided <see cref="T:System.Text.Json.Utf8JsonWriter" />.
|
|
</summary><param name="writer">The <see cref="T:System.Text.Json.Utf8JsonWriter" /> to write into.</param><param name="options">The <see cref="T:System.ClientModel.Primitives.ModelReaderWriterOptions" /> to use.</param><exception cref="T:System.FormatException">If the model does not support the requested <see cref="P:System.ClientModel.Primitives.ModelReaderWriterOptions.Format" />.</exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.InternalOpenAIPageableListOfMessageFile.System#ClientModel#Primitives#IJsonModel{Azure#AI#OpenAI#Assistants#InternalOpenAIPageableListOfMessageFile}#Create(System.Text.Json.Utf8JsonReader@,System.ClientModel.Primitives.ModelReaderWriterOptions)">
|
|
<summary>
|
|
Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model.
|
|
</summary><param name="reader">The <see cref="T:System.Text.Json.Utf8JsonReader" /> to read.</param><param name="options">The <see cref="T:System.ClientModel.Primitives.ModelReaderWriterOptions" /> to use.</param><returns>A <typeparamref name="T" /> representation of the JSON value.</returns><exception cref="T:System.FormatException">If the model does not support the requested <see cref="P:System.ClientModel.Primitives.ModelReaderWriterOptions.Format" />.</exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.InternalOpenAIPageableListOfMessageFile.System#ClientModel#Primitives#IPersistableModel{Azure#AI#OpenAI#Assistants#InternalOpenAIPageableListOfMessageFile}#Write(System.ClientModel.Primitives.ModelReaderWriterOptions)">
|
|
<summary>
|
|
Writes the model into a <see cref="T:System.BinaryData" />.
|
|
</summary><param name="options">The <see cref="T:System.ClientModel.Primitives.ModelReaderWriterOptions" /> to use.</param><returns>A binary representation of the written model.</returns><exception cref="T:System.FormatException">If the model does not support the requested <see cref="P:System.ClientModel.Primitives.ModelReaderWriterOptions.Format" />.</exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.InternalOpenAIPageableListOfMessageFile.System#ClientModel#Primitives#IPersistableModel{Azure#AI#OpenAI#Assistants#InternalOpenAIPageableListOfMessageFile}#Create(System.BinaryData,System.ClientModel.Primitives.ModelReaderWriterOptions)">
|
|
<summary>
|
|
Converts the provided <see cref="T:System.BinaryData" /> into a model.
|
|
</summary><param name="data">The <see cref="T:System.BinaryData" /> to parse.</param><param name="options">The <see cref="T:System.ClientModel.Primitives.ModelReaderWriterOptions" /> to use.</param><returns>A <typeparamref name="T" /> representation of the data.</returns><exception cref="T:System.FormatException">If the model does not support the requested <see cref="P:System.ClientModel.Primitives.ModelReaderWriterOptions.Format" />.</exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.InternalOpenAIPageableListOfMessageFile.System#ClientModel#Primitives#IPersistableModel{Azure#AI#OpenAI#Assistants#InternalOpenAIPageableListOfMessageFile}#GetFormatFromOptions(System.ClientModel.Primitives.ModelReaderWriterOptions)">
|
|
<summary>
|
|
Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service.
|
|
<param name="options">The <see cref="T:System.ClientModel.Primitives.ModelReaderWriterOptions" /> to use.</param></summary><returns>The format that the model uses when communicating with the serivce.</returns>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.InternalOpenAIPageableListOfRunStep.System#ClientModel#Primitives#IJsonModel{Azure#AI#OpenAI#Assistants#InternalOpenAIPageableListOfRunStep}#Write(System.Text.Json.Utf8JsonWriter,System.ClientModel.Primitives.ModelReaderWriterOptions)">
|
|
<summary>
|
|
Writes the model to the provided <see cref="T:System.Text.Json.Utf8JsonWriter" />.
|
|
</summary><param name="writer">The <see cref="T:System.Text.Json.Utf8JsonWriter" /> to write into.</param><param name="options">The <see cref="T:System.ClientModel.Primitives.ModelReaderWriterOptions" /> to use.</param><exception cref="T:System.FormatException">If the model does not support the requested <see cref="P:System.ClientModel.Primitives.ModelReaderWriterOptions.Format" />.</exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.InternalOpenAIPageableListOfRunStep.System#ClientModel#Primitives#IJsonModel{Azure#AI#OpenAI#Assistants#InternalOpenAIPageableListOfRunStep}#Create(System.Text.Json.Utf8JsonReader@,System.ClientModel.Primitives.ModelReaderWriterOptions)">
|
|
<summary>
|
|
Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model.
|
|
</summary><param name="reader">The <see cref="T:System.Text.Json.Utf8JsonReader" /> to read.</param><param name="options">The <see cref="T:System.ClientModel.Primitives.ModelReaderWriterOptions" /> to use.</param><returns>A <typeparamref name="T" /> representation of the JSON value.</returns><exception cref="T:System.FormatException">If the model does not support the requested <see cref="P:System.ClientModel.Primitives.ModelReaderWriterOptions.Format" />.</exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.InternalOpenAIPageableListOfRunStep.System#ClientModel#Primitives#IPersistableModel{Azure#AI#OpenAI#Assistants#InternalOpenAIPageableListOfRunStep}#Write(System.ClientModel.Primitives.ModelReaderWriterOptions)">
|
|
<summary>
|
|
Writes the model into a <see cref="T:System.BinaryData" />.
|
|
</summary><param name="options">The <see cref="T:System.ClientModel.Primitives.ModelReaderWriterOptions" /> to use.</param><returns>A binary representation of the written model.</returns><exception cref="T:System.FormatException">If the model does not support the requested <see cref="P:System.ClientModel.Primitives.ModelReaderWriterOptions.Format" />.</exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.InternalOpenAIPageableListOfRunStep.System#ClientModel#Primitives#IPersistableModel{Azure#AI#OpenAI#Assistants#InternalOpenAIPageableListOfRunStep}#Create(System.BinaryData,System.ClientModel.Primitives.ModelReaderWriterOptions)">
|
|
<summary>
|
|
Converts the provided <see cref="T:System.BinaryData" /> into a model.
|
|
</summary><param name="data">The <see cref="T:System.BinaryData" /> to parse.</param><param name="options">The <see cref="T:System.ClientModel.Primitives.ModelReaderWriterOptions" /> to use.</param><returns>A <typeparamref name="T" /> representation of the data.</returns><exception cref="T:System.FormatException">If the model does not support the requested <see cref="P:System.ClientModel.Primitives.ModelReaderWriterOptions.Format" />.</exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.InternalOpenAIPageableListOfRunStep.System#ClientModel#Primitives#IPersistableModel{Azure#AI#OpenAI#Assistants#InternalOpenAIPageableListOfRunStep}#GetFormatFromOptions(System.ClientModel.Primitives.ModelReaderWriterOptions)">
|
|
<summary>
|
|
Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service.
|
|
<param name="options">The <see cref="T:System.ClientModel.Primitives.ModelReaderWriterOptions" /> to use.</param></summary><returns>The format that the model uses when communicating with the serivce.</returns>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.InternalOpenAIPageableListOfThreadRun.System#ClientModel#Primitives#IJsonModel{Azure#AI#OpenAI#Assistants#InternalOpenAIPageableListOfThreadRun}#Write(System.Text.Json.Utf8JsonWriter,System.ClientModel.Primitives.ModelReaderWriterOptions)">
|
|
<summary>
|
|
Writes the model to the provided <see cref="T:System.Text.Json.Utf8JsonWriter" />.
|
|
</summary><param name="writer">The <see cref="T:System.Text.Json.Utf8JsonWriter" /> to write into.</param><param name="options">The <see cref="T:System.ClientModel.Primitives.ModelReaderWriterOptions" /> to use.</param><exception cref="T:System.FormatException">If the model does not support the requested <see cref="P:System.ClientModel.Primitives.ModelReaderWriterOptions.Format" />.</exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.InternalOpenAIPageableListOfThreadRun.System#ClientModel#Primitives#IJsonModel{Azure#AI#OpenAI#Assistants#InternalOpenAIPageableListOfThreadRun}#Create(System.Text.Json.Utf8JsonReader@,System.ClientModel.Primitives.ModelReaderWriterOptions)">
|
|
<summary>
|
|
Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model.
|
|
</summary><param name="reader">The <see cref="T:System.Text.Json.Utf8JsonReader" /> to read.</param><param name="options">The <see cref="T:System.ClientModel.Primitives.ModelReaderWriterOptions" /> to use.</param><returns>A <typeparamref name="T" /> representation of the JSON value.</returns><exception cref="T:System.FormatException">If the model does not support the requested <see cref="P:System.ClientModel.Primitives.ModelReaderWriterOptions.Format" />.</exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.InternalOpenAIPageableListOfThreadRun.System#ClientModel#Primitives#IPersistableModel{Azure#AI#OpenAI#Assistants#InternalOpenAIPageableListOfThreadRun}#Write(System.ClientModel.Primitives.ModelReaderWriterOptions)">
|
|
<summary>
|
|
Writes the model into a <see cref="T:System.BinaryData" />.
|
|
</summary><param name="options">The <see cref="T:System.ClientModel.Primitives.ModelReaderWriterOptions" /> to use.</param><returns>A binary representation of the written model.</returns><exception cref="T:System.FormatException">If the model does not support the requested <see cref="P:System.ClientModel.Primitives.ModelReaderWriterOptions.Format" />.</exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.InternalOpenAIPageableListOfThreadRun.System#ClientModel#Primitives#IPersistableModel{Azure#AI#OpenAI#Assistants#InternalOpenAIPageableListOfThreadRun}#Create(System.BinaryData,System.ClientModel.Primitives.ModelReaderWriterOptions)">
|
|
<summary>
|
|
Converts the provided <see cref="T:System.BinaryData" /> into a model.
|
|
</summary><param name="data">The <see cref="T:System.BinaryData" /> to parse.</param><param name="options">The <see cref="T:System.ClientModel.Primitives.ModelReaderWriterOptions" /> to use.</param><returns>A <typeparamref name="T" /> representation of the data.</returns><exception cref="T:System.FormatException">If the model does not support the requested <see cref="P:System.ClientModel.Primitives.ModelReaderWriterOptions.Format" />.</exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.InternalOpenAIPageableListOfThreadRun.System#ClientModel#Primitives#IPersistableModel{Azure#AI#OpenAI#Assistants#InternalOpenAIPageableListOfThreadRun}#GetFormatFromOptions(System.ClientModel.Primitives.ModelReaderWriterOptions)">
|
|
<summary>
|
|
Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service.
|
|
<param name="options">The <see cref="T:System.ClientModel.Primitives.ModelReaderWriterOptions" /> to use.</param></summary><returns>The format that the model uses when communicating with the serivce.</returns>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.RequiredFunctionToolCall.System#ClientModel#Primitives#IJsonModel{Azure#AI#OpenAI#Assistants#RequiredFunctionToolCall}#Write(System.Text.Json.Utf8JsonWriter,System.ClientModel.Primitives.ModelReaderWriterOptions)">
|
|
<summary>
|
|
Writes the model to the provided <see cref="T:System.Text.Json.Utf8JsonWriter" />.
|
|
</summary><param name="writer">The <see cref="T:System.Text.Json.Utf8JsonWriter" /> to write into.</param><param name="options">The <see cref="T:System.ClientModel.Primitives.ModelReaderWriterOptions" /> to use.</param><exception cref="T:System.FormatException">If the model does not support the requested <see cref="P:System.ClientModel.Primitives.ModelReaderWriterOptions.Format" />.</exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.RequiredFunctionToolCall.System#ClientModel#Primitives#IJsonModel{Azure#AI#OpenAI#Assistants#RequiredFunctionToolCall}#Create(System.Text.Json.Utf8JsonReader@,System.ClientModel.Primitives.ModelReaderWriterOptions)">
|
|
<summary>
|
|
Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model.
|
|
</summary><param name="reader">The <see cref="T:System.Text.Json.Utf8JsonReader" /> to read.</param><param name="options">The <see cref="T:System.ClientModel.Primitives.ModelReaderWriterOptions" /> to use.</param><returns>A <typeparamref name="T" /> representation of the JSON value.</returns><exception cref="T:System.FormatException">If the model does not support the requested <see cref="P:System.ClientModel.Primitives.ModelReaderWriterOptions.Format" />.</exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.RequiredFunctionToolCall.System#ClientModel#Primitives#IPersistableModel{Azure#AI#OpenAI#Assistants#RequiredFunctionToolCall}#Write(System.ClientModel.Primitives.ModelReaderWriterOptions)">
|
|
<summary>
|
|
Writes the model into a <see cref="T:System.BinaryData" />.
|
|
</summary><param name="options">The <see cref="T:System.ClientModel.Primitives.ModelReaderWriterOptions" /> to use.</param><returns>A binary representation of the written model.</returns><exception cref="T:System.FormatException">If the model does not support the requested <see cref="P:System.ClientModel.Primitives.ModelReaderWriterOptions.Format" />.</exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.RequiredFunctionToolCall.System#ClientModel#Primitives#IPersistableModel{Azure#AI#OpenAI#Assistants#RequiredFunctionToolCall}#Create(System.BinaryData,System.ClientModel.Primitives.ModelReaderWriterOptions)">
|
|
<summary>
|
|
Converts the provided <see cref="T:System.BinaryData" /> into a model.
|
|
</summary><param name="data">The <see cref="T:System.BinaryData" /> to parse.</param><param name="options">The <see cref="T:System.ClientModel.Primitives.ModelReaderWriterOptions" /> to use.</param><returns>A <typeparamref name="T" /> representation of the data.</returns><exception cref="T:System.FormatException">If the model does not support the requested <see cref="P:System.ClientModel.Primitives.ModelReaderWriterOptions.Format" />.</exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.RequiredFunctionToolCall.System#ClientModel#Primitives#IPersistableModel{Azure#AI#OpenAI#Assistants#RequiredFunctionToolCall}#GetFormatFromOptions(System.ClientModel.Primitives.ModelReaderWriterOptions)">
|
|
<summary>
|
|
Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service.
|
|
<param name="options">The <see cref="T:System.ClientModel.Primitives.ModelReaderWriterOptions" /> to use.</param></summary><returns>The format that the model uses when communicating with the serivce.</returns>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.RunStep.System#ClientModel#Primitives#IJsonModel{Azure#AI#OpenAI#Assistants#RunStep}#Write(System.Text.Json.Utf8JsonWriter,System.ClientModel.Primitives.ModelReaderWriterOptions)">
|
|
<summary>
|
|
Writes the model to the provided <see cref="T:System.Text.Json.Utf8JsonWriter" />.
|
|
</summary><param name="writer">The <see cref="T:System.Text.Json.Utf8JsonWriter" /> to write into.</param><param name="options">The <see cref="T:System.ClientModel.Primitives.ModelReaderWriterOptions" /> to use.</param><exception cref="T:System.FormatException">If the model does not support the requested <see cref="P:System.ClientModel.Primitives.ModelReaderWriterOptions.Format" />.</exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.RunStep.System#ClientModel#Primitives#IJsonModel{Azure#AI#OpenAI#Assistants#RunStep}#Create(System.Text.Json.Utf8JsonReader@,System.ClientModel.Primitives.ModelReaderWriterOptions)">
|
|
<summary>
|
|
Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model.
|
|
</summary><param name="reader">The <see cref="T:System.Text.Json.Utf8JsonReader" /> to read.</param><param name="options">The <see cref="T:System.ClientModel.Primitives.ModelReaderWriterOptions" /> to use.</param><returns>A <typeparamref name="T" /> representation of the JSON value.</returns><exception cref="T:System.FormatException">If the model does not support the requested <see cref="P:System.ClientModel.Primitives.ModelReaderWriterOptions.Format" />.</exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.RunStep.System#ClientModel#Primitives#IPersistableModel{Azure#AI#OpenAI#Assistants#RunStep}#Write(System.ClientModel.Primitives.ModelReaderWriterOptions)">
|
|
<summary>
|
|
Writes the model into a <see cref="T:System.BinaryData" />.
|
|
</summary><param name="options">The <see cref="T:System.ClientModel.Primitives.ModelReaderWriterOptions" /> to use.</param><returns>A binary representation of the written model.</returns><exception cref="T:System.FormatException">If the model does not support the requested <see cref="P:System.ClientModel.Primitives.ModelReaderWriterOptions.Format" />.</exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.RunStep.System#ClientModel#Primitives#IPersistableModel{Azure#AI#OpenAI#Assistants#RunStep}#Create(System.BinaryData,System.ClientModel.Primitives.ModelReaderWriterOptions)">
|
|
<summary>
|
|
Converts the provided <see cref="T:System.BinaryData" /> into a model.
|
|
</summary><param name="data">The <see cref="T:System.BinaryData" /> to parse.</param><param name="options">The <see cref="T:System.ClientModel.Primitives.ModelReaderWriterOptions" /> to use.</param><returns>A <typeparamref name="T" /> representation of the data.</returns><exception cref="T:System.FormatException">If the model does not support the requested <see cref="P:System.ClientModel.Primitives.ModelReaderWriterOptions.Format" />.</exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.RunStep.System#ClientModel#Primitives#IPersistableModel{Azure#AI#OpenAI#Assistants#RunStep}#GetFormatFromOptions(System.ClientModel.Primitives.ModelReaderWriterOptions)">
|
|
<summary>
|
|
Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service.
|
|
<param name="options">The <see cref="T:System.ClientModel.Primitives.ModelReaderWriterOptions" /> to use.</param></summary><returns>The format that the model uses when communicating with the serivce.</returns>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.RunStepCodeInterpreterToolCall.System#ClientModel#Primitives#IJsonModel{Azure#AI#OpenAI#Assistants#RunStepCodeInterpreterToolCall}#Write(System.Text.Json.Utf8JsonWriter,System.ClientModel.Primitives.ModelReaderWriterOptions)">
|
|
<summary>
|
|
Writes the model to the provided <see cref="T:System.Text.Json.Utf8JsonWriter" />.
|
|
</summary><param name="writer">The <see cref="T:System.Text.Json.Utf8JsonWriter" /> to write into.</param><param name="options">The <see cref="T:System.ClientModel.Primitives.ModelReaderWriterOptions" /> to use.</param><exception cref="T:System.FormatException">If the model does not support the requested <see cref="P:System.ClientModel.Primitives.ModelReaderWriterOptions.Format" />.</exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.RunStepCodeInterpreterToolCall.System#ClientModel#Primitives#IJsonModel{Azure#AI#OpenAI#Assistants#RunStepCodeInterpreterToolCall}#Create(System.Text.Json.Utf8JsonReader@,System.ClientModel.Primitives.ModelReaderWriterOptions)">
|
|
<summary>
|
|
Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model.
|
|
</summary><param name="reader">The <see cref="T:System.Text.Json.Utf8JsonReader" /> to read.</param><param name="options">The <see cref="T:System.ClientModel.Primitives.ModelReaderWriterOptions" /> to use.</param><returns>A <typeparamref name="T" /> representation of the JSON value.</returns><exception cref="T:System.FormatException">If the model does not support the requested <see cref="P:System.ClientModel.Primitives.ModelReaderWriterOptions.Format" />.</exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.RunStepCodeInterpreterToolCall.System#ClientModel#Primitives#IPersistableModel{Azure#AI#OpenAI#Assistants#RunStepCodeInterpreterToolCall}#Write(System.ClientModel.Primitives.ModelReaderWriterOptions)">
|
|
<summary>
|
|
Writes the model into a <see cref="T:System.BinaryData" />.
|
|
</summary><param name="options">The <see cref="T:System.ClientModel.Primitives.ModelReaderWriterOptions" /> to use.</param><returns>A binary representation of the written model.</returns><exception cref="T:System.FormatException">If the model does not support the requested <see cref="P:System.ClientModel.Primitives.ModelReaderWriterOptions.Format" />.</exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.RunStepCodeInterpreterToolCall.System#ClientModel#Primitives#IPersistableModel{Azure#AI#OpenAI#Assistants#RunStepCodeInterpreterToolCall}#Create(System.BinaryData,System.ClientModel.Primitives.ModelReaderWriterOptions)">
|
|
<summary>
|
|
Converts the provided <see cref="T:System.BinaryData" /> into a model.
|
|
</summary><param name="data">The <see cref="T:System.BinaryData" /> to parse.</param><param name="options">The <see cref="T:System.ClientModel.Primitives.ModelReaderWriterOptions" /> to use.</param><returns>A <typeparamref name="T" /> representation of the data.</returns><exception cref="T:System.FormatException">If the model does not support the requested <see cref="P:System.ClientModel.Primitives.ModelReaderWriterOptions.Format" />.</exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.RunStepCodeInterpreterToolCall.System#ClientModel#Primitives#IPersistableModel{Azure#AI#OpenAI#Assistants#RunStepCodeInterpreterToolCall}#GetFormatFromOptions(System.ClientModel.Primitives.ModelReaderWriterOptions)">
|
|
<summary>
|
|
Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service.
|
|
<param name="options">The <see cref="T:System.ClientModel.Primitives.ModelReaderWriterOptions" /> to use.</param></summary><returns>The format that the model uses when communicating with the serivce.</returns>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.RunStepFunctionToolCall.System#ClientModel#Primitives#IJsonModel{Azure#AI#OpenAI#Assistants#RunStepFunctionToolCall}#Write(System.Text.Json.Utf8JsonWriter,System.ClientModel.Primitives.ModelReaderWriterOptions)">
|
|
<summary>
|
|
Writes the model to the provided <see cref="T:System.Text.Json.Utf8JsonWriter" />.
|
|
</summary><param name="writer">The <see cref="T:System.Text.Json.Utf8JsonWriter" /> to write into.</param><param name="options">The <see cref="T:System.ClientModel.Primitives.ModelReaderWriterOptions" /> to use.</param><exception cref="T:System.FormatException">If the model does not support the requested <see cref="P:System.ClientModel.Primitives.ModelReaderWriterOptions.Format" />.</exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.RunStepFunctionToolCall.System#ClientModel#Primitives#IJsonModel{Azure#AI#OpenAI#Assistants#RunStepFunctionToolCall}#Create(System.Text.Json.Utf8JsonReader@,System.ClientModel.Primitives.ModelReaderWriterOptions)">
|
|
<summary>
|
|
Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model.
|
|
</summary><param name="reader">The <see cref="T:System.Text.Json.Utf8JsonReader" /> to read.</param><param name="options">The <see cref="T:System.ClientModel.Primitives.ModelReaderWriterOptions" /> to use.</param><returns>A <typeparamref name="T" /> representation of the JSON value.</returns><exception cref="T:System.FormatException">If the model does not support the requested <see cref="P:System.ClientModel.Primitives.ModelReaderWriterOptions.Format" />.</exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.RunStepFunctionToolCall.System#ClientModel#Primitives#IPersistableModel{Azure#AI#OpenAI#Assistants#RunStepFunctionToolCall}#Write(System.ClientModel.Primitives.ModelReaderWriterOptions)">
|
|
<summary>
|
|
Writes the model into a <see cref="T:System.BinaryData" />.
|
|
</summary><param name="options">The <see cref="T:System.ClientModel.Primitives.ModelReaderWriterOptions" /> to use.</param><returns>A binary representation of the written model.</returns><exception cref="T:System.FormatException">If the model does not support the requested <see cref="P:System.ClientModel.Primitives.ModelReaderWriterOptions.Format" />.</exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.RunStepFunctionToolCall.System#ClientModel#Primitives#IPersistableModel{Azure#AI#OpenAI#Assistants#RunStepFunctionToolCall}#Create(System.BinaryData,System.ClientModel.Primitives.ModelReaderWriterOptions)">
|
|
<summary>
|
|
Converts the provided <see cref="T:System.BinaryData" /> into a model.
|
|
</summary><param name="data">The <see cref="T:System.BinaryData" /> to parse.</param><param name="options">The <see cref="T:System.ClientModel.Primitives.ModelReaderWriterOptions" /> to use.</param><returns>A <typeparamref name="T" /> representation of the data.</returns><exception cref="T:System.FormatException">If the model does not support the requested <see cref="P:System.ClientModel.Primitives.ModelReaderWriterOptions.Format" />.</exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.RunStepFunctionToolCall.System#ClientModel#Primitives#IPersistableModel{Azure#AI#OpenAI#Assistants#RunStepFunctionToolCall}#GetFormatFromOptions(System.ClientModel.Primitives.ModelReaderWriterOptions)">
|
|
<summary>
|
|
Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service.
|
|
<param name="options">The <see cref="T:System.ClientModel.Primitives.ModelReaderWriterOptions" /> to use.</param></summary><returns>The format that the model uses when communicating with the serivce.</returns>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.SubmitToolOutputsAction.System#ClientModel#Primitives#IJsonModel{Azure#AI#OpenAI#Assistants#SubmitToolOutputsAction}#Write(System.Text.Json.Utf8JsonWriter,System.ClientModel.Primitives.ModelReaderWriterOptions)">
|
|
<summary>
|
|
Writes the model to the provided <see cref="T:System.Text.Json.Utf8JsonWriter" />.
|
|
</summary><param name="writer">The <see cref="T:System.Text.Json.Utf8JsonWriter" /> to write into.</param><param name="options">The <see cref="T:System.ClientModel.Primitives.ModelReaderWriterOptions" /> to use.</param><exception cref="T:System.FormatException">If the model does not support the requested <see cref="P:System.ClientModel.Primitives.ModelReaderWriterOptions.Format" />.</exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.SubmitToolOutputsAction.System#ClientModel#Primitives#IJsonModel{Azure#AI#OpenAI#Assistants#SubmitToolOutputsAction}#Create(System.Text.Json.Utf8JsonReader@,System.ClientModel.Primitives.ModelReaderWriterOptions)">
|
|
<summary>
|
|
Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model.
|
|
</summary><param name="reader">The <see cref="T:System.Text.Json.Utf8JsonReader" /> to read.</param><param name="options">The <see cref="T:System.ClientModel.Primitives.ModelReaderWriterOptions" /> to use.</param><returns>A <typeparamref name="T" /> representation of the JSON value.</returns><exception cref="T:System.FormatException">If the model does not support the requested <see cref="P:System.ClientModel.Primitives.ModelReaderWriterOptions.Format" />.</exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.SubmitToolOutputsAction.System#ClientModel#Primitives#IPersistableModel{Azure#AI#OpenAI#Assistants#SubmitToolOutputsAction}#Write(System.ClientModel.Primitives.ModelReaderWriterOptions)">
|
|
<summary>
|
|
Writes the model into a <see cref="T:System.BinaryData" />.
|
|
</summary><param name="options">The <see cref="T:System.ClientModel.Primitives.ModelReaderWriterOptions" /> to use.</param><returns>A binary representation of the written model.</returns><exception cref="T:System.FormatException">If the model does not support the requested <see cref="P:System.ClientModel.Primitives.ModelReaderWriterOptions.Format" />.</exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.SubmitToolOutputsAction.System#ClientModel#Primitives#IPersistableModel{Azure#AI#OpenAI#Assistants#SubmitToolOutputsAction}#Create(System.BinaryData,System.ClientModel.Primitives.ModelReaderWriterOptions)">
|
|
<summary>
|
|
Converts the provided <see cref="T:System.BinaryData" /> into a model.
|
|
</summary><param name="data">The <see cref="T:System.BinaryData" /> to parse.</param><param name="options">The <see cref="T:System.ClientModel.Primitives.ModelReaderWriterOptions" /> to use.</param><returns>A <typeparamref name="T" /> representation of the data.</returns><exception cref="T:System.FormatException">If the model does not support the requested <see cref="P:System.ClientModel.Primitives.ModelReaderWriterOptions.Format" />.</exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.SubmitToolOutputsAction.System#ClientModel#Primitives#IPersistableModel{Azure#AI#OpenAI#Assistants#SubmitToolOutputsAction}#GetFormatFromOptions(System.ClientModel.Primitives.ModelReaderWriterOptions)">
|
|
<summary>
|
|
Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service.
|
|
<param name="options">The <see cref="T:System.ClientModel.Primitives.ModelReaderWriterOptions" /> to use.</param></summary><returns>The format that the model uses when communicating with the serivce.</returns>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.ThreadRun.System#ClientModel#Primitives#IJsonModel{Azure#AI#OpenAI#Assistants#ThreadRun}#Write(System.Text.Json.Utf8JsonWriter,System.ClientModel.Primitives.ModelReaderWriterOptions)">
|
|
<summary>
|
|
Writes the model to the provided <see cref="T:System.Text.Json.Utf8JsonWriter" />.
|
|
</summary><param name="writer">The <see cref="T:System.Text.Json.Utf8JsonWriter" /> to write into.</param><param name="options">The <see cref="T:System.ClientModel.Primitives.ModelReaderWriterOptions" /> to use.</param><exception cref="T:System.FormatException">If the model does not support the requested <see cref="P:System.ClientModel.Primitives.ModelReaderWriterOptions.Format" />.</exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.ThreadRun.System#ClientModel#Primitives#IJsonModel{Azure#AI#OpenAI#Assistants#ThreadRun}#Create(System.Text.Json.Utf8JsonReader@,System.ClientModel.Primitives.ModelReaderWriterOptions)">
|
|
<summary>
|
|
Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model.
|
|
</summary><param name="reader">The <see cref="T:System.Text.Json.Utf8JsonReader" /> to read.</param><param name="options">The <see cref="T:System.ClientModel.Primitives.ModelReaderWriterOptions" /> to use.</param><returns>A <typeparamref name="T" /> representation of the JSON value.</returns><exception cref="T:System.FormatException">If the model does not support the requested <see cref="P:System.ClientModel.Primitives.ModelReaderWriterOptions.Format" />.</exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.ThreadRun.System#ClientModel#Primitives#IPersistableModel{Azure#AI#OpenAI#Assistants#ThreadRun}#Write(System.ClientModel.Primitives.ModelReaderWriterOptions)">
|
|
<summary>
|
|
Writes the model into a <see cref="T:System.BinaryData" />.
|
|
</summary><param name="options">The <see cref="T:System.ClientModel.Primitives.ModelReaderWriterOptions" /> to use.</param><returns>A binary representation of the written model.</returns><exception cref="T:System.FormatException">If the model does not support the requested <see cref="P:System.ClientModel.Primitives.ModelReaderWriterOptions.Format" />.</exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.ThreadRun.System#ClientModel#Primitives#IPersistableModel{Azure#AI#OpenAI#Assistants#ThreadRun}#Create(System.BinaryData,System.ClientModel.Primitives.ModelReaderWriterOptions)">
|
|
<summary>
|
|
Converts the provided <see cref="T:System.BinaryData" /> into a model.
|
|
</summary><param name="data">The <see cref="T:System.BinaryData" /> to parse.</param><param name="options">The <see cref="T:System.ClientModel.Primitives.ModelReaderWriterOptions" /> to use.</param><returns>A <typeparamref name="T" /> representation of the data.</returns><exception cref="T:System.FormatException">If the model does not support the requested <see cref="P:System.ClientModel.Primitives.ModelReaderWriterOptions.Format" />.</exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.ThreadRun.System#ClientModel#Primitives#IPersistableModel{Azure#AI#OpenAI#Assistants#ThreadRun}#GetFormatFromOptions(System.ClientModel.Primitives.ModelReaderWriterOptions)">
|
|
<summary>
|
|
Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service.
|
|
<param name="options">The <see cref="T:System.ClientModel.Primitives.ModelReaderWriterOptions" /> to use.</param></summary><returns>The format that the model uses when communicating with the serivce.</returns>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.ToolOutput.System#ClientModel#Primitives#IJsonModel{Azure#AI#OpenAI#Assistants#ToolOutput}#Write(System.Text.Json.Utf8JsonWriter,System.ClientModel.Primitives.ModelReaderWriterOptions)">
|
|
<summary>
|
|
Writes the model to the provided <see cref="T:System.Text.Json.Utf8JsonWriter" />.
|
|
</summary><param name="writer">The <see cref="T:System.Text.Json.Utf8JsonWriter" /> to write into.</param><param name="options">The <see cref="T:System.ClientModel.Primitives.ModelReaderWriterOptions" /> to use.</param><exception cref="T:System.FormatException">If the model does not support the requested <see cref="P:System.ClientModel.Primitives.ModelReaderWriterOptions.Format" />.</exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.ToolOutput.System#ClientModel#Primitives#IJsonModel{Azure#AI#OpenAI#Assistants#ToolOutput}#Create(System.Text.Json.Utf8JsonReader@,System.ClientModel.Primitives.ModelReaderWriterOptions)">
|
|
<summary>
|
|
Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model.
|
|
</summary><param name="reader">The <see cref="T:System.Text.Json.Utf8JsonReader" /> to read.</param><param name="options">The <see cref="T:System.ClientModel.Primitives.ModelReaderWriterOptions" /> to use.</param><returns>A <typeparamref name="T" /> representation of the JSON value.</returns><exception cref="T:System.FormatException">If the model does not support the requested <see cref="P:System.ClientModel.Primitives.ModelReaderWriterOptions.Format" />.</exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.ToolOutput.System#ClientModel#Primitives#IPersistableModel{Azure#AI#OpenAI#Assistants#ToolOutput}#Write(System.ClientModel.Primitives.ModelReaderWriterOptions)">
|
|
<summary>
|
|
Writes the model into a <see cref="T:System.BinaryData" />.
|
|
</summary><param name="options">The <see cref="T:System.ClientModel.Primitives.ModelReaderWriterOptions" /> to use.</param><returns>A binary representation of the written model.</returns><exception cref="T:System.FormatException">If the model does not support the requested <see cref="P:System.ClientModel.Primitives.ModelReaderWriterOptions.Format" />.</exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.ToolOutput.System#ClientModel#Primitives#IPersistableModel{Azure#AI#OpenAI#Assistants#ToolOutput}#Create(System.BinaryData,System.ClientModel.Primitives.ModelReaderWriterOptions)">
|
|
<summary>
|
|
Converts the provided <see cref="T:System.BinaryData" /> into a model.
|
|
</summary><param name="data">The <see cref="T:System.BinaryData" /> to parse.</param><param name="options">The <see cref="T:System.ClientModel.Primitives.ModelReaderWriterOptions" /> to use.</param><returns>A <typeparamref name="T" /> representation of the data.</returns><exception cref="T:System.FormatException">If the model does not support the requested <see cref="P:System.ClientModel.Primitives.ModelReaderWriterOptions.Format" />.</exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.ToolOutput.System#ClientModel#Primitives#IPersistableModel{Azure#AI#OpenAI#Assistants#ToolOutput}#GetFormatFromOptions(System.ClientModel.Primitives.ModelReaderWriterOptions)">
|
|
<summary>
|
|
Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service.
|
|
<param name="options">The <see cref="T:System.ClientModel.Primitives.ModelReaderWriterOptions" /> to use.</param></summary><returns>The format that the model uses when communicating with the serivce.</returns>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.UploadFileRequest.System#ClientModel#Primitives#IJsonModel{Azure#AI#OpenAI#Assistants#UploadFileRequest}#Write(System.Text.Json.Utf8JsonWriter,System.ClientModel.Primitives.ModelReaderWriterOptions)">
|
|
<summary>
|
|
Writes the model to the provided <see cref="T:System.Text.Json.Utf8JsonWriter" />.
|
|
</summary><param name="writer">The <see cref="T:System.Text.Json.Utf8JsonWriter" /> to write into.</param><param name="options">The <see cref="T:System.ClientModel.Primitives.ModelReaderWriterOptions" /> to use.</param><exception cref="T:System.FormatException">If the model does not support the requested <see cref="P:System.ClientModel.Primitives.ModelReaderWriterOptions.Format" />.</exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.UploadFileRequest.System#ClientModel#Primitives#IJsonModel{Azure#AI#OpenAI#Assistants#UploadFileRequest}#Create(System.Text.Json.Utf8JsonReader@,System.ClientModel.Primitives.ModelReaderWriterOptions)">
|
|
<summary>
|
|
Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model.
|
|
</summary><param name="reader">The <see cref="T:System.Text.Json.Utf8JsonReader" /> to read.</param><param name="options">The <see cref="T:System.ClientModel.Primitives.ModelReaderWriterOptions" /> to use.</param><returns>A <typeparamref name="T" /> representation of the JSON value.</returns><exception cref="T:System.FormatException">If the model does not support the requested <see cref="P:System.ClientModel.Primitives.ModelReaderWriterOptions.Format" />.</exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.UploadFileRequest.System#ClientModel#Primitives#IPersistableModel{Azure#AI#OpenAI#Assistants#UploadFileRequest}#Write(System.ClientModel.Primitives.ModelReaderWriterOptions)">
|
|
<summary>
|
|
Writes the model into a <see cref="T:System.BinaryData" />.
|
|
</summary><param name="options">The <see cref="T:System.ClientModel.Primitives.ModelReaderWriterOptions" /> to use.</param><returns>A binary representation of the written model.</returns><exception cref="T:System.FormatException">If the model does not support the requested <see cref="P:System.ClientModel.Primitives.ModelReaderWriterOptions.Format" />.</exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.UploadFileRequest.System#ClientModel#Primitives#IPersistableModel{Azure#AI#OpenAI#Assistants#UploadFileRequest}#Create(System.BinaryData,System.ClientModel.Primitives.ModelReaderWriterOptions)">
|
|
<summary>
|
|
Converts the provided <see cref="T:System.BinaryData" /> into a model.
|
|
</summary><param name="data">The <see cref="T:System.BinaryData" /> to parse.</param><param name="options">The <see cref="T:System.ClientModel.Primitives.ModelReaderWriterOptions" /> to use.</param><returns>A <typeparamref name="T" /> representation of the data.</returns><exception cref="T:System.FormatException">If the model does not support the requested <see cref="P:System.ClientModel.Primitives.ModelReaderWriterOptions.Format" />.</exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.UploadFileRequest.System#ClientModel#Primitives#IPersistableModel{Azure#AI#OpenAI#Assistants#UploadFileRequest}#GetFormatFromOptions(System.ClientModel.Primitives.ModelReaderWriterOptions)">
|
|
<summary>
|
|
Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service.
|
|
<param name="options">The <see cref="T:System.ClientModel.Primitives.ModelReaderWriterOptions" /> to use.</param></summary><returns>The format that the model uses when communicating with the serivce.</returns>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.Assistant.System#ClientModel#Primitives#IJsonModel{Azure#AI#OpenAI#Assistants#Assistant}#Write(System.Text.Json.Utf8JsonWriter,System.ClientModel.Primitives.ModelReaderWriterOptions)">
|
|
<summary>
|
|
Writes the model to the provided <see cref="T:System.Text.Json.Utf8JsonWriter" />.
|
|
</summary><param name="writer">The <see cref="T:System.Text.Json.Utf8JsonWriter" /> to write into.</param><param name="options">The <see cref="T:System.ClientModel.Primitives.ModelReaderWriterOptions" /> to use.</param><exception cref="T:System.FormatException">If the model does not support the requested <see cref="P:System.ClientModel.Primitives.ModelReaderWriterOptions.Format" />.</exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.Assistant.System#ClientModel#Primitives#IJsonModel{Azure#AI#OpenAI#Assistants#Assistant}#Create(System.Text.Json.Utf8JsonReader@,System.ClientModel.Primitives.ModelReaderWriterOptions)">
|
|
<summary>
|
|
Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model.
|
|
</summary><param name="reader">The <see cref="T:System.Text.Json.Utf8JsonReader" /> to read.</param><param name="options">The <see cref="T:System.ClientModel.Primitives.ModelReaderWriterOptions" /> to use.</param><returns>A <typeparamref name="T" /> representation of the JSON value.</returns><exception cref="T:System.FormatException">If the model does not support the requested <see cref="P:System.ClientModel.Primitives.ModelReaderWriterOptions.Format" />.</exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.Assistant.System#ClientModel#Primitives#IPersistableModel{Azure#AI#OpenAI#Assistants#Assistant}#Write(System.ClientModel.Primitives.ModelReaderWriterOptions)">
|
|
<summary>
|
|
Writes the model into a <see cref="T:System.BinaryData" />.
|
|
</summary><param name="options">The <see cref="T:System.ClientModel.Primitives.ModelReaderWriterOptions" /> to use.</param><returns>A binary representation of the written model.</returns><exception cref="T:System.FormatException">If the model does not support the requested <see cref="P:System.ClientModel.Primitives.ModelReaderWriterOptions.Format" />.</exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.Assistant.System#ClientModel#Primitives#IPersistableModel{Azure#AI#OpenAI#Assistants#Assistant}#Create(System.BinaryData,System.ClientModel.Primitives.ModelReaderWriterOptions)">
|
|
<summary>
|
|
Converts the provided <see cref="T:System.BinaryData" /> into a model.
|
|
</summary><param name="data">The <see cref="T:System.BinaryData" /> to parse.</param><param name="options">The <see cref="T:System.ClientModel.Primitives.ModelReaderWriterOptions" /> to use.</param><returns>A <typeparamref name="T" /> representation of the data.</returns><exception cref="T:System.FormatException">If the model does not support the requested <see cref="P:System.ClientModel.Primitives.ModelReaderWriterOptions.Format" />.</exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.Assistant.System#ClientModel#Primitives#IPersistableModel{Azure#AI#OpenAI#Assistants#Assistant}#GetFormatFromOptions(System.ClientModel.Primitives.ModelReaderWriterOptions)">
|
|
<summary>
|
|
Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service.
|
|
<param name="options">The <see cref="T:System.ClientModel.Primitives.ModelReaderWriterOptions" /> to use.</param></summary><returns>The format that the model uses when communicating with the serivce.</returns>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.AssistantFile.System#ClientModel#Primitives#IJsonModel{Azure#AI#OpenAI#Assistants#AssistantFile}#Write(System.Text.Json.Utf8JsonWriter,System.ClientModel.Primitives.ModelReaderWriterOptions)">
|
|
<summary>
|
|
Writes the model to the provided <see cref="T:System.Text.Json.Utf8JsonWriter" />.
|
|
</summary><param name="writer">The <see cref="T:System.Text.Json.Utf8JsonWriter" /> to write into.</param><param name="options">The <see cref="T:System.ClientModel.Primitives.ModelReaderWriterOptions" /> to use.</param><exception cref="T:System.FormatException">If the model does not support the requested <see cref="P:System.ClientModel.Primitives.ModelReaderWriterOptions.Format" />.</exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.AssistantFile.System#ClientModel#Primitives#IJsonModel{Azure#AI#OpenAI#Assistants#AssistantFile}#Create(System.Text.Json.Utf8JsonReader@,System.ClientModel.Primitives.ModelReaderWriterOptions)">
|
|
<summary>
|
|
Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model.
|
|
</summary><param name="reader">The <see cref="T:System.Text.Json.Utf8JsonReader" /> to read.</param><param name="options">The <see cref="T:System.ClientModel.Primitives.ModelReaderWriterOptions" /> to use.</param><returns>A <typeparamref name="T" /> representation of the JSON value.</returns><exception cref="T:System.FormatException">If the model does not support the requested <see cref="P:System.ClientModel.Primitives.ModelReaderWriterOptions.Format" />.</exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.AssistantFile.System#ClientModel#Primitives#IPersistableModel{Azure#AI#OpenAI#Assistants#AssistantFile}#Write(System.ClientModel.Primitives.ModelReaderWriterOptions)">
|
|
<summary>
|
|
Writes the model into a <see cref="T:System.BinaryData" />.
|
|
</summary><param name="options">The <see cref="T:System.ClientModel.Primitives.ModelReaderWriterOptions" /> to use.</param><returns>A binary representation of the written model.</returns><exception cref="T:System.FormatException">If the model does not support the requested <see cref="P:System.ClientModel.Primitives.ModelReaderWriterOptions.Format" />.</exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.AssistantFile.System#ClientModel#Primitives#IPersistableModel{Azure#AI#OpenAI#Assistants#AssistantFile}#Create(System.BinaryData,System.ClientModel.Primitives.ModelReaderWriterOptions)">
|
|
<summary>
|
|
Converts the provided <see cref="T:System.BinaryData" /> into a model.
|
|
</summary><param name="data">The <see cref="T:System.BinaryData" /> to parse.</param><param name="options">The <see cref="T:System.ClientModel.Primitives.ModelReaderWriterOptions" /> to use.</param><returns>A <typeparamref name="T" /> representation of the data.</returns><exception cref="T:System.FormatException">If the model does not support the requested <see cref="P:System.ClientModel.Primitives.ModelReaderWriterOptions.Format" />.</exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.AssistantFile.System#ClientModel#Primitives#IPersistableModel{Azure#AI#OpenAI#Assistants#AssistantFile}#GetFormatFromOptions(System.ClientModel.Primitives.ModelReaderWriterOptions)">
|
|
<summary>
|
|
Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service.
|
|
<param name="options">The <see cref="T:System.ClientModel.Primitives.ModelReaderWriterOptions" /> to use.</param></summary><returns>The format that the model uses when communicating with the serivce.</returns>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.AssistantThread.System#ClientModel#Primitives#IJsonModel{Azure#AI#OpenAI#Assistants#AssistantThread}#Write(System.Text.Json.Utf8JsonWriter,System.ClientModel.Primitives.ModelReaderWriterOptions)">
|
|
<summary>
|
|
Writes the model to the provided <see cref="T:System.Text.Json.Utf8JsonWriter" />.
|
|
</summary><param name="writer">The <see cref="T:System.Text.Json.Utf8JsonWriter" /> to write into.</param><param name="options">The <see cref="T:System.ClientModel.Primitives.ModelReaderWriterOptions" /> to use.</param><exception cref="T:System.FormatException">If the model does not support the requested <see cref="P:System.ClientModel.Primitives.ModelReaderWriterOptions.Format" />.</exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.AssistantThread.System#ClientModel#Primitives#IJsonModel{Azure#AI#OpenAI#Assistants#AssistantThread}#Create(System.Text.Json.Utf8JsonReader@,System.ClientModel.Primitives.ModelReaderWriterOptions)">
|
|
<summary>
|
|
Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model.
|
|
</summary><param name="reader">The <see cref="T:System.Text.Json.Utf8JsonReader" /> to read.</param><param name="options">The <see cref="T:System.ClientModel.Primitives.ModelReaderWriterOptions" /> to use.</param><returns>A <typeparamref name="T" /> representation of the JSON value.</returns><exception cref="T:System.FormatException">If the model does not support the requested <see cref="P:System.ClientModel.Primitives.ModelReaderWriterOptions.Format" />.</exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.AssistantThread.System#ClientModel#Primitives#IPersistableModel{Azure#AI#OpenAI#Assistants#AssistantThread}#Write(System.ClientModel.Primitives.ModelReaderWriterOptions)">
|
|
<summary>
|
|
Writes the model into a <see cref="T:System.BinaryData" />.
|
|
</summary><param name="options">The <see cref="T:System.ClientModel.Primitives.ModelReaderWriterOptions" /> to use.</param><returns>A binary representation of the written model.</returns><exception cref="T:System.FormatException">If the model does not support the requested <see cref="P:System.ClientModel.Primitives.ModelReaderWriterOptions.Format" />.</exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.AssistantThread.System#ClientModel#Primitives#IPersistableModel{Azure#AI#OpenAI#Assistants#AssistantThread}#Create(System.BinaryData,System.ClientModel.Primitives.ModelReaderWriterOptions)">
|
|
<summary>
|
|
Converts the provided <see cref="T:System.BinaryData" /> into a model.
|
|
</summary><param name="data">The <see cref="T:System.BinaryData" /> to parse.</param><param name="options">The <see cref="T:System.ClientModel.Primitives.ModelReaderWriterOptions" /> to use.</param><returns>A <typeparamref name="T" /> representation of the data.</returns><exception cref="T:System.FormatException">If the model does not support the requested <see cref="P:System.ClientModel.Primitives.ModelReaderWriterOptions.Format" />.</exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.AssistantThread.System#ClientModel#Primitives#IPersistableModel{Azure#AI#OpenAI#Assistants#AssistantThread}#GetFormatFromOptions(System.ClientModel.Primitives.ModelReaderWriterOptions)">
|
|
<summary>
|
|
Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service.
|
|
<param name="options">The <see cref="T:System.ClientModel.Primitives.ModelReaderWriterOptions" /> to use.</param></summary><returns>The format that the model uses when communicating with the serivce.</returns>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.MessageFile.System#ClientModel#Primitives#IJsonModel{Azure#AI#OpenAI#Assistants#MessageFile}#Write(System.Text.Json.Utf8JsonWriter,System.ClientModel.Primitives.ModelReaderWriterOptions)">
|
|
<summary>
|
|
Writes the model to the provided <see cref="T:System.Text.Json.Utf8JsonWriter" />.
|
|
</summary><param name="writer">The <see cref="T:System.Text.Json.Utf8JsonWriter" /> to write into.</param><param name="options">The <see cref="T:System.ClientModel.Primitives.ModelReaderWriterOptions" /> to use.</param><exception cref="T:System.FormatException">If the model does not support the requested <see cref="P:System.ClientModel.Primitives.ModelReaderWriterOptions.Format" />.</exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.MessageFile.System#ClientModel#Primitives#IJsonModel{Azure#AI#OpenAI#Assistants#MessageFile}#Create(System.Text.Json.Utf8JsonReader@,System.ClientModel.Primitives.ModelReaderWriterOptions)">
|
|
<summary>
|
|
Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model.
|
|
</summary><param name="reader">The <see cref="T:System.Text.Json.Utf8JsonReader" /> to read.</param><param name="options">The <see cref="T:System.ClientModel.Primitives.ModelReaderWriterOptions" /> to use.</param><returns>A <typeparamref name="T" /> representation of the JSON value.</returns><exception cref="T:System.FormatException">If the model does not support the requested <see cref="P:System.ClientModel.Primitives.ModelReaderWriterOptions.Format" />.</exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.MessageFile.System#ClientModel#Primitives#IPersistableModel{Azure#AI#OpenAI#Assistants#MessageFile}#Write(System.ClientModel.Primitives.ModelReaderWriterOptions)">
|
|
<summary>
|
|
Writes the model into a <see cref="T:System.BinaryData" />.
|
|
</summary><param name="options">The <see cref="T:System.ClientModel.Primitives.ModelReaderWriterOptions" /> to use.</param><returns>A binary representation of the written model.</returns><exception cref="T:System.FormatException">If the model does not support the requested <see cref="P:System.ClientModel.Primitives.ModelReaderWriterOptions.Format" />.</exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.MessageFile.System#ClientModel#Primitives#IPersistableModel{Azure#AI#OpenAI#Assistants#MessageFile}#Create(System.BinaryData,System.ClientModel.Primitives.ModelReaderWriterOptions)">
|
|
<summary>
|
|
Converts the provided <see cref="T:System.BinaryData" /> into a model.
|
|
</summary><param name="data">The <see cref="T:System.BinaryData" /> to parse.</param><param name="options">The <see cref="T:System.ClientModel.Primitives.ModelReaderWriterOptions" /> to use.</param><returns>A <typeparamref name="T" /> representation of the data.</returns><exception cref="T:System.FormatException">If the model does not support the requested <see cref="P:System.ClientModel.Primitives.ModelReaderWriterOptions.Format" />.</exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.MessageFile.System#ClientModel#Primitives#IPersistableModel{Azure#AI#OpenAI#Assistants#MessageFile}#GetFormatFromOptions(System.ClientModel.Primitives.ModelReaderWriterOptions)">
|
|
<summary>
|
|
Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service.
|
|
<param name="options">The <see cref="T:System.ClientModel.Primitives.ModelReaderWriterOptions" /> to use.</param></summary><returns>The format that the model uses when communicating with the serivce.</returns>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.ThreadMessage.System#ClientModel#Primitives#IJsonModel{Azure#AI#OpenAI#Assistants#ThreadMessage}#Write(System.Text.Json.Utf8JsonWriter,System.ClientModel.Primitives.ModelReaderWriterOptions)">
|
|
<summary>
|
|
Writes the model to the provided <see cref="T:System.Text.Json.Utf8JsonWriter" />.
|
|
</summary><param name="writer">The <see cref="T:System.Text.Json.Utf8JsonWriter" /> to write into.</param><param name="options">The <see cref="T:System.ClientModel.Primitives.ModelReaderWriterOptions" /> to use.</param><exception cref="T:System.FormatException">If the model does not support the requested <see cref="P:System.ClientModel.Primitives.ModelReaderWriterOptions.Format" />.</exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.ThreadMessage.System#ClientModel#Primitives#IJsonModel{Azure#AI#OpenAI#Assistants#ThreadMessage}#Create(System.Text.Json.Utf8JsonReader@,System.ClientModel.Primitives.ModelReaderWriterOptions)">
|
|
<summary>
|
|
Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model.
|
|
</summary><param name="reader">The <see cref="T:System.Text.Json.Utf8JsonReader" /> to read.</param><param name="options">The <see cref="T:System.ClientModel.Primitives.ModelReaderWriterOptions" /> to use.</param><returns>A <typeparamref name="T" /> representation of the JSON value.</returns><exception cref="T:System.FormatException">If the model does not support the requested <see cref="P:System.ClientModel.Primitives.ModelReaderWriterOptions.Format" />.</exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.ThreadMessage.System#ClientModel#Primitives#IPersistableModel{Azure#AI#OpenAI#Assistants#ThreadMessage}#Write(System.ClientModel.Primitives.ModelReaderWriterOptions)">
|
|
<summary>
|
|
Writes the model into a <see cref="T:System.BinaryData" />.
|
|
</summary><param name="options">The <see cref="T:System.ClientModel.Primitives.ModelReaderWriterOptions" /> to use.</param><returns>A binary representation of the written model.</returns><exception cref="T:System.FormatException">If the model does not support the requested <see cref="P:System.ClientModel.Primitives.ModelReaderWriterOptions.Format" />.</exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.ThreadMessage.System#ClientModel#Primitives#IPersistableModel{Azure#AI#OpenAI#Assistants#ThreadMessage}#Create(System.BinaryData,System.ClientModel.Primitives.ModelReaderWriterOptions)">
|
|
<summary>
|
|
Converts the provided <see cref="T:System.BinaryData" /> into a model.
|
|
</summary><param name="data">The <see cref="T:System.BinaryData" /> to parse.</param><param name="options">The <see cref="T:System.ClientModel.Primitives.ModelReaderWriterOptions" /> to use.</param><returns>A <typeparamref name="T" /> representation of the data.</returns><exception cref="T:System.FormatException">If the model does not support the requested <see cref="P:System.ClientModel.Primitives.ModelReaderWriterOptions.Format" />.</exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.ThreadMessage.System#ClientModel#Primitives#IPersistableModel{Azure#AI#OpenAI#Assistants#ThreadMessage}#GetFormatFromOptions(System.ClientModel.Primitives.ModelReaderWriterOptions)">
|
|
<summary>
|
|
Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service.
|
|
<param name="options">The <see cref="T:System.ClientModel.Primitives.ModelReaderWriterOptions" /> to use.</param></summary><returns>The format that the model uses when communicating with the serivce.</returns>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.AssistantCreationOptions.System#ClientModel#Primitives#IJsonModel{Azure#AI#OpenAI#Assistants#AssistantCreationOptions}#Write(System.Text.Json.Utf8JsonWriter,System.ClientModel.Primitives.ModelReaderWriterOptions)">
|
|
<summary>
|
|
Writes the model to the provided <see cref="T:System.Text.Json.Utf8JsonWriter" />.
|
|
</summary><param name="writer">The <see cref="T:System.Text.Json.Utf8JsonWriter" /> to write into.</param><param name="options">The <see cref="T:System.ClientModel.Primitives.ModelReaderWriterOptions" /> to use.</param><exception cref="T:System.FormatException">If the model does not support the requested <see cref="P:System.ClientModel.Primitives.ModelReaderWriterOptions.Format" />.</exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.AssistantCreationOptions.System#ClientModel#Primitives#IJsonModel{Azure#AI#OpenAI#Assistants#AssistantCreationOptions}#Create(System.Text.Json.Utf8JsonReader@,System.ClientModel.Primitives.ModelReaderWriterOptions)">
|
|
<summary>
|
|
Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model.
|
|
</summary><param name="reader">The <see cref="T:System.Text.Json.Utf8JsonReader" /> to read.</param><param name="options">The <see cref="T:System.ClientModel.Primitives.ModelReaderWriterOptions" /> to use.</param><returns>A <typeparamref name="T" /> representation of the JSON value.</returns><exception cref="T:System.FormatException">If the model does not support the requested <see cref="P:System.ClientModel.Primitives.ModelReaderWriterOptions.Format" />.</exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.AssistantCreationOptions.System#ClientModel#Primitives#IPersistableModel{Azure#AI#OpenAI#Assistants#AssistantCreationOptions}#Write(System.ClientModel.Primitives.ModelReaderWriterOptions)">
|
|
<summary>
|
|
Writes the model into a <see cref="T:System.BinaryData" />.
|
|
</summary><param name="options">The <see cref="T:System.ClientModel.Primitives.ModelReaderWriterOptions" /> to use.</param><returns>A binary representation of the written model.</returns><exception cref="T:System.FormatException">If the model does not support the requested <see cref="P:System.ClientModel.Primitives.ModelReaderWriterOptions.Format" />.</exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.AssistantCreationOptions.System#ClientModel#Primitives#IPersistableModel{Azure#AI#OpenAI#Assistants#AssistantCreationOptions}#Create(System.BinaryData,System.ClientModel.Primitives.ModelReaderWriterOptions)">
|
|
<summary>
|
|
Converts the provided <see cref="T:System.BinaryData" /> into a model.
|
|
</summary><param name="data">The <see cref="T:System.BinaryData" /> to parse.</param><param name="options">The <see cref="T:System.ClientModel.Primitives.ModelReaderWriterOptions" /> to use.</param><returns>A <typeparamref name="T" /> representation of the data.</returns><exception cref="T:System.FormatException">If the model does not support the requested <see cref="P:System.ClientModel.Primitives.ModelReaderWriterOptions.Format" />.</exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.AssistantCreationOptions.System#ClientModel#Primitives#IPersistableModel{Azure#AI#OpenAI#Assistants#AssistantCreationOptions}#GetFormatFromOptions(System.ClientModel.Primitives.ModelReaderWriterOptions)">
|
|
<summary>
|
|
Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service.
|
|
<param name="options">The <see cref="T:System.ClientModel.Primitives.ModelReaderWriterOptions" /> to use.</param></summary><returns>The format that the model uses when communicating with the serivce.</returns>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.AssistantThreadCreationOptions.System#ClientModel#Primitives#IJsonModel{Azure#AI#OpenAI#Assistants#AssistantThreadCreationOptions}#Write(System.Text.Json.Utf8JsonWriter,System.ClientModel.Primitives.ModelReaderWriterOptions)">
|
|
<summary>
|
|
Writes the model to the provided <see cref="T:System.Text.Json.Utf8JsonWriter" />.
|
|
</summary><param name="writer">The <see cref="T:System.Text.Json.Utf8JsonWriter" /> to write into.</param><param name="options">The <see cref="T:System.ClientModel.Primitives.ModelReaderWriterOptions" /> to use.</param><exception cref="T:System.FormatException">If the model does not support the requested <see cref="P:System.ClientModel.Primitives.ModelReaderWriterOptions.Format" />.</exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.AssistantThreadCreationOptions.System#ClientModel#Primitives#IJsonModel{Azure#AI#OpenAI#Assistants#AssistantThreadCreationOptions}#Create(System.Text.Json.Utf8JsonReader@,System.ClientModel.Primitives.ModelReaderWriterOptions)">
|
|
<summary>
|
|
Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model.
|
|
</summary><param name="reader">The <see cref="T:System.Text.Json.Utf8JsonReader" /> to read.</param><param name="options">The <see cref="T:System.ClientModel.Primitives.ModelReaderWriterOptions" /> to use.</param><returns>A <typeparamref name="T" /> representation of the JSON value.</returns><exception cref="T:System.FormatException">If the model does not support the requested <see cref="P:System.ClientModel.Primitives.ModelReaderWriterOptions.Format" />.</exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.AssistantThreadCreationOptions.System#ClientModel#Primitives#IPersistableModel{Azure#AI#OpenAI#Assistants#AssistantThreadCreationOptions}#Write(System.ClientModel.Primitives.ModelReaderWriterOptions)">
|
|
<summary>
|
|
Writes the model into a <see cref="T:System.BinaryData" />.
|
|
</summary><param name="options">The <see cref="T:System.ClientModel.Primitives.ModelReaderWriterOptions" /> to use.</param><returns>A binary representation of the written model.</returns><exception cref="T:System.FormatException">If the model does not support the requested <see cref="P:System.ClientModel.Primitives.ModelReaderWriterOptions.Format" />.</exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.AssistantThreadCreationOptions.System#ClientModel#Primitives#IPersistableModel{Azure#AI#OpenAI#Assistants#AssistantThreadCreationOptions}#Create(System.BinaryData,System.ClientModel.Primitives.ModelReaderWriterOptions)">
|
|
<summary>
|
|
Converts the provided <see cref="T:System.BinaryData" /> into a model.
|
|
</summary><param name="data">The <see cref="T:System.BinaryData" /> to parse.</param><param name="options">The <see cref="T:System.ClientModel.Primitives.ModelReaderWriterOptions" /> to use.</param><returns>A <typeparamref name="T" /> representation of the data.</returns><exception cref="T:System.FormatException">If the model does not support the requested <see cref="P:System.ClientModel.Primitives.ModelReaderWriterOptions.Format" />.</exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.AssistantThreadCreationOptions.System#ClientModel#Primitives#IPersistableModel{Azure#AI#OpenAI#Assistants#AssistantThreadCreationOptions}#GetFormatFromOptions(System.ClientModel.Primitives.ModelReaderWriterOptions)">
|
|
<summary>
|
|
Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service.
|
|
<param name="options">The <see cref="T:System.ClientModel.Primitives.ModelReaderWriterOptions" /> to use.</param></summary><returns>The format that the model uses when communicating with the serivce.</returns>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.CodeInterpreterToolDefinition.System#ClientModel#Primitives#IJsonModel{Azure#AI#OpenAI#Assistants#CodeInterpreterToolDefinition}#Write(System.Text.Json.Utf8JsonWriter,System.ClientModel.Primitives.ModelReaderWriterOptions)">
|
|
<summary>
|
|
Writes the model to the provided <see cref="T:System.Text.Json.Utf8JsonWriter" />.
|
|
</summary><param name="writer">The <see cref="T:System.Text.Json.Utf8JsonWriter" /> to write into.</param><param name="options">The <see cref="T:System.ClientModel.Primitives.ModelReaderWriterOptions" /> to use.</param><exception cref="T:System.FormatException">If the model does not support the requested <see cref="P:System.ClientModel.Primitives.ModelReaderWriterOptions.Format" />.</exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.CodeInterpreterToolDefinition.System#ClientModel#Primitives#IJsonModel{Azure#AI#OpenAI#Assistants#CodeInterpreterToolDefinition}#Create(System.Text.Json.Utf8JsonReader@,System.ClientModel.Primitives.ModelReaderWriterOptions)">
|
|
<summary>
|
|
Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model.
|
|
</summary><param name="reader">The <see cref="T:System.Text.Json.Utf8JsonReader" /> to read.</param><param name="options">The <see cref="T:System.ClientModel.Primitives.ModelReaderWriterOptions" /> to use.</param><returns>A <typeparamref name="T" /> representation of the JSON value.</returns><exception cref="T:System.FormatException">If the model does not support the requested <see cref="P:System.ClientModel.Primitives.ModelReaderWriterOptions.Format" />.</exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.CodeInterpreterToolDefinition.System#ClientModel#Primitives#IPersistableModel{Azure#AI#OpenAI#Assistants#CodeInterpreterToolDefinition}#Write(System.ClientModel.Primitives.ModelReaderWriterOptions)">
|
|
<summary>
|
|
Writes the model into a <see cref="T:System.BinaryData" />.
|
|
</summary><param name="options">The <see cref="T:System.ClientModel.Primitives.ModelReaderWriterOptions" /> to use.</param><returns>A binary representation of the written model.</returns><exception cref="T:System.FormatException">If the model does not support the requested <see cref="P:System.ClientModel.Primitives.ModelReaderWriterOptions.Format" />.</exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.CodeInterpreterToolDefinition.System#ClientModel#Primitives#IPersistableModel{Azure#AI#OpenAI#Assistants#CodeInterpreterToolDefinition}#Create(System.BinaryData,System.ClientModel.Primitives.ModelReaderWriterOptions)">
|
|
<summary>
|
|
Converts the provided <see cref="T:System.BinaryData" /> into a model.
|
|
</summary><param name="data">The <see cref="T:System.BinaryData" /> to parse.</param><param name="options">The <see cref="T:System.ClientModel.Primitives.ModelReaderWriterOptions" /> to use.</param><returns>A <typeparamref name="T" /> representation of the data.</returns><exception cref="T:System.FormatException">If the model does not support the requested <see cref="P:System.ClientModel.Primitives.ModelReaderWriterOptions.Format" />.</exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.CodeInterpreterToolDefinition.System#ClientModel#Primitives#IPersistableModel{Azure#AI#OpenAI#Assistants#CodeInterpreterToolDefinition}#GetFormatFromOptions(System.ClientModel.Primitives.ModelReaderWriterOptions)">
|
|
<summary>
|
|
Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service.
|
|
<param name="options">The <see cref="T:System.ClientModel.Primitives.ModelReaderWriterOptions" /> to use.</param></summary><returns>The format that the model uses when communicating with the serivce.</returns>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.CreateAndRunThreadOptions.System#ClientModel#Primitives#IJsonModel{Azure#AI#OpenAI#Assistants#CreateAndRunThreadOptions}#Write(System.Text.Json.Utf8JsonWriter,System.ClientModel.Primitives.ModelReaderWriterOptions)">
|
|
<summary>
|
|
Writes the model to the provided <see cref="T:System.Text.Json.Utf8JsonWriter" />.
|
|
</summary><param name="writer">The <see cref="T:System.Text.Json.Utf8JsonWriter" /> to write into.</param><param name="options">The <see cref="T:System.ClientModel.Primitives.ModelReaderWriterOptions" /> to use.</param><exception cref="T:System.FormatException">If the model does not support the requested <see cref="P:System.ClientModel.Primitives.ModelReaderWriterOptions.Format" />.</exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.CreateAndRunThreadOptions.System#ClientModel#Primitives#IJsonModel{Azure#AI#OpenAI#Assistants#CreateAndRunThreadOptions}#Create(System.Text.Json.Utf8JsonReader@,System.ClientModel.Primitives.ModelReaderWriterOptions)">
|
|
<summary>
|
|
Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model.
|
|
</summary><param name="reader">The <see cref="T:System.Text.Json.Utf8JsonReader" /> to read.</param><param name="options">The <see cref="T:System.ClientModel.Primitives.ModelReaderWriterOptions" /> to use.</param><returns>A <typeparamref name="T" /> representation of the JSON value.</returns><exception cref="T:System.FormatException">If the model does not support the requested <see cref="P:System.ClientModel.Primitives.ModelReaderWriterOptions.Format" />.</exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.CreateAndRunThreadOptions.System#ClientModel#Primitives#IPersistableModel{Azure#AI#OpenAI#Assistants#CreateAndRunThreadOptions}#Write(System.ClientModel.Primitives.ModelReaderWriterOptions)">
|
|
<summary>
|
|
Writes the model into a <see cref="T:System.BinaryData" />.
|
|
</summary><param name="options">The <see cref="T:System.ClientModel.Primitives.ModelReaderWriterOptions" /> to use.</param><returns>A binary representation of the written model.</returns><exception cref="T:System.FormatException">If the model does not support the requested <see cref="P:System.ClientModel.Primitives.ModelReaderWriterOptions.Format" />.</exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.CreateAndRunThreadOptions.System#ClientModel#Primitives#IPersistableModel{Azure#AI#OpenAI#Assistants#CreateAndRunThreadOptions}#Create(System.BinaryData,System.ClientModel.Primitives.ModelReaderWriterOptions)">
|
|
<summary>
|
|
Converts the provided <see cref="T:System.BinaryData" /> into a model.
|
|
</summary><param name="data">The <see cref="T:System.BinaryData" /> to parse.</param><param name="options">The <see cref="T:System.ClientModel.Primitives.ModelReaderWriterOptions" /> to use.</param><returns>A <typeparamref name="T" /> representation of the data.</returns><exception cref="T:System.FormatException">If the model does not support the requested <see cref="P:System.ClientModel.Primitives.ModelReaderWriterOptions.Format" />.</exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.CreateAndRunThreadOptions.System#ClientModel#Primitives#IPersistableModel{Azure#AI#OpenAI#Assistants#CreateAndRunThreadOptions}#GetFormatFromOptions(System.ClientModel.Primitives.ModelReaderWriterOptions)">
|
|
<summary>
|
|
Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service.
|
|
<param name="options">The <see cref="T:System.ClientModel.Primitives.ModelReaderWriterOptions" /> to use.</param></summary><returns>The format that the model uses when communicating with the serivce.</returns>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.CreateAssistantFileRequest.System#ClientModel#Primitives#IJsonModel{Azure#AI#OpenAI#Assistants#CreateAssistantFileRequest}#Write(System.Text.Json.Utf8JsonWriter,System.ClientModel.Primitives.ModelReaderWriterOptions)">
|
|
<summary>
|
|
Writes the model to the provided <see cref="T:System.Text.Json.Utf8JsonWriter" />.
|
|
</summary><param name="writer">The <see cref="T:System.Text.Json.Utf8JsonWriter" /> to write into.</param><param name="options">The <see cref="T:System.ClientModel.Primitives.ModelReaderWriterOptions" /> to use.</param><exception cref="T:System.FormatException">If the model does not support the requested <see cref="P:System.ClientModel.Primitives.ModelReaderWriterOptions.Format" />.</exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.CreateAssistantFileRequest.System#ClientModel#Primitives#IJsonModel{Azure#AI#OpenAI#Assistants#CreateAssistantFileRequest}#Create(System.Text.Json.Utf8JsonReader@,System.ClientModel.Primitives.ModelReaderWriterOptions)">
|
|
<summary>
|
|
Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model.
|
|
</summary><param name="reader">The <see cref="T:System.Text.Json.Utf8JsonReader" /> to read.</param><param name="options">The <see cref="T:System.ClientModel.Primitives.ModelReaderWriterOptions" /> to use.</param><returns>A <typeparamref name="T" /> representation of the JSON value.</returns><exception cref="T:System.FormatException">If the model does not support the requested <see cref="P:System.ClientModel.Primitives.ModelReaderWriterOptions.Format" />.</exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.CreateAssistantFileRequest.System#ClientModel#Primitives#IPersistableModel{Azure#AI#OpenAI#Assistants#CreateAssistantFileRequest}#Write(System.ClientModel.Primitives.ModelReaderWriterOptions)">
|
|
<summary>
|
|
Writes the model into a <see cref="T:System.BinaryData" />.
|
|
</summary><param name="options">The <see cref="T:System.ClientModel.Primitives.ModelReaderWriterOptions" /> to use.</param><returns>A binary representation of the written model.</returns><exception cref="T:System.FormatException">If the model does not support the requested <see cref="P:System.ClientModel.Primitives.ModelReaderWriterOptions.Format" />.</exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.CreateAssistantFileRequest.System#ClientModel#Primitives#IPersistableModel{Azure#AI#OpenAI#Assistants#CreateAssistantFileRequest}#Create(System.BinaryData,System.ClientModel.Primitives.ModelReaderWriterOptions)">
|
|
<summary>
|
|
Converts the provided <see cref="T:System.BinaryData" /> into a model.
|
|
</summary><param name="data">The <see cref="T:System.BinaryData" /> to parse.</param><param name="options">The <see cref="T:System.ClientModel.Primitives.ModelReaderWriterOptions" /> to use.</param><returns>A <typeparamref name="T" /> representation of the data.</returns><exception cref="T:System.FormatException">If the model does not support the requested <see cref="P:System.ClientModel.Primitives.ModelReaderWriterOptions.Format" />.</exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.CreateAssistantFileRequest.System#ClientModel#Primitives#IPersistableModel{Azure#AI#OpenAI#Assistants#CreateAssistantFileRequest}#GetFormatFromOptions(System.ClientModel.Primitives.ModelReaderWriterOptions)">
|
|
<summary>
|
|
Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service.
|
|
<param name="options">The <see cref="T:System.ClientModel.Primitives.ModelReaderWriterOptions" /> to use.</param></summary><returns>The format that the model uses when communicating with the serivce.</returns>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.CreateMessageRequest.System#ClientModel#Primitives#IJsonModel{Azure#AI#OpenAI#Assistants#CreateMessageRequest}#Write(System.Text.Json.Utf8JsonWriter,System.ClientModel.Primitives.ModelReaderWriterOptions)">
|
|
<summary>
|
|
Writes the model to the provided <see cref="T:System.Text.Json.Utf8JsonWriter" />.
|
|
</summary><param name="writer">The <see cref="T:System.Text.Json.Utf8JsonWriter" /> to write into.</param><param name="options">The <see cref="T:System.ClientModel.Primitives.ModelReaderWriterOptions" /> to use.</param><exception cref="T:System.FormatException">If the model does not support the requested <see cref="P:System.ClientModel.Primitives.ModelReaderWriterOptions.Format" />.</exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.CreateMessageRequest.System#ClientModel#Primitives#IJsonModel{Azure#AI#OpenAI#Assistants#CreateMessageRequest}#Create(System.Text.Json.Utf8JsonReader@,System.ClientModel.Primitives.ModelReaderWriterOptions)">
|
|
<summary>
|
|
Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model.
|
|
</summary><param name="reader">The <see cref="T:System.Text.Json.Utf8JsonReader" /> to read.</param><param name="options">The <see cref="T:System.ClientModel.Primitives.ModelReaderWriterOptions" /> to use.</param><returns>A <typeparamref name="T" /> representation of the JSON value.</returns><exception cref="T:System.FormatException">If the model does not support the requested <see cref="P:System.ClientModel.Primitives.ModelReaderWriterOptions.Format" />.</exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.CreateMessageRequest.System#ClientModel#Primitives#IPersistableModel{Azure#AI#OpenAI#Assistants#CreateMessageRequest}#Write(System.ClientModel.Primitives.ModelReaderWriterOptions)">
|
|
<summary>
|
|
Writes the model into a <see cref="T:System.BinaryData" />.
|
|
</summary><param name="options">The <see cref="T:System.ClientModel.Primitives.ModelReaderWriterOptions" /> to use.</param><returns>A binary representation of the written model.</returns><exception cref="T:System.FormatException">If the model does not support the requested <see cref="P:System.ClientModel.Primitives.ModelReaderWriterOptions.Format" />.</exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.CreateMessageRequest.System#ClientModel#Primitives#IPersistableModel{Azure#AI#OpenAI#Assistants#CreateMessageRequest}#Create(System.BinaryData,System.ClientModel.Primitives.ModelReaderWriterOptions)">
|
|
<summary>
|
|
Converts the provided <see cref="T:System.BinaryData" /> into a model.
|
|
</summary><param name="data">The <see cref="T:System.BinaryData" /> to parse.</param><param name="options">The <see cref="T:System.ClientModel.Primitives.ModelReaderWriterOptions" /> to use.</param><returns>A <typeparamref name="T" /> representation of the data.</returns><exception cref="T:System.FormatException">If the model does not support the requested <see cref="P:System.ClientModel.Primitives.ModelReaderWriterOptions.Format" />.</exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.CreateMessageRequest.System#ClientModel#Primitives#IPersistableModel{Azure#AI#OpenAI#Assistants#CreateMessageRequest}#GetFormatFromOptions(System.ClientModel.Primitives.ModelReaderWriterOptions)">
|
|
<summary>
|
|
Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service.
|
|
<param name="options">The <see cref="T:System.ClientModel.Primitives.ModelReaderWriterOptions" /> to use.</param></summary><returns>The format that the model uses when communicating with the serivce.</returns>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.CreateRunOptions.System#ClientModel#Primitives#IJsonModel{Azure#AI#OpenAI#Assistants#CreateRunOptions}#Write(System.Text.Json.Utf8JsonWriter,System.ClientModel.Primitives.ModelReaderWriterOptions)">
|
|
<summary>
|
|
Writes the model to the provided <see cref="T:System.Text.Json.Utf8JsonWriter" />.
|
|
</summary><param name="writer">The <see cref="T:System.Text.Json.Utf8JsonWriter" /> to write into.</param><param name="options">The <see cref="T:System.ClientModel.Primitives.ModelReaderWriterOptions" /> to use.</param><exception cref="T:System.FormatException">If the model does not support the requested <see cref="P:System.ClientModel.Primitives.ModelReaderWriterOptions.Format" />.</exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.CreateRunOptions.System#ClientModel#Primitives#IJsonModel{Azure#AI#OpenAI#Assistants#CreateRunOptions}#Create(System.Text.Json.Utf8JsonReader@,System.ClientModel.Primitives.ModelReaderWriterOptions)">
|
|
<summary>
|
|
Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model.
|
|
</summary><param name="reader">The <see cref="T:System.Text.Json.Utf8JsonReader" /> to read.</param><param name="options">The <see cref="T:System.ClientModel.Primitives.ModelReaderWriterOptions" /> to use.</param><returns>A <typeparamref name="T" /> representation of the JSON value.</returns><exception cref="T:System.FormatException">If the model does not support the requested <see cref="P:System.ClientModel.Primitives.ModelReaderWriterOptions.Format" />.</exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.CreateRunOptions.System#ClientModel#Primitives#IPersistableModel{Azure#AI#OpenAI#Assistants#CreateRunOptions}#Write(System.ClientModel.Primitives.ModelReaderWriterOptions)">
|
|
<summary>
|
|
Writes the model into a <see cref="T:System.BinaryData" />.
|
|
</summary><param name="options">The <see cref="T:System.ClientModel.Primitives.ModelReaderWriterOptions" /> to use.</param><returns>A binary representation of the written model.</returns><exception cref="T:System.FormatException">If the model does not support the requested <see cref="P:System.ClientModel.Primitives.ModelReaderWriterOptions.Format" />.</exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.CreateRunOptions.System#ClientModel#Primitives#IPersistableModel{Azure#AI#OpenAI#Assistants#CreateRunOptions}#Create(System.BinaryData,System.ClientModel.Primitives.ModelReaderWriterOptions)">
|
|
<summary>
|
|
Converts the provided <see cref="T:System.BinaryData" /> into a model.
|
|
</summary><param name="data">The <see cref="T:System.BinaryData" /> to parse.</param><param name="options">The <see cref="T:System.ClientModel.Primitives.ModelReaderWriterOptions" /> to use.</param><returns>A <typeparamref name="T" /> representation of the data.</returns><exception cref="T:System.FormatException">If the model does not support the requested <see cref="P:System.ClientModel.Primitives.ModelReaderWriterOptions.Format" />.</exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.CreateRunOptions.System#ClientModel#Primitives#IPersistableModel{Azure#AI#OpenAI#Assistants#CreateRunOptions}#GetFormatFromOptions(System.ClientModel.Primitives.ModelReaderWriterOptions)">
|
|
<summary>
|
|
Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service.
|
|
<param name="options">The <see cref="T:System.ClientModel.Primitives.ModelReaderWriterOptions" /> to use.</param></summary><returns>The format that the model uses when communicating with the serivce.</returns>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.InternalAssistantDeletionStatus.System#ClientModel#Primitives#IJsonModel{Azure#AI#OpenAI#Assistants#InternalAssistantDeletionStatus}#Write(System.Text.Json.Utf8JsonWriter,System.ClientModel.Primitives.ModelReaderWriterOptions)">
|
|
<summary>
|
|
Writes the model to the provided <see cref="T:System.Text.Json.Utf8JsonWriter" />.
|
|
</summary><param name="writer">The <see cref="T:System.Text.Json.Utf8JsonWriter" /> to write into.</param><param name="options">The <see cref="T:System.ClientModel.Primitives.ModelReaderWriterOptions" /> to use.</param><exception cref="T:System.FormatException">If the model does not support the requested <see cref="P:System.ClientModel.Primitives.ModelReaderWriterOptions.Format" />.</exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.InternalAssistantDeletionStatus.System#ClientModel#Primitives#IJsonModel{Azure#AI#OpenAI#Assistants#InternalAssistantDeletionStatus}#Create(System.Text.Json.Utf8JsonReader@,System.ClientModel.Primitives.ModelReaderWriterOptions)">
|
|
<summary>
|
|
Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model.
|
|
</summary><param name="reader">The <see cref="T:System.Text.Json.Utf8JsonReader" /> to read.</param><param name="options">The <see cref="T:System.ClientModel.Primitives.ModelReaderWriterOptions" /> to use.</param><returns>A <typeparamref name="T" /> representation of the JSON value.</returns><exception cref="T:System.FormatException">If the model does not support the requested <see cref="P:System.ClientModel.Primitives.ModelReaderWriterOptions.Format" />.</exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.InternalAssistantDeletionStatus.System#ClientModel#Primitives#IPersistableModel{Azure#AI#OpenAI#Assistants#InternalAssistantDeletionStatus}#Write(System.ClientModel.Primitives.ModelReaderWriterOptions)">
|
|
<summary>
|
|
Writes the model into a <see cref="T:System.BinaryData" />.
|
|
</summary><param name="options">The <see cref="T:System.ClientModel.Primitives.ModelReaderWriterOptions" /> to use.</param><returns>A binary representation of the written model.</returns><exception cref="T:System.FormatException">If the model does not support the requested <see cref="P:System.ClientModel.Primitives.ModelReaderWriterOptions.Format" />.</exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.InternalAssistantDeletionStatus.System#ClientModel#Primitives#IPersistableModel{Azure#AI#OpenAI#Assistants#InternalAssistantDeletionStatus}#Create(System.BinaryData,System.ClientModel.Primitives.ModelReaderWriterOptions)">
|
|
<summary>
|
|
Converts the provided <see cref="T:System.BinaryData" /> into a model.
|
|
</summary><param name="data">The <see cref="T:System.BinaryData" /> to parse.</param><param name="options">The <see cref="T:System.ClientModel.Primitives.ModelReaderWriterOptions" /> to use.</param><returns>A <typeparamref name="T" /> representation of the data.</returns><exception cref="T:System.FormatException">If the model does not support the requested <see cref="P:System.ClientModel.Primitives.ModelReaderWriterOptions.Format" />.</exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.InternalAssistantDeletionStatus.System#ClientModel#Primitives#IPersistableModel{Azure#AI#OpenAI#Assistants#InternalAssistantDeletionStatus}#GetFormatFromOptions(System.ClientModel.Primitives.ModelReaderWriterOptions)">
|
|
<summary>
|
|
Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service.
|
|
<param name="options">The <see cref="T:System.ClientModel.Primitives.ModelReaderWriterOptions" /> to use.</param></summary><returns>The format that the model uses when communicating with the serivce.</returns>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.InternalAssistantFileDeletionStatus.System#ClientModel#Primitives#IJsonModel{Azure#AI#OpenAI#Assistants#InternalAssistantFileDeletionStatus}#Write(System.Text.Json.Utf8JsonWriter,System.ClientModel.Primitives.ModelReaderWriterOptions)">
|
|
<summary>
|
|
Writes the model to the provided <see cref="T:System.Text.Json.Utf8JsonWriter" />.
|
|
</summary><param name="writer">The <see cref="T:System.Text.Json.Utf8JsonWriter" /> to write into.</param><param name="options">The <see cref="T:System.ClientModel.Primitives.ModelReaderWriterOptions" /> to use.</param><exception cref="T:System.FormatException">If the model does not support the requested <see cref="P:System.ClientModel.Primitives.ModelReaderWriterOptions.Format" />.</exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.InternalAssistantFileDeletionStatus.System#ClientModel#Primitives#IJsonModel{Azure#AI#OpenAI#Assistants#InternalAssistantFileDeletionStatus}#Create(System.Text.Json.Utf8JsonReader@,System.ClientModel.Primitives.ModelReaderWriterOptions)">
|
|
<summary>
|
|
Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model.
|
|
</summary><param name="reader">The <see cref="T:System.Text.Json.Utf8JsonReader" /> to read.</param><param name="options">The <see cref="T:System.ClientModel.Primitives.ModelReaderWriterOptions" /> to use.</param><returns>A <typeparamref name="T" /> representation of the JSON value.</returns><exception cref="T:System.FormatException">If the model does not support the requested <see cref="P:System.ClientModel.Primitives.ModelReaderWriterOptions.Format" />.</exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.InternalAssistantFileDeletionStatus.System#ClientModel#Primitives#IPersistableModel{Azure#AI#OpenAI#Assistants#InternalAssistantFileDeletionStatus}#Write(System.ClientModel.Primitives.ModelReaderWriterOptions)">
|
|
<summary>
|
|
Writes the model into a <see cref="T:System.BinaryData" />.
|
|
</summary><param name="options">The <see cref="T:System.ClientModel.Primitives.ModelReaderWriterOptions" /> to use.</param><returns>A binary representation of the written model.</returns><exception cref="T:System.FormatException">If the model does not support the requested <see cref="P:System.ClientModel.Primitives.ModelReaderWriterOptions.Format" />.</exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.InternalAssistantFileDeletionStatus.System#ClientModel#Primitives#IPersistableModel{Azure#AI#OpenAI#Assistants#InternalAssistantFileDeletionStatus}#Create(System.BinaryData,System.ClientModel.Primitives.ModelReaderWriterOptions)">
|
|
<summary>
|
|
Converts the provided <see cref="T:System.BinaryData" /> into a model.
|
|
</summary><param name="data">The <see cref="T:System.BinaryData" /> to parse.</param><param name="options">The <see cref="T:System.ClientModel.Primitives.ModelReaderWriterOptions" /> to use.</param><returns>A <typeparamref name="T" /> representation of the data.</returns><exception cref="T:System.FormatException">If the model does not support the requested <see cref="P:System.ClientModel.Primitives.ModelReaderWriterOptions.Format" />.</exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.InternalAssistantFileDeletionStatus.System#ClientModel#Primitives#IPersistableModel{Azure#AI#OpenAI#Assistants#InternalAssistantFileDeletionStatus}#GetFormatFromOptions(System.ClientModel.Primitives.ModelReaderWriterOptions)">
|
|
<summary>
|
|
Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service.
|
|
<param name="options">The <see cref="T:System.ClientModel.Primitives.ModelReaderWriterOptions" /> to use.</param></summary><returns>The format that the model uses when communicating with the serivce.</returns>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.InternalCodeInterpreterToolCallDetails.System#ClientModel#Primitives#IJsonModel{Azure#AI#OpenAI#Assistants#InternalCodeInterpreterToolCallDetails}#Write(System.Text.Json.Utf8JsonWriter,System.ClientModel.Primitives.ModelReaderWriterOptions)">
|
|
<summary>
|
|
Writes the model to the provided <see cref="T:System.Text.Json.Utf8JsonWriter" />.
|
|
</summary><param name="writer">The <see cref="T:System.Text.Json.Utf8JsonWriter" /> to write into.</param><param name="options">The <see cref="T:System.ClientModel.Primitives.ModelReaderWriterOptions" /> to use.</param><exception cref="T:System.FormatException">If the model does not support the requested <see cref="P:System.ClientModel.Primitives.ModelReaderWriterOptions.Format" />.</exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.InternalCodeInterpreterToolCallDetails.System#ClientModel#Primitives#IJsonModel{Azure#AI#OpenAI#Assistants#InternalCodeInterpreterToolCallDetails}#Create(System.Text.Json.Utf8JsonReader@,System.ClientModel.Primitives.ModelReaderWriterOptions)">
|
|
<summary>
|
|
Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model.
|
|
</summary><param name="reader">The <see cref="T:System.Text.Json.Utf8JsonReader" /> to read.</param><param name="options">The <see cref="T:System.ClientModel.Primitives.ModelReaderWriterOptions" /> to use.</param><returns>A <typeparamref name="T" /> representation of the JSON value.</returns><exception cref="T:System.FormatException">If the model does not support the requested <see cref="P:System.ClientModel.Primitives.ModelReaderWriterOptions.Format" />.</exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.InternalCodeInterpreterToolCallDetails.System#ClientModel#Primitives#IPersistableModel{Azure#AI#OpenAI#Assistants#InternalCodeInterpreterToolCallDetails}#Write(System.ClientModel.Primitives.ModelReaderWriterOptions)">
|
|
<summary>
|
|
Writes the model into a <see cref="T:System.BinaryData" />.
|
|
</summary><param name="options">The <see cref="T:System.ClientModel.Primitives.ModelReaderWriterOptions" /> to use.</param><returns>A binary representation of the written model.</returns><exception cref="T:System.FormatException">If the model does not support the requested <see cref="P:System.ClientModel.Primitives.ModelReaderWriterOptions.Format" />.</exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.InternalCodeInterpreterToolCallDetails.System#ClientModel#Primitives#IPersistableModel{Azure#AI#OpenAI#Assistants#InternalCodeInterpreterToolCallDetails}#Create(System.BinaryData,System.ClientModel.Primitives.ModelReaderWriterOptions)">
|
|
<summary>
|
|
Converts the provided <see cref="T:System.BinaryData" /> into a model.
|
|
</summary><param name="data">The <see cref="T:System.BinaryData" /> to parse.</param><param name="options">The <see cref="T:System.ClientModel.Primitives.ModelReaderWriterOptions" /> to use.</param><returns>A <typeparamref name="T" /> representation of the data.</returns><exception cref="T:System.FormatException">If the model does not support the requested <see cref="P:System.ClientModel.Primitives.ModelReaderWriterOptions.Format" />.</exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.InternalCodeInterpreterToolCallDetails.System#ClientModel#Primitives#IPersistableModel{Azure#AI#OpenAI#Assistants#InternalCodeInterpreterToolCallDetails}#GetFormatFromOptions(System.ClientModel.Primitives.ModelReaderWriterOptions)">
|
|
<summary>
|
|
Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service.
|
|
<param name="options">The <see cref="T:System.ClientModel.Primitives.ModelReaderWriterOptions" /> to use.</param></summary><returns>The format that the model uses when communicating with the serivce.</returns>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.InternalFileDeletionStatus.System#ClientModel#Primitives#IJsonModel{Azure#AI#OpenAI#Assistants#InternalFileDeletionStatus}#Write(System.Text.Json.Utf8JsonWriter,System.ClientModel.Primitives.ModelReaderWriterOptions)">
|
|
<summary>
|
|
Writes the model to the provided <see cref="T:System.Text.Json.Utf8JsonWriter" />.
|
|
</summary><param name="writer">The <see cref="T:System.Text.Json.Utf8JsonWriter" /> to write into.</param><param name="options">The <see cref="T:System.ClientModel.Primitives.ModelReaderWriterOptions" /> to use.</param><exception cref="T:System.FormatException">If the model does not support the requested <see cref="P:System.ClientModel.Primitives.ModelReaderWriterOptions.Format" />.</exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.InternalFileDeletionStatus.System#ClientModel#Primitives#IJsonModel{Azure#AI#OpenAI#Assistants#InternalFileDeletionStatus}#Create(System.Text.Json.Utf8JsonReader@,System.ClientModel.Primitives.ModelReaderWriterOptions)">
|
|
<summary>
|
|
Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model.
|
|
</summary><param name="reader">The <see cref="T:System.Text.Json.Utf8JsonReader" /> to read.</param><param name="options">The <see cref="T:System.ClientModel.Primitives.ModelReaderWriterOptions" /> to use.</param><returns>A <typeparamref name="T" /> representation of the JSON value.</returns><exception cref="T:System.FormatException">If the model does not support the requested <see cref="P:System.ClientModel.Primitives.ModelReaderWriterOptions.Format" />.</exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.InternalFileDeletionStatus.System#ClientModel#Primitives#IPersistableModel{Azure#AI#OpenAI#Assistants#InternalFileDeletionStatus}#Write(System.ClientModel.Primitives.ModelReaderWriterOptions)">
|
|
<summary>
|
|
Writes the model into a <see cref="T:System.BinaryData" />.
|
|
</summary><param name="options">The <see cref="T:System.ClientModel.Primitives.ModelReaderWriterOptions" /> to use.</param><returns>A binary representation of the written model.</returns><exception cref="T:System.FormatException">If the model does not support the requested <see cref="P:System.ClientModel.Primitives.ModelReaderWriterOptions.Format" />.</exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.InternalFileDeletionStatus.System#ClientModel#Primitives#IPersistableModel{Azure#AI#OpenAI#Assistants#InternalFileDeletionStatus}#Create(System.BinaryData,System.ClientModel.Primitives.ModelReaderWriterOptions)">
|
|
<summary>
|
|
Converts the provided <see cref="T:System.BinaryData" /> into a model.
|
|
</summary><param name="data">The <see cref="T:System.BinaryData" /> to parse.</param><param name="options">The <see cref="T:System.ClientModel.Primitives.ModelReaderWriterOptions" /> to use.</param><returns>A <typeparamref name="T" /> representation of the data.</returns><exception cref="T:System.FormatException">If the model does not support the requested <see cref="P:System.ClientModel.Primitives.ModelReaderWriterOptions.Format" />.</exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.InternalFileDeletionStatus.System#ClientModel#Primitives#IPersistableModel{Azure#AI#OpenAI#Assistants#InternalFileDeletionStatus}#GetFormatFromOptions(System.ClientModel.Primitives.ModelReaderWriterOptions)">
|
|
<summary>
|
|
Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service.
|
|
<param name="options">The <see cref="T:System.ClientModel.Primitives.ModelReaderWriterOptions" /> to use.</param></summary><returns>The format that the model uses when communicating with the serivce.</returns>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.InternalFileListResponse.System#ClientModel#Primitives#IJsonModel{Azure#AI#OpenAI#Assistants#InternalFileListResponse}#Write(System.Text.Json.Utf8JsonWriter,System.ClientModel.Primitives.ModelReaderWriterOptions)">
|
|
<summary>
|
|
Writes the model to the provided <see cref="T:System.Text.Json.Utf8JsonWriter" />.
|
|
</summary><param name="writer">The <see cref="T:System.Text.Json.Utf8JsonWriter" /> to write into.</param><param name="options">The <see cref="T:System.ClientModel.Primitives.ModelReaderWriterOptions" /> to use.</param><exception cref="T:System.FormatException">If the model does not support the requested <see cref="P:System.ClientModel.Primitives.ModelReaderWriterOptions.Format" />.</exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.InternalFileListResponse.System#ClientModel#Primitives#IJsonModel{Azure#AI#OpenAI#Assistants#InternalFileListResponse}#Create(System.Text.Json.Utf8JsonReader@,System.ClientModel.Primitives.ModelReaderWriterOptions)">
|
|
<summary>
|
|
Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model.
|
|
</summary><param name="reader">The <see cref="T:System.Text.Json.Utf8JsonReader" /> to read.</param><param name="options">The <see cref="T:System.ClientModel.Primitives.ModelReaderWriterOptions" /> to use.</param><returns>A <typeparamref name="T" /> representation of the JSON value.</returns><exception cref="T:System.FormatException">If the model does not support the requested <see cref="P:System.ClientModel.Primitives.ModelReaderWriterOptions.Format" />.</exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.InternalFileListResponse.System#ClientModel#Primitives#IPersistableModel{Azure#AI#OpenAI#Assistants#InternalFileListResponse}#Write(System.ClientModel.Primitives.ModelReaderWriterOptions)">
|
|
<summary>
|
|
Writes the model into a <see cref="T:System.BinaryData" />.
|
|
</summary><param name="options">The <see cref="T:System.ClientModel.Primitives.ModelReaderWriterOptions" /> to use.</param><returns>A binary representation of the written model.</returns><exception cref="T:System.FormatException">If the model does not support the requested <see cref="P:System.ClientModel.Primitives.ModelReaderWriterOptions.Format" />.</exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.InternalFileListResponse.System#ClientModel#Primitives#IPersistableModel{Azure#AI#OpenAI#Assistants#InternalFileListResponse}#Create(System.BinaryData,System.ClientModel.Primitives.ModelReaderWriterOptions)">
|
|
<summary>
|
|
Converts the provided <see cref="T:System.BinaryData" /> into a model.
|
|
</summary><param name="data">The <see cref="T:System.BinaryData" /> to parse.</param><param name="options">The <see cref="T:System.ClientModel.Primitives.ModelReaderWriterOptions" /> to use.</param><returns>A <typeparamref name="T" /> representation of the data.</returns><exception cref="T:System.FormatException">If the model does not support the requested <see cref="P:System.ClientModel.Primitives.ModelReaderWriterOptions.Format" />.</exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.InternalFileListResponse.System#ClientModel#Primitives#IPersistableModel{Azure#AI#OpenAI#Assistants#InternalFileListResponse}#GetFormatFromOptions(System.ClientModel.Primitives.ModelReaderWriterOptions)">
|
|
<summary>
|
|
Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service.
|
|
<param name="options">The <see cref="T:System.ClientModel.Primitives.ModelReaderWriterOptions" /> to use.</param></summary><returns>The format that the model uses when communicating with the serivce.</returns>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.InternalFunctionDefinition.System#ClientModel#Primitives#IJsonModel{Azure#AI#OpenAI#Assistants#InternalFunctionDefinition}#Write(System.Text.Json.Utf8JsonWriter,System.ClientModel.Primitives.ModelReaderWriterOptions)">
|
|
<summary>
|
|
Writes the model to the provided <see cref="T:System.Text.Json.Utf8JsonWriter" />.
|
|
</summary><param name="writer">The <see cref="T:System.Text.Json.Utf8JsonWriter" /> to write into.</param><param name="options">The <see cref="T:System.ClientModel.Primitives.ModelReaderWriterOptions" /> to use.</param><exception cref="T:System.FormatException">If the model does not support the requested <see cref="P:System.ClientModel.Primitives.ModelReaderWriterOptions.Format" />.</exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.InternalFunctionDefinition.System#ClientModel#Primitives#IJsonModel{Azure#AI#OpenAI#Assistants#InternalFunctionDefinition}#Create(System.Text.Json.Utf8JsonReader@,System.ClientModel.Primitives.ModelReaderWriterOptions)">
|
|
<summary>
|
|
Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model.
|
|
</summary><param name="reader">The <see cref="T:System.Text.Json.Utf8JsonReader" /> to read.</param><param name="options">The <see cref="T:System.ClientModel.Primitives.ModelReaderWriterOptions" /> to use.</param><returns>A <typeparamref name="T" /> representation of the JSON value.</returns><exception cref="T:System.FormatException">If the model does not support the requested <see cref="P:System.ClientModel.Primitives.ModelReaderWriterOptions.Format" />.</exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.InternalFunctionDefinition.System#ClientModel#Primitives#IPersistableModel{Azure#AI#OpenAI#Assistants#InternalFunctionDefinition}#Write(System.ClientModel.Primitives.ModelReaderWriterOptions)">
|
|
<summary>
|
|
Writes the model into a <see cref="T:System.BinaryData" />.
|
|
</summary><param name="options">The <see cref="T:System.ClientModel.Primitives.ModelReaderWriterOptions" /> to use.</param><returns>A binary representation of the written model.</returns><exception cref="T:System.FormatException">If the model does not support the requested <see cref="P:System.ClientModel.Primitives.ModelReaderWriterOptions.Format" />.</exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.InternalFunctionDefinition.System#ClientModel#Primitives#IPersistableModel{Azure#AI#OpenAI#Assistants#InternalFunctionDefinition}#Create(System.BinaryData,System.ClientModel.Primitives.ModelReaderWriterOptions)">
|
|
<summary>
|
|
Converts the provided <see cref="T:System.BinaryData" /> into a model.
|
|
</summary><param name="data">The <see cref="T:System.BinaryData" /> to parse.</param><param name="options">The <see cref="T:System.ClientModel.Primitives.ModelReaderWriterOptions" /> to use.</param><returns>A <typeparamref name="T" /> representation of the data.</returns><exception cref="T:System.FormatException">If the model does not support the requested <see cref="P:System.ClientModel.Primitives.ModelReaderWriterOptions.Format" />.</exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.InternalFunctionDefinition.System#ClientModel#Primitives#IPersistableModel{Azure#AI#OpenAI#Assistants#InternalFunctionDefinition}#GetFormatFromOptions(System.ClientModel.Primitives.ModelReaderWriterOptions)">
|
|
<summary>
|
|
Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service.
|
|
<param name="options">The <see cref="T:System.ClientModel.Primitives.ModelReaderWriterOptions" /> to use.</param></summary><returns>The format that the model uses when communicating with the serivce.</returns>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.InternalMessageImageFileDetails.System#ClientModel#Primitives#IJsonModel{Azure#AI#OpenAI#Assistants#InternalMessageImageFileDetails}#Write(System.Text.Json.Utf8JsonWriter,System.ClientModel.Primitives.ModelReaderWriterOptions)">
|
|
<summary>
|
|
Writes the model to the provided <see cref="T:System.Text.Json.Utf8JsonWriter" />.
|
|
</summary><param name="writer">The <see cref="T:System.Text.Json.Utf8JsonWriter" /> to write into.</param><param name="options">The <see cref="T:System.ClientModel.Primitives.ModelReaderWriterOptions" /> to use.</param><exception cref="T:System.FormatException">If the model does not support the requested <see cref="P:System.ClientModel.Primitives.ModelReaderWriterOptions.Format" />.</exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.InternalMessageImageFileDetails.System#ClientModel#Primitives#IJsonModel{Azure#AI#OpenAI#Assistants#InternalMessageImageFileDetails}#Create(System.Text.Json.Utf8JsonReader@,System.ClientModel.Primitives.ModelReaderWriterOptions)">
|
|
<summary>
|
|
Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model.
|
|
</summary><param name="reader">The <see cref="T:System.Text.Json.Utf8JsonReader" /> to read.</param><param name="options">The <see cref="T:System.ClientModel.Primitives.ModelReaderWriterOptions" /> to use.</param><returns>A <typeparamref name="T" /> representation of the JSON value.</returns><exception cref="T:System.FormatException">If the model does not support the requested <see cref="P:System.ClientModel.Primitives.ModelReaderWriterOptions.Format" />.</exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.InternalMessageImageFileDetails.System#ClientModel#Primitives#IPersistableModel{Azure#AI#OpenAI#Assistants#InternalMessageImageFileDetails}#Write(System.ClientModel.Primitives.ModelReaderWriterOptions)">
|
|
<summary>
|
|
Writes the model into a <see cref="T:System.BinaryData" />.
|
|
</summary><param name="options">The <see cref="T:System.ClientModel.Primitives.ModelReaderWriterOptions" /> to use.</param><returns>A binary representation of the written model.</returns><exception cref="T:System.FormatException">If the model does not support the requested <see cref="P:System.ClientModel.Primitives.ModelReaderWriterOptions.Format" />.</exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.InternalMessageImageFileDetails.System#ClientModel#Primitives#IPersistableModel{Azure#AI#OpenAI#Assistants#InternalMessageImageFileDetails}#Create(System.BinaryData,System.ClientModel.Primitives.ModelReaderWriterOptions)">
|
|
<summary>
|
|
Converts the provided <see cref="T:System.BinaryData" /> into a model.
|
|
</summary><param name="data">The <see cref="T:System.BinaryData" /> to parse.</param><param name="options">The <see cref="T:System.ClientModel.Primitives.ModelReaderWriterOptions" /> to use.</param><returns>A <typeparamref name="T" /> representation of the data.</returns><exception cref="T:System.FormatException">If the model does not support the requested <see cref="P:System.ClientModel.Primitives.ModelReaderWriterOptions.Format" />.</exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.InternalMessageImageFileDetails.System#ClientModel#Primitives#IPersistableModel{Azure#AI#OpenAI#Assistants#InternalMessageImageFileDetails}#GetFormatFromOptions(System.ClientModel.Primitives.ModelReaderWriterOptions)">
|
|
<summary>
|
|
Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service.
|
|
<param name="options">The <see cref="T:System.ClientModel.Primitives.ModelReaderWriterOptions" /> to use.</param></summary><returns>The format that the model uses when communicating with the serivce.</returns>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.InternalMessageTextDetails.System#ClientModel#Primitives#IJsonModel{Azure#AI#OpenAI#Assistants#InternalMessageTextDetails}#Write(System.Text.Json.Utf8JsonWriter,System.ClientModel.Primitives.ModelReaderWriterOptions)">
|
|
<summary>
|
|
Writes the model to the provided <see cref="T:System.Text.Json.Utf8JsonWriter" />.
|
|
</summary><param name="writer">The <see cref="T:System.Text.Json.Utf8JsonWriter" /> to write into.</param><param name="options">The <see cref="T:System.ClientModel.Primitives.ModelReaderWriterOptions" /> to use.</param><exception cref="T:System.FormatException">If the model does not support the requested <see cref="P:System.ClientModel.Primitives.ModelReaderWriterOptions.Format" />.</exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.InternalMessageTextDetails.System#ClientModel#Primitives#IJsonModel{Azure#AI#OpenAI#Assistants#InternalMessageTextDetails}#Create(System.Text.Json.Utf8JsonReader@,System.ClientModel.Primitives.ModelReaderWriterOptions)">
|
|
<summary>
|
|
Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model.
|
|
</summary><param name="reader">The <see cref="T:System.Text.Json.Utf8JsonReader" /> to read.</param><param name="options">The <see cref="T:System.ClientModel.Primitives.ModelReaderWriterOptions" /> to use.</param><returns>A <typeparamref name="T" /> representation of the JSON value.</returns><exception cref="T:System.FormatException">If the model does not support the requested <see cref="P:System.ClientModel.Primitives.ModelReaderWriterOptions.Format" />.</exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.InternalMessageTextDetails.System#ClientModel#Primitives#IPersistableModel{Azure#AI#OpenAI#Assistants#InternalMessageTextDetails}#Write(System.ClientModel.Primitives.ModelReaderWriterOptions)">
|
|
<summary>
|
|
Writes the model into a <see cref="T:System.BinaryData" />.
|
|
</summary><param name="options">The <see cref="T:System.ClientModel.Primitives.ModelReaderWriterOptions" /> to use.</param><returns>A binary representation of the written model.</returns><exception cref="T:System.FormatException">If the model does not support the requested <see cref="P:System.ClientModel.Primitives.ModelReaderWriterOptions.Format" />.</exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.InternalMessageTextDetails.System#ClientModel#Primitives#IPersistableModel{Azure#AI#OpenAI#Assistants#InternalMessageTextDetails}#Create(System.BinaryData,System.ClientModel.Primitives.ModelReaderWriterOptions)">
|
|
<summary>
|
|
Converts the provided <see cref="T:System.BinaryData" /> into a model.
|
|
</summary><param name="data">The <see cref="T:System.BinaryData" /> to parse.</param><param name="options">The <see cref="T:System.ClientModel.Primitives.ModelReaderWriterOptions" /> to use.</param><returns>A <typeparamref name="T" /> representation of the data.</returns><exception cref="T:System.FormatException">If the model does not support the requested <see cref="P:System.ClientModel.Primitives.ModelReaderWriterOptions.Format" />.</exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.InternalMessageTextDetails.System#ClientModel#Primitives#IPersistableModel{Azure#AI#OpenAI#Assistants#InternalMessageTextDetails}#GetFormatFromOptions(System.ClientModel.Primitives.ModelReaderWriterOptions)">
|
|
<summary>
|
|
Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service.
|
|
<param name="options">The <see cref="T:System.ClientModel.Primitives.ModelReaderWriterOptions" /> to use.</param></summary><returns>The format that the model uses when communicating with the serivce.</returns>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.InternalMessageTextFileCitationDetails.System#ClientModel#Primitives#IJsonModel{Azure#AI#OpenAI#Assistants#InternalMessageTextFileCitationDetails}#Write(System.Text.Json.Utf8JsonWriter,System.ClientModel.Primitives.ModelReaderWriterOptions)">
|
|
<summary>
|
|
Writes the model to the provided <see cref="T:System.Text.Json.Utf8JsonWriter" />.
|
|
</summary><param name="writer">The <see cref="T:System.Text.Json.Utf8JsonWriter" /> to write into.</param><param name="options">The <see cref="T:System.ClientModel.Primitives.ModelReaderWriterOptions" /> to use.</param><exception cref="T:System.FormatException">If the model does not support the requested <see cref="P:System.ClientModel.Primitives.ModelReaderWriterOptions.Format" />.</exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.InternalMessageTextFileCitationDetails.System#ClientModel#Primitives#IJsonModel{Azure#AI#OpenAI#Assistants#InternalMessageTextFileCitationDetails}#Create(System.Text.Json.Utf8JsonReader@,System.ClientModel.Primitives.ModelReaderWriterOptions)">
|
|
<summary>
|
|
Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model.
|
|
</summary><param name="reader">The <see cref="T:System.Text.Json.Utf8JsonReader" /> to read.</param><param name="options">The <see cref="T:System.ClientModel.Primitives.ModelReaderWriterOptions" /> to use.</param><returns>A <typeparamref name="T" /> representation of the JSON value.</returns><exception cref="T:System.FormatException">If the model does not support the requested <see cref="P:System.ClientModel.Primitives.ModelReaderWriterOptions.Format" />.</exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.InternalMessageTextFileCitationDetails.System#ClientModel#Primitives#IPersistableModel{Azure#AI#OpenAI#Assistants#InternalMessageTextFileCitationDetails}#Write(System.ClientModel.Primitives.ModelReaderWriterOptions)">
|
|
<summary>
|
|
Writes the model into a <see cref="T:System.BinaryData" />.
|
|
</summary><param name="options">The <see cref="T:System.ClientModel.Primitives.ModelReaderWriterOptions" /> to use.</param><returns>A binary representation of the written model.</returns><exception cref="T:System.FormatException">If the model does not support the requested <see cref="P:System.ClientModel.Primitives.ModelReaderWriterOptions.Format" />.</exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.InternalMessageTextFileCitationDetails.System#ClientModel#Primitives#IPersistableModel{Azure#AI#OpenAI#Assistants#InternalMessageTextFileCitationDetails}#Create(System.BinaryData,System.ClientModel.Primitives.ModelReaderWriterOptions)">
|
|
<summary>
|
|
Converts the provided <see cref="T:System.BinaryData" /> into a model.
|
|
</summary><param name="data">The <see cref="T:System.BinaryData" /> to parse.</param><param name="options">The <see cref="T:System.ClientModel.Primitives.ModelReaderWriterOptions" /> to use.</param><returns>A <typeparamref name="T" /> representation of the data.</returns><exception cref="T:System.FormatException">If the model does not support the requested <see cref="P:System.ClientModel.Primitives.ModelReaderWriterOptions.Format" />.</exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.InternalMessageTextFileCitationDetails.System#ClientModel#Primitives#IPersistableModel{Azure#AI#OpenAI#Assistants#InternalMessageTextFileCitationDetails}#GetFormatFromOptions(System.ClientModel.Primitives.ModelReaderWriterOptions)">
|
|
<summary>
|
|
Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service.
|
|
<param name="options">The <see cref="T:System.ClientModel.Primitives.ModelReaderWriterOptions" /> to use.</param></summary><returns>The format that the model uses when communicating with the serivce.</returns>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.InternalMessageTextFilePathDetails.System#ClientModel#Primitives#IJsonModel{Azure#AI#OpenAI#Assistants#InternalMessageTextFilePathDetails}#Write(System.Text.Json.Utf8JsonWriter,System.ClientModel.Primitives.ModelReaderWriterOptions)">
|
|
<summary>
|
|
Writes the model to the provided <see cref="T:System.Text.Json.Utf8JsonWriter" />.
|
|
</summary><param name="writer">The <see cref="T:System.Text.Json.Utf8JsonWriter" /> to write into.</param><param name="options">The <see cref="T:System.ClientModel.Primitives.ModelReaderWriterOptions" /> to use.</param><exception cref="T:System.FormatException">If the model does not support the requested <see cref="P:System.ClientModel.Primitives.ModelReaderWriterOptions.Format" />.</exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.InternalMessageTextFilePathDetails.System#ClientModel#Primitives#IJsonModel{Azure#AI#OpenAI#Assistants#InternalMessageTextFilePathDetails}#Create(System.Text.Json.Utf8JsonReader@,System.ClientModel.Primitives.ModelReaderWriterOptions)">
|
|
<summary>
|
|
Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model.
|
|
</summary><param name="reader">The <see cref="T:System.Text.Json.Utf8JsonReader" /> to read.</param><param name="options">The <see cref="T:System.ClientModel.Primitives.ModelReaderWriterOptions" /> to use.</param><returns>A <typeparamref name="T" /> representation of the JSON value.</returns><exception cref="T:System.FormatException">If the model does not support the requested <see cref="P:System.ClientModel.Primitives.ModelReaderWriterOptions.Format" />.</exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.InternalMessageTextFilePathDetails.System#ClientModel#Primitives#IPersistableModel{Azure#AI#OpenAI#Assistants#InternalMessageTextFilePathDetails}#Write(System.ClientModel.Primitives.ModelReaderWriterOptions)">
|
|
<summary>
|
|
Writes the model into a <see cref="T:System.BinaryData" />.
|
|
</summary><param name="options">The <see cref="T:System.ClientModel.Primitives.ModelReaderWriterOptions" /> to use.</param><returns>A binary representation of the written model.</returns><exception cref="T:System.FormatException">If the model does not support the requested <see cref="P:System.ClientModel.Primitives.ModelReaderWriterOptions.Format" />.</exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.InternalMessageTextFilePathDetails.System#ClientModel#Primitives#IPersistableModel{Azure#AI#OpenAI#Assistants#InternalMessageTextFilePathDetails}#Create(System.BinaryData,System.ClientModel.Primitives.ModelReaderWriterOptions)">
|
|
<summary>
|
|
Converts the provided <see cref="T:System.BinaryData" /> into a model.
|
|
</summary><param name="data">The <see cref="T:System.BinaryData" /> to parse.</param><param name="options">The <see cref="T:System.ClientModel.Primitives.ModelReaderWriterOptions" /> to use.</param><returns>A <typeparamref name="T" /> representation of the data.</returns><exception cref="T:System.FormatException">If the model does not support the requested <see cref="P:System.ClientModel.Primitives.ModelReaderWriterOptions.Format" />.</exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.InternalMessageTextFilePathDetails.System#ClientModel#Primitives#IPersistableModel{Azure#AI#OpenAI#Assistants#InternalMessageTextFilePathDetails}#GetFormatFromOptions(System.ClientModel.Primitives.ModelReaderWriterOptions)">
|
|
<summary>
|
|
Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service.
|
|
<param name="options">The <see cref="T:System.ClientModel.Primitives.ModelReaderWriterOptions" /> to use.</param></summary><returns>The format that the model uses when communicating with the serivce.</returns>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.InternalRequiredFunctionToolCallDetails.System#ClientModel#Primitives#IJsonModel{Azure#AI#OpenAI#Assistants#InternalRequiredFunctionToolCallDetails}#Write(System.Text.Json.Utf8JsonWriter,System.ClientModel.Primitives.ModelReaderWriterOptions)">
|
|
<summary>
|
|
Writes the model to the provided <see cref="T:System.Text.Json.Utf8JsonWriter" />.
|
|
</summary><param name="writer">The <see cref="T:System.Text.Json.Utf8JsonWriter" /> to write into.</param><param name="options">The <see cref="T:System.ClientModel.Primitives.ModelReaderWriterOptions" /> to use.</param><exception cref="T:System.FormatException">If the model does not support the requested <see cref="P:System.ClientModel.Primitives.ModelReaderWriterOptions.Format" />.</exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.InternalRequiredFunctionToolCallDetails.System#ClientModel#Primitives#IJsonModel{Azure#AI#OpenAI#Assistants#InternalRequiredFunctionToolCallDetails}#Create(System.Text.Json.Utf8JsonReader@,System.ClientModel.Primitives.ModelReaderWriterOptions)">
|
|
<summary>
|
|
Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model.
|
|
</summary><param name="reader">The <see cref="T:System.Text.Json.Utf8JsonReader" /> to read.</param><param name="options">The <see cref="T:System.ClientModel.Primitives.ModelReaderWriterOptions" /> to use.</param><returns>A <typeparamref name="T" /> representation of the JSON value.</returns><exception cref="T:System.FormatException">If the model does not support the requested <see cref="P:System.ClientModel.Primitives.ModelReaderWriterOptions.Format" />.</exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.InternalRequiredFunctionToolCallDetails.System#ClientModel#Primitives#IPersistableModel{Azure#AI#OpenAI#Assistants#InternalRequiredFunctionToolCallDetails}#Write(System.ClientModel.Primitives.ModelReaderWriterOptions)">
|
|
<summary>
|
|
Writes the model into a <see cref="T:System.BinaryData" />.
|
|
</summary><param name="options">The <see cref="T:System.ClientModel.Primitives.ModelReaderWriterOptions" /> to use.</param><returns>A binary representation of the written model.</returns><exception cref="T:System.FormatException">If the model does not support the requested <see cref="P:System.ClientModel.Primitives.ModelReaderWriterOptions.Format" />.</exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.InternalRequiredFunctionToolCallDetails.System#ClientModel#Primitives#IPersistableModel{Azure#AI#OpenAI#Assistants#InternalRequiredFunctionToolCallDetails}#Create(System.BinaryData,System.ClientModel.Primitives.ModelReaderWriterOptions)">
|
|
<summary>
|
|
Converts the provided <see cref="T:System.BinaryData" /> into a model.
|
|
</summary><param name="data">The <see cref="T:System.BinaryData" /> to parse.</param><param name="options">The <see cref="T:System.ClientModel.Primitives.ModelReaderWriterOptions" /> to use.</param><returns>A <typeparamref name="T" /> representation of the data.</returns><exception cref="T:System.FormatException">If the model does not support the requested <see cref="P:System.ClientModel.Primitives.ModelReaderWriterOptions.Format" />.</exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.InternalRequiredFunctionToolCallDetails.System#ClientModel#Primitives#IPersistableModel{Azure#AI#OpenAI#Assistants#InternalRequiredFunctionToolCallDetails}#GetFormatFromOptions(System.ClientModel.Primitives.ModelReaderWriterOptions)">
|
|
<summary>
|
|
Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service.
|
|
<param name="options">The <see cref="T:System.ClientModel.Primitives.ModelReaderWriterOptions" /> to use.</param></summary><returns>The format that the model uses when communicating with the serivce.</returns>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.InternalRunStepFunctionToolCallDetails.System#ClientModel#Primitives#IJsonModel{Azure#AI#OpenAI#Assistants#InternalRunStepFunctionToolCallDetails}#Write(System.Text.Json.Utf8JsonWriter,System.ClientModel.Primitives.ModelReaderWriterOptions)">
|
|
<summary>
|
|
Writes the model to the provided <see cref="T:System.Text.Json.Utf8JsonWriter" />.
|
|
</summary><param name="writer">The <see cref="T:System.Text.Json.Utf8JsonWriter" /> to write into.</param><param name="options">The <see cref="T:System.ClientModel.Primitives.ModelReaderWriterOptions" /> to use.</param><exception cref="T:System.FormatException">If the model does not support the requested <see cref="P:System.ClientModel.Primitives.ModelReaderWriterOptions.Format" />.</exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.InternalRunStepFunctionToolCallDetails.System#ClientModel#Primitives#IJsonModel{Azure#AI#OpenAI#Assistants#InternalRunStepFunctionToolCallDetails}#Create(System.Text.Json.Utf8JsonReader@,System.ClientModel.Primitives.ModelReaderWriterOptions)">
|
|
<summary>
|
|
Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model.
|
|
</summary><param name="reader">The <see cref="T:System.Text.Json.Utf8JsonReader" /> to read.</param><param name="options">The <see cref="T:System.ClientModel.Primitives.ModelReaderWriterOptions" /> to use.</param><returns>A <typeparamref name="T" /> representation of the JSON value.</returns><exception cref="T:System.FormatException">If the model does not support the requested <see cref="P:System.ClientModel.Primitives.ModelReaderWriterOptions.Format" />.</exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.InternalRunStepFunctionToolCallDetails.System#ClientModel#Primitives#IPersistableModel{Azure#AI#OpenAI#Assistants#InternalRunStepFunctionToolCallDetails}#Write(System.ClientModel.Primitives.ModelReaderWriterOptions)">
|
|
<summary>
|
|
Writes the model into a <see cref="T:System.BinaryData" />.
|
|
</summary><param name="options">The <see cref="T:System.ClientModel.Primitives.ModelReaderWriterOptions" /> to use.</param><returns>A binary representation of the written model.</returns><exception cref="T:System.FormatException">If the model does not support the requested <see cref="P:System.ClientModel.Primitives.ModelReaderWriterOptions.Format" />.</exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.InternalRunStepFunctionToolCallDetails.System#ClientModel#Primitives#IPersistableModel{Azure#AI#OpenAI#Assistants#InternalRunStepFunctionToolCallDetails}#Create(System.BinaryData,System.ClientModel.Primitives.ModelReaderWriterOptions)">
|
|
<summary>
|
|
Converts the provided <see cref="T:System.BinaryData" /> into a model.
|
|
</summary><param name="data">The <see cref="T:System.BinaryData" /> to parse.</param><param name="options">The <see cref="T:System.ClientModel.Primitives.ModelReaderWriterOptions" /> to use.</param><returns>A <typeparamref name="T" /> representation of the data.</returns><exception cref="T:System.FormatException">If the model does not support the requested <see cref="P:System.ClientModel.Primitives.ModelReaderWriterOptions.Format" />.</exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.InternalRunStepFunctionToolCallDetails.System#ClientModel#Primitives#IPersistableModel{Azure#AI#OpenAI#Assistants#InternalRunStepFunctionToolCallDetails}#GetFormatFromOptions(System.ClientModel.Primitives.ModelReaderWriterOptions)">
|
|
<summary>
|
|
Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service.
|
|
<param name="options">The <see cref="T:System.ClientModel.Primitives.ModelReaderWriterOptions" /> to use.</param></summary><returns>The format that the model uses when communicating with the serivce.</returns>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.InternalSubmitToolOutputsDetails.System#ClientModel#Primitives#IJsonModel{Azure#AI#OpenAI#Assistants#InternalSubmitToolOutputsDetails}#Write(System.Text.Json.Utf8JsonWriter,System.ClientModel.Primitives.ModelReaderWriterOptions)">
|
|
<summary>
|
|
Writes the model to the provided <see cref="T:System.Text.Json.Utf8JsonWriter" />.
|
|
</summary><param name="writer">The <see cref="T:System.Text.Json.Utf8JsonWriter" /> to write into.</param><param name="options">The <see cref="T:System.ClientModel.Primitives.ModelReaderWriterOptions" /> to use.</param><exception cref="T:System.FormatException">If the model does not support the requested <see cref="P:System.ClientModel.Primitives.ModelReaderWriterOptions.Format" />.</exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.InternalSubmitToolOutputsDetails.System#ClientModel#Primitives#IJsonModel{Azure#AI#OpenAI#Assistants#InternalSubmitToolOutputsDetails}#Create(System.Text.Json.Utf8JsonReader@,System.ClientModel.Primitives.ModelReaderWriterOptions)">
|
|
<summary>
|
|
Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model.
|
|
</summary><param name="reader">The <see cref="T:System.Text.Json.Utf8JsonReader" /> to read.</param><param name="options">The <see cref="T:System.ClientModel.Primitives.ModelReaderWriterOptions" /> to use.</param><returns>A <typeparamref name="T" /> representation of the JSON value.</returns><exception cref="T:System.FormatException">If the model does not support the requested <see cref="P:System.ClientModel.Primitives.ModelReaderWriterOptions.Format" />.</exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.InternalSubmitToolOutputsDetails.System#ClientModel#Primitives#IPersistableModel{Azure#AI#OpenAI#Assistants#InternalSubmitToolOutputsDetails}#Write(System.ClientModel.Primitives.ModelReaderWriterOptions)">
|
|
<summary>
|
|
Writes the model into a <see cref="T:System.BinaryData" />.
|
|
</summary><param name="options">The <see cref="T:System.ClientModel.Primitives.ModelReaderWriterOptions" /> to use.</param><returns>A binary representation of the written model.</returns><exception cref="T:System.FormatException">If the model does not support the requested <see cref="P:System.ClientModel.Primitives.ModelReaderWriterOptions.Format" />.</exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.InternalSubmitToolOutputsDetails.System#ClientModel#Primitives#IPersistableModel{Azure#AI#OpenAI#Assistants#InternalSubmitToolOutputsDetails}#Create(System.BinaryData,System.ClientModel.Primitives.ModelReaderWriterOptions)">
|
|
<summary>
|
|
Converts the provided <see cref="T:System.BinaryData" /> into a model.
|
|
</summary><param name="data">The <see cref="T:System.BinaryData" /> to parse.</param><param name="options">The <see cref="T:System.ClientModel.Primitives.ModelReaderWriterOptions" /> to use.</param><returns>A <typeparamref name="T" /> representation of the data.</returns><exception cref="T:System.FormatException">If the model does not support the requested <see cref="P:System.ClientModel.Primitives.ModelReaderWriterOptions.Format" />.</exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.InternalSubmitToolOutputsDetails.System#ClientModel#Primitives#IPersistableModel{Azure#AI#OpenAI#Assistants#InternalSubmitToolOutputsDetails}#GetFormatFromOptions(System.ClientModel.Primitives.ModelReaderWriterOptions)">
|
|
<summary>
|
|
Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service.
|
|
<param name="options">The <see cref="T:System.ClientModel.Primitives.ModelReaderWriterOptions" /> to use.</param></summary><returns>The format that the model uses when communicating with the serivce.</returns>
|
|
</member>
|
|
<member name="P:Azure.AI.OpenAI.Assistants.ChangeTrackingDictionary`2.System#Collections#Generic#IReadOnlyDictionary{TKey@TValue}#Keys">
|
|
<summary>Gets an enumerable collection that contains the keys in the read-only dictionary.</summary><returns>An enumerable collection that contains the keys in the read-only dictionary.</returns>
|
|
</member>
|
|
<member name="P:Azure.AI.OpenAI.Assistants.ChangeTrackingDictionary`2.System#Collections#Generic#IReadOnlyDictionary{TKey@TValue}#Values">
|
|
<summary>Gets an enumerable collection that contains the values in the read-only dictionary.</summary><returns>An enumerable collection that contains the values in the read-only dictionary.</returns>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.ChangeTrackingDictionary`2.System#Collections#IEnumerable#GetEnumerator">
|
|
<summary>Returns an enumerator that iterates through a collection.</summary><returns>An <see cref="T:System.Collections.IEnumerator" /> object that can be used to iterate through the collection.</returns>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.ChangeTrackingList`1.System#Collections#IEnumerable#GetEnumerator">
|
|
<summary>Returns an enumerator that iterates through a collection.</summary><returns>An <see cref="T:System.Collections.IEnumerator" /> object that can be used to iterate through the collection.</returns>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.MessageContent.System#ClientModel#Primitives#IJsonModel{Azure#AI#OpenAI#Assistants#MessageContent}#Write(System.Text.Json.Utf8JsonWriter,System.ClientModel.Primitives.ModelReaderWriterOptions)">
|
|
<summary>
|
|
Writes the model to the provided <see cref="T:System.Text.Json.Utf8JsonWriter" />.
|
|
</summary><param name="writer">The <see cref="T:System.Text.Json.Utf8JsonWriter" /> to write into.</param><param name="options">The <see cref="T:System.ClientModel.Primitives.ModelReaderWriterOptions" /> to use.</param><exception cref="T:System.FormatException">If the model does not support the requested <see cref="P:System.ClientModel.Primitives.ModelReaderWriterOptions.Format" />.</exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.MessageContent.System#ClientModel#Primitives#IJsonModel{Azure#AI#OpenAI#Assistants#MessageContent}#Create(System.Text.Json.Utf8JsonReader@,System.ClientModel.Primitives.ModelReaderWriterOptions)">
|
|
<summary>
|
|
Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model.
|
|
</summary><param name="reader">The <see cref="T:System.Text.Json.Utf8JsonReader" /> to read.</param><param name="options">The <see cref="T:System.ClientModel.Primitives.ModelReaderWriterOptions" /> to use.</param><returns>A <typeparamref name="T" /> representation of the JSON value.</returns><exception cref="T:System.FormatException">If the model does not support the requested <see cref="P:System.ClientModel.Primitives.ModelReaderWriterOptions.Format" />.</exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.MessageContent.System#ClientModel#Primitives#IPersistableModel{Azure#AI#OpenAI#Assistants#MessageContent}#Write(System.ClientModel.Primitives.ModelReaderWriterOptions)">
|
|
<summary>
|
|
Writes the model into a <see cref="T:System.BinaryData" />.
|
|
</summary><param name="options">The <see cref="T:System.ClientModel.Primitives.ModelReaderWriterOptions" /> to use.</param><returns>A binary representation of the written model.</returns><exception cref="T:System.FormatException">If the model does not support the requested <see cref="P:System.ClientModel.Primitives.ModelReaderWriterOptions.Format" />.</exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.MessageContent.System#ClientModel#Primitives#IPersistableModel{Azure#AI#OpenAI#Assistants#MessageContent}#Create(System.BinaryData,System.ClientModel.Primitives.ModelReaderWriterOptions)">
|
|
<summary>
|
|
Converts the provided <see cref="T:System.BinaryData" /> into a model.
|
|
</summary><param name="data">The <see cref="T:System.BinaryData" /> to parse.</param><param name="options">The <see cref="T:System.ClientModel.Primitives.ModelReaderWriterOptions" /> to use.</param><returns>A <typeparamref name="T" /> representation of the data.</returns><exception cref="T:System.FormatException">If the model does not support the requested <see cref="P:System.ClientModel.Primitives.ModelReaderWriterOptions.Format" />.</exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.MessageContent.System#ClientModel#Primitives#IPersistableModel{Azure#AI#OpenAI#Assistants#MessageContent}#GetFormatFromOptions(System.ClientModel.Primitives.ModelReaderWriterOptions)">
|
|
<summary>
|
|
Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service.
|
|
<param name="options">The <see cref="T:System.ClientModel.Primitives.ModelReaderWriterOptions" /> to use.</param></summary><returns>The format that the model uses when communicating with the serivce.</returns>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.MessageTextAnnotation.System#ClientModel#Primitives#IJsonModel{Azure#AI#OpenAI#Assistants#MessageTextAnnotation}#Write(System.Text.Json.Utf8JsonWriter,System.ClientModel.Primitives.ModelReaderWriterOptions)">
|
|
<summary>
|
|
Writes the model to the provided <see cref="T:System.Text.Json.Utf8JsonWriter" />.
|
|
</summary><param name="writer">The <see cref="T:System.Text.Json.Utf8JsonWriter" /> to write into.</param><param name="options">The <see cref="T:System.ClientModel.Primitives.ModelReaderWriterOptions" /> to use.</param><exception cref="T:System.FormatException">If the model does not support the requested <see cref="P:System.ClientModel.Primitives.ModelReaderWriterOptions.Format" />.</exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.MessageTextAnnotation.System#ClientModel#Primitives#IJsonModel{Azure#AI#OpenAI#Assistants#MessageTextAnnotation}#Create(System.Text.Json.Utf8JsonReader@,System.ClientModel.Primitives.ModelReaderWriterOptions)">
|
|
<summary>
|
|
Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model.
|
|
</summary><param name="reader">The <see cref="T:System.Text.Json.Utf8JsonReader" /> to read.</param><param name="options">The <see cref="T:System.ClientModel.Primitives.ModelReaderWriterOptions" /> to use.</param><returns>A <typeparamref name="T" /> representation of the JSON value.</returns><exception cref="T:System.FormatException">If the model does not support the requested <see cref="P:System.ClientModel.Primitives.ModelReaderWriterOptions.Format" />.</exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.MessageTextAnnotation.System#ClientModel#Primitives#IPersistableModel{Azure#AI#OpenAI#Assistants#MessageTextAnnotation}#Write(System.ClientModel.Primitives.ModelReaderWriterOptions)">
|
|
<summary>
|
|
Writes the model into a <see cref="T:System.BinaryData" />.
|
|
</summary><param name="options">The <see cref="T:System.ClientModel.Primitives.ModelReaderWriterOptions" /> to use.</param><returns>A binary representation of the written model.</returns><exception cref="T:System.FormatException">If the model does not support the requested <see cref="P:System.ClientModel.Primitives.ModelReaderWriterOptions.Format" />.</exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.MessageTextAnnotation.System#ClientModel#Primitives#IPersistableModel{Azure#AI#OpenAI#Assistants#MessageTextAnnotation}#Create(System.BinaryData,System.ClientModel.Primitives.ModelReaderWriterOptions)">
|
|
<summary>
|
|
Converts the provided <see cref="T:System.BinaryData" /> into a model.
|
|
</summary><param name="data">The <see cref="T:System.BinaryData" /> to parse.</param><param name="options">The <see cref="T:System.ClientModel.Primitives.ModelReaderWriterOptions" /> to use.</param><returns>A <typeparamref name="T" /> representation of the data.</returns><exception cref="T:System.FormatException">If the model does not support the requested <see cref="P:System.ClientModel.Primitives.ModelReaderWriterOptions.Format" />.</exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.MessageTextAnnotation.System#ClientModel#Primitives#IPersistableModel{Azure#AI#OpenAI#Assistants#MessageTextAnnotation}#GetFormatFromOptions(System.ClientModel.Primitives.ModelReaderWriterOptions)">
|
|
<summary>
|
|
Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service.
|
|
<param name="options">The <see cref="T:System.ClientModel.Primitives.ModelReaderWriterOptions" /> to use.</param></summary><returns>The format that the model uses when communicating with the serivce.</returns>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.RequiredAction.System#ClientModel#Primitives#IJsonModel{Azure#AI#OpenAI#Assistants#RequiredAction}#Write(System.Text.Json.Utf8JsonWriter,System.ClientModel.Primitives.ModelReaderWriterOptions)">
|
|
<summary>
|
|
Writes the model to the provided <see cref="T:System.Text.Json.Utf8JsonWriter" />.
|
|
</summary><param name="writer">The <see cref="T:System.Text.Json.Utf8JsonWriter" /> to write into.</param><param name="options">The <see cref="T:System.ClientModel.Primitives.ModelReaderWriterOptions" /> to use.</param><exception cref="T:System.FormatException">If the model does not support the requested <see cref="P:System.ClientModel.Primitives.ModelReaderWriterOptions.Format" />.</exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.RequiredAction.System#ClientModel#Primitives#IJsonModel{Azure#AI#OpenAI#Assistants#RequiredAction}#Create(System.Text.Json.Utf8JsonReader@,System.ClientModel.Primitives.ModelReaderWriterOptions)">
|
|
<summary>
|
|
Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model.
|
|
</summary><param name="reader">The <see cref="T:System.Text.Json.Utf8JsonReader" /> to read.</param><param name="options">The <see cref="T:System.ClientModel.Primitives.ModelReaderWriterOptions" /> to use.</param><returns>A <typeparamref name="T" /> representation of the JSON value.</returns><exception cref="T:System.FormatException">If the model does not support the requested <see cref="P:System.ClientModel.Primitives.ModelReaderWriterOptions.Format" />.</exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.RequiredAction.System#ClientModel#Primitives#IPersistableModel{Azure#AI#OpenAI#Assistants#RequiredAction}#Write(System.ClientModel.Primitives.ModelReaderWriterOptions)">
|
|
<summary>
|
|
Writes the model into a <see cref="T:System.BinaryData" />.
|
|
</summary><param name="options">The <see cref="T:System.ClientModel.Primitives.ModelReaderWriterOptions" /> to use.</param><returns>A binary representation of the written model.</returns><exception cref="T:System.FormatException">If the model does not support the requested <see cref="P:System.ClientModel.Primitives.ModelReaderWriterOptions.Format" />.</exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.RequiredAction.System#ClientModel#Primitives#IPersistableModel{Azure#AI#OpenAI#Assistants#RequiredAction}#Create(System.BinaryData,System.ClientModel.Primitives.ModelReaderWriterOptions)">
|
|
<summary>
|
|
Converts the provided <see cref="T:System.BinaryData" /> into a model.
|
|
</summary><param name="data">The <see cref="T:System.BinaryData" /> to parse.</param><param name="options">The <see cref="T:System.ClientModel.Primitives.ModelReaderWriterOptions" /> to use.</param><returns>A <typeparamref name="T" /> representation of the data.</returns><exception cref="T:System.FormatException">If the model does not support the requested <see cref="P:System.ClientModel.Primitives.ModelReaderWriterOptions.Format" />.</exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.RequiredAction.System#ClientModel#Primitives#IPersistableModel{Azure#AI#OpenAI#Assistants#RequiredAction}#GetFormatFromOptions(System.ClientModel.Primitives.ModelReaderWriterOptions)">
|
|
<summary>
|
|
Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service.
|
|
<param name="options">The <see cref="T:System.ClientModel.Primitives.ModelReaderWriterOptions" /> to use.</param></summary><returns>The format that the model uses when communicating with the serivce.</returns>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.RequiredToolCall.System#ClientModel#Primitives#IJsonModel{Azure#AI#OpenAI#Assistants#RequiredToolCall}#Write(System.Text.Json.Utf8JsonWriter,System.ClientModel.Primitives.ModelReaderWriterOptions)">
|
|
<summary>
|
|
Writes the model to the provided <see cref="T:System.Text.Json.Utf8JsonWriter" />.
|
|
</summary><param name="writer">The <see cref="T:System.Text.Json.Utf8JsonWriter" /> to write into.</param><param name="options">The <see cref="T:System.ClientModel.Primitives.ModelReaderWriterOptions" /> to use.</param><exception cref="T:System.FormatException">If the model does not support the requested <see cref="P:System.ClientModel.Primitives.ModelReaderWriterOptions.Format" />.</exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.RequiredToolCall.System#ClientModel#Primitives#IJsonModel{Azure#AI#OpenAI#Assistants#RequiredToolCall}#Create(System.Text.Json.Utf8JsonReader@,System.ClientModel.Primitives.ModelReaderWriterOptions)">
|
|
<summary>
|
|
Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model.
|
|
</summary><param name="reader">The <see cref="T:System.Text.Json.Utf8JsonReader" /> to read.</param><param name="options">The <see cref="T:System.ClientModel.Primitives.ModelReaderWriterOptions" /> to use.</param><returns>A <typeparamref name="T" /> representation of the JSON value.</returns><exception cref="T:System.FormatException">If the model does not support the requested <see cref="P:System.ClientModel.Primitives.ModelReaderWriterOptions.Format" />.</exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.RequiredToolCall.System#ClientModel#Primitives#IPersistableModel{Azure#AI#OpenAI#Assistants#RequiredToolCall}#Write(System.ClientModel.Primitives.ModelReaderWriterOptions)">
|
|
<summary>
|
|
Writes the model into a <see cref="T:System.BinaryData" />.
|
|
</summary><param name="options">The <see cref="T:System.ClientModel.Primitives.ModelReaderWriterOptions" /> to use.</param><returns>A binary representation of the written model.</returns><exception cref="T:System.FormatException">If the model does not support the requested <see cref="P:System.ClientModel.Primitives.ModelReaderWriterOptions.Format" />.</exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.RequiredToolCall.System#ClientModel#Primitives#IPersistableModel{Azure#AI#OpenAI#Assistants#RequiredToolCall}#Create(System.BinaryData,System.ClientModel.Primitives.ModelReaderWriterOptions)">
|
|
<summary>
|
|
Converts the provided <see cref="T:System.BinaryData" /> into a model.
|
|
</summary><param name="data">The <see cref="T:System.BinaryData" /> to parse.</param><param name="options">The <see cref="T:System.ClientModel.Primitives.ModelReaderWriterOptions" /> to use.</param><returns>A <typeparamref name="T" /> representation of the data.</returns><exception cref="T:System.FormatException">If the model does not support the requested <see cref="P:System.ClientModel.Primitives.ModelReaderWriterOptions.Format" />.</exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.RequiredToolCall.System#ClientModel#Primitives#IPersistableModel{Azure#AI#OpenAI#Assistants#RequiredToolCall}#GetFormatFromOptions(System.ClientModel.Primitives.ModelReaderWriterOptions)">
|
|
<summary>
|
|
Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service.
|
|
<param name="options">The <see cref="T:System.ClientModel.Primitives.ModelReaderWriterOptions" /> to use.</param></summary><returns>The format that the model uses when communicating with the serivce.</returns>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.RetrievalToolDefinition.System#ClientModel#Primitives#IJsonModel{Azure#AI#OpenAI#Assistants#RetrievalToolDefinition}#Write(System.Text.Json.Utf8JsonWriter,System.ClientModel.Primitives.ModelReaderWriterOptions)">
|
|
<summary>
|
|
Writes the model to the provided <see cref="T:System.Text.Json.Utf8JsonWriter" />.
|
|
</summary><param name="writer">The <see cref="T:System.Text.Json.Utf8JsonWriter" /> to write into.</param><param name="options">The <see cref="T:System.ClientModel.Primitives.ModelReaderWriterOptions" /> to use.</param><exception cref="T:System.FormatException">If the model does not support the requested <see cref="P:System.ClientModel.Primitives.ModelReaderWriterOptions.Format" />.</exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.RetrievalToolDefinition.System#ClientModel#Primitives#IJsonModel{Azure#AI#OpenAI#Assistants#RetrievalToolDefinition}#Create(System.Text.Json.Utf8JsonReader@,System.ClientModel.Primitives.ModelReaderWriterOptions)">
|
|
<summary>
|
|
Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model.
|
|
</summary><param name="reader">The <see cref="T:System.Text.Json.Utf8JsonReader" /> to read.</param><param name="options">The <see cref="T:System.ClientModel.Primitives.ModelReaderWriterOptions" /> to use.</param><returns>A <typeparamref name="T" /> representation of the JSON value.</returns><exception cref="T:System.FormatException">If the model does not support the requested <see cref="P:System.ClientModel.Primitives.ModelReaderWriterOptions.Format" />.</exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.RetrievalToolDefinition.System#ClientModel#Primitives#IPersistableModel{Azure#AI#OpenAI#Assistants#RetrievalToolDefinition}#Write(System.ClientModel.Primitives.ModelReaderWriterOptions)">
|
|
<summary>
|
|
Writes the model into a <see cref="T:System.BinaryData" />.
|
|
</summary><param name="options">The <see cref="T:System.ClientModel.Primitives.ModelReaderWriterOptions" /> to use.</param><returns>A binary representation of the written model.</returns><exception cref="T:System.FormatException">If the model does not support the requested <see cref="P:System.ClientModel.Primitives.ModelReaderWriterOptions.Format" />.</exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.RetrievalToolDefinition.System#ClientModel#Primitives#IPersistableModel{Azure#AI#OpenAI#Assistants#RetrievalToolDefinition}#Create(System.BinaryData,System.ClientModel.Primitives.ModelReaderWriterOptions)">
|
|
<summary>
|
|
Converts the provided <see cref="T:System.BinaryData" /> into a model.
|
|
</summary><param name="data">The <see cref="T:System.BinaryData" /> to parse.</param><param name="options">The <see cref="T:System.ClientModel.Primitives.ModelReaderWriterOptions" /> to use.</param><returns>A <typeparamref name="T" /> representation of the data.</returns><exception cref="T:System.FormatException">If the model does not support the requested <see cref="P:System.ClientModel.Primitives.ModelReaderWriterOptions.Format" />.</exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.RetrievalToolDefinition.System#ClientModel#Primitives#IPersistableModel{Azure#AI#OpenAI#Assistants#RetrievalToolDefinition}#GetFormatFromOptions(System.ClientModel.Primitives.ModelReaderWriterOptions)">
|
|
<summary>
|
|
Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service.
|
|
<param name="options">The <see cref="T:System.ClientModel.Primitives.ModelReaderWriterOptions" /> to use.</param></summary><returns>The format that the model uses when communicating with the serivce.</returns>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.RunError.System#ClientModel#Primitives#IJsonModel{Azure#AI#OpenAI#Assistants#RunError}#Write(System.Text.Json.Utf8JsonWriter,System.ClientModel.Primitives.ModelReaderWriterOptions)">
|
|
<summary>
|
|
Writes the model to the provided <see cref="T:System.Text.Json.Utf8JsonWriter" />.
|
|
</summary><param name="writer">The <see cref="T:System.Text.Json.Utf8JsonWriter" /> to write into.</param><param name="options">The <see cref="T:System.ClientModel.Primitives.ModelReaderWriterOptions" /> to use.</param><exception cref="T:System.FormatException">If the model does not support the requested <see cref="P:System.ClientModel.Primitives.ModelReaderWriterOptions.Format" />.</exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.RunError.System#ClientModel#Primitives#IJsonModel{Azure#AI#OpenAI#Assistants#RunError}#Create(System.Text.Json.Utf8JsonReader@,System.ClientModel.Primitives.ModelReaderWriterOptions)">
|
|
<summary>
|
|
Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model.
|
|
</summary><param name="reader">The <see cref="T:System.Text.Json.Utf8JsonReader" /> to read.</param><param name="options">The <see cref="T:System.ClientModel.Primitives.ModelReaderWriterOptions" /> to use.</param><returns>A <typeparamref name="T" /> representation of the JSON value.</returns><exception cref="T:System.FormatException">If the model does not support the requested <see cref="P:System.ClientModel.Primitives.ModelReaderWriterOptions.Format" />.</exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.RunError.System#ClientModel#Primitives#IPersistableModel{Azure#AI#OpenAI#Assistants#RunError}#Write(System.ClientModel.Primitives.ModelReaderWriterOptions)">
|
|
<summary>
|
|
Writes the model into a <see cref="T:System.BinaryData" />.
|
|
</summary><param name="options">The <see cref="T:System.ClientModel.Primitives.ModelReaderWriterOptions" /> to use.</param><returns>A binary representation of the written model.</returns><exception cref="T:System.FormatException">If the model does not support the requested <see cref="P:System.ClientModel.Primitives.ModelReaderWriterOptions.Format" />.</exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.RunError.System#ClientModel#Primitives#IPersistableModel{Azure#AI#OpenAI#Assistants#RunError}#Create(System.BinaryData,System.ClientModel.Primitives.ModelReaderWriterOptions)">
|
|
<summary>
|
|
Converts the provided <see cref="T:System.BinaryData" /> into a model.
|
|
</summary><param name="data">The <see cref="T:System.BinaryData" /> to parse.</param><param name="options">The <see cref="T:System.ClientModel.Primitives.ModelReaderWriterOptions" /> to use.</param><returns>A <typeparamref name="T" /> representation of the data.</returns><exception cref="T:System.FormatException">If the model does not support the requested <see cref="P:System.ClientModel.Primitives.ModelReaderWriterOptions.Format" />.</exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.RunError.System#ClientModel#Primitives#IPersistableModel{Azure#AI#OpenAI#Assistants#RunError}#GetFormatFromOptions(System.ClientModel.Primitives.ModelReaderWriterOptions)">
|
|
<summary>
|
|
Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service.
|
|
<param name="options">The <see cref="T:System.ClientModel.Primitives.ModelReaderWriterOptions" /> to use.</param></summary><returns>The format that the model uses when communicating with the serivce.</returns>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.RunStepCodeInterpreterImageOutput.System#ClientModel#Primitives#IJsonModel{Azure#AI#OpenAI#Assistants#RunStepCodeInterpreterImageOutput}#Write(System.Text.Json.Utf8JsonWriter,System.ClientModel.Primitives.ModelReaderWriterOptions)">
|
|
<summary>
|
|
Writes the model to the provided <see cref="T:System.Text.Json.Utf8JsonWriter" />.
|
|
</summary><param name="writer">The <see cref="T:System.Text.Json.Utf8JsonWriter" /> to write into.</param><param name="options">The <see cref="T:System.ClientModel.Primitives.ModelReaderWriterOptions" /> to use.</param><exception cref="T:System.FormatException">If the model does not support the requested <see cref="P:System.ClientModel.Primitives.ModelReaderWriterOptions.Format" />.</exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.RunStepCodeInterpreterImageOutput.System#ClientModel#Primitives#IJsonModel{Azure#AI#OpenAI#Assistants#RunStepCodeInterpreterImageOutput}#Create(System.Text.Json.Utf8JsonReader@,System.ClientModel.Primitives.ModelReaderWriterOptions)">
|
|
<summary>
|
|
Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model.
|
|
</summary><param name="reader">The <see cref="T:System.Text.Json.Utf8JsonReader" /> to read.</param><param name="options">The <see cref="T:System.ClientModel.Primitives.ModelReaderWriterOptions" /> to use.</param><returns>A <typeparamref name="T" /> representation of the JSON value.</returns><exception cref="T:System.FormatException">If the model does not support the requested <see cref="P:System.ClientModel.Primitives.ModelReaderWriterOptions.Format" />.</exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.RunStepCodeInterpreterImageOutput.System#ClientModel#Primitives#IPersistableModel{Azure#AI#OpenAI#Assistants#RunStepCodeInterpreterImageOutput}#Write(System.ClientModel.Primitives.ModelReaderWriterOptions)">
|
|
<summary>
|
|
Writes the model into a <see cref="T:System.BinaryData" />.
|
|
</summary><param name="options">The <see cref="T:System.ClientModel.Primitives.ModelReaderWriterOptions" /> to use.</param><returns>A binary representation of the written model.</returns><exception cref="T:System.FormatException">If the model does not support the requested <see cref="P:System.ClientModel.Primitives.ModelReaderWriterOptions.Format" />.</exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.RunStepCodeInterpreterImageOutput.System#ClientModel#Primitives#IPersistableModel{Azure#AI#OpenAI#Assistants#RunStepCodeInterpreterImageOutput}#Create(System.BinaryData,System.ClientModel.Primitives.ModelReaderWriterOptions)">
|
|
<summary>
|
|
Converts the provided <see cref="T:System.BinaryData" /> into a model.
|
|
</summary><param name="data">The <see cref="T:System.BinaryData" /> to parse.</param><param name="options">The <see cref="T:System.ClientModel.Primitives.ModelReaderWriterOptions" /> to use.</param><returns>A <typeparamref name="T" /> representation of the data.</returns><exception cref="T:System.FormatException">If the model does not support the requested <see cref="P:System.ClientModel.Primitives.ModelReaderWriterOptions.Format" />.</exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.RunStepCodeInterpreterImageOutput.System#ClientModel#Primitives#IPersistableModel{Azure#AI#OpenAI#Assistants#RunStepCodeInterpreterImageOutput}#GetFormatFromOptions(System.ClientModel.Primitives.ModelReaderWriterOptions)">
|
|
<summary>
|
|
Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service.
|
|
<param name="options">The <see cref="T:System.ClientModel.Primitives.ModelReaderWriterOptions" /> to use.</param></summary><returns>The format that the model uses when communicating with the serivce.</returns>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.RunStepCodeInterpreterImageReference.System#ClientModel#Primitives#IJsonModel{Azure#AI#OpenAI#Assistants#RunStepCodeInterpreterImageReference}#Write(System.Text.Json.Utf8JsonWriter,System.ClientModel.Primitives.ModelReaderWriterOptions)">
|
|
<summary>
|
|
Writes the model to the provided <see cref="T:System.Text.Json.Utf8JsonWriter" />.
|
|
</summary><param name="writer">The <see cref="T:System.Text.Json.Utf8JsonWriter" /> to write into.</param><param name="options">The <see cref="T:System.ClientModel.Primitives.ModelReaderWriterOptions" /> to use.</param><exception cref="T:System.FormatException">If the model does not support the requested <see cref="P:System.ClientModel.Primitives.ModelReaderWriterOptions.Format" />.</exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.RunStepCodeInterpreterImageReference.System#ClientModel#Primitives#IJsonModel{Azure#AI#OpenAI#Assistants#RunStepCodeInterpreterImageReference}#Create(System.Text.Json.Utf8JsonReader@,System.ClientModel.Primitives.ModelReaderWriterOptions)">
|
|
<summary>
|
|
Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model.
|
|
</summary><param name="reader">The <see cref="T:System.Text.Json.Utf8JsonReader" /> to read.</param><param name="options">The <see cref="T:System.ClientModel.Primitives.ModelReaderWriterOptions" /> to use.</param><returns>A <typeparamref name="T" /> representation of the JSON value.</returns><exception cref="T:System.FormatException">If the model does not support the requested <see cref="P:System.ClientModel.Primitives.ModelReaderWriterOptions.Format" />.</exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.RunStepCodeInterpreterImageReference.System#ClientModel#Primitives#IPersistableModel{Azure#AI#OpenAI#Assistants#RunStepCodeInterpreterImageReference}#Write(System.ClientModel.Primitives.ModelReaderWriterOptions)">
|
|
<summary>
|
|
Writes the model into a <see cref="T:System.BinaryData" />.
|
|
</summary><param name="options">The <see cref="T:System.ClientModel.Primitives.ModelReaderWriterOptions" /> to use.</param><returns>A binary representation of the written model.</returns><exception cref="T:System.FormatException">If the model does not support the requested <see cref="P:System.ClientModel.Primitives.ModelReaderWriterOptions.Format" />.</exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.RunStepCodeInterpreterImageReference.System#ClientModel#Primitives#IPersistableModel{Azure#AI#OpenAI#Assistants#RunStepCodeInterpreterImageReference}#Create(System.BinaryData,System.ClientModel.Primitives.ModelReaderWriterOptions)">
|
|
<summary>
|
|
Converts the provided <see cref="T:System.BinaryData" /> into a model.
|
|
</summary><param name="data">The <see cref="T:System.BinaryData" /> to parse.</param><param name="options">The <see cref="T:System.ClientModel.Primitives.ModelReaderWriterOptions" /> to use.</param><returns>A <typeparamref name="T" /> representation of the data.</returns><exception cref="T:System.FormatException">If the model does not support the requested <see cref="P:System.ClientModel.Primitives.ModelReaderWriterOptions.Format" />.</exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.RunStepCodeInterpreterImageReference.System#ClientModel#Primitives#IPersistableModel{Azure#AI#OpenAI#Assistants#RunStepCodeInterpreterImageReference}#GetFormatFromOptions(System.ClientModel.Primitives.ModelReaderWriterOptions)">
|
|
<summary>
|
|
Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service.
|
|
<param name="options">The <see cref="T:System.ClientModel.Primitives.ModelReaderWriterOptions" /> to use.</param></summary><returns>The format that the model uses when communicating with the serivce.</returns>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.RunStepCodeInterpreterLogOutput.System#ClientModel#Primitives#IJsonModel{Azure#AI#OpenAI#Assistants#RunStepCodeInterpreterLogOutput}#Write(System.Text.Json.Utf8JsonWriter,System.ClientModel.Primitives.ModelReaderWriterOptions)">
|
|
<summary>
|
|
Writes the model to the provided <see cref="T:System.Text.Json.Utf8JsonWriter" />.
|
|
</summary><param name="writer">The <see cref="T:System.Text.Json.Utf8JsonWriter" /> to write into.</param><param name="options">The <see cref="T:System.ClientModel.Primitives.ModelReaderWriterOptions" /> to use.</param><exception cref="T:System.FormatException">If the model does not support the requested <see cref="P:System.ClientModel.Primitives.ModelReaderWriterOptions.Format" />.</exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.RunStepCodeInterpreterLogOutput.System#ClientModel#Primitives#IJsonModel{Azure#AI#OpenAI#Assistants#RunStepCodeInterpreterLogOutput}#Create(System.Text.Json.Utf8JsonReader@,System.ClientModel.Primitives.ModelReaderWriterOptions)">
|
|
<summary>
|
|
Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model.
|
|
</summary><param name="reader">The <see cref="T:System.Text.Json.Utf8JsonReader" /> to read.</param><param name="options">The <see cref="T:System.ClientModel.Primitives.ModelReaderWriterOptions" /> to use.</param><returns>A <typeparamref name="T" /> representation of the JSON value.</returns><exception cref="T:System.FormatException">If the model does not support the requested <see cref="P:System.ClientModel.Primitives.ModelReaderWriterOptions.Format" />.</exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.RunStepCodeInterpreterLogOutput.System#ClientModel#Primitives#IPersistableModel{Azure#AI#OpenAI#Assistants#RunStepCodeInterpreterLogOutput}#Write(System.ClientModel.Primitives.ModelReaderWriterOptions)">
|
|
<summary>
|
|
Writes the model into a <see cref="T:System.BinaryData" />.
|
|
</summary><param name="options">The <see cref="T:System.ClientModel.Primitives.ModelReaderWriterOptions" /> to use.</param><returns>A binary representation of the written model.</returns><exception cref="T:System.FormatException">If the model does not support the requested <see cref="P:System.ClientModel.Primitives.ModelReaderWriterOptions.Format" />.</exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.RunStepCodeInterpreterLogOutput.System#ClientModel#Primitives#IPersistableModel{Azure#AI#OpenAI#Assistants#RunStepCodeInterpreterLogOutput}#Create(System.BinaryData,System.ClientModel.Primitives.ModelReaderWriterOptions)">
|
|
<summary>
|
|
Converts the provided <see cref="T:System.BinaryData" /> into a model.
|
|
</summary><param name="data">The <see cref="T:System.BinaryData" /> to parse.</param><param name="options">The <see cref="T:System.ClientModel.Primitives.ModelReaderWriterOptions" /> to use.</param><returns>A <typeparamref name="T" /> representation of the data.</returns><exception cref="T:System.FormatException">If the model does not support the requested <see cref="P:System.ClientModel.Primitives.ModelReaderWriterOptions.Format" />.</exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.RunStepCodeInterpreterLogOutput.System#ClientModel#Primitives#IPersistableModel{Azure#AI#OpenAI#Assistants#RunStepCodeInterpreterLogOutput}#GetFormatFromOptions(System.ClientModel.Primitives.ModelReaderWriterOptions)">
|
|
<summary>
|
|
Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service.
|
|
<param name="options">The <see cref="T:System.ClientModel.Primitives.ModelReaderWriterOptions" /> to use.</param></summary><returns>The format that the model uses when communicating with the serivce.</returns>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.RunStepCodeInterpreterToolCallOutput.System#ClientModel#Primitives#IJsonModel{Azure#AI#OpenAI#Assistants#RunStepCodeInterpreterToolCallOutput}#Write(System.Text.Json.Utf8JsonWriter,System.ClientModel.Primitives.ModelReaderWriterOptions)">
|
|
<summary>
|
|
Writes the model to the provided <see cref="T:System.Text.Json.Utf8JsonWriter" />.
|
|
</summary><param name="writer">The <see cref="T:System.Text.Json.Utf8JsonWriter" /> to write into.</param><param name="options">The <see cref="T:System.ClientModel.Primitives.ModelReaderWriterOptions" /> to use.</param><exception cref="T:System.FormatException">If the model does not support the requested <see cref="P:System.ClientModel.Primitives.ModelReaderWriterOptions.Format" />.</exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.RunStepCodeInterpreterToolCallOutput.System#ClientModel#Primitives#IJsonModel{Azure#AI#OpenAI#Assistants#RunStepCodeInterpreterToolCallOutput}#Create(System.Text.Json.Utf8JsonReader@,System.ClientModel.Primitives.ModelReaderWriterOptions)">
|
|
<summary>
|
|
Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model.
|
|
</summary><param name="reader">The <see cref="T:System.Text.Json.Utf8JsonReader" /> to read.</param><param name="options">The <see cref="T:System.ClientModel.Primitives.ModelReaderWriterOptions" /> to use.</param><returns>A <typeparamref name="T" /> representation of the JSON value.</returns><exception cref="T:System.FormatException">If the model does not support the requested <see cref="P:System.ClientModel.Primitives.ModelReaderWriterOptions.Format" />.</exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.RunStepCodeInterpreterToolCallOutput.System#ClientModel#Primitives#IPersistableModel{Azure#AI#OpenAI#Assistants#RunStepCodeInterpreterToolCallOutput}#Write(System.ClientModel.Primitives.ModelReaderWriterOptions)">
|
|
<summary>
|
|
Writes the model into a <see cref="T:System.BinaryData" />.
|
|
</summary><param name="options">The <see cref="T:System.ClientModel.Primitives.ModelReaderWriterOptions" /> to use.</param><returns>A binary representation of the written model.</returns><exception cref="T:System.FormatException">If the model does not support the requested <see cref="P:System.ClientModel.Primitives.ModelReaderWriterOptions.Format" />.</exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.RunStepCodeInterpreterToolCallOutput.System#ClientModel#Primitives#IPersistableModel{Azure#AI#OpenAI#Assistants#RunStepCodeInterpreterToolCallOutput}#Create(System.BinaryData,System.ClientModel.Primitives.ModelReaderWriterOptions)">
|
|
<summary>
|
|
Converts the provided <see cref="T:System.BinaryData" /> into a model.
|
|
</summary><param name="data">The <see cref="T:System.BinaryData" /> to parse.</param><param name="options">The <see cref="T:System.ClientModel.Primitives.ModelReaderWriterOptions" /> to use.</param><returns>A <typeparamref name="T" /> representation of the data.</returns><exception cref="T:System.FormatException">If the model does not support the requested <see cref="P:System.ClientModel.Primitives.ModelReaderWriterOptions.Format" />.</exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.RunStepCodeInterpreterToolCallOutput.System#ClientModel#Primitives#IPersistableModel{Azure#AI#OpenAI#Assistants#RunStepCodeInterpreterToolCallOutput}#GetFormatFromOptions(System.ClientModel.Primitives.ModelReaderWriterOptions)">
|
|
<summary>
|
|
Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service.
|
|
<param name="options">The <see cref="T:System.ClientModel.Primitives.ModelReaderWriterOptions" /> to use.</param></summary><returns>The format that the model uses when communicating with the serivce.</returns>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.RunStepDetails.System#ClientModel#Primitives#IJsonModel{Azure#AI#OpenAI#Assistants#RunStepDetails}#Write(System.Text.Json.Utf8JsonWriter,System.ClientModel.Primitives.ModelReaderWriterOptions)">
|
|
<summary>
|
|
Writes the model to the provided <see cref="T:System.Text.Json.Utf8JsonWriter" />.
|
|
</summary><param name="writer">The <see cref="T:System.Text.Json.Utf8JsonWriter" /> to write into.</param><param name="options">The <see cref="T:System.ClientModel.Primitives.ModelReaderWriterOptions" /> to use.</param><exception cref="T:System.FormatException">If the model does not support the requested <see cref="P:System.ClientModel.Primitives.ModelReaderWriterOptions.Format" />.</exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.RunStepDetails.System#ClientModel#Primitives#IJsonModel{Azure#AI#OpenAI#Assistants#RunStepDetails}#Create(System.Text.Json.Utf8JsonReader@,System.ClientModel.Primitives.ModelReaderWriterOptions)">
|
|
<summary>
|
|
Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model.
|
|
</summary><param name="reader">The <see cref="T:System.Text.Json.Utf8JsonReader" /> to read.</param><param name="options">The <see cref="T:System.ClientModel.Primitives.ModelReaderWriterOptions" /> to use.</param><returns>A <typeparamref name="T" /> representation of the JSON value.</returns><exception cref="T:System.FormatException">If the model does not support the requested <see cref="P:System.ClientModel.Primitives.ModelReaderWriterOptions.Format" />.</exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.RunStepDetails.System#ClientModel#Primitives#IPersistableModel{Azure#AI#OpenAI#Assistants#RunStepDetails}#Write(System.ClientModel.Primitives.ModelReaderWriterOptions)">
|
|
<summary>
|
|
Writes the model into a <see cref="T:System.BinaryData" />.
|
|
</summary><param name="options">The <see cref="T:System.ClientModel.Primitives.ModelReaderWriterOptions" /> to use.</param><returns>A binary representation of the written model.</returns><exception cref="T:System.FormatException">If the model does not support the requested <see cref="P:System.ClientModel.Primitives.ModelReaderWriterOptions.Format" />.</exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.RunStepDetails.System#ClientModel#Primitives#IPersistableModel{Azure#AI#OpenAI#Assistants#RunStepDetails}#Create(System.BinaryData,System.ClientModel.Primitives.ModelReaderWriterOptions)">
|
|
<summary>
|
|
Converts the provided <see cref="T:System.BinaryData" /> into a model.
|
|
</summary><param name="data">The <see cref="T:System.BinaryData" /> to parse.</param><param name="options">The <see cref="T:System.ClientModel.Primitives.ModelReaderWriterOptions" /> to use.</param><returns>A <typeparamref name="T" /> representation of the data.</returns><exception cref="T:System.FormatException">If the model does not support the requested <see cref="P:System.ClientModel.Primitives.ModelReaderWriterOptions.Format" />.</exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.RunStepDetails.System#ClientModel#Primitives#IPersistableModel{Azure#AI#OpenAI#Assistants#RunStepDetails}#GetFormatFromOptions(System.ClientModel.Primitives.ModelReaderWriterOptions)">
|
|
<summary>
|
|
Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service.
|
|
<param name="options">The <see cref="T:System.ClientModel.Primitives.ModelReaderWriterOptions" /> to use.</param></summary><returns>The format that the model uses when communicating with the serivce.</returns>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.RunStepError.System#ClientModel#Primitives#IJsonModel{Azure#AI#OpenAI#Assistants#RunStepError}#Write(System.Text.Json.Utf8JsonWriter,System.ClientModel.Primitives.ModelReaderWriterOptions)">
|
|
<summary>
|
|
Writes the model to the provided <see cref="T:System.Text.Json.Utf8JsonWriter" />.
|
|
</summary><param name="writer">The <see cref="T:System.Text.Json.Utf8JsonWriter" /> to write into.</param><param name="options">The <see cref="T:System.ClientModel.Primitives.ModelReaderWriterOptions" /> to use.</param><exception cref="T:System.FormatException">If the model does not support the requested <see cref="P:System.ClientModel.Primitives.ModelReaderWriterOptions.Format" />.</exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.RunStepError.System#ClientModel#Primitives#IJsonModel{Azure#AI#OpenAI#Assistants#RunStepError}#Create(System.Text.Json.Utf8JsonReader@,System.ClientModel.Primitives.ModelReaderWriterOptions)">
|
|
<summary>
|
|
Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model.
|
|
</summary><param name="reader">The <see cref="T:System.Text.Json.Utf8JsonReader" /> to read.</param><param name="options">The <see cref="T:System.ClientModel.Primitives.ModelReaderWriterOptions" /> to use.</param><returns>A <typeparamref name="T" /> representation of the JSON value.</returns><exception cref="T:System.FormatException">If the model does not support the requested <see cref="P:System.ClientModel.Primitives.ModelReaderWriterOptions.Format" />.</exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.RunStepError.System#ClientModel#Primitives#IPersistableModel{Azure#AI#OpenAI#Assistants#RunStepError}#Write(System.ClientModel.Primitives.ModelReaderWriterOptions)">
|
|
<summary>
|
|
Writes the model into a <see cref="T:System.BinaryData" />.
|
|
</summary><param name="options">The <see cref="T:System.ClientModel.Primitives.ModelReaderWriterOptions" /> to use.</param><returns>A binary representation of the written model.</returns><exception cref="T:System.FormatException">If the model does not support the requested <see cref="P:System.ClientModel.Primitives.ModelReaderWriterOptions.Format" />.</exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.RunStepError.System#ClientModel#Primitives#IPersistableModel{Azure#AI#OpenAI#Assistants#RunStepError}#Create(System.BinaryData,System.ClientModel.Primitives.ModelReaderWriterOptions)">
|
|
<summary>
|
|
Converts the provided <see cref="T:System.BinaryData" /> into a model.
|
|
</summary><param name="data">The <see cref="T:System.BinaryData" /> to parse.</param><param name="options">The <see cref="T:System.ClientModel.Primitives.ModelReaderWriterOptions" /> to use.</param><returns>A <typeparamref name="T" /> representation of the data.</returns><exception cref="T:System.FormatException">If the model does not support the requested <see cref="P:System.ClientModel.Primitives.ModelReaderWriterOptions.Format" />.</exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.RunStepError.System#ClientModel#Primitives#IPersistableModel{Azure#AI#OpenAI#Assistants#RunStepError}#GetFormatFromOptions(System.ClientModel.Primitives.ModelReaderWriterOptions)">
|
|
<summary>
|
|
Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service.
|
|
<param name="options">The <see cref="T:System.ClientModel.Primitives.ModelReaderWriterOptions" /> to use.</param></summary><returns>The format that the model uses when communicating with the serivce.</returns>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.RunStepMessageCreationDetails.System#ClientModel#Primitives#IJsonModel{Azure#AI#OpenAI#Assistants#RunStepMessageCreationDetails}#Write(System.Text.Json.Utf8JsonWriter,System.ClientModel.Primitives.ModelReaderWriterOptions)">
|
|
<summary>
|
|
Writes the model to the provided <see cref="T:System.Text.Json.Utf8JsonWriter" />.
|
|
</summary><param name="writer">The <see cref="T:System.Text.Json.Utf8JsonWriter" /> to write into.</param><param name="options">The <see cref="T:System.ClientModel.Primitives.ModelReaderWriterOptions" /> to use.</param><exception cref="T:System.FormatException">If the model does not support the requested <see cref="P:System.ClientModel.Primitives.ModelReaderWriterOptions.Format" />.</exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.RunStepMessageCreationDetails.System#ClientModel#Primitives#IJsonModel{Azure#AI#OpenAI#Assistants#RunStepMessageCreationDetails}#Create(System.Text.Json.Utf8JsonReader@,System.ClientModel.Primitives.ModelReaderWriterOptions)">
|
|
<summary>
|
|
Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model.
|
|
</summary><param name="reader">The <see cref="T:System.Text.Json.Utf8JsonReader" /> to read.</param><param name="options">The <see cref="T:System.ClientModel.Primitives.ModelReaderWriterOptions" /> to use.</param><returns>A <typeparamref name="T" /> representation of the JSON value.</returns><exception cref="T:System.FormatException">If the model does not support the requested <see cref="P:System.ClientModel.Primitives.ModelReaderWriterOptions.Format" />.</exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.RunStepMessageCreationDetails.System#ClientModel#Primitives#IPersistableModel{Azure#AI#OpenAI#Assistants#RunStepMessageCreationDetails}#Write(System.ClientModel.Primitives.ModelReaderWriterOptions)">
|
|
<summary>
|
|
Writes the model into a <see cref="T:System.BinaryData" />.
|
|
</summary><param name="options">The <see cref="T:System.ClientModel.Primitives.ModelReaderWriterOptions" /> to use.</param><returns>A binary representation of the written model.</returns><exception cref="T:System.FormatException">If the model does not support the requested <see cref="P:System.ClientModel.Primitives.ModelReaderWriterOptions.Format" />.</exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.RunStepMessageCreationDetails.System#ClientModel#Primitives#IPersistableModel{Azure#AI#OpenAI#Assistants#RunStepMessageCreationDetails}#Create(System.BinaryData,System.ClientModel.Primitives.ModelReaderWriterOptions)">
|
|
<summary>
|
|
Converts the provided <see cref="T:System.BinaryData" /> into a model.
|
|
</summary><param name="data">The <see cref="T:System.BinaryData" /> to parse.</param><param name="options">The <see cref="T:System.ClientModel.Primitives.ModelReaderWriterOptions" /> to use.</param><returns>A <typeparamref name="T" /> representation of the data.</returns><exception cref="T:System.FormatException">If the model does not support the requested <see cref="P:System.ClientModel.Primitives.ModelReaderWriterOptions.Format" />.</exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.RunStepMessageCreationDetails.System#ClientModel#Primitives#IPersistableModel{Azure#AI#OpenAI#Assistants#RunStepMessageCreationDetails}#GetFormatFromOptions(System.ClientModel.Primitives.ModelReaderWriterOptions)">
|
|
<summary>
|
|
Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service.
|
|
<param name="options">The <see cref="T:System.ClientModel.Primitives.ModelReaderWriterOptions" /> to use.</param></summary><returns>The format that the model uses when communicating with the serivce.</returns>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.RunStepMessageCreationReference.System#ClientModel#Primitives#IJsonModel{Azure#AI#OpenAI#Assistants#RunStepMessageCreationReference}#Write(System.Text.Json.Utf8JsonWriter,System.ClientModel.Primitives.ModelReaderWriterOptions)">
|
|
<summary>
|
|
Writes the model to the provided <see cref="T:System.Text.Json.Utf8JsonWriter" />.
|
|
</summary><param name="writer">The <see cref="T:System.Text.Json.Utf8JsonWriter" /> to write into.</param><param name="options">The <see cref="T:System.ClientModel.Primitives.ModelReaderWriterOptions" /> to use.</param><exception cref="T:System.FormatException">If the model does not support the requested <see cref="P:System.ClientModel.Primitives.ModelReaderWriterOptions.Format" />.</exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.RunStepMessageCreationReference.System#ClientModel#Primitives#IJsonModel{Azure#AI#OpenAI#Assistants#RunStepMessageCreationReference}#Create(System.Text.Json.Utf8JsonReader@,System.ClientModel.Primitives.ModelReaderWriterOptions)">
|
|
<summary>
|
|
Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model.
|
|
</summary><param name="reader">The <see cref="T:System.Text.Json.Utf8JsonReader" /> to read.</param><param name="options">The <see cref="T:System.ClientModel.Primitives.ModelReaderWriterOptions" /> to use.</param><returns>A <typeparamref name="T" /> representation of the JSON value.</returns><exception cref="T:System.FormatException">If the model does not support the requested <see cref="P:System.ClientModel.Primitives.ModelReaderWriterOptions.Format" />.</exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.RunStepMessageCreationReference.System#ClientModel#Primitives#IPersistableModel{Azure#AI#OpenAI#Assistants#RunStepMessageCreationReference}#Write(System.ClientModel.Primitives.ModelReaderWriterOptions)">
|
|
<summary>
|
|
Writes the model into a <see cref="T:System.BinaryData" />.
|
|
</summary><param name="options">The <see cref="T:System.ClientModel.Primitives.ModelReaderWriterOptions" /> to use.</param><returns>A binary representation of the written model.</returns><exception cref="T:System.FormatException">If the model does not support the requested <see cref="P:System.ClientModel.Primitives.ModelReaderWriterOptions.Format" />.</exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.RunStepMessageCreationReference.System#ClientModel#Primitives#IPersistableModel{Azure#AI#OpenAI#Assistants#RunStepMessageCreationReference}#Create(System.BinaryData,System.ClientModel.Primitives.ModelReaderWriterOptions)">
|
|
<summary>
|
|
Converts the provided <see cref="T:System.BinaryData" /> into a model.
|
|
</summary><param name="data">The <see cref="T:System.BinaryData" /> to parse.</param><param name="options">The <see cref="T:System.ClientModel.Primitives.ModelReaderWriterOptions" /> to use.</param><returns>A <typeparamref name="T" /> representation of the data.</returns><exception cref="T:System.FormatException">If the model does not support the requested <see cref="P:System.ClientModel.Primitives.ModelReaderWriterOptions.Format" />.</exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.RunStepMessageCreationReference.System#ClientModel#Primitives#IPersistableModel{Azure#AI#OpenAI#Assistants#RunStepMessageCreationReference}#GetFormatFromOptions(System.ClientModel.Primitives.ModelReaderWriterOptions)">
|
|
<summary>
|
|
Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service.
|
|
<param name="options">The <see cref="T:System.ClientModel.Primitives.ModelReaderWriterOptions" /> to use.</param></summary><returns>The format that the model uses when communicating with the serivce.</returns>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.RunStepRetrievalToolCall.System#ClientModel#Primitives#IJsonModel{Azure#AI#OpenAI#Assistants#RunStepRetrievalToolCall}#Write(System.Text.Json.Utf8JsonWriter,System.ClientModel.Primitives.ModelReaderWriterOptions)">
|
|
<summary>
|
|
Writes the model to the provided <see cref="T:System.Text.Json.Utf8JsonWriter" />.
|
|
</summary><param name="writer">The <see cref="T:System.Text.Json.Utf8JsonWriter" /> to write into.</param><param name="options">The <see cref="T:System.ClientModel.Primitives.ModelReaderWriterOptions" /> to use.</param><exception cref="T:System.FormatException">If the model does not support the requested <see cref="P:System.ClientModel.Primitives.ModelReaderWriterOptions.Format" />.</exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.RunStepRetrievalToolCall.System#ClientModel#Primitives#IJsonModel{Azure#AI#OpenAI#Assistants#RunStepRetrievalToolCall}#Create(System.Text.Json.Utf8JsonReader@,System.ClientModel.Primitives.ModelReaderWriterOptions)">
|
|
<summary>
|
|
Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model.
|
|
</summary><param name="reader">The <see cref="T:System.Text.Json.Utf8JsonReader" /> to read.</param><param name="options">The <see cref="T:System.ClientModel.Primitives.ModelReaderWriterOptions" /> to use.</param><returns>A <typeparamref name="T" /> representation of the JSON value.</returns><exception cref="T:System.FormatException">If the model does not support the requested <see cref="P:System.ClientModel.Primitives.ModelReaderWriterOptions.Format" />.</exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.RunStepRetrievalToolCall.System#ClientModel#Primitives#IPersistableModel{Azure#AI#OpenAI#Assistants#RunStepRetrievalToolCall}#Write(System.ClientModel.Primitives.ModelReaderWriterOptions)">
|
|
<summary>
|
|
Writes the model into a <see cref="T:System.BinaryData" />.
|
|
</summary><param name="options">The <see cref="T:System.ClientModel.Primitives.ModelReaderWriterOptions" /> to use.</param><returns>A binary representation of the written model.</returns><exception cref="T:System.FormatException">If the model does not support the requested <see cref="P:System.ClientModel.Primitives.ModelReaderWriterOptions.Format" />.</exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.RunStepRetrievalToolCall.System#ClientModel#Primitives#IPersistableModel{Azure#AI#OpenAI#Assistants#RunStepRetrievalToolCall}#Create(System.BinaryData,System.ClientModel.Primitives.ModelReaderWriterOptions)">
|
|
<summary>
|
|
Converts the provided <see cref="T:System.BinaryData" /> into a model.
|
|
</summary><param name="data">The <see cref="T:System.BinaryData" /> to parse.</param><param name="options">The <see cref="T:System.ClientModel.Primitives.ModelReaderWriterOptions" /> to use.</param><returns>A <typeparamref name="T" /> representation of the data.</returns><exception cref="T:System.FormatException">If the model does not support the requested <see cref="P:System.ClientModel.Primitives.ModelReaderWriterOptions.Format" />.</exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.RunStepRetrievalToolCall.System#ClientModel#Primitives#IPersistableModel{Azure#AI#OpenAI#Assistants#RunStepRetrievalToolCall}#GetFormatFromOptions(System.ClientModel.Primitives.ModelReaderWriterOptions)">
|
|
<summary>
|
|
Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service.
|
|
<param name="options">The <see cref="T:System.ClientModel.Primitives.ModelReaderWriterOptions" /> to use.</param></summary><returns>The format that the model uses when communicating with the serivce.</returns>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.RunStepToolCall.System#ClientModel#Primitives#IJsonModel{Azure#AI#OpenAI#Assistants#RunStepToolCall}#Write(System.Text.Json.Utf8JsonWriter,System.ClientModel.Primitives.ModelReaderWriterOptions)">
|
|
<summary>
|
|
Writes the model to the provided <see cref="T:System.Text.Json.Utf8JsonWriter" />.
|
|
</summary><param name="writer">The <see cref="T:System.Text.Json.Utf8JsonWriter" /> to write into.</param><param name="options">The <see cref="T:System.ClientModel.Primitives.ModelReaderWriterOptions" /> to use.</param><exception cref="T:System.FormatException">If the model does not support the requested <see cref="P:System.ClientModel.Primitives.ModelReaderWriterOptions.Format" />.</exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.RunStepToolCall.System#ClientModel#Primitives#IJsonModel{Azure#AI#OpenAI#Assistants#RunStepToolCall}#Create(System.Text.Json.Utf8JsonReader@,System.ClientModel.Primitives.ModelReaderWriterOptions)">
|
|
<summary>
|
|
Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model.
|
|
</summary><param name="reader">The <see cref="T:System.Text.Json.Utf8JsonReader" /> to read.</param><param name="options">The <see cref="T:System.ClientModel.Primitives.ModelReaderWriterOptions" /> to use.</param><returns>A <typeparamref name="T" /> representation of the JSON value.</returns><exception cref="T:System.FormatException">If the model does not support the requested <see cref="P:System.ClientModel.Primitives.ModelReaderWriterOptions.Format" />.</exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.RunStepToolCall.System#ClientModel#Primitives#IPersistableModel{Azure#AI#OpenAI#Assistants#RunStepToolCall}#Write(System.ClientModel.Primitives.ModelReaderWriterOptions)">
|
|
<summary>
|
|
Writes the model into a <see cref="T:System.BinaryData" />.
|
|
</summary><param name="options">The <see cref="T:System.ClientModel.Primitives.ModelReaderWriterOptions" /> to use.</param><returns>A binary representation of the written model.</returns><exception cref="T:System.FormatException">If the model does not support the requested <see cref="P:System.ClientModel.Primitives.ModelReaderWriterOptions.Format" />.</exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.RunStepToolCall.System#ClientModel#Primitives#IPersistableModel{Azure#AI#OpenAI#Assistants#RunStepToolCall}#Create(System.BinaryData,System.ClientModel.Primitives.ModelReaderWriterOptions)">
|
|
<summary>
|
|
Converts the provided <see cref="T:System.BinaryData" /> into a model.
|
|
</summary><param name="data">The <see cref="T:System.BinaryData" /> to parse.</param><param name="options">The <see cref="T:System.ClientModel.Primitives.ModelReaderWriterOptions" /> to use.</param><returns>A <typeparamref name="T" /> representation of the data.</returns><exception cref="T:System.FormatException">If the model does not support the requested <see cref="P:System.ClientModel.Primitives.ModelReaderWriterOptions.Format" />.</exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.RunStepToolCall.System#ClientModel#Primitives#IPersistableModel{Azure#AI#OpenAI#Assistants#RunStepToolCall}#GetFormatFromOptions(System.ClientModel.Primitives.ModelReaderWriterOptions)">
|
|
<summary>
|
|
Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service.
|
|
<param name="options">The <see cref="T:System.ClientModel.Primitives.ModelReaderWriterOptions" /> to use.</param></summary><returns>The format that the model uses when communicating with the serivce.</returns>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.RunStepToolCallDetails.System#ClientModel#Primitives#IJsonModel{Azure#AI#OpenAI#Assistants#RunStepToolCallDetails}#Write(System.Text.Json.Utf8JsonWriter,System.ClientModel.Primitives.ModelReaderWriterOptions)">
|
|
<summary>
|
|
Writes the model to the provided <see cref="T:System.Text.Json.Utf8JsonWriter" />.
|
|
</summary><param name="writer">The <see cref="T:System.Text.Json.Utf8JsonWriter" /> to write into.</param><param name="options">The <see cref="T:System.ClientModel.Primitives.ModelReaderWriterOptions" /> to use.</param><exception cref="T:System.FormatException">If the model does not support the requested <see cref="P:System.ClientModel.Primitives.ModelReaderWriterOptions.Format" />.</exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.RunStepToolCallDetails.System#ClientModel#Primitives#IJsonModel{Azure#AI#OpenAI#Assistants#RunStepToolCallDetails}#Create(System.Text.Json.Utf8JsonReader@,System.ClientModel.Primitives.ModelReaderWriterOptions)">
|
|
<summary>
|
|
Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model.
|
|
</summary><param name="reader">The <see cref="T:System.Text.Json.Utf8JsonReader" /> to read.</param><param name="options">The <see cref="T:System.ClientModel.Primitives.ModelReaderWriterOptions" /> to use.</param><returns>A <typeparamref name="T" /> representation of the JSON value.</returns><exception cref="T:System.FormatException">If the model does not support the requested <see cref="P:System.ClientModel.Primitives.ModelReaderWriterOptions.Format" />.</exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.RunStepToolCallDetails.System#ClientModel#Primitives#IPersistableModel{Azure#AI#OpenAI#Assistants#RunStepToolCallDetails}#Write(System.ClientModel.Primitives.ModelReaderWriterOptions)">
|
|
<summary>
|
|
Writes the model into a <see cref="T:System.BinaryData" />.
|
|
</summary><param name="options">The <see cref="T:System.ClientModel.Primitives.ModelReaderWriterOptions" /> to use.</param><returns>A binary representation of the written model.</returns><exception cref="T:System.FormatException">If the model does not support the requested <see cref="P:System.ClientModel.Primitives.ModelReaderWriterOptions.Format" />.</exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.RunStepToolCallDetails.System#ClientModel#Primitives#IPersistableModel{Azure#AI#OpenAI#Assistants#RunStepToolCallDetails}#Create(System.BinaryData,System.ClientModel.Primitives.ModelReaderWriterOptions)">
|
|
<summary>
|
|
Converts the provided <see cref="T:System.BinaryData" /> into a model.
|
|
</summary><param name="data">The <see cref="T:System.BinaryData" /> to parse.</param><param name="options">The <see cref="T:System.ClientModel.Primitives.ModelReaderWriterOptions" /> to use.</param><returns>A <typeparamref name="T" /> representation of the data.</returns><exception cref="T:System.FormatException">If the model does not support the requested <see cref="P:System.ClientModel.Primitives.ModelReaderWriterOptions.Format" />.</exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.RunStepToolCallDetails.System#ClientModel#Primitives#IPersistableModel{Azure#AI#OpenAI#Assistants#RunStepToolCallDetails}#GetFormatFromOptions(System.ClientModel.Primitives.ModelReaderWriterOptions)">
|
|
<summary>
|
|
Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service.
|
|
<param name="options">The <see cref="T:System.ClientModel.Primitives.ModelReaderWriterOptions" /> to use.</param></summary><returns>The format that the model uses when communicating with the serivce.</returns>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.SubmitToolOutputsToRunRequest.System#ClientModel#Primitives#IJsonModel{Azure#AI#OpenAI#Assistants#SubmitToolOutputsToRunRequest}#Write(System.Text.Json.Utf8JsonWriter,System.ClientModel.Primitives.ModelReaderWriterOptions)">
|
|
<summary>
|
|
Writes the model to the provided <see cref="T:System.Text.Json.Utf8JsonWriter" />.
|
|
</summary><param name="writer">The <see cref="T:System.Text.Json.Utf8JsonWriter" /> to write into.</param><param name="options">The <see cref="T:System.ClientModel.Primitives.ModelReaderWriterOptions" /> to use.</param><exception cref="T:System.FormatException">If the model does not support the requested <see cref="P:System.ClientModel.Primitives.ModelReaderWriterOptions.Format" />.</exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.SubmitToolOutputsToRunRequest.System#ClientModel#Primitives#IJsonModel{Azure#AI#OpenAI#Assistants#SubmitToolOutputsToRunRequest}#Create(System.Text.Json.Utf8JsonReader@,System.ClientModel.Primitives.ModelReaderWriterOptions)">
|
|
<summary>
|
|
Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model.
|
|
</summary><param name="reader">The <see cref="T:System.Text.Json.Utf8JsonReader" /> to read.</param><param name="options">The <see cref="T:System.ClientModel.Primitives.ModelReaderWriterOptions" /> to use.</param><returns>A <typeparamref name="T" /> representation of the JSON value.</returns><exception cref="T:System.FormatException">If the model does not support the requested <see cref="P:System.ClientModel.Primitives.ModelReaderWriterOptions.Format" />.</exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.SubmitToolOutputsToRunRequest.System#ClientModel#Primitives#IPersistableModel{Azure#AI#OpenAI#Assistants#SubmitToolOutputsToRunRequest}#Write(System.ClientModel.Primitives.ModelReaderWriterOptions)">
|
|
<summary>
|
|
Writes the model into a <see cref="T:System.BinaryData" />.
|
|
</summary><param name="options">The <see cref="T:System.ClientModel.Primitives.ModelReaderWriterOptions" /> to use.</param><returns>A binary representation of the written model.</returns><exception cref="T:System.FormatException">If the model does not support the requested <see cref="P:System.ClientModel.Primitives.ModelReaderWriterOptions.Format" />.</exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.SubmitToolOutputsToRunRequest.System#ClientModel#Primitives#IPersistableModel{Azure#AI#OpenAI#Assistants#SubmitToolOutputsToRunRequest}#Create(System.BinaryData,System.ClientModel.Primitives.ModelReaderWriterOptions)">
|
|
<summary>
|
|
Converts the provided <see cref="T:System.BinaryData" /> into a model.
|
|
</summary><param name="data">The <see cref="T:System.BinaryData" /> to parse.</param><param name="options">The <see cref="T:System.ClientModel.Primitives.ModelReaderWriterOptions" /> to use.</param><returns>A <typeparamref name="T" /> representation of the data.</returns><exception cref="T:System.FormatException">If the model does not support the requested <see cref="P:System.ClientModel.Primitives.ModelReaderWriterOptions.Format" />.</exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.SubmitToolOutputsToRunRequest.System#ClientModel#Primitives#IPersistableModel{Azure#AI#OpenAI#Assistants#SubmitToolOutputsToRunRequest}#GetFormatFromOptions(System.ClientModel.Primitives.ModelReaderWriterOptions)">
|
|
<summary>
|
|
Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service.
|
|
<param name="options">The <see cref="T:System.ClientModel.Primitives.ModelReaderWriterOptions" /> to use.</param></summary><returns>The format that the model uses when communicating with the serivce.</returns>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.ThreadDeletionStatus.System#ClientModel#Primitives#IJsonModel{Azure#AI#OpenAI#Assistants#ThreadDeletionStatus}#Write(System.Text.Json.Utf8JsonWriter,System.ClientModel.Primitives.ModelReaderWriterOptions)">
|
|
<summary>
|
|
Writes the model to the provided <see cref="T:System.Text.Json.Utf8JsonWriter" />.
|
|
</summary><param name="writer">The <see cref="T:System.Text.Json.Utf8JsonWriter" /> to write into.</param><param name="options">The <see cref="T:System.ClientModel.Primitives.ModelReaderWriterOptions" /> to use.</param><exception cref="T:System.FormatException">If the model does not support the requested <see cref="P:System.ClientModel.Primitives.ModelReaderWriterOptions.Format" />.</exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.ThreadDeletionStatus.System#ClientModel#Primitives#IJsonModel{Azure#AI#OpenAI#Assistants#ThreadDeletionStatus}#Create(System.Text.Json.Utf8JsonReader@,System.ClientModel.Primitives.ModelReaderWriterOptions)">
|
|
<summary>
|
|
Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model.
|
|
</summary><param name="reader">The <see cref="T:System.Text.Json.Utf8JsonReader" /> to read.</param><param name="options">The <see cref="T:System.ClientModel.Primitives.ModelReaderWriterOptions" /> to use.</param><returns>A <typeparamref name="T" /> representation of the JSON value.</returns><exception cref="T:System.FormatException">If the model does not support the requested <see cref="P:System.ClientModel.Primitives.ModelReaderWriterOptions.Format" />.</exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.ThreadDeletionStatus.System#ClientModel#Primitives#IPersistableModel{Azure#AI#OpenAI#Assistants#ThreadDeletionStatus}#Write(System.ClientModel.Primitives.ModelReaderWriterOptions)">
|
|
<summary>
|
|
Writes the model into a <see cref="T:System.BinaryData" />.
|
|
</summary><param name="options">The <see cref="T:System.ClientModel.Primitives.ModelReaderWriterOptions" /> to use.</param><returns>A binary representation of the written model.</returns><exception cref="T:System.FormatException">If the model does not support the requested <see cref="P:System.ClientModel.Primitives.ModelReaderWriterOptions.Format" />.</exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.ThreadDeletionStatus.System#ClientModel#Primitives#IPersistableModel{Azure#AI#OpenAI#Assistants#ThreadDeletionStatus}#Create(System.BinaryData,System.ClientModel.Primitives.ModelReaderWriterOptions)">
|
|
<summary>
|
|
Converts the provided <see cref="T:System.BinaryData" /> into a model.
|
|
</summary><param name="data">The <see cref="T:System.BinaryData" /> to parse.</param><param name="options">The <see cref="T:System.ClientModel.Primitives.ModelReaderWriterOptions" /> to use.</param><returns>A <typeparamref name="T" /> representation of the data.</returns><exception cref="T:System.FormatException">If the model does not support the requested <see cref="P:System.ClientModel.Primitives.ModelReaderWriterOptions.Format" />.</exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.ThreadDeletionStatus.System#ClientModel#Primitives#IPersistableModel{Azure#AI#OpenAI#Assistants#ThreadDeletionStatus}#GetFormatFromOptions(System.ClientModel.Primitives.ModelReaderWriterOptions)">
|
|
<summary>
|
|
Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service.
|
|
<param name="options">The <see cref="T:System.ClientModel.Primitives.ModelReaderWriterOptions" /> to use.</param></summary><returns>The format that the model uses when communicating with the serivce.</returns>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.ThreadInitializationMessage.System#ClientModel#Primitives#IJsonModel{Azure#AI#OpenAI#Assistants#ThreadInitializationMessage}#Write(System.Text.Json.Utf8JsonWriter,System.ClientModel.Primitives.ModelReaderWriterOptions)">
|
|
<summary>
|
|
Writes the model to the provided <see cref="T:System.Text.Json.Utf8JsonWriter" />.
|
|
</summary><param name="writer">The <see cref="T:System.Text.Json.Utf8JsonWriter" /> to write into.</param><param name="options">The <see cref="T:System.ClientModel.Primitives.ModelReaderWriterOptions" /> to use.</param><exception cref="T:System.FormatException">If the model does not support the requested <see cref="P:System.ClientModel.Primitives.ModelReaderWriterOptions.Format" />.</exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.ThreadInitializationMessage.System#ClientModel#Primitives#IJsonModel{Azure#AI#OpenAI#Assistants#ThreadInitializationMessage}#Create(System.Text.Json.Utf8JsonReader@,System.ClientModel.Primitives.ModelReaderWriterOptions)">
|
|
<summary>
|
|
Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model.
|
|
</summary><param name="reader">The <see cref="T:System.Text.Json.Utf8JsonReader" /> to read.</param><param name="options">The <see cref="T:System.ClientModel.Primitives.ModelReaderWriterOptions" /> to use.</param><returns>A <typeparamref name="T" /> representation of the JSON value.</returns><exception cref="T:System.FormatException">If the model does not support the requested <see cref="P:System.ClientModel.Primitives.ModelReaderWriterOptions.Format" />.</exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.ThreadInitializationMessage.System#ClientModel#Primitives#IPersistableModel{Azure#AI#OpenAI#Assistants#ThreadInitializationMessage}#Write(System.ClientModel.Primitives.ModelReaderWriterOptions)">
|
|
<summary>
|
|
Writes the model into a <see cref="T:System.BinaryData" />.
|
|
</summary><param name="options">The <see cref="T:System.ClientModel.Primitives.ModelReaderWriterOptions" /> to use.</param><returns>A binary representation of the written model.</returns><exception cref="T:System.FormatException">If the model does not support the requested <see cref="P:System.ClientModel.Primitives.ModelReaderWriterOptions.Format" />.</exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.ThreadInitializationMessage.System#ClientModel#Primitives#IPersistableModel{Azure#AI#OpenAI#Assistants#ThreadInitializationMessage}#Create(System.BinaryData,System.ClientModel.Primitives.ModelReaderWriterOptions)">
|
|
<summary>
|
|
Converts the provided <see cref="T:System.BinaryData" /> into a model.
|
|
</summary><param name="data">The <see cref="T:System.BinaryData" /> to parse.</param><param name="options">The <see cref="T:System.ClientModel.Primitives.ModelReaderWriterOptions" /> to use.</param><returns>A <typeparamref name="T" /> representation of the data.</returns><exception cref="T:System.FormatException">If the model does not support the requested <see cref="P:System.ClientModel.Primitives.ModelReaderWriterOptions.Format" />.</exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.ThreadInitializationMessage.System#ClientModel#Primitives#IPersistableModel{Azure#AI#OpenAI#Assistants#ThreadInitializationMessage}#GetFormatFromOptions(System.ClientModel.Primitives.ModelReaderWriterOptions)">
|
|
<summary>
|
|
Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service.
|
|
<param name="options">The <see cref="T:System.ClientModel.Primitives.ModelReaderWriterOptions" /> to use.</param></summary><returns>The format that the model uses when communicating with the serivce.</returns>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.ToolDefinition.System#ClientModel#Primitives#IJsonModel{Azure#AI#OpenAI#Assistants#ToolDefinition}#Write(System.Text.Json.Utf8JsonWriter,System.ClientModel.Primitives.ModelReaderWriterOptions)">
|
|
<summary>
|
|
Writes the model to the provided <see cref="T:System.Text.Json.Utf8JsonWriter" />.
|
|
</summary><param name="writer">The <see cref="T:System.Text.Json.Utf8JsonWriter" /> to write into.</param><param name="options">The <see cref="T:System.ClientModel.Primitives.ModelReaderWriterOptions" /> to use.</param><exception cref="T:System.FormatException">If the model does not support the requested <see cref="P:System.ClientModel.Primitives.ModelReaderWriterOptions.Format" />.</exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.ToolDefinition.System#ClientModel#Primitives#IJsonModel{Azure#AI#OpenAI#Assistants#ToolDefinition}#Create(System.Text.Json.Utf8JsonReader@,System.ClientModel.Primitives.ModelReaderWriterOptions)">
|
|
<summary>
|
|
Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model.
|
|
</summary><param name="reader">The <see cref="T:System.Text.Json.Utf8JsonReader" /> to read.</param><param name="options">The <see cref="T:System.ClientModel.Primitives.ModelReaderWriterOptions" /> to use.</param><returns>A <typeparamref name="T" /> representation of the JSON value.</returns><exception cref="T:System.FormatException">If the model does not support the requested <see cref="P:System.ClientModel.Primitives.ModelReaderWriterOptions.Format" />.</exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.ToolDefinition.System#ClientModel#Primitives#IPersistableModel{Azure#AI#OpenAI#Assistants#ToolDefinition}#Write(System.ClientModel.Primitives.ModelReaderWriterOptions)">
|
|
<summary>
|
|
Writes the model into a <see cref="T:System.BinaryData" />.
|
|
</summary><param name="options">The <see cref="T:System.ClientModel.Primitives.ModelReaderWriterOptions" /> to use.</param><returns>A binary representation of the written model.</returns><exception cref="T:System.FormatException">If the model does not support the requested <see cref="P:System.ClientModel.Primitives.ModelReaderWriterOptions.Format" />.</exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.ToolDefinition.System#ClientModel#Primitives#IPersistableModel{Azure#AI#OpenAI#Assistants#ToolDefinition}#Create(System.BinaryData,System.ClientModel.Primitives.ModelReaderWriterOptions)">
|
|
<summary>
|
|
Converts the provided <see cref="T:System.BinaryData" /> into a model.
|
|
</summary><param name="data">The <see cref="T:System.BinaryData" /> to parse.</param><param name="options">The <see cref="T:System.ClientModel.Primitives.ModelReaderWriterOptions" /> to use.</param><returns>A <typeparamref name="T" /> representation of the data.</returns><exception cref="T:System.FormatException">If the model does not support the requested <see cref="P:System.ClientModel.Primitives.ModelReaderWriterOptions.Format" />.</exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.ToolDefinition.System#ClientModel#Primitives#IPersistableModel{Azure#AI#OpenAI#Assistants#ToolDefinition}#GetFormatFromOptions(System.ClientModel.Primitives.ModelReaderWriterOptions)">
|
|
<summary>
|
|
Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service.
|
|
<param name="options">The <see cref="T:System.ClientModel.Primitives.ModelReaderWriterOptions" /> to use.</param></summary><returns>The format that the model uses when communicating with the serivce.</returns>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.UnknownMessageContent.System#ClientModel#Primitives#IJsonModel{Azure#AI#OpenAI#Assistants#MessageContent}#Write(System.Text.Json.Utf8JsonWriter,System.ClientModel.Primitives.ModelReaderWriterOptions)">
|
|
<summary>
|
|
Writes the model to the provided <see cref="T:System.Text.Json.Utf8JsonWriter" />.
|
|
</summary><param name="writer">The <see cref="T:System.Text.Json.Utf8JsonWriter" /> to write into.</param><param name="options">The <see cref="T:System.ClientModel.Primitives.ModelReaderWriterOptions" /> to use.</param><exception cref="T:System.FormatException">If the model does not support the requested <see cref="P:System.ClientModel.Primitives.ModelReaderWriterOptions.Format" />.</exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.UnknownMessageContent.System#ClientModel#Primitives#IJsonModel{Azure#AI#OpenAI#Assistants#MessageContent}#Create(System.Text.Json.Utf8JsonReader@,System.ClientModel.Primitives.ModelReaderWriterOptions)">
|
|
<summary>
|
|
Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model.
|
|
</summary><param name="reader">The <see cref="T:System.Text.Json.Utf8JsonReader" /> to read.</param><param name="options">The <see cref="T:System.ClientModel.Primitives.ModelReaderWriterOptions" /> to use.</param><returns>A <typeparamref name="T" /> representation of the JSON value.</returns><exception cref="T:System.FormatException">If the model does not support the requested <see cref="P:System.ClientModel.Primitives.ModelReaderWriterOptions.Format" />.</exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.UnknownMessageContent.System#ClientModel#Primitives#IPersistableModel{Azure#AI#OpenAI#Assistants#MessageContent}#Write(System.ClientModel.Primitives.ModelReaderWriterOptions)">
|
|
<summary>
|
|
Writes the model into a <see cref="T:System.BinaryData" />.
|
|
</summary><param name="options">The <see cref="T:System.ClientModel.Primitives.ModelReaderWriterOptions" /> to use.</param><returns>A binary representation of the written model.</returns><exception cref="T:System.FormatException">If the model does not support the requested <see cref="P:System.ClientModel.Primitives.ModelReaderWriterOptions.Format" />.</exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.UnknownMessageContent.System#ClientModel#Primitives#IPersistableModel{Azure#AI#OpenAI#Assistants#MessageContent}#Create(System.BinaryData,System.ClientModel.Primitives.ModelReaderWriterOptions)">
|
|
<summary>
|
|
Converts the provided <see cref="T:System.BinaryData" /> into a model.
|
|
</summary><param name="data">The <see cref="T:System.BinaryData" /> to parse.</param><param name="options">The <see cref="T:System.ClientModel.Primitives.ModelReaderWriterOptions" /> to use.</param><returns>A <typeparamref name="T" /> representation of the data.</returns><exception cref="T:System.FormatException">If the model does not support the requested <see cref="P:System.ClientModel.Primitives.ModelReaderWriterOptions.Format" />.</exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.UnknownMessageContent.System#ClientModel#Primitives#IPersistableModel{Azure#AI#OpenAI#Assistants#MessageContent}#GetFormatFromOptions(System.ClientModel.Primitives.ModelReaderWriterOptions)">
|
|
<summary>
|
|
Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service.
|
|
<param name="options">The <see cref="T:System.ClientModel.Primitives.ModelReaderWriterOptions" /> to use.</param></summary><returns>The format that the model uses when communicating with the serivce.</returns>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.UnknownMessageTextAnnotation.System#ClientModel#Primitives#IJsonModel{Azure#AI#OpenAI#Assistants#MessageTextAnnotation}#Write(System.Text.Json.Utf8JsonWriter,System.ClientModel.Primitives.ModelReaderWriterOptions)">
|
|
<summary>
|
|
Writes the model to the provided <see cref="T:System.Text.Json.Utf8JsonWriter" />.
|
|
</summary><param name="writer">The <see cref="T:System.Text.Json.Utf8JsonWriter" /> to write into.</param><param name="options">The <see cref="T:System.ClientModel.Primitives.ModelReaderWriterOptions" /> to use.</param><exception cref="T:System.FormatException">If the model does not support the requested <see cref="P:System.ClientModel.Primitives.ModelReaderWriterOptions.Format" />.</exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.UnknownMessageTextAnnotation.System#ClientModel#Primitives#IJsonModel{Azure#AI#OpenAI#Assistants#MessageTextAnnotation}#Create(System.Text.Json.Utf8JsonReader@,System.ClientModel.Primitives.ModelReaderWriterOptions)">
|
|
<summary>
|
|
Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model.
|
|
</summary><param name="reader">The <see cref="T:System.Text.Json.Utf8JsonReader" /> to read.</param><param name="options">The <see cref="T:System.ClientModel.Primitives.ModelReaderWriterOptions" /> to use.</param><returns>A <typeparamref name="T" /> representation of the JSON value.</returns><exception cref="T:System.FormatException">If the model does not support the requested <see cref="P:System.ClientModel.Primitives.ModelReaderWriterOptions.Format" />.</exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.UnknownMessageTextAnnotation.System#ClientModel#Primitives#IPersistableModel{Azure#AI#OpenAI#Assistants#MessageTextAnnotation}#Write(System.ClientModel.Primitives.ModelReaderWriterOptions)">
|
|
<summary>
|
|
Writes the model into a <see cref="T:System.BinaryData" />.
|
|
</summary><param name="options">The <see cref="T:System.ClientModel.Primitives.ModelReaderWriterOptions" /> to use.</param><returns>A binary representation of the written model.</returns><exception cref="T:System.FormatException">If the model does not support the requested <see cref="P:System.ClientModel.Primitives.ModelReaderWriterOptions.Format" />.</exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.UnknownMessageTextAnnotation.System#ClientModel#Primitives#IPersistableModel{Azure#AI#OpenAI#Assistants#MessageTextAnnotation}#Create(System.BinaryData,System.ClientModel.Primitives.ModelReaderWriterOptions)">
|
|
<summary>
|
|
Converts the provided <see cref="T:System.BinaryData" /> into a model.
|
|
</summary><param name="data">The <see cref="T:System.BinaryData" /> to parse.</param><param name="options">The <see cref="T:System.ClientModel.Primitives.ModelReaderWriterOptions" /> to use.</param><returns>A <typeparamref name="T" /> representation of the data.</returns><exception cref="T:System.FormatException">If the model does not support the requested <see cref="P:System.ClientModel.Primitives.ModelReaderWriterOptions.Format" />.</exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.UnknownMessageTextAnnotation.System#ClientModel#Primitives#IPersistableModel{Azure#AI#OpenAI#Assistants#MessageTextAnnotation}#GetFormatFromOptions(System.ClientModel.Primitives.ModelReaderWriterOptions)">
|
|
<summary>
|
|
Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service.
|
|
<param name="options">The <see cref="T:System.ClientModel.Primitives.ModelReaderWriterOptions" /> to use.</param></summary><returns>The format that the model uses when communicating with the serivce.</returns>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.UnknownRequiredAction.System#ClientModel#Primitives#IJsonModel{Azure#AI#OpenAI#Assistants#RequiredAction}#Write(System.Text.Json.Utf8JsonWriter,System.ClientModel.Primitives.ModelReaderWriterOptions)">
|
|
<summary>
|
|
Writes the model to the provided <see cref="T:System.Text.Json.Utf8JsonWriter" />.
|
|
</summary><param name="writer">The <see cref="T:System.Text.Json.Utf8JsonWriter" /> to write into.</param><param name="options">The <see cref="T:System.ClientModel.Primitives.ModelReaderWriterOptions" /> to use.</param><exception cref="T:System.FormatException">If the model does not support the requested <see cref="P:System.ClientModel.Primitives.ModelReaderWriterOptions.Format" />.</exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.UnknownRequiredAction.System#ClientModel#Primitives#IJsonModel{Azure#AI#OpenAI#Assistants#RequiredAction}#Create(System.Text.Json.Utf8JsonReader@,System.ClientModel.Primitives.ModelReaderWriterOptions)">
|
|
<summary>
|
|
Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model.
|
|
</summary><param name="reader">The <see cref="T:System.Text.Json.Utf8JsonReader" /> to read.</param><param name="options">The <see cref="T:System.ClientModel.Primitives.ModelReaderWriterOptions" /> to use.</param><returns>A <typeparamref name="T" /> representation of the JSON value.</returns><exception cref="T:System.FormatException">If the model does not support the requested <see cref="P:System.ClientModel.Primitives.ModelReaderWriterOptions.Format" />.</exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.UnknownRequiredAction.System#ClientModel#Primitives#IPersistableModel{Azure#AI#OpenAI#Assistants#RequiredAction}#Write(System.ClientModel.Primitives.ModelReaderWriterOptions)">
|
|
<summary>
|
|
Writes the model into a <see cref="T:System.BinaryData" />.
|
|
</summary><param name="options">The <see cref="T:System.ClientModel.Primitives.ModelReaderWriterOptions" /> to use.</param><returns>A binary representation of the written model.</returns><exception cref="T:System.FormatException">If the model does not support the requested <see cref="P:System.ClientModel.Primitives.ModelReaderWriterOptions.Format" />.</exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.UnknownRequiredAction.System#ClientModel#Primitives#IPersistableModel{Azure#AI#OpenAI#Assistants#RequiredAction}#Create(System.BinaryData,System.ClientModel.Primitives.ModelReaderWriterOptions)">
|
|
<summary>
|
|
Converts the provided <see cref="T:System.BinaryData" /> into a model.
|
|
</summary><param name="data">The <see cref="T:System.BinaryData" /> to parse.</param><param name="options">The <see cref="T:System.ClientModel.Primitives.ModelReaderWriterOptions" /> to use.</param><returns>A <typeparamref name="T" /> representation of the data.</returns><exception cref="T:System.FormatException">If the model does not support the requested <see cref="P:System.ClientModel.Primitives.ModelReaderWriterOptions.Format" />.</exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.UnknownRequiredAction.System#ClientModel#Primitives#IPersistableModel{Azure#AI#OpenAI#Assistants#RequiredAction}#GetFormatFromOptions(System.ClientModel.Primitives.ModelReaderWriterOptions)">
|
|
<summary>
|
|
Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service.
|
|
<param name="options">The <see cref="T:System.ClientModel.Primitives.ModelReaderWriterOptions" /> to use.</param></summary><returns>The format that the model uses when communicating with the serivce.</returns>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.UnknownRequiredToolCall.System#ClientModel#Primitives#IJsonModel{Azure#AI#OpenAI#Assistants#RequiredToolCall}#Write(System.Text.Json.Utf8JsonWriter,System.ClientModel.Primitives.ModelReaderWriterOptions)">
|
|
<summary>
|
|
Writes the model to the provided <see cref="T:System.Text.Json.Utf8JsonWriter" />.
|
|
</summary><param name="writer">The <see cref="T:System.Text.Json.Utf8JsonWriter" /> to write into.</param><param name="options">The <see cref="T:System.ClientModel.Primitives.ModelReaderWriterOptions" /> to use.</param><exception cref="T:System.FormatException">If the model does not support the requested <see cref="P:System.ClientModel.Primitives.ModelReaderWriterOptions.Format" />.</exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.UnknownRequiredToolCall.System#ClientModel#Primitives#IJsonModel{Azure#AI#OpenAI#Assistants#RequiredToolCall}#Create(System.Text.Json.Utf8JsonReader@,System.ClientModel.Primitives.ModelReaderWriterOptions)">
|
|
<summary>
|
|
Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model.
|
|
</summary><param name="reader">The <see cref="T:System.Text.Json.Utf8JsonReader" /> to read.</param><param name="options">The <see cref="T:System.ClientModel.Primitives.ModelReaderWriterOptions" /> to use.</param><returns>A <typeparamref name="T" /> representation of the JSON value.</returns><exception cref="T:System.FormatException">If the model does not support the requested <see cref="P:System.ClientModel.Primitives.ModelReaderWriterOptions.Format" />.</exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.UnknownRequiredToolCall.System#ClientModel#Primitives#IPersistableModel{Azure#AI#OpenAI#Assistants#RequiredToolCall}#Write(System.ClientModel.Primitives.ModelReaderWriterOptions)">
|
|
<summary>
|
|
Writes the model into a <see cref="T:System.BinaryData" />.
|
|
</summary><param name="options">The <see cref="T:System.ClientModel.Primitives.ModelReaderWriterOptions" /> to use.</param><returns>A binary representation of the written model.</returns><exception cref="T:System.FormatException">If the model does not support the requested <see cref="P:System.ClientModel.Primitives.ModelReaderWriterOptions.Format" />.</exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.UnknownRequiredToolCall.System#ClientModel#Primitives#IPersistableModel{Azure#AI#OpenAI#Assistants#RequiredToolCall}#Create(System.BinaryData,System.ClientModel.Primitives.ModelReaderWriterOptions)">
|
|
<summary>
|
|
Converts the provided <see cref="T:System.BinaryData" /> into a model.
|
|
</summary><param name="data">The <see cref="T:System.BinaryData" /> to parse.</param><param name="options">The <see cref="T:System.ClientModel.Primitives.ModelReaderWriterOptions" /> to use.</param><returns>A <typeparamref name="T" /> representation of the data.</returns><exception cref="T:System.FormatException">If the model does not support the requested <see cref="P:System.ClientModel.Primitives.ModelReaderWriterOptions.Format" />.</exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.UnknownRequiredToolCall.System#ClientModel#Primitives#IPersistableModel{Azure#AI#OpenAI#Assistants#RequiredToolCall}#GetFormatFromOptions(System.ClientModel.Primitives.ModelReaderWriterOptions)">
|
|
<summary>
|
|
Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service.
|
|
<param name="options">The <see cref="T:System.ClientModel.Primitives.ModelReaderWriterOptions" /> to use.</param></summary><returns>The format that the model uses when communicating with the serivce.</returns>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.UnknownRunStepCodeInterpreterToolCallOutput.System#ClientModel#Primitives#IJsonModel{Azure#AI#OpenAI#Assistants#RunStepCodeInterpreterToolCallOutput}#Write(System.Text.Json.Utf8JsonWriter,System.ClientModel.Primitives.ModelReaderWriterOptions)">
|
|
<summary>
|
|
Writes the model to the provided <see cref="T:System.Text.Json.Utf8JsonWriter" />.
|
|
</summary><param name="writer">The <see cref="T:System.Text.Json.Utf8JsonWriter" /> to write into.</param><param name="options">The <see cref="T:System.ClientModel.Primitives.ModelReaderWriterOptions" /> to use.</param><exception cref="T:System.FormatException">If the model does not support the requested <see cref="P:System.ClientModel.Primitives.ModelReaderWriterOptions.Format" />.</exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.UnknownRunStepCodeInterpreterToolCallOutput.System#ClientModel#Primitives#IJsonModel{Azure#AI#OpenAI#Assistants#RunStepCodeInterpreterToolCallOutput}#Create(System.Text.Json.Utf8JsonReader@,System.ClientModel.Primitives.ModelReaderWriterOptions)">
|
|
<summary>
|
|
Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model.
|
|
</summary><param name="reader">The <see cref="T:System.Text.Json.Utf8JsonReader" /> to read.</param><param name="options">The <see cref="T:System.ClientModel.Primitives.ModelReaderWriterOptions" /> to use.</param><returns>A <typeparamref name="T" /> representation of the JSON value.</returns><exception cref="T:System.FormatException">If the model does not support the requested <see cref="P:System.ClientModel.Primitives.ModelReaderWriterOptions.Format" />.</exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.UnknownRunStepCodeInterpreterToolCallOutput.System#ClientModel#Primitives#IPersistableModel{Azure#AI#OpenAI#Assistants#RunStepCodeInterpreterToolCallOutput}#Write(System.ClientModel.Primitives.ModelReaderWriterOptions)">
|
|
<summary>
|
|
Writes the model into a <see cref="T:System.BinaryData" />.
|
|
</summary><param name="options">The <see cref="T:System.ClientModel.Primitives.ModelReaderWriterOptions" /> to use.</param><returns>A binary representation of the written model.</returns><exception cref="T:System.FormatException">If the model does not support the requested <see cref="P:System.ClientModel.Primitives.ModelReaderWriterOptions.Format" />.</exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.UnknownRunStepCodeInterpreterToolCallOutput.System#ClientModel#Primitives#IPersistableModel{Azure#AI#OpenAI#Assistants#RunStepCodeInterpreterToolCallOutput}#Create(System.BinaryData,System.ClientModel.Primitives.ModelReaderWriterOptions)">
|
|
<summary>
|
|
Converts the provided <see cref="T:System.BinaryData" /> into a model.
|
|
</summary><param name="data">The <see cref="T:System.BinaryData" /> to parse.</param><param name="options">The <see cref="T:System.ClientModel.Primitives.ModelReaderWriterOptions" /> to use.</param><returns>A <typeparamref name="T" /> representation of the data.</returns><exception cref="T:System.FormatException">If the model does not support the requested <see cref="P:System.ClientModel.Primitives.ModelReaderWriterOptions.Format" />.</exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.UnknownRunStepCodeInterpreterToolCallOutput.System#ClientModel#Primitives#IPersistableModel{Azure#AI#OpenAI#Assistants#RunStepCodeInterpreterToolCallOutput}#GetFormatFromOptions(System.ClientModel.Primitives.ModelReaderWriterOptions)">
|
|
<summary>
|
|
Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service.
|
|
<param name="options">The <see cref="T:System.ClientModel.Primitives.ModelReaderWriterOptions" /> to use.</param></summary><returns>The format that the model uses when communicating with the serivce.</returns>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.UnknownRunStepDetails.System#ClientModel#Primitives#IJsonModel{Azure#AI#OpenAI#Assistants#RunStepDetails}#Write(System.Text.Json.Utf8JsonWriter,System.ClientModel.Primitives.ModelReaderWriterOptions)">
|
|
<summary>
|
|
Writes the model to the provided <see cref="T:System.Text.Json.Utf8JsonWriter" />.
|
|
</summary><param name="writer">The <see cref="T:System.Text.Json.Utf8JsonWriter" /> to write into.</param><param name="options">The <see cref="T:System.ClientModel.Primitives.ModelReaderWriterOptions" /> to use.</param><exception cref="T:System.FormatException">If the model does not support the requested <see cref="P:System.ClientModel.Primitives.ModelReaderWriterOptions.Format" />.</exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.UnknownRunStepDetails.System#ClientModel#Primitives#IJsonModel{Azure#AI#OpenAI#Assistants#RunStepDetails}#Create(System.Text.Json.Utf8JsonReader@,System.ClientModel.Primitives.ModelReaderWriterOptions)">
|
|
<summary>
|
|
Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model.
|
|
</summary><param name="reader">The <see cref="T:System.Text.Json.Utf8JsonReader" /> to read.</param><param name="options">The <see cref="T:System.ClientModel.Primitives.ModelReaderWriterOptions" /> to use.</param><returns>A <typeparamref name="T" /> representation of the JSON value.</returns><exception cref="T:System.FormatException">If the model does not support the requested <see cref="P:System.ClientModel.Primitives.ModelReaderWriterOptions.Format" />.</exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.UnknownRunStepDetails.System#ClientModel#Primitives#IPersistableModel{Azure#AI#OpenAI#Assistants#RunStepDetails}#Write(System.ClientModel.Primitives.ModelReaderWriterOptions)">
|
|
<summary>
|
|
Writes the model into a <see cref="T:System.BinaryData" />.
|
|
</summary><param name="options">The <see cref="T:System.ClientModel.Primitives.ModelReaderWriterOptions" /> to use.</param><returns>A binary representation of the written model.</returns><exception cref="T:System.FormatException">If the model does not support the requested <see cref="P:System.ClientModel.Primitives.ModelReaderWriterOptions.Format" />.</exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.UnknownRunStepDetails.System#ClientModel#Primitives#IPersistableModel{Azure#AI#OpenAI#Assistants#RunStepDetails}#Create(System.BinaryData,System.ClientModel.Primitives.ModelReaderWriterOptions)">
|
|
<summary>
|
|
Converts the provided <see cref="T:System.BinaryData" /> into a model.
|
|
</summary><param name="data">The <see cref="T:System.BinaryData" /> to parse.</param><param name="options">The <see cref="T:System.ClientModel.Primitives.ModelReaderWriterOptions" /> to use.</param><returns>A <typeparamref name="T" /> representation of the data.</returns><exception cref="T:System.FormatException">If the model does not support the requested <see cref="P:System.ClientModel.Primitives.ModelReaderWriterOptions.Format" />.</exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.UnknownRunStepDetails.System#ClientModel#Primitives#IPersistableModel{Azure#AI#OpenAI#Assistants#RunStepDetails}#GetFormatFromOptions(System.ClientModel.Primitives.ModelReaderWriterOptions)">
|
|
<summary>
|
|
Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service.
|
|
<param name="options">The <see cref="T:System.ClientModel.Primitives.ModelReaderWriterOptions" /> to use.</param></summary><returns>The format that the model uses when communicating with the serivce.</returns>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.UnknownRunStepToolCall.System#ClientModel#Primitives#IJsonModel{Azure#AI#OpenAI#Assistants#RunStepToolCall}#Write(System.Text.Json.Utf8JsonWriter,System.ClientModel.Primitives.ModelReaderWriterOptions)">
|
|
<summary>
|
|
Writes the model to the provided <see cref="T:System.Text.Json.Utf8JsonWriter" />.
|
|
</summary><param name="writer">The <see cref="T:System.Text.Json.Utf8JsonWriter" /> to write into.</param><param name="options">The <see cref="T:System.ClientModel.Primitives.ModelReaderWriterOptions" /> to use.</param><exception cref="T:System.FormatException">If the model does not support the requested <see cref="P:System.ClientModel.Primitives.ModelReaderWriterOptions.Format" />.</exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.UnknownRunStepToolCall.System#ClientModel#Primitives#IJsonModel{Azure#AI#OpenAI#Assistants#RunStepToolCall}#Create(System.Text.Json.Utf8JsonReader@,System.ClientModel.Primitives.ModelReaderWriterOptions)">
|
|
<summary>
|
|
Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model.
|
|
</summary><param name="reader">The <see cref="T:System.Text.Json.Utf8JsonReader" /> to read.</param><param name="options">The <see cref="T:System.ClientModel.Primitives.ModelReaderWriterOptions" /> to use.</param><returns>A <typeparamref name="T" /> representation of the JSON value.</returns><exception cref="T:System.FormatException">If the model does not support the requested <see cref="P:System.ClientModel.Primitives.ModelReaderWriterOptions.Format" />.</exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.UnknownRunStepToolCall.System#ClientModel#Primitives#IPersistableModel{Azure#AI#OpenAI#Assistants#RunStepToolCall}#Write(System.ClientModel.Primitives.ModelReaderWriterOptions)">
|
|
<summary>
|
|
Writes the model into a <see cref="T:System.BinaryData" />.
|
|
</summary><param name="options">The <see cref="T:System.ClientModel.Primitives.ModelReaderWriterOptions" /> to use.</param><returns>A binary representation of the written model.</returns><exception cref="T:System.FormatException">If the model does not support the requested <see cref="P:System.ClientModel.Primitives.ModelReaderWriterOptions.Format" />.</exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.UnknownRunStepToolCall.System#ClientModel#Primitives#IPersistableModel{Azure#AI#OpenAI#Assistants#RunStepToolCall}#Create(System.BinaryData,System.ClientModel.Primitives.ModelReaderWriterOptions)">
|
|
<summary>
|
|
Converts the provided <see cref="T:System.BinaryData" /> into a model.
|
|
</summary><param name="data">The <see cref="T:System.BinaryData" /> to parse.</param><param name="options">The <see cref="T:System.ClientModel.Primitives.ModelReaderWriterOptions" /> to use.</param><returns>A <typeparamref name="T" /> representation of the data.</returns><exception cref="T:System.FormatException">If the model does not support the requested <see cref="P:System.ClientModel.Primitives.ModelReaderWriterOptions.Format" />.</exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.UnknownRunStepToolCall.System#ClientModel#Primitives#IPersistableModel{Azure#AI#OpenAI#Assistants#RunStepToolCall}#GetFormatFromOptions(System.ClientModel.Primitives.ModelReaderWriterOptions)">
|
|
<summary>
|
|
Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service.
|
|
<param name="options">The <see cref="T:System.ClientModel.Primitives.ModelReaderWriterOptions" /> to use.</param></summary><returns>The format that the model uses when communicating with the serivce.</returns>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.UnknownToolDefinition.System#ClientModel#Primitives#IJsonModel{Azure#AI#OpenAI#Assistants#ToolDefinition}#Write(System.Text.Json.Utf8JsonWriter,System.ClientModel.Primitives.ModelReaderWriterOptions)">
|
|
<summary>
|
|
Writes the model to the provided <see cref="T:System.Text.Json.Utf8JsonWriter" />.
|
|
</summary><param name="writer">The <see cref="T:System.Text.Json.Utf8JsonWriter" /> to write into.</param><param name="options">The <see cref="T:System.ClientModel.Primitives.ModelReaderWriterOptions" /> to use.</param><exception cref="T:System.FormatException">If the model does not support the requested <see cref="P:System.ClientModel.Primitives.ModelReaderWriterOptions.Format" />.</exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.UnknownToolDefinition.System#ClientModel#Primitives#IJsonModel{Azure#AI#OpenAI#Assistants#ToolDefinition}#Create(System.Text.Json.Utf8JsonReader@,System.ClientModel.Primitives.ModelReaderWriterOptions)">
|
|
<summary>
|
|
Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model.
|
|
</summary><param name="reader">The <see cref="T:System.Text.Json.Utf8JsonReader" /> to read.</param><param name="options">The <see cref="T:System.ClientModel.Primitives.ModelReaderWriterOptions" /> to use.</param><returns>A <typeparamref name="T" /> representation of the JSON value.</returns><exception cref="T:System.FormatException">If the model does not support the requested <see cref="P:System.ClientModel.Primitives.ModelReaderWriterOptions.Format" />.</exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.UnknownToolDefinition.System#ClientModel#Primitives#IPersistableModel{Azure#AI#OpenAI#Assistants#ToolDefinition}#Write(System.ClientModel.Primitives.ModelReaderWriterOptions)">
|
|
<summary>
|
|
Writes the model into a <see cref="T:System.BinaryData" />.
|
|
</summary><param name="options">The <see cref="T:System.ClientModel.Primitives.ModelReaderWriterOptions" /> to use.</param><returns>A binary representation of the written model.</returns><exception cref="T:System.FormatException">If the model does not support the requested <see cref="P:System.ClientModel.Primitives.ModelReaderWriterOptions.Format" />.</exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.UnknownToolDefinition.System#ClientModel#Primitives#IPersistableModel{Azure#AI#OpenAI#Assistants#ToolDefinition}#Create(System.BinaryData,System.ClientModel.Primitives.ModelReaderWriterOptions)">
|
|
<summary>
|
|
Converts the provided <see cref="T:System.BinaryData" /> into a model.
|
|
</summary><param name="data">The <see cref="T:System.BinaryData" /> to parse.</param><param name="options">The <see cref="T:System.ClientModel.Primitives.ModelReaderWriterOptions" /> to use.</param><returns>A <typeparamref name="T" /> representation of the data.</returns><exception cref="T:System.FormatException">If the model does not support the requested <see cref="P:System.ClientModel.Primitives.ModelReaderWriterOptions.Format" />.</exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.UnknownToolDefinition.System#ClientModel#Primitives#IPersistableModel{Azure#AI#OpenAI#Assistants#ToolDefinition}#GetFormatFromOptions(System.ClientModel.Primitives.ModelReaderWriterOptions)">
|
|
<summary>
|
|
Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service.
|
|
<param name="options">The <see cref="T:System.ClientModel.Primitives.ModelReaderWriterOptions" /> to use.</param></summary><returns>The format that the model uses when communicating with the serivce.</returns>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.UpdateAssistantOptions.System#ClientModel#Primitives#IJsonModel{Azure#AI#OpenAI#Assistants#UpdateAssistantOptions}#Write(System.Text.Json.Utf8JsonWriter,System.ClientModel.Primitives.ModelReaderWriterOptions)">
|
|
<summary>
|
|
Writes the model to the provided <see cref="T:System.Text.Json.Utf8JsonWriter" />.
|
|
</summary><param name="writer">The <see cref="T:System.Text.Json.Utf8JsonWriter" /> to write into.</param><param name="options">The <see cref="T:System.ClientModel.Primitives.ModelReaderWriterOptions" /> to use.</param><exception cref="T:System.FormatException">If the model does not support the requested <see cref="P:System.ClientModel.Primitives.ModelReaderWriterOptions.Format" />.</exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.UpdateAssistantOptions.System#ClientModel#Primitives#IJsonModel{Azure#AI#OpenAI#Assistants#UpdateAssistantOptions}#Create(System.Text.Json.Utf8JsonReader@,System.ClientModel.Primitives.ModelReaderWriterOptions)">
|
|
<summary>
|
|
Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model.
|
|
</summary><param name="reader">The <see cref="T:System.Text.Json.Utf8JsonReader" /> to read.</param><param name="options">The <see cref="T:System.ClientModel.Primitives.ModelReaderWriterOptions" /> to use.</param><returns>A <typeparamref name="T" /> representation of the JSON value.</returns><exception cref="T:System.FormatException">If the model does not support the requested <see cref="P:System.ClientModel.Primitives.ModelReaderWriterOptions.Format" />.</exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.UpdateAssistantOptions.System#ClientModel#Primitives#IPersistableModel{Azure#AI#OpenAI#Assistants#UpdateAssistantOptions}#Write(System.ClientModel.Primitives.ModelReaderWriterOptions)">
|
|
<summary>
|
|
Writes the model into a <see cref="T:System.BinaryData" />.
|
|
</summary><param name="options">The <see cref="T:System.ClientModel.Primitives.ModelReaderWriterOptions" /> to use.</param><returns>A binary representation of the written model.</returns><exception cref="T:System.FormatException">If the model does not support the requested <see cref="P:System.ClientModel.Primitives.ModelReaderWriterOptions.Format" />.</exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.UpdateAssistantOptions.System#ClientModel#Primitives#IPersistableModel{Azure#AI#OpenAI#Assistants#UpdateAssistantOptions}#Create(System.BinaryData,System.ClientModel.Primitives.ModelReaderWriterOptions)">
|
|
<summary>
|
|
Converts the provided <see cref="T:System.BinaryData" /> into a model.
|
|
</summary><param name="data">The <see cref="T:System.BinaryData" /> to parse.</param><param name="options">The <see cref="T:System.ClientModel.Primitives.ModelReaderWriterOptions" /> to use.</param><returns>A <typeparamref name="T" /> representation of the data.</returns><exception cref="T:System.FormatException">If the model does not support the requested <see cref="P:System.ClientModel.Primitives.ModelReaderWriterOptions.Format" />.</exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.UpdateAssistantOptions.System#ClientModel#Primitives#IPersistableModel{Azure#AI#OpenAI#Assistants#UpdateAssistantOptions}#GetFormatFromOptions(System.ClientModel.Primitives.ModelReaderWriterOptions)">
|
|
<summary>
|
|
Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service.
|
|
<param name="options">The <see cref="T:System.ClientModel.Primitives.ModelReaderWriterOptions" /> to use.</param></summary><returns>The format that the model uses when communicating with the serivce.</returns>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.UpdateMessageRequest.System#ClientModel#Primitives#IJsonModel{Azure#AI#OpenAI#Assistants#UpdateMessageRequest}#Write(System.Text.Json.Utf8JsonWriter,System.ClientModel.Primitives.ModelReaderWriterOptions)">
|
|
<summary>
|
|
Writes the model to the provided <see cref="T:System.Text.Json.Utf8JsonWriter" />.
|
|
</summary><param name="writer">The <see cref="T:System.Text.Json.Utf8JsonWriter" /> to write into.</param><param name="options">The <see cref="T:System.ClientModel.Primitives.ModelReaderWriterOptions" /> to use.</param><exception cref="T:System.FormatException">If the model does not support the requested <see cref="P:System.ClientModel.Primitives.ModelReaderWriterOptions.Format" />.</exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.UpdateMessageRequest.System#ClientModel#Primitives#IJsonModel{Azure#AI#OpenAI#Assistants#UpdateMessageRequest}#Create(System.Text.Json.Utf8JsonReader@,System.ClientModel.Primitives.ModelReaderWriterOptions)">
|
|
<summary>
|
|
Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model.
|
|
</summary><param name="reader">The <see cref="T:System.Text.Json.Utf8JsonReader" /> to read.</param><param name="options">The <see cref="T:System.ClientModel.Primitives.ModelReaderWriterOptions" /> to use.</param><returns>A <typeparamref name="T" /> representation of the JSON value.</returns><exception cref="T:System.FormatException">If the model does not support the requested <see cref="P:System.ClientModel.Primitives.ModelReaderWriterOptions.Format" />.</exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.UpdateMessageRequest.System#ClientModel#Primitives#IPersistableModel{Azure#AI#OpenAI#Assistants#UpdateMessageRequest}#Write(System.ClientModel.Primitives.ModelReaderWriterOptions)">
|
|
<summary>
|
|
Writes the model into a <see cref="T:System.BinaryData" />.
|
|
</summary><param name="options">The <see cref="T:System.ClientModel.Primitives.ModelReaderWriterOptions" /> to use.</param><returns>A binary representation of the written model.</returns><exception cref="T:System.FormatException">If the model does not support the requested <see cref="P:System.ClientModel.Primitives.ModelReaderWriterOptions.Format" />.</exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.UpdateMessageRequest.System#ClientModel#Primitives#IPersistableModel{Azure#AI#OpenAI#Assistants#UpdateMessageRequest}#Create(System.BinaryData,System.ClientModel.Primitives.ModelReaderWriterOptions)">
|
|
<summary>
|
|
Converts the provided <see cref="T:System.BinaryData" /> into a model.
|
|
</summary><param name="data">The <see cref="T:System.BinaryData" /> to parse.</param><param name="options">The <see cref="T:System.ClientModel.Primitives.ModelReaderWriterOptions" /> to use.</param><returns>A <typeparamref name="T" /> representation of the data.</returns><exception cref="T:System.FormatException">If the model does not support the requested <see cref="P:System.ClientModel.Primitives.ModelReaderWriterOptions.Format" />.</exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.UpdateMessageRequest.System#ClientModel#Primitives#IPersistableModel{Azure#AI#OpenAI#Assistants#UpdateMessageRequest}#GetFormatFromOptions(System.ClientModel.Primitives.ModelReaderWriterOptions)">
|
|
<summary>
|
|
Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service.
|
|
<param name="options">The <see cref="T:System.ClientModel.Primitives.ModelReaderWriterOptions" /> to use.</param></summary><returns>The format that the model uses when communicating with the serivce.</returns>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.UpdateRunRequest.System#ClientModel#Primitives#IJsonModel{Azure#AI#OpenAI#Assistants#UpdateRunRequest}#Write(System.Text.Json.Utf8JsonWriter,System.ClientModel.Primitives.ModelReaderWriterOptions)">
|
|
<summary>
|
|
Writes the model to the provided <see cref="T:System.Text.Json.Utf8JsonWriter" />.
|
|
</summary><param name="writer">The <see cref="T:System.Text.Json.Utf8JsonWriter" /> to write into.</param><param name="options">The <see cref="T:System.ClientModel.Primitives.ModelReaderWriterOptions" /> to use.</param><exception cref="T:System.FormatException">If the model does not support the requested <see cref="P:System.ClientModel.Primitives.ModelReaderWriterOptions.Format" />.</exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.UpdateRunRequest.System#ClientModel#Primitives#IJsonModel{Azure#AI#OpenAI#Assistants#UpdateRunRequest}#Create(System.Text.Json.Utf8JsonReader@,System.ClientModel.Primitives.ModelReaderWriterOptions)">
|
|
<summary>
|
|
Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model.
|
|
</summary><param name="reader">The <see cref="T:System.Text.Json.Utf8JsonReader" /> to read.</param><param name="options">The <see cref="T:System.ClientModel.Primitives.ModelReaderWriterOptions" /> to use.</param><returns>A <typeparamref name="T" /> representation of the JSON value.</returns><exception cref="T:System.FormatException">If the model does not support the requested <see cref="P:System.ClientModel.Primitives.ModelReaderWriterOptions.Format" />.</exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.UpdateRunRequest.System#ClientModel#Primitives#IPersistableModel{Azure#AI#OpenAI#Assistants#UpdateRunRequest}#Write(System.ClientModel.Primitives.ModelReaderWriterOptions)">
|
|
<summary>
|
|
Writes the model into a <see cref="T:System.BinaryData" />.
|
|
</summary><param name="options">The <see cref="T:System.ClientModel.Primitives.ModelReaderWriterOptions" /> to use.</param><returns>A binary representation of the written model.</returns><exception cref="T:System.FormatException">If the model does not support the requested <see cref="P:System.ClientModel.Primitives.ModelReaderWriterOptions.Format" />.</exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.UpdateRunRequest.System#ClientModel#Primitives#IPersistableModel{Azure#AI#OpenAI#Assistants#UpdateRunRequest}#Create(System.BinaryData,System.ClientModel.Primitives.ModelReaderWriterOptions)">
|
|
<summary>
|
|
Converts the provided <see cref="T:System.BinaryData" /> into a model.
|
|
</summary><param name="data">The <see cref="T:System.BinaryData" /> to parse.</param><param name="options">The <see cref="T:System.ClientModel.Primitives.ModelReaderWriterOptions" /> to use.</param><returns>A <typeparamref name="T" /> representation of the data.</returns><exception cref="T:System.FormatException">If the model does not support the requested <see cref="P:System.ClientModel.Primitives.ModelReaderWriterOptions.Format" />.</exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.UpdateRunRequest.System#ClientModel#Primitives#IPersistableModel{Azure#AI#OpenAI#Assistants#UpdateRunRequest}#GetFormatFromOptions(System.ClientModel.Primitives.ModelReaderWriterOptions)">
|
|
<summary>
|
|
Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service.
|
|
<param name="options">The <see cref="T:System.ClientModel.Primitives.ModelReaderWriterOptions" /> to use.</param></summary><returns>The format that the model uses when communicating with the serivce.</returns>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.UpdateThreadRequest.System#ClientModel#Primitives#IJsonModel{Azure#AI#OpenAI#Assistants#UpdateThreadRequest}#Write(System.Text.Json.Utf8JsonWriter,System.ClientModel.Primitives.ModelReaderWriterOptions)">
|
|
<summary>
|
|
Writes the model to the provided <see cref="T:System.Text.Json.Utf8JsonWriter" />.
|
|
</summary><param name="writer">The <see cref="T:System.Text.Json.Utf8JsonWriter" /> to write into.</param><param name="options">The <see cref="T:System.ClientModel.Primitives.ModelReaderWriterOptions" /> to use.</param><exception cref="T:System.FormatException">If the model does not support the requested <see cref="P:System.ClientModel.Primitives.ModelReaderWriterOptions.Format" />.</exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.UpdateThreadRequest.System#ClientModel#Primitives#IJsonModel{Azure#AI#OpenAI#Assistants#UpdateThreadRequest}#Create(System.Text.Json.Utf8JsonReader@,System.ClientModel.Primitives.ModelReaderWriterOptions)">
|
|
<summary>
|
|
Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model.
|
|
</summary><param name="reader">The <see cref="T:System.Text.Json.Utf8JsonReader" /> to read.</param><param name="options">The <see cref="T:System.ClientModel.Primitives.ModelReaderWriterOptions" /> to use.</param><returns>A <typeparamref name="T" /> representation of the JSON value.</returns><exception cref="T:System.FormatException">If the model does not support the requested <see cref="P:System.ClientModel.Primitives.ModelReaderWriterOptions.Format" />.</exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.UpdateThreadRequest.System#ClientModel#Primitives#IPersistableModel{Azure#AI#OpenAI#Assistants#UpdateThreadRequest}#Write(System.ClientModel.Primitives.ModelReaderWriterOptions)">
|
|
<summary>
|
|
Writes the model into a <see cref="T:System.BinaryData" />.
|
|
</summary><param name="options">The <see cref="T:System.ClientModel.Primitives.ModelReaderWriterOptions" /> to use.</param><returns>A binary representation of the written model.</returns><exception cref="T:System.FormatException">If the model does not support the requested <see cref="P:System.ClientModel.Primitives.ModelReaderWriterOptions.Format" />.</exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.UpdateThreadRequest.System#ClientModel#Primitives#IPersistableModel{Azure#AI#OpenAI#Assistants#UpdateThreadRequest}#Create(System.BinaryData,System.ClientModel.Primitives.ModelReaderWriterOptions)">
|
|
<summary>
|
|
Converts the provided <see cref="T:System.BinaryData" /> into a model.
|
|
</summary><param name="data">The <see cref="T:System.BinaryData" /> to parse.</param><param name="options">The <see cref="T:System.ClientModel.Primitives.ModelReaderWriterOptions" /> to use.</param><returns>A <typeparamref name="T" /> representation of the data.</returns><exception cref="T:System.FormatException">If the model does not support the requested <see cref="P:System.ClientModel.Primitives.ModelReaderWriterOptions.Format" />.</exception>
|
|
</member>
|
|
<member name="M:Azure.AI.OpenAI.Assistants.UpdateThreadRequest.System#ClientModel#Primitives#IPersistableModel{Azure#AI#OpenAI#Assistants#UpdateThreadRequest}#GetFormatFromOptions(System.ClientModel.Primitives.ModelReaderWriterOptions)">
|
|
<summary>
|
|
Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service.
|
|
<param name="options">The <see cref="T:System.ClientModel.Primitives.ModelReaderWriterOptions" /> to use.</param></summary><returns>The format that the model uses when communicating with the serivce.</returns>
|
|
</member>
|
|
<member name="M:Azure.Core.Pipeline.TaskExtensions.Enumerable`1.System#Collections#Generic#IEnumerable{T}#GetEnumerator">
|
|
<summary>Returns an enumerator that iterates through the collection.</summary><returns>An enumerator that can be used to iterate through the collection.</returns>
|
|
</member>
|
|
<member name="M:Azure.Core.Pipeline.TaskExtensions.Enumerable`1.System#Collections#IEnumerable#GetEnumerator">
|
|
<summary>Returns an enumerator that iterates through a collection.</summary><returns>An <see cref="T:System.Collections.IEnumerator" /> object that can be used to iterate through the collection.</returns>
|
|
</member>
|
|
<member name="P:Azure.Core.Pipeline.TaskExtensions.Enumerator`1.System#Collections#IEnumerator#Current">
|
|
<summary>Gets the element in the collection at the current position of the enumerator.</summary><returns>The element in the collection at the current position of the enumerator.</returns>
|
|
</member>
|
|
</members>
|
|
</doc>
|