|
| 1 | +<Type Name="AzureChatExtensionConfiguration" FullName="Azure.AI.OpenAI.AzureChatExtensionConfiguration"> |
| 2 | + <TypeSignature Language="C#" Value="public class AzureChatExtensionConfiguration" /> |
| 3 | + <TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit AzureChatExtensionConfiguration extends System.Object" /> |
| 4 | + <TypeSignature Language="DocId" Value="T:Azure.AI.OpenAI.AzureChatExtensionConfiguration" /> |
| 5 | + <TypeSignature Language="VB.NET" Value="Public Class AzureChatExtensionConfiguration" /> |
| 6 | + <TypeSignature Language="F#" Value="type AzureChatExtensionConfiguration = class" /> |
| 7 | + <AssemblyInfo> |
| 8 | + <AssemblyName>Azure.AI.OpenAI</AssemblyName> |
| 9 | + <AssemblyVersion>1.0.0.0</AssemblyVersion> |
| 10 | + </AssemblyInfo> |
| 11 | + <Base> |
| 12 | + <BaseTypeName>System.Object</BaseTypeName> |
| 13 | + </Base> |
| 14 | + <Interfaces /> |
| 15 | + <Docs> |
| 16 | + <summary> |
| 17 | + A representation of configuration data for a single Azure OpenAI chat extension. This will be used by a chat |
| 18 | + completions request that should use Azure OpenAI chat extensions to augment the response behavior. |
| 19 | + The use of this configuration is compatible only with Azure OpenAI. |
| 20 | + </summary> |
| 21 | + <remarks>To be added.</remarks> |
| 22 | + </Docs> |
| 23 | + <Members> |
| 24 | + <Member MemberName=".ctor"> |
| 25 | + <MemberSignature Language="C#" Value="public AzureChatExtensionConfiguration ();" /> |
| 26 | + <MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor() cil managed" /> |
| 27 | + <MemberSignature Language="DocId" Value="M:Azure.AI.OpenAI.AzureChatExtensionConfiguration.#ctor" /> |
| 28 | + <MemberSignature Language="VB.NET" Value="Public Sub New ()" /> |
| 29 | + <MemberType>Constructor</MemberType> |
| 30 | + <AssemblyInfo> |
| 31 | + <AssemblyName>Azure.AI.OpenAI</AssemblyName> |
| 32 | + <AssemblyVersion>1.0.0.0</AssemblyVersion> |
| 33 | + </AssemblyInfo> |
| 34 | + <Parameters /> |
| 35 | + <Docs> |
| 36 | + <summary> Initializes a new instance of AzureChatExtensionConfiguration. </summary> |
| 37 | + <remarks>To be added.</remarks> |
| 38 | + </Docs> |
| 39 | + </Member> |
| 40 | + <Member MemberName=".ctor"> |
| 41 | + <MemberSignature Language="C#" Value="public AzureChatExtensionConfiguration (Azure.AI.OpenAI.AzureChatExtensionType type, BinaryData parameters);" /> |
| 42 | + <MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(valuetype Azure.AI.OpenAI.AzureChatExtensionType type, class System.BinaryData parameters) cil managed" /> |
| 43 | + <MemberSignature Language="DocId" Value="M:Azure.AI.OpenAI.AzureChatExtensionConfiguration.#ctor(Azure.AI.OpenAI.AzureChatExtensionType,System.BinaryData)" /> |
| 44 | + <MemberSignature Language="VB.NET" Value="Public Sub New (type As AzureChatExtensionType, parameters As BinaryData)" /> |
| 45 | + <MemberSignature Language="F#" Value="new Azure.AI.OpenAI.AzureChatExtensionConfiguration : Azure.AI.OpenAI.AzureChatExtensionType * BinaryData -> Azure.AI.OpenAI.AzureChatExtensionConfiguration" Usage="new Azure.AI.OpenAI.AzureChatExtensionConfiguration (type, parameters)" /> |
| 46 | + <MemberType>Constructor</MemberType> |
| 47 | + <AssemblyInfo> |
| 48 | + <AssemblyName>Azure.AI.OpenAI</AssemblyName> |
| 49 | + <AssemblyVersion>1.0.0.0</AssemblyVersion> |
| 50 | + </AssemblyInfo> |
| 51 | + <Parameters> |
| 52 | + <Parameter Name="type" Type="Azure.AI.OpenAI.AzureChatExtensionType" /> |
| 53 | + <Parameter Name="parameters" Type="System.BinaryData" /> |
| 54 | + </Parameters> |
| 55 | + <Docs> |
| 56 | + <param name="type"> |
| 57 | + The label for the type of an Azure chat extension. This typically corresponds to a matching Azure resource. |
| 58 | + Azure chat extensions are only compatible with Azure OpenAI. |
| 59 | + </param> |
| 60 | + <param name="parameters"> |
| 61 | + The configuration payload used for the Azure chat extension. The structure payload details are specific to the |
| 62 | + extension being configured. |
| 63 | + Azure chat extensions are only compatible with Azure OpenAI. |
| 64 | + </param> |
| 65 | + <summary> Initializes a new instance of AzureChatExtensionConfiguration. </summary> |
| 66 | + <remarks>To be added.</remarks> |
| 67 | + <exception cref="T:System.ArgumentNullException"> |
| 68 | + <paramref name="parameters" /> is null. </exception> |
| 69 | + </Docs> |
| 70 | + </Member> |
| 71 | + <Member MemberName="Parameters"> |
| 72 | + <MemberSignature Language="C#" Value="public BinaryData Parameters { get; set; }" /> |
| 73 | + <MemberSignature Language="ILAsm" Value=".property instance class System.BinaryData Parameters" /> |
| 74 | + <MemberSignature Language="DocId" Value="P:Azure.AI.OpenAI.AzureChatExtensionConfiguration.Parameters" /> |
| 75 | + <MemberSignature Language="VB.NET" Value="Public Property Parameters As BinaryData" /> |
| 76 | + <MemberSignature Language="F#" Value="member this.Parameters : BinaryData with get, set" Usage="Azure.AI.OpenAI.AzureChatExtensionConfiguration.Parameters" /> |
| 77 | + <MemberType>Property</MemberType> |
| 78 | + <AssemblyInfo> |
| 79 | + <AssemblyName>Azure.AI.OpenAI</AssemblyName> |
| 80 | + <AssemblyVersion>1.0.0.0</AssemblyVersion> |
| 81 | + </AssemblyInfo> |
| 82 | + <ReturnValue> |
| 83 | + <ReturnType>System.BinaryData</ReturnType> |
| 84 | + </ReturnValue> |
| 85 | + <Docs> |
| 86 | + <summary> |
| 87 | + The configuration payload used for the Azure chat extension. The structure payload details are specific to the |
| 88 | + extension being configured. |
| 89 | + Azure chat extensions are only compatible with Azure OpenAI. |
| 90 | + <para> |
| 91 | + To assign an object to this property use <see cref="M:System.BinaryData.FromObjectAsJson``1(``0,System.Text.Json.JsonSerializerOptions)" />. |
| 92 | + </para><para> |
| 93 | + To assign an already formated json string to this property use <see cref="M:System.BinaryData.FromString(System.String)" />. |
| 94 | + </para><para> |
| 95 | + Examples: |
| 96 | + <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> |
| 97 | + <value>To be added.</value> |
| 98 | + <remarks>To be added.</remarks> |
| 99 | + </Docs> |
| 100 | + </Member> |
| 101 | + <Member MemberName="Type"> |
| 102 | + <MemberSignature Language="C#" Value="public virtual Azure.AI.OpenAI.AzureChatExtensionType Type { get; set; }" /> |
| 103 | + <MemberSignature Language="ILAsm" Value=".property instance valuetype Azure.AI.OpenAI.AzureChatExtensionType Type" /> |
| 104 | + <MemberSignature Language="DocId" Value="P:Azure.AI.OpenAI.AzureChatExtensionConfiguration.Type" /> |
| 105 | + <MemberSignature Language="VB.NET" Value="Public Overridable Property Type As AzureChatExtensionType" /> |
| 106 | + <MemberSignature Language="F#" Value="member this.Type : Azure.AI.OpenAI.AzureChatExtensionType with get, set" Usage="Azure.AI.OpenAI.AzureChatExtensionConfiguration.Type" /> |
| 107 | + <MemberType>Property</MemberType> |
| 108 | + <AssemblyInfo> |
| 109 | + <AssemblyName>Azure.AI.OpenAI</AssemblyName> |
| 110 | + <AssemblyVersion>1.0.0.0</AssemblyVersion> |
| 111 | + </AssemblyInfo> |
| 112 | + <ReturnValue> |
| 113 | + <ReturnType>Azure.AI.OpenAI.AzureChatExtensionType</ReturnType> |
| 114 | + </ReturnValue> |
| 115 | + <Docs> |
| 116 | + <summary> |
| 117 | + The label for the type of an Azure chat extension. This typically corresponds to a matching Azure resource. |
| 118 | + Azure chat extensions are only compatible with Azure OpenAI. |
| 119 | + </summary> |
| 120 | + <value>To be added.</value> |
| 121 | + <remarks>To be added.</remarks> |
| 122 | + </Docs> |
| 123 | + </Member> |
| 124 | + </Members> |
| 125 | +</Type> |
0 commit comments