//------------------------------------------------------------------------------
// <auto-generated>
// This file is auto-generated by scripts/Export-Api.ps1 and must not be
// modified manually. To update it, make the necessary source-code changes
// and re-run scripts/Export-Api.ps1 to regenerate it.
// </auto-generated>
//------------------------------------------------------------------------------
namespace OpenAI {
public class OpenAIClient {
protected OpenAIClient();
public OpenAIClient(ApiKeyCredential credential, OpenAIClientOptions options);
public OpenAIClient(ApiKeyCredential credential);
public OpenAIClient(AuthenticationPolicy authenticationPolicy, OpenAIClientOptions options);
public OpenAIClient(AuthenticationPolicy authenticationPolicy);
protected internal OpenAIClient(ClientPipeline pipeline, OpenAIClientOptions options);
public OpenAIClient(string apiKey);
public Uri Endpoint { get; }
public ClientPipeline Pipeline { get; }
public virtual AssistantClient GetAssistantClient();
public virtual AudioClient GetAudioClient(string model);
public virtual BatchClient GetBatchClient();
public virtual ChatClient GetChatClient(string model);
public virtual ContainerClient GetContainerClient();
public virtual ConversationClient GetConversationClient();
public virtual EmbeddingClient GetEmbeddingClient(string model);
public virtual EvaluationClient GetEvaluationClient();
public virtual FineTuningClient GetFineTuningClient();
public virtual GraderClient GetGraderClient();
public virtual ImageClient GetImageClient(string model);
public virtual ModerationClient GetModerationClient(string model);
public virtual OpenAIFileClient GetOpenAIFileClient();
public virtual OpenAIModelClient GetOpenAIModelClient();
public virtual RealtimeClient GetRealtimeClient();
public virtual ResponsesClient GetResponsesClient();
public virtual SkillClient GetSkillClient();
public virtual VectorStoreClient GetVectorStoreClient();
public virtual VideoClient GetVideoClient();
}
public class OpenAIClientOptions : ClientPipelineOptions {
public Uri Endpoint { get; set; }
public string OrganizationId { get; set; }
public string ProjectId { get; set; }
public string UserAgentApplicationId { get; set; }
}
public class OpenAIContext : ModelReaderWriterContext {
public static OpenAIContext Default { get; }
protected override bool TryGetTypeBuilderCore(Type type, out ModelReaderWriterTypeBuilder builder);
}
public static class OpenAIHostBuilderExtensions {
public static IClientBuilder AddAssistantClient(this Microsoft.Extensions.Hosting.IHostApplicationBuilder builder, string sectionName);
public static IClientBuilder AddAudioClient(this Microsoft.Extensions.Hosting.IHostApplicationBuilder builder, string sectionName);
public static IClientBuilder AddBatchClient(this Microsoft.Extensions.Hosting.IHostApplicationBuilder builder, string sectionName);
public static IClientBuilder AddChatClient(this Microsoft.Extensions.Hosting.IHostApplicationBuilder builder, string sectionName);
public static IClientBuilder AddContainerClient(this Microsoft.Extensions.Hosting.IHostApplicationBuilder builder, string sectionName);
public static IClientBuilder AddConversationClient(this Microsoft.Extensions.Hosting.IHostApplicationBuilder builder, string sectionName);
public static IClientBuilder AddEmbeddingClient(this Microsoft.Extensions.Hosting.IHostApplicationBuilder builder, string sectionName);
public static IClientBuilder AddEvaluationClient(this Microsoft.Extensions.Hosting.IHostApplicationBuilder builder, string sectionName);
public static IClientBuilder AddFineTuningClient(this Microsoft.Extensions.Hosting.IHostApplicationBuilder builder, string sectionName);
public static IClientBuilder AddGraderClient(this Microsoft.Extensions.Hosting.IHostApplicationBuilder builder, string sectionName);
public static IClientBuilder AddImageClient(this Microsoft.Extensions.Hosting.IHostApplicationBuilder builder, string sectionName);
public static IClientBuilder AddKeyedAssistantClient(this Microsoft.Extensions.Hosting.IHostApplicationBuilder builder, string serviceKey, string sectionName);
public static IClientBuilder AddKeyedAudioClient(this Microsoft.Extensions.Hosting.IHostApplicationBuilder builder, string serviceKey, string sectionName);
public static IClientBuilder AddKeyedBatchClient(this Microsoft.Extensions.Hosting.IHostApplicationBuilder builder, string serviceKey, string sectionName);
public static IClientBuilder AddKeyedChatClient(this Microsoft.Extensions.Hosting.IHostApplicationBuilder builder, string serviceKey, string sectionName);
public static IClientBuilder AddKeyedContainerClient(this Microsoft.Extensions.Hosting.IHostApplicationBuilder builder, string serviceKey, string sectionName);
public static IClientBuilder AddKeyedConversationClient(this Microsoft.Extensions.Hosting.IHostApplicationBuilder builder, string serviceKey, string sectionName);
public static IClientBuilder AddKeyedEmbeddingClient(this Microsoft.Extensions.Hosting.IHostApplicationBuilder builder, string serviceKey, string sectionName);
public static IClientBuilder AddKeyedEvaluationClient(this Microsoft.Extensions.Hosting.IHostApplicationBuilder builder, string serviceKey, string sectionName);
public static IClientBuilder AddKeyedFineTuningClient(this Microsoft.Extensions.Hosting.IHostApplicationBuilder builder, string serviceKey, string sectionName);
public static IClientBuilder AddKeyedGraderClient(this Microsoft.Extensions.Hosting.IHostApplicationBuilder builder, string serviceKey, string sectionName);
public static IClientBuilder AddKeyedImageClient(this Microsoft.Extensions.Hosting.IHostApplicationBuilder builder, string serviceKey, string sectionName);
public static IClientBuilder AddKeyedModerationClient(this Microsoft.Extensions.Hosting.IHostApplicationBuilder builder, string serviceKey, string sectionName);
public static IClientBuilder AddKeyedOpenAIFileClient(this Microsoft.Extensions.Hosting.IHostApplicationBuilder builder, string serviceKey, string sectionName);
public static IClientBuilder AddKeyedOpenAIModelClient(this Microsoft.Extensions.Hosting.IHostApplicationBuilder builder, string serviceKey, string sectionName);
public static IClientBuilder AddKeyedRealtimeClient(this Microsoft.Extensions.Hosting.IHostApplicationBuilder builder, string serviceKey, string sectionName);
public static IClientBuilder AddKeyedSkillClient(this Microsoft.Extensions.Hosting.IHostApplicationBuilder builder, string serviceKey, string sectionName);
public static IClientBuilder AddKeyedVectorStoreClient(this Microsoft.Extensions.Hosting.IHostApplicationBuilder builder, string serviceKey, string sectionName);
public static IClientBuilder AddKeyedVideoClient(this Microsoft.Extensions.Hosting.IHostApplicationBuilder builder, string serviceKey, string sectionName);
public static IClientBuilder AddModerationClient(this Microsoft.Extensions.Hosting.IHostApplicationBuilder builder, string sectionName);
public static IClientBuilder AddOpenAIFileClient(this Microsoft.Extensions.Hosting.IHostApplicationBuilder builder, string sectionName);
public static IClientBuilder AddOpenAIModelClient(this Microsoft.Extensions.Hosting.IHostApplicationBuilder builder, string sectionName);
public static IClientBuilder AddRealtimeClient(this Microsoft.Extensions.Hosting.IHostApplicationBuilder builder, string sectionName);
public static IClientBuilder AddSkillClient(this Microsoft.Extensions.Hosting.IHostApplicationBuilder builder, string sectionName);
public static IClientBuilder AddVectorStoreClient(this Microsoft.Extensions.Hosting.IHostApplicationBuilder builder, string sectionName);
public static IClientBuilder AddVideoClient(this Microsoft.Extensions.Hosting.IHostApplicationBuilder builder, string sectionName);
}
}
namespace OpenAI.Assistants {
public class Assistant : IJsonModel<Assistant>, IPersistableModel<Assistant> {
public DateTimeOffset CreatedAt { get; }
public string Description { get; }
public string Id { get; }
public string Instructions { get; }
public IReadOnlyDictionary<string, string> Metadata { get; }
public string Model { get; }
public string Name { get; }
public float? NucleusSamplingFactor { get; }
public AssistantResponseFormat ResponseFormat { get; }
public float? Temperature { get; }
public ToolResources ToolResources { get; }
public IReadOnlyList<ToolDefinition> Tools { get; }
public static explicit operator Assistant(ClientResult result);
}
public class AssistantClient {
protected AssistantClient();
public AssistantClient(AssistantClientSettings settings);
public AssistantClient(ApiKeyCredential credential, OpenAIClientOptions options);
public AssistantClient(ApiKeyCredential credential);
public AssistantClient(AuthenticationPolicy authenticationPolicy, OpenAIClientOptions options);
public AssistantClient(AuthenticationPolicy authenticationPolicy);
protected internal AssistantClient(ClientPipeline pipeline, OpenAIClientOptions options);
public AssistantClient(string apiKey);
public Uri Endpoint { get; }
public ClientPipeline Pipeline { get; }
public virtual ClientResult CancelRun(string threadId, string runId, RequestOptions options);
public virtual ClientResult<ThreadRun> CancelRun(string threadId, string runId, CancellationToken cancellationToken = default);
public virtual Task<ClientResult> CancelRunAsync(string threadId, string runId, RequestOptions options);
public virtual Task<ClientResult<ThreadRun>> CancelRunAsync(string threadId, string runId, CancellationToken cancellationToken = default);
public virtual ClientResult CreateAssistant(BinaryContent content, RequestOptions options = null);
public virtual ClientResult<Assistant> CreateAssistant(string model, AssistantCreationOptions options = null, CancellationToken cancellationToken = default);
public virtual Task<ClientResult> CreateAssistantAsync(BinaryContent content, RequestOptions options = null);
public virtual Task<ClientResult<Assistant>> CreateAssistantAsync(string model, AssistantCreationOptions options = null, CancellationToken cancellationToken = default);
public virtual ClientResult<ThreadMessage> CreateMessage(string threadId, MessageRole role, IEnumerable<MessageContent> content, MessageCreationOptions options = null, CancellationToken cancellationToken = default);
public virtual ClientResult CreateMessage(string threadId, BinaryContent content, RequestOptions options = null);
public virtual Task<ClientResult<ThreadMessage>> CreateMessageAsync(string threadId, MessageRole role, IEnumerable<MessageContent> content, MessageCreationOptions options = null, CancellationToken cancellationToken = default);
public virtual Task<ClientResult> CreateMessageAsync(string threadId, BinaryContent content, RequestOptions options = null);
public virtual ClientResult CreateRun(string threadId, BinaryContent content, RequestOptions options = null);
public virtual ClientResult<ThreadRun> CreateRun(string threadId, string assistantId, RunCreationOptions options = null, CancellationToken cancellationToken = default);
public virtual Task<ClientResult> CreateRunAsync(string threadId, BinaryContent content, RequestOptions options = null);
public virtual Task<ClientResult<ThreadRun>> CreateRunAsync(string threadId, string assistantId, RunCreationOptions options = null, CancellationToken cancellationToken = default);
public virtual CollectionResult<StreamingUpdate> CreateRunStreaming(string threadId, string assistantId, RunCreationOptions options = null, CancellationToken cancellationToken = default);
public virtual AsyncCollectionResult<StreamingUpdate> CreateRunStreamingAsync(string threadId, string assistantId, RunCreationOptions options = null, CancellationToken cancellationToken = default);
public virtual ClientResult<AssistantThread> CreateThread(ThreadCreationOptions options = null, CancellationToken cancellationToken = default);
public virtual ClientResult CreateThread(BinaryContent content, RequestOptions options = null);
public virtual ClientResult CreateThreadAndRun(BinaryContent content, RequestOptions options = null);
public virtual ClientResult<ThreadRun> CreateThreadAndRun(string assistantId, ThreadCreationOptions threadOptions = null, RunCreationOptions runOptions = null, CancellationToken cancellationToken = default);
public virtual Task<ClientResult> CreateThreadAndRunAsync(BinaryContent content, RequestOptions options = null);
public virtual Task<ClientResult<ThreadRun>> CreateThreadAndRunAsync(string assistantId, ThreadCreationOptions threadOptions = null, RunCreationOptions runOptions = null, CancellationToken cancellationToken = default);
public virtual CollectionResult<StreamingUpdate> CreateThreadAndRunStreaming(string assistantId, ThreadCreationOptions threadOptions = null, RunCreationOptions runOptions = null, CancellationToken cancellationToken = default);
public virtual AsyncCollectionResult<StreamingUpdate> CreateThreadAndRunStreamingAsync(string assistantId, ThreadCreationOptions threadOptions = null, RunCreationOptions runOptions = null, CancellationToken cancellationToken = default);
public virtual Task<ClientResult<AssistantThread>> CreateThreadAsync(ThreadCreationOptions options = null, CancellationToken cancellationToken = default);
public virtual Task<ClientResult> CreateThreadAsync(BinaryContent content, RequestOptions options = null);
public virtual ClientResult DeleteAssistant(string assistantId, RequestOptions options);
public virtual ClientResult<AssistantDeletionResult> DeleteAssistant(string assistantId, CancellationToken cancellationToken = default);
public virtual Task<ClientResult> DeleteAssistantAsync(string assistantId, RequestOptions options);
public virtual Task<ClientResult<AssistantDeletionResult>> DeleteAssistantAsync(string assistantId, CancellationToken cancellationToken = default);
public virtual ClientResult DeleteMessage(string threadId, string messageId, RequestOptions options);
public virtual ClientResult<MessageDeletionResult> DeleteMessage(string threadId, string messageId, CancellationToken cancellationToken = default);
public virtual Task<ClientResult> DeleteMessageAsync(string threadId, string messageId, RequestOptions options);
public virtual Task<ClientResult<MessageDeletionResult>> DeleteMessageAsync(string threadId, string messageId, CancellationToken cancellationToken = default);
public virtual ClientResult DeleteThread(string threadId, RequestOptions options);
public virtual ClientResult<ThreadDeletionResult> DeleteThread(string threadId, CancellationToken cancellationToken = default);
public virtual Task<ClientResult> DeleteThreadAsync(string threadId, RequestOptions options);
public virtual Task<ClientResult<ThreadDeletionResult>> DeleteThreadAsync(string threadId, CancellationToken cancellationToken = default);
public virtual ClientResult GetAssistant(string assistantId, RequestOptions options);
public virtual ClientResult<Assistant> GetAssistant(string assistantId, CancellationToken cancellationToken = default);
public virtual Task<ClientResult> GetAssistantAsync(string assistantId, RequestOptions options);
public virtual Task<ClientResult<Assistant>> GetAssistantAsync(string assistantId, CancellationToken cancellationToken = default);
public virtual CollectionResult<Assistant> GetAssistants(AssistantCollectionOptions options = null, CancellationToken cancellationToken = default);
public virtual CollectionResult GetAssistants(int? limit, string order, string after, string before, RequestOptions options);
public virtual AsyncCollectionResult<Assistant> GetAssistantsAsync(AssistantCollectionOptions options = null, CancellationToken cancellationToken = default);
public virtual AsyncCollectionResult GetAssistantsAsync(int? limit, string order, string after, string before, RequestOptions options);
public virtual ClientResult GetMessage(string threadId, string messageId, RequestOptions options);
public virtual ClientResult<ThreadMessage> GetMessage(string threadId, string messageId, CancellationToken cancellationToken = default);
public virtual Task<ClientResult> GetMessageAsync(string threadId, string messageId, RequestOptions options);
public virtual Task<ClientResult<ThreadMessage>> GetMessageAsync(string threadId, string messageId, CancellationToken cancellationToken = default);
public virtual CollectionResult<ThreadMessage> GetMessages(string threadId, MessageCollectionOptions options = null, CancellationToken cancellationToken = default);
public virtual CollectionResult GetMessages(string threadId, int? limit, string order, string after, string before, RequestOptions options);
public virtual AsyncCollectionResult<ThreadMessage> GetMessagesAsync(string threadId, MessageCollectionOptions options = null, CancellationToken cancellationToken = default);
public virtual AsyncCollectionResult GetMessagesAsync(string threadId, int? limit, string order, string after, string before, RequestOptions options);
public virtual ClientResult GetRun(string threadId, string runId, RequestOptions options);
public virtual ClientResult<ThreadRun> GetRun(string threadId, string runId, CancellationToken cancellationToken = default);
public virtual Task<ClientResult> GetRunAsync(string threadId, string runId, RequestOptions options);
public virtual Task<ClientResult<ThreadRun>> GetRunAsync(string threadId, string runId, CancellationToken cancellationToken = default);
public virtual CollectionResult<ThreadRun> GetRuns(string threadId, RunCollectionOptions options = null, CancellationToken cancellationToken = default);
public virtual CollectionResult GetRuns(string threadId, int? limit, string order, string after, string before, RequestOptions options);
public virtual AsyncCollectionResult<ThreadRun> GetRunsAsync(string threadId, RunCollectionOptions options = null, CancellationToken cancellationToken = default);
public virtual AsyncCollectionResult GetRunsAsync(string threadId, int? limit, string order, string after, string before, RequestOptions options);
public virtual ClientResult GetRunStep(string threadId, string runId, string stepId, RequestOptions options);
public virtual ClientResult<RunStep> GetRunStep(string threadId, string runId, string stepId, CancellationToken cancellationToken = default);
public virtual Task<ClientResult> GetRunStepAsync(string threadId, string runId, string stepId, RequestOptions options);
public virtual Task<ClientResult<RunStep>> GetRunStepAsync(string threadId, string runId, string stepId, CancellationToken cancellationToken = default);
public virtual CollectionResult<RunStep> GetRunSteps(string threadId, string runId, RunStepCollectionOptions options = null, CancellationToken cancellationToken = default);
public virtual CollectionResult GetRunSteps(string threadId, string runId, int? limit, string order, string after, string before, RequestOptions options);
public virtual AsyncCollectionResult<RunStep> GetRunStepsAsync(string threadId, string runId, RunStepCollectionOptions options = null, CancellationToken cancellationToken = default);
public virtual AsyncCollectionResult GetRunStepsAsync(string threadId, string runId, int? limit, string order, string after, string before, RequestOptions options);
public virtual ClientResult GetThread(string threadId, RequestOptions options);
public virtual ClientResult<AssistantThread> GetThread(string threadId, CancellationToken cancellationToken = default);
public virtual Task<ClientResult> GetThreadAsync(string threadId, RequestOptions options);
public virtual Task<ClientResult<AssistantThread>> GetThreadAsync(string threadId, CancellationToken cancellationToken = default);
public virtual ClientResult<Assistant> ModifyAssistant(string assistantId, AssistantModificationOptions options, CancellationToken cancellationToken = default);
public virtual ClientResult ModifyAssistant(string assistantId, BinaryContent content, RequestOptions options = null);
public virtual Task<ClientResult<Assistant>> ModifyAssistantAsync(string assistantId, AssistantModificationOptions options, CancellationToken cancellationToken = default);
public virtual Task<ClientResult> ModifyAssistantAsync(string assistantId, BinaryContent content, RequestOptions options = null);
public virtual ClientResult<ThreadMessage> ModifyMessage(string threadId, string messageId, MessageModificationOptions options, CancellationToken cancellationToken = default);
public virtual ClientResult ModifyMessage(string threadId, string messageId, BinaryContent content, RequestOptions options = null);
public virtual Task<ClientResult<ThreadMessage>> ModifyMessageAsync(string threadId, string messageId, MessageModificationOptions options, CancellationToken cancellationToken = default);
public virtual Task<ClientResult> ModifyMessageAsync(string threadId, string messageId, BinaryContent content, RequestOptions options = null);
public virtual ClientResult ModifyRun(string threadId, string runId, BinaryContent content, RequestOptions options = null);
public virtual Task<ClientResult> ModifyRunAsync(string threadId, string runId, BinaryContent content, RequestOptions options = null);
public virtual ClientResult<AssistantThread> ModifyThread(string threadId, ThreadModificationOptions options, CancellationToken cancellationToken = default);
public virtual ClientResult ModifyThread(string threadId, BinaryContent content, RequestOptions options = null);
public virtual Task<ClientResult<AssistantThread>> ModifyThreadAsync(string threadId, ThreadModificationOptions options, CancellationToken cancellationToken = default);
public virtual Task<ClientResult> ModifyThreadAsync(string threadId, BinaryContent content, RequestOptions options = null);
public virtual ClientResult SubmitToolOutputsToRun(string threadId, string runId, BinaryContent content, RequestOptions options = null);
public virtual ClientResult<ThreadRun> SubmitToolOutputsToRun(string threadId, string runId, IEnumerable<ToolOutput> toolOutputs, CancellationToken cancellationToken = default);
public virtual Task<ClientResult> SubmitToolOutputsToRunAsync(string threadId, string runId, BinaryContent content, RequestOptions options = null);
public virtual Task<ClientResult<ThreadRun>> SubmitToolOutputsToRunAsync(string threadId, string runId, IEnumerable<ToolOutput> toolOutputs, CancellationToken cancellationToken = default);
public virtual CollectionResult<StreamingUpdate> SubmitToolOutputsToRunStreaming(string threadId, string runId, IEnumerable<ToolOutput> toolOutputs, CancellationToken cancellationToken = default);
public virtual AsyncCollectionResult<StreamingUpdate> SubmitToolOutputsToRunStreamingAsync(string threadId, string runId, IEnumerable<ToolOutput> toolOutputs, CancellationToken cancellationToken = default);
}
public sealed class AssistantClientSettings : ClientSettings {
public OpenAIClientOptions Options { get; set; }
protected override void BindCore(Microsoft.Extensions.Configuration.IConfigurationSection section);
}
public class AssistantCollectionOptions : IJsonModel<AssistantCollectionOptions>, IPersistableModel<AssistantCollectionOptions> {
public string AfterId { get; set; }
public string BeforeId { get; set; }
public AssistantCollectionOrder? Order { get; set; }
public int? PageSizeLimit { get; set; }
}
public readonly partial struct AssistantCollectionOrder : IEquatable<AssistantCollectionOrder> {
public AssistantCollectionOrder(string value);
public static AssistantCollectionOrder Ascending { get; }
public static AssistantCollectionOrder Descending { get; }
public readonly bool Equals(AssistantCollectionOrder other);
[EditorBrowsable(EditorBrowsableState.Never)]
public override readonly bool Equals(object obj);
[EditorBrowsable(EditorBrowsableState.Never)]
public override readonly int GetHashCode();
public static bool operator ==(AssistantCollectionOrder left, AssistantCollectionOrder right);
public static implicit operator AssistantCollectionOrder(string value);
public static implicit operator AssistantCollectionOrder?(string value);
public static bool operator !=(AssistantCollectionOrder left, AssistantCollectionOrder right);
public override readonly string ToString();
}
public class AssistantCreationOptions : IJsonModel<AssistantCreationOptions>, IPersistableModel<AssistantCreationOptions> {
public string Description { get; set; }
public string Instructions { get; set; }
public IDictionary<string, string> Metadata { get; }
public string Name { get; set; }
public float? NucleusSamplingFactor { get; set; }
public AssistantResponseFormat ResponseFormat { get; set; }
public float? Temperature { get; set; }
public ToolResources ToolResources { get; set; }
public IList<ToolDefinition> Tools { get; }
}
public class AssistantDeletionResult : IJsonModel<AssistantDeletionResult>, IPersistableModel<AssistantDeletionResult> {
public string AssistantId { get; }
public bool Deleted { get; }
public static explicit operator AssistantDeletionResult(ClientResult result);
}
public class AssistantModificationOptions : IJsonModel<AssistantModificationOptions>, IPersistableModel<AssistantModificationOptions> {
public IList<ToolDefinition> DefaultTools { get; }
public string Description { get; set; }
public string Instructions { get; set; }
public IDictionary<string, string> Metadata { get; }
public string Model { get; set; }
public string Name { get; set; }
public float? NucleusSamplingFactor { get; set; }
public AssistantResponseFormat ResponseFormat { get; set; }
public float? Temperature { get; set; }
public ToolResources ToolResources { get; set; }
}
public class AssistantResponseFormat : IEquatable<AssistantResponseFormat>, IEquatable<string>, IJsonModel<AssistantResponseFormat>, IPersistableModel<AssistantResponseFormat> {
public static AssistantResponseFormat Auto { get; }
public static AssistantResponseFormat JsonObject { get; }
public static AssistantResponseFormat Text { get; }
public static AssistantResponseFormat CreateAutoFormat();
public static AssistantResponseFormat CreateJsonObjectFormat();
public static AssistantResponseFormat CreateJsonSchemaFormat(string name, BinaryData jsonSchema, string description = null, bool? strictSchemaEnabled = null);
public static AssistantResponseFormat CreateTextFormat();
[EditorBrowsable(EditorBrowsableState.Never)]
public override bool Equals(object obj);
[EditorBrowsable(EditorBrowsableState.Never)]
public override int GetHashCode();
[EditorBrowsable(EditorBrowsableState.Never)]
public static bool operator ==(AssistantResponseFormat first, AssistantResponseFormat second);
[EditorBrowsable(EditorBrowsableState.Never)]
public static implicit operator AssistantResponseFormat(string plainTextFormat);
[EditorBrowsable(EditorBrowsableState.Never)]
public static bool operator !=(AssistantResponseFormat first, AssistantResponseFormat second);
[EditorBrowsable(EditorBrowsableState.Never)]
bool IEquatable<AssistantResponseFormat>.Equals(AssistantResponseFormat other);
[EditorBrowsable(EditorBrowsableState.Never)]
bool IEquatable<string>.Equals(string other);
public override string ToString();
}
public class AssistantThread : IJsonModel<AssistantThread>, IPersistableModel<AssistantThread> {
public DateTimeOffset CreatedAt { get; }
public string Id { get; }
public IReadOnlyDictionary<string, string> Metadata { get; }
public ToolResources ToolResources { get; }
public static explicit operator AssistantThread(ClientResult result);
}
public class CodeInterpreterToolDefinition : ToolDefinition, IJsonModel<CodeInterpreterToolDefinition>, IPersistableModel<CodeInterpreterToolDefinition> {
public CodeInterpreterToolDefinition();
}
public class CodeInterpreterToolResources : IJsonModel<CodeInterpreterToolResources>, IPersistableModel<CodeInterpreterToolResources> {
public IList<string> FileIds { get; }
}
public readonly partial struct FileSearchRanker : IEquatable<FileSearchRanker> {
public FileSearchRanker(string value);
public static FileSearchRanker Auto { get; }
public static FileSearchRanker Default20240821 { get; }
public readonly bool Equals(FileSearchRanker other);
[EditorBrowsable(EditorBrowsableState.Never)]
public override readonly bool Equals(object obj);
[EditorBrowsable(EditorBrowsableState.Never)]
public override readonly int GetHashCode();
public static bool operator ==(FileSearchRanker left, FileSearchRanker right);
public static implicit operator FileSearchRanker(string value);
public static implicit operator FileSearchRanker?(string value);
public static bool operator !=(FileSearchRanker left, FileSearchRanker right);
public override readonly string ToString();
}
public class FileSearchRankingOptions : IJsonModel<FileSearchRankingOptions>, IPersistableModel<FileSearchRankingOptions> {
public FileSearchRankingOptions(float scoreThreshold);
public FileSearchRanker? Ranker { get; set; }
public float ScoreThreshold { get; set; }
}
public class FileSearchToolDefinition : ToolDefinition, IJsonModel<FileSearchToolDefinition>, IPersistableModel<FileSearchToolDefinition> {
public FileSearchToolDefinition();
public int? MaxResults { get; set; }
public FileSearchRankingOptions RankingOptions { get; set; }
}
public class FileSearchToolResources : IJsonModel<FileSearchToolResources>, IPersistableModel<FileSearchToolResources> {
public IList<VectorStoreCreationHelper> NewVectorStores { get; }
public IList<string> VectorStoreIds { get; }
}
public class FunctionToolDefinition : ToolDefinition, IJsonModel<FunctionToolDefinition>, IPersistableModel<FunctionToolDefinition> {
public FunctionToolDefinition();
public FunctionToolDefinition(string name);
public string Description { get; set; }
public string FunctionName { get; set; }
public BinaryData Parameters { get; set; }
public bool? StrictParameterSchemaEnabled { get; set; }
}
public class MessageCollectionOptions : IJsonModel<MessageCollectionOptions>, IPersistableModel<MessageCollectionOptions> {
public string AfterId { get; set; }
public string BeforeId { get; set; }
public MessageCollectionOrder? Order { get; set; }
public int? PageSizeLimit { get; set; }
}
public readonly partial struct MessageCollectionOrder : IEquatable<MessageCollectionOrder> {
public MessageCollectionOrder(string value);
public static MessageCollectionOrder Ascending { get; }
public static MessageCollectionOrder Descending { get; }
public readonly bool Equals(MessageCollectionOrder other);
[EditorBrowsable(EditorBrowsableState.Never)]
public override readonly bool Equals(object obj);
[EditorBrowsable(EditorBrowsableState.Never)]
public override readonly int GetHashCode();
public static bool operator ==(MessageCollectionOrder left, MessageCollectionOrder right);
public static implicit operator MessageCollectionOrder(string value);
public static implicit operator MessageCollectionOrder?(string value);
public static bool operator !=(MessageCollectionOrder left, MessageCollectionOrder right);
public override readonly string ToString();
}
public abstract class MessageContent : IJsonModel<MessageContent>, IPersistableModel<MessageContent> {
public MessageImageDetail? ImageDetail { get; }
public string ImageFileId { get; }
public Uri ImageUri { get; }
public string Refusal { get; }
public string Text { get; }
public IReadOnlyList<TextAnnotation> TextAnnotations { get; }
public static MessageContent FromImageFileId(string imageFileId, MessageImageDetail? detail = null);
public static MessageContent FromImageUri(Uri imageUri, MessageImageDetail? detail = null);
public static MessageContent FromText(string text);
public static implicit operator MessageContent(string value);
}
public class MessageContentUpdate : StreamingUpdate {
public MessageImageDetail? ImageDetail { get; }
public string ImageFileId { get; }
public string MessageId { get; }
public int MessageIndex { get; }
public string RefusalUpdate { get; }
public MessageRole? Role { get; }
public string Text { get; }
public TextAnnotationUpdate TextAnnotation { get; }
}
public class MessageCreationAttachment : IJsonModel<MessageCreationAttachment>, IPersistableModel<MessageCreationAttachment> {
public MessageCreationAttachment(string fileId, IEnumerable<ToolDefinition> tools);
public string FileId { get; }
public IReadOnlyList<ToolDefinition> Tools { get; }
}
public class MessageCreationOptions : IJsonModel<MessageCreationOptions>, IPersistableModel<MessageCreationOptions> {
public IList<MessageCreationAttachment> Attachments { get; set; }
public IDictionary<string, string> Metadata { get; }
}
public class MessageDeletionResult : IJsonModel<MessageDeletionResult>, IPersistableModel<MessageDeletionResult> {
public bool Deleted { get; }
public string MessageId { get; }
public static explicit operator MessageDeletionResult(ClientResult result);
}
public class MessageFailureDetails : IJsonModel<MessageFailureDetails>, IPersistableModel<MessageFailureDetails> {
public MessageFailureReason Reason { get; }
}
public readonly partial struct MessageFailureReason : IEquatable<MessageFailureReason> {
public MessageFailureReason(string value);
public static MessageFailureReason ContentFilter { get; }
public static MessageFailureReason MaxTokens { get; }
public static MessageFailureReason RunCancelled { get; }
public static MessageFailureReason RunExpired { get; }
public static MessageFailureReason RunFailed { get; }
public readonly bool Equals(MessageFailureReason other);
[EditorBrowsable(EditorBrowsableState.Never)]
public override readonly bool Equals(object obj);
[EditorBrowsable(EditorBrowsableState.Never)]
public override readonly int GetHashCode();
public static bool operator ==(MessageFailureReason left, MessageFailureReason right);
public static implicit operator MessageFailureReason(string value);
public static implicit operator MessageFailureReason?(string value);
public static bool operator !=(MessageFailureReason left, MessageFailureReason right);
public override readonly string ToString();
}
public enum MessageImageDetail {
Auto = 0,
Low = 1,
High = 2
}
public class MessageModificationOptions : IJsonModel<MessageModificationOptions>, IPersistableModel<MessageModificationOptions> {
public IDictionary<string, string> Metadata { get; }
}
public enum MessageRole {
User = 0,
Assistant = 1
}
public readonly partial struct MessageStatus : IEquatable<MessageStatus> {
public MessageStatus(string value);
public static MessageStatus Completed { get; }
public static MessageStatus Incomplete { get; }
public static MessageStatus InProgress { get; }
public readonly bool Equals(MessageStatus other);
[EditorBrowsable(EditorBrowsableState.Never)]
public override readonly bool Equals(object obj);
[EditorBrowsable(EditorBrowsableState.Never)]
public override readonly int GetHashCode();
public static bool operator ==(MessageStatus left, MessageStatus right);
public static implicit operator MessageStatus(string value);
public static implicit operator MessageStatus?(string value);
public static bool operator !=(MessageStatus left, MessageStatus right);
public override readonly string ToString();
}
public class MessageStatusUpdate : StreamingUpdate<ThreadMessage> {
}
public abstract class RequiredAction {
public string FunctionArguments { get; }
public string FunctionName { get; }
public string ToolCallId { get; }
}
public class RequiredActionUpdate : RunUpdate {
public string FunctionArguments { get; }
public string FunctionName { get; }
public string ToolCallId { get; }
public ThreadRun GetThreadRun();
}
public class RunCollectionOptions : IJsonModel<RunCollectionOptions>, IPersistableModel<RunCollectionOptions> {
public string AfterId { get; set; }
public string BeforeId { get; set; }
public RunCollectionOrder? Order { get; set; }
public int? PageSizeLimit { get; set; }
}
public readonly partial struct RunCollectionOrder : IEquatable<RunCollectionOrder> {
public RunCollectionOrder(string value);
public static RunCollectionOrder Ascending { get; }
public static RunCollectionOrder Descending { get; }
public readonly bool Equals(RunCollectionOrder other);
[EditorBrowsable(EditorBrowsableState.Never)]
public override readonly bool Equals(object obj);
[EditorBrowsable(EditorBrowsableState.Never)]
public override readonly int GetHashCode();
public static bool operator ==(RunCollectionOrder left, RunCollectionOrder right);
public static implicit operator RunCollectionOrder(string value);
public static implicit operator RunCollectionOrder?(string value);
public static bool operator !=(RunCollectionOrder left, RunCollectionOrder right);
public override readonly string ToString();
}
public class RunCreationOptions : IJsonModel<RunCreationOptions>, IPersistableModel<RunCreationOptions> {
public string AdditionalInstructions { get; set; }
public IList<ThreadInitializationMessage> AdditionalMessages { get; }
public bool? AllowParallelToolCalls { get; set; }
public string InstructionsOverride { get; set; }
public int? MaxInputTokenCount { get; set; }
public int? MaxOutputTokenCount { get; set; }
public IDictionary<string, string> Metadata { get; }
public string ModelOverride { get; set; }
public float? NucleusSamplingFactor { get; set; }
public AssistantResponseFormat ResponseFormat { get; set; }
public float? Temperature { get; set; }
public ToolConstraint ToolConstraint { get; set; }
public IList<ToolDefinition> ToolsOverride { get; }
public RunTruncationStrategy TruncationStrategy { get; set; }
}
public class RunError : IJsonModel<RunError>, IPersistableModel<RunError> {
public RunErrorCode Code { get; }
public string Message { get; }
}
public readonly partial struct RunErrorCode : IEquatable<RunErrorCode> {
public RunErrorCode(string value);
public static RunErrorCode InvalidPrompt { get; }
public static RunErrorCode RateLimitExceeded { get; }
public static RunErrorCode ServerError { get; }
public readonly bool Equals(RunErrorCode other);
[EditorBrowsable(EditorBrowsableState.Never)]
public override readonly bool Equals(object obj);
[EditorBrowsable(EditorBrowsableState.Never)]
public override readonly int GetHashCode();
public static bool operator ==(RunErrorCode left, RunErrorCode right);
public static implicit operator RunErrorCode(string value);
public static implicit operator RunErrorCode?(string value);
public static bool operator !=(RunErrorCode left, RunErrorCode right);
public override readonly string ToString();
}
public class RunIncompleteDetails : IJsonModel<RunIncompleteDetails>, IPersistableModel<RunIncompleteDetails> {
public RunIncompleteReason? Reason { get; }
}
public readonly partial struct RunIncompleteReason : IEquatable<RunIncompleteReason> {
public RunIncompleteReason(string value);
public static RunIncompleteReason MaxInputTokenCount { get; }
public static RunIncompleteReason MaxOutputTokenCount { get; }
public readonly bool Equals(RunIncompleteReason other);
[EditorBrowsable(EditorBrowsableState.Never)]
public override readonly bool Equals(object obj);
[EditorBrowsable(EditorBrowsableState.Never)]
public override readonly int GetHashCode();
public static bool operator ==(RunIncompleteReason left, RunIncompleteReason right);
public static implicit operator RunIncompleteReason(string value);
public static implicit operator RunIncompleteReason?(string value);
public static bool operator !=(RunIncompleteReason left, RunIncompleteReason right);
public override readonly string ToString();
}
public class RunModificationOptions : IJsonModel<RunModificationOptions>, IPersistableModel<RunModificationOptions> {
public IDictionary<string, string> Metadata { get; }
}
public readonly partial struct RunStatus : IEquatable<RunStatus> {
public RunStatus(string value);
public static RunStatus Cancelled { get; }
public static RunStatus Cancelling { get; }
public static RunStatus Completed { get; }
public static RunStatus Expired { get; }
public static RunStatus Failed { get; }
public static RunStatus Incomplete { get; }
public static RunStatus InProgress { get; }
public bool IsTerminal { get; }
public static RunStatus Queued { get; }
public static RunStatus RequiresAction { get; }
public readonly bool Equals(RunStatus other);
[EditorBrowsable(EditorBrowsableState.Never)]
public override readonly bool Equals(object obj);
[EditorBrowsable(EditorBrowsableState.Never)]
public override readonly int GetHashCode();
public static bool operator ==(RunStatus left, RunStatus right);
public static implicit operator RunStatus(string value);
public static implicit operator RunStatus?(string value);
public static bool operator !=(RunStatus left, RunStatus right);
public override readonly string ToString();
}
public class RunStep : IJsonModel<RunStep>, IPersistableModel<RunStep> {
public string AssistantId { get; }
public DateTimeOffset? CancelledAt { get; }
public DateTimeOffset? CompletedAt { get; }
public DateTimeOffset CreatedAt { get; }
public RunStepDetails Details { get; }
public DateTimeOffset? ExpiredAt { get; }
public DateTimeOffset? FailedAt { get; }
public string Id { get; }
public RunStepKind Kind { get; }
public RunStepError LastError { get; }
public IReadOnlyDictionary<string, string> Metadata { get; }
public string RunId { get; }
public RunStepStatus Status { get; }
public string ThreadId { get; }
public RunStepTokenUsage Usage { get; }
public static explicit operator RunStep(ClientResult result);
}
public abstract class RunStepCodeInterpreterOutput : IJsonModel<RunStepCodeInterpreterOutput>, IPersistableModel<RunStepCodeInterpreterOutput> {
public string ImageFileId { get; }
public string Logs { get; }
}
public class RunStepCollectionOptions : IJsonModel<RunStepCollectionOptions>, IPersistableModel<RunStepCollectionOptions> {
public string AfterId { get; set; }
public string BeforeId { get; set; }
public RunStepCollectionOrder? Order { get; set; }
public int? PageSizeLimit { get; set; }
}
public readonly partial struct RunStepCollectionOrder : IEquatable<RunStepCollectionOrder> {
public RunStepCollectionOrder(string value);
public static RunStepCollectionOrder Ascending { get; }
public static RunStepCollectionOrder Descending { get; }
public readonly bool Equals(RunStepCollectionOrder other);
[EditorBrowsable(EditorBrowsableState.Never)]
public override readonly bool Equals(object obj);
[EditorBrowsable(EditorBrowsableState.Never)]
public override readonly int GetHashCode();
public static bool operator ==(RunStepCollectionOrder left, RunStepCollectionOrder right);
public static implicit operator RunStepCollectionOrder(string value);
public static implicit operator RunStepCollectionOrder?(string value);
public static bool operator !=(RunStepCollectionOrder left, RunStepCollectionOrder right);
public override readonly string ToString();
}
public abstract class RunStepDetails : IJsonModel<RunStepDetails>, IPersistableModel<RunStepDetails> {
public string CreatedMessageId { get; }
public IReadOnlyList<RunStepToolCall> ToolCalls { get; }
}
public class RunStepDetailsUpdate : StreamingUpdate {
public string CodeInterpreterInput { get; }
public IReadOnlyList<RunStepUpdateCodeInterpreterOutput> CodeInterpreterOutputs { get; }
public string CreatedMessageId { get; }
public FileSearchRankingOptions FileSearchRankingOptions { get; }
public IReadOnlyList<RunStepFileSearchResult> FileSearchResults { get; }
public string FunctionArguments { get; }
public string FunctionName { get; }
public string FunctionOutput { get; }
public string StepId { get; }
public string ToolCallId { get; }
public int? ToolCallIndex { get; }
}
public class RunStepError : IJsonModel<RunStepError>, IPersistableModel<RunStepError> {
public RunStepErrorCode Code { get; }
public string Message { get; }
}
public readonly partial struct RunStepErrorCode : IEquatable<RunStepErrorCode> {
public RunStepErrorCode(string value);
public static RunStepErrorCode RateLimitExceeded { get; }
public static RunStepErrorCode ServerError { get; }
public readonly bool Equals(RunStepErrorCode other);
[EditorBrowsable(EditorBrowsableState.Never)]
public override readonly bool Equals(object obj);
[EditorBrowsable(EditorBrowsableState.Never)]
public override readonly int GetHashCode();
public static bool operator ==(RunStepErrorCode left, RunStepErrorCode right);
public static implicit operator RunStepErrorCode(string value);
public static implicit operator RunStepErrorCode?(string value);
public static bool operator !=(RunStepErrorCode left, RunStepErrorCode right);
public override readonly string ToString();
}
public class RunStepFileSearchResult : IJsonModel<RunStepFileSearchResult>, IPersistableModel<RunStepFileSearchResult> {
public IReadOnlyList<RunStepFileSearchResultContent> Content { get; }
public string FileId { get; }
public string FileName { get; }
public float Score { get; }
}
public class RunStepFileSearchResultContent : IJsonModel<RunStepFileSearchResultContent>, IPersistableModel<RunStepFileSearchResultContent> {
public RunStepFileSearchResultContentKind Kind { get; }
public string Text { get; }
}
public enum RunStepFileSearchResultContentKind {
Text = 0
}
public enum RunStepKind {
CreatedMessage = 0,
ToolCall = 1
}
public readonly partial struct RunStepStatus : IEquatable<RunStepStatus> {
public RunStepStatus(string value);
public static RunStepStatus Cancelled { get; }
public static RunStepStatus Completed { get; }
public static RunStepStatus Expired { get; }
public static RunStepStatus Failed { get; }
public static RunStepStatus InProgress { get; }
public readonly bool Equals(RunStepStatus other);
[EditorBrowsable(EditorBrowsableState.Never)]
public override readonly bool Equals(object obj);
[EditorBrowsable(EditorBrowsableState.Never)]
public override readonly int GetHashCode();
public static bool operator ==(RunStepStatus left, RunStepStatus right);
public static implicit operator RunStepStatus(string value);
public static implicit operator RunStepStatus?(string value);
public static bool operator !=(RunStepStatus left, RunStepStatus right);
public override readonly string ToString();
}
public class RunStepTokenUsage : IJsonModel<RunStepTokenUsage>, IPersistableModel<RunStepTokenUsage> {
public int InputTokenCount { get; }
public int OutputTokenCount { get; }
public int TotalTokenCount { get; }
}
public class RunStepToolCall : IJsonModel<RunStepToolCall>, IPersistableModel<RunStepToolCall> {
public string CodeInterpreterInput { get; }
public IReadOnlyList<RunStepCodeInterpreterOutput> CodeInterpreterOutputs { get; }
public FileSearchRankingOptions FileSearchRankingOptions { get; }
public IReadOnlyList<RunStepFileSearchResult> FileSearchResults { get; }
public string FunctionArguments { get; }
public string FunctionName { get; }
public string FunctionOutput { get; }
public string Id { get; }
public RunStepToolCallKind Kind { get; }
}
public enum RunStepToolCallKind {
CodeInterpreter = 0,
FileSearch = 1,
Function = 2
}
public class RunStepUpdate : StreamingUpdate<RunStep> {
}
public class RunStepUpdateCodeInterpreterOutput : IJsonModel<RunStepUpdateCodeInterpreterOutput>, IPersistableModel<RunStepUpdateCodeInterpreterOutput> {
public string ImageFileId { get; }
public string Logs { get; }
public int OutputIndex { get; }
}
public class RunTokenUsage : IJsonModel<RunTokenUsage>, IPersistableModel<RunTokenUsage> {
public int InputTokenCount { get; }
public int OutputTokenCount { get; }
public int TotalTokenCount { get; }
}
public class RunTruncationStrategy : IJsonModel<RunTruncationStrategy>, IPersistableModel<RunTruncationStrategy> {
public static RunTruncationStrategy Auto { get; }
public int? LastMessages { get; }
public static RunTruncationStrategy CreateLastMessagesStrategy(int lastMessageCount);
}
public class RunUpdate : StreamingUpdate<ThreadRun> {
}
public abstract class StreamingUpdate {
public StreamingUpdateReason UpdateKind { get; }
}
public enum StreamingUpdateReason {
Unknown = 0,
ThreadCreated = 1,
RunCreated = 2,
RunQueued = 3,
RunInProgress = 4,
RunRequiresAction = 5,
RunCompleted = 6,
RunIncomplete = 7,
RunFailed = 8,
RunCancelling = 9,
RunCancelled = 10,
RunExpired = 11,
RunStepCreated = 12,
RunStepInProgress = 13,
RunStepUpdated = 14,
RunStepCompleted = 15,
RunStepFailed = 16,
RunStepCancelled = 17,
RunStepExpired = 18,
MessageCreated = 19,
MessageInProgress = 20,
MessageUpdated = 21,
MessageCompleted = 22,
MessageFailed = 23,
Error = 24,
Done = 25
}
public class StreamingUpdate<T> : StreamingUpdate where T : class {
public T Value { get; }
public static implicit operator T(StreamingUpdate<T> update);
}
public class TextAnnotation {
public int EndIndex { get; }
public string InputFileId { get; }
public string OutputFileId { get; }
public int StartIndex { get; }
public string TextToReplace { get; }
}
public class TextAnnotationUpdate {
public int ContentIndex { get; }
public int? EndIndex { get; }
public string InputFileId { get; }
public string OutputFileId { get; }
public int? StartIndex { get; }
public string TextToReplace { get; }
}
public class ThreadCreationOptions : IJsonModel<ThreadCreationOptions>, IPersistableModel<ThreadCreationOptions> {
public IList<ThreadInitializationMessage> InitialMessages { get; }
public IDictionary<string, string> Metadata { get; }
public ToolResources ToolResources { get; set; }
}
public class ThreadDeletionResult : IJsonModel<ThreadDeletionResult>, IPersistableModel<ThreadDeletionResult> {
public bool Deleted { get; }
public string ThreadId { get; }
public static explicit operator ThreadDeletionResult(ClientResult result);
}
public class ThreadInitializationMessage : MessageCreationOptions {
public ThreadInitializationMessage(MessageRole role, IEnumerable<MessageContent> content);
public static implicit operator ThreadInitializationMessage(string initializationMessage);
}
public class ThreadMessage : IJsonModel<ThreadMessage>, IPersistableModel<ThreadMessage> {
public string AssistantId { get; }
public IReadOnlyList<MessageCreationAttachment> Attachments { get; }
public DateTimeOffset? CompletedAt { get; }
public IReadOnlyList<MessageContent> Content { get; }
public DateTimeOffset CreatedAt { get; }
public string Id { get; }
public DateTimeOffset? IncompleteAt { get; }
public MessageFailureDetails IncompleteDetails { get; }
public IReadOnlyDictionary<string, string> Metadata { get; }
public MessageRole Role { get; }
public string RunId { get; }
public MessageStatus Status { get; }
public string ThreadId { get; }
public static explicit operator ThreadMessage(ClientResult result);
}
public class ThreadModificationOptions : IJsonModel<ThreadModificationOptions>, IPersistableModel<ThreadModificationOptions> {
public IDictionary<string, string> Metadata { get; }
public ToolResources ToolResources { get; set; }
}
public class ThreadRun : IJsonModel<ThreadRun>, IPersistableModel<ThreadRun> {
public bool? AllowParallelToolCalls { get; }
public string AssistantId { get; }
public DateTimeOffset? CancelledAt { get; }
public DateTimeOffset? CompletedAt { get; }
public DateTimeOffset CreatedAt { get; }
public DateTimeOffset? ExpiresAt { get; }
public DateTimeOffset? FailedAt { get; }
public string Id { get; }
public RunIncompleteDetails IncompleteDetails { get; }
public string Instructions { get; }
public RunError LastError { get; }
public int? MaxInputTokenCount { get; }
public int? MaxOutputTokenCount { get; }
public IReadOnlyDictionary<string, string> Metadata { get; }
public string Model { get; }
public float? NucleusSamplingFactor { get; }
public IReadOnlyList<RequiredAction> RequiredActions { get; }
public AssistantResponseFormat ResponseFormat { get; }
public DateTimeOffset? StartedAt { get; }
public RunStatus Status { get; }
public float? Temperature { get; }
public string ThreadId { get; }
public ToolConstraint ToolConstraint { get; }
public IReadOnlyList<ToolDefinition> Tools { get; }
public RunTruncationStrategy TruncationStrategy { get; }
public RunTokenUsage Usage { get; }
public static explicit operator ThreadRun(ClientResult result);
}
public class ThreadUpdate : StreamingUpdate<AssistantThread> {
public DateTimeOffset CreatedAt { get; }
public string Id { get; }
public IReadOnlyDictionary<string, string> Metadata { get; }
public ToolResources ToolResources { get; }
}
public class ToolConstraint : IJsonModel<ToolConstraint>, IPersistableModel<ToolConstraint> {
public ToolConstraint(ToolDefinition toolDefinition);
public static ToolConstraint Auto { get; }
public static ToolConstraint None { get; }
public static ToolConstraint Required { get; }
}
public class ToolDefinition : IJsonModel<ToolDefinition>, IPersistableModel<ToolDefinition> {
public static CodeInterpreterToolDefinition CreateCodeInterpreter();
public static FileSearchToolDefinition CreateFileSearch(int? maxResults = null);
public static FunctionToolDefinition CreateFunction(string name, string description = null, BinaryData parameters = null, bool? strictParameterSchemaEnabled = null);
}
public class ToolOutput : IJsonModel<ToolOutput>, IPersistableModel<ToolOutput> {
public ToolOutput();
public ToolOutput(string toolCallId, string output);
public string Output { get; set; }
public string ToolCallId { get; set; }
}
public class ToolResources : IJsonModel<ToolResources>, IPersistableModel<ToolResources> {
public CodeInterpreterToolResources CodeInterpreter { get; set; }
public FileSearchToolResources FileSearch { get; set; }
}
public class VectorStoreCreationHelper : IJsonModel<VectorStoreCreationHelper>, IPersistableModel<VectorStoreCreationHelper> {
public VectorStoreCreationHelper();
public VectorStoreCreationHelper(IEnumerable<OpenAIFile> files);
public VectorStoreCreationHelper(IEnumerable<string> fileIds);
public FileChunkingStrategy ChunkingStrategy { get; set; }
public IList<string> FileIds { get; }
public IDictionary<string, string> Metadata { get; }
}
}
namespace OpenAI.Audio {
public class AudioClient {
protected AudioClient();
public AudioClient(AudioClientSettings settings);
protected internal AudioClient(ClientPipeline pipeline, string model, OpenAIClientOptions options);
public AudioClient(string model, ApiKeyCredential credential, OpenAIClientOptions options);
public AudioClient(string model, ApiKeyCredential credential);
public AudioClient(string model, AuthenticationPolicy authenticationPolicy, OpenAIClientOptions options);
public AudioClient(string model, AuthenticationPolicy authenticationPolicy);
public AudioClient(string model, string apiKey);
public Uri Endpoint { get; }
public string Model { get; }
public ClientPipeline Pipeline { get; }
public virtual ClientResult CreateVoice(BinaryContent content, string contentType, RequestOptions options = null);
public virtual Task<ClientResult> CreateVoiceAsync(BinaryContent content, string contentType, RequestOptions options = null);
public virtual ClientResult CreateVoiceConsent(BinaryContent content, string contentType, RequestOptions options = null);
public virtual Task<ClientResult> CreateVoiceConsentAsync(BinaryContent content, string contentType, RequestOptions options = null);
public virtual ClientResult DeleteVoiceConsent(string consentId, RequestOptions options = null);
public virtual Task<ClientResult> DeleteVoiceConsentAsync(string consentId, RequestOptions options = null);
public virtual ClientResult GenerateSpeech(BinaryContent content, RequestOptions options = null);
public virtual ClientResult<BinaryData> GenerateSpeech(string text, GeneratedSpeechVoice voice, SpeechGenerationOptions options = null, CancellationToken cancellationToken = default);
public virtual Task<ClientResult> GenerateSpeechAsync(BinaryContent content, RequestOptions options = null);
public virtual Task<ClientResult<BinaryData>> GenerateSpeechAsync(string text, GeneratedSpeechVoice voice, SpeechGenerationOptions options = null, CancellationToken cancellationToken = default);
public virtual CollectionResult<StreamingSpeechUpdate> GenerateSpeechStreaming(string text, GeneratedSpeechVoice voice, SpeechGenerationOptions options = null, CancellationToken cancellationToken = default);
public virtual AsyncCollectionResult<StreamingSpeechUpdate> GenerateSpeechStreamingAsync(string text, GeneratedSpeechVoice voice, SpeechGenerationOptions options = null, CancellationToken cancellationToken = default);
public virtual ClientResult GetVoiceConsent(string consentId, RequestOptions options = null);
public virtual Task<ClientResult> GetVoiceConsentAsync(string consentId, RequestOptions options = null);
public virtual CollectionResult GetVoiceConsents(string after = null, int? limit = null, RequestOptions options = null);
public virtual AsyncCollectionResult GetVoiceConsentsAsync(string after = null, int? limit = null, RequestOptions options = null);
public virtual ClientResult TranscribeAudio(BinaryContent content, string contentType, RequestOptions options = null);
public virtual ClientResult<AudioTranscription> TranscribeAudio(Stream audio, string audioFilename, AudioTranscriptionOptions options = null, CancellationToken cancellationToken = default);
public virtual ClientResult<AudioTranscription> TranscribeAudio(string audioFilePath, AudioTranscriptionOptions options = null);
public virtual Task<ClientResult> TranscribeAudioAsync(BinaryContent content, string contentType, RequestOptions options = null);
public virtual Task<ClientResult<AudioTranscription>> TranscribeAudioAsync(Stream audio, string audioFilename, AudioTranscriptionOptions options = null, CancellationToken cancellationToken = default);
public virtual Task<ClientResult<AudioTranscription>> TranscribeAudioAsync(string audioFilePath, AudioTranscriptionOptions options = null);
public virtual ClientResult<DiarizedAudioTranscription> TranscribeAudioDiarized(Stream audio, string audioFilename, AudioTranscriptionOptions options = null, CancellationToken cancellationToken = default);
public virtual ClientResult<DiarizedAudioTranscription> TranscribeAudioDiarized(string audioFilePath, AudioTranscriptionOptions options = null);
public virtual Task<ClientResult<DiarizedAudioTranscription>> TranscribeAudioDiarizedAsync(Stream audio, string audioFilename, AudioTranscriptionOptions options = null, CancellationToken cancellationToken = default);
public virtual Task<ClientResult<DiarizedAudioTranscription>> TranscribeAudioDiarizedAsync(string audioFilePath, AudioTranscriptionOptions options = null);
public virtual CollectionResult<StreamingAudioTranscriptionUpdate> TranscribeAudioStreaming(Stream audio, string audioFilename, AudioTranscriptionOptions options = null, CancellationToken cancellationToken = default);
public virtual CollectionResult<StreamingAudioTranscriptionUpdate> TranscribeAudioStreaming(string audioFilePath, AudioTranscriptionOptions options = null, CancellationToken cancellationToken = default);
public virtual AsyncCollectionResult<StreamingAudioTranscriptionUpdate> TranscribeAudioStreamingAsync(Stream audio, string audioFilename, AudioTranscriptionOptions options = null, CancellationToken cancellationToken = default);
public virtual AsyncCollectionResult<StreamingAudioTranscriptionUpdate> TranscribeAudioStreamingAsync(string audioFilePath, AudioTranscriptionOptions options = null, CancellationToken cancellationToken = default);
public virtual ClientResult TranslateAudio(BinaryContent content, string contentType, RequestOptions options = null);
public virtual ClientResult<AudioTranslation> TranslateAudio(Stream audio, string audioFilename, AudioTranslationOptions options = null, CancellationToken cancellationToken = default);
public virtual ClientResult<AudioTranslation> TranslateAudio(string audioFilePath, AudioTranslationOptions options = null);
public virtual Task<ClientResult> TranslateAudioAsync(BinaryContent content, string contentType, RequestOptions options = null);
public virtual Task<ClientResult<AudioTranslation>> TranslateAudioAsync(Stream audio, string audioFilename, AudioTranslationOptions options = null, CancellationToken cancellationToken = default);
public virtual Task<ClientResult<AudioTranslation>> TranslateAudioAsync(string audioFilePath, AudioTranslationOptions options = null);
public virtual ClientResult UpdateVoiceConsent(string consentId, BinaryContent content, RequestOptions options = null);
public virtual Task<ClientResult> UpdateVoiceConsentAsync(string consentId, BinaryContent content, RequestOptions options = null);
}
public sealed class AudioClientSettings : ClientSettings {
public string Model { get; set; }
public OpenAIClientOptions Options { get; set; }
protected override void BindCore(Microsoft.Extensions.Configuration.IConfigurationSection section);
}
[Flags]
public enum AudioTimestampGranularities {
Default = 0,
Word = 1,
Segment = 2
}
public class AudioTokenLogProbabilityDetails : IJsonModel<AudioTokenLogProbabilityDetails>, IPersistableModel<AudioTokenLogProbabilityDetails> {
public float LogProbability { get; }
public string Token { get; }
public ReadOnlyMemory<byte> Utf8Bytes { get; }
}
public class AudioTranscription : IJsonModel<AudioTranscription>, IPersistableModel<AudioTranscription> {
public TimeSpan? Duration { get; }
public string Language { get; }
public IReadOnlyList<TranscribedSegment> Segments { get; }
public string Text { get; }
public IReadOnlyList<AudioTokenLogProbabilityDetails> TranscriptionTokenLogProbabilities { get; }
public AudioTranscriptionUsage Usage { get; }
public IReadOnlyList<TranscribedWord> Words { get; }
public static explicit operator AudioTranscription(ClientResult result);
}
public class AudioTranscriptionChunkingStrategy : IJsonModel<AudioTranscriptionChunkingStrategy>, IPersistableModel<AudioTranscriptionChunkingStrategy> {
public AudioTranscriptionChunkingStrategy(AudioTranscriptionCustomChunkingStrategy customChunkingStrategy);
public AudioTranscriptionChunkingStrategy(AudioTranscriptionDefaultChunkingStrategy defaultChunkingStrategy);
public AudioTranscriptionCustomChunkingStrategy CustomChunkingStrategy { get; }
public AudioTranscriptionDefaultChunkingStrategy? DefaultChunkingStrategy { get; }
public static implicit operator AudioTranscriptionChunkingStrategy(AudioTranscriptionCustomChunkingStrategy customChunkingStrategy);
public static implicit operator AudioTranscriptionChunkingStrategy(AudioTranscriptionDefaultChunkingStrategy defaultChunkingStrategy);
}
public class AudioTranscriptionCustomChunkingStrategy : IJsonModel<AudioTranscriptionCustomChunkingStrategy>, IPersistableModel<AudioTranscriptionCustomChunkingStrategy> {
}
public class AudioTranscriptionCustomServerVadChunkingStrategy : AudioTranscriptionCustomChunkingStrategy, IJsonModel<AudioTranscriptionCustomServerVadChunkingStrategy>, IPersistableModel<AudioTranscriptionCustomServerVadChunkingStrategy> {
public AudioTranscriptionCustomServerVadChunkingStrategy();
public float? DetectionThreshold { get; set; }
public TimeSpan? PrefixPadding { get; set; }
public TimeSpan? SilenceDuration { get; set; }
}
public readonly partial struct AudioTranscriptionDefaultChunkingStrategy : IEquatable<AudioTranscriptionDefaultChunkingStrategy> {
public AudioTranscriptionDefaultChunkingStrategy(string value);
public static AudioTranscriptionDefaultChunkingStrategy Auto { get; }
public readonly bool Equals(AudioTranscriptionDefaultChunkingStrategy other);
[EditorBrowsable(EditorBrowsableState.Never)]
public override readonly bool Equals(object obj);
[EditorBrowsable(EditorBrowsableState.Never)]
public override readonly int GetHashCode();
public static bool operator ==(AudioTranscriptionDefaultChunkingStrategy left, AudioTranscriptionDefaultChunkingStrategy right);
public static implicit operator AudioTranscriptionDefaultChunkingStrategy(string value);
public static implicit operator AudioTranscriptionDefaultChunkingStrategy?(string value);
public static bool operator !=(AudioTranscriptionDefaultChunkingStrategy left, AudioTranscriptionDefaultChunkingStrategy right);
public override readonly string ToString();
}
public class AudioTranscriptionDurationUsage : AudioTranscriptionUsage, IJsonModel<AudioTranscriptionDurationUsage>, IPersistableModel<AudioTranscriptionDurationUsage> {
public TimeSpan Duration { get; }
}
public readonly partial struct AudioTranscriptionFormat : IEquatable<AudioTranscriptionFormat> {
public AudioTranscriptionFormat(string value);
public static AudioTranscriptionFormat Diarized { get; }
public static AudioTranscriptionFormat Simple { get; }
public static AudioTranscriptionFormat Srt { get; }
[EditorBrowsable(EditorBrowsableState.Never)]
public static AudioTranscriptionFormat Text { get; }
public static AudioTranscriptionFormat Verbose { get; }
public static AudioTranscriptionFormat Vtt { get; }
public readonly bool Equals(AudioTranscriptionFormat other);
[EditorBrowsable(EditorBrowsableState.Never)]
public override readonly bool Equals(object obj);
[EditorBrowsable(EditorBrowsableState.Never)]
public override readonly int GetHashCode();
public static bool operator ==(AudioTranscriptionFormat left, AudioTranscriptionFormat right);
public static implicit operator AudioTranscriptionFormat(string value);
public static implicit operator AudioTranscriptionFormat?(string value);
public static bool operator !=(AudioTranscriptionFormat left, AudioTranscriptionFormat right);
public override readonly string ToString();
}
[Flags]
public enum AudioTranscriptionIncludes {
Default = 0,
Logprobs = 1
}
public class AudioTranscriptionInputTokenUsageDetails : IJsonModel<AudioTranscriptionInputTokenUsageDetails>, IPersistableModel<AudioTranscriptionInputTokenUsageDetails> {
public int? AudioTokenCount { get; }
public int? TextTokenCount { get; }
}
public class AudioTranscriptionOptions : IJsonModel<AudioTranscriptionOptions>, IPersistableModel<AudioTranscriptionOptions> {
public AudioTranscriptionChunkingStrategy ChunkingStrategy { get; set; }
public AudioTranscriptionIncludes Includes { get; set; }
public IList<string> KnownSpeakerNames { get; }
public IList<string> KnownSpeakerReferenceUris { get; }
public string Language { get; set; }
public string Prompt { get; set; }
public AudioTranscriptionFormat? ResponseFormat { get; set; }
public float? Temperature { get; set; }
public AudioTimestampGranularities TimestampGranularities { get; set; }
}
public class AudioTranscriptionTokenUsage : AudioTranscriptionUsage, IJsonModel<AudioTranscriptionTokenUsage>, IPersistableModel<AudioTranscriptionTokenUsage> {
public int InputTokenCount { get; }
public AudioTranscriptionInputTokenUsageDetails InputTokenDetails { get; }
public int OutputTokenCount { get; }
public int TotalTokenCount { get; }
}
public class AudioTranscriptionUsage : IJsonModel<AudioTranscriptionUsage>, IPersistableModel<AudioTranscriptionUsage> {
}
public class AudioTranslation : IJsonModel<AudioTranslation>, IPersistableModel<AudioTranslation> {
public TimeSpan? Duration { get; }
public string Language { get; }
public IReadOnlyList<TranscribedSegment> Segments { get; }
public string Text { get; }
public static explicit operator AudioTranslation(ClientResult result);
}
public readonly partial struct AudioTranslationFormat : IEquatable<AudioTranslationFormat> {
public AudioTranslationFormat(string value);
public static AudioTranslationFormat Simple { get; }
public static AudioTranslationFormat Srt { get; }
[EditorBrowsable(EditorBrowsableState.Never)]
public static AudioTranslationFormat Text { get; }
public static AudioTranslationFormat Verbose { get; }
public static AudioTranslationFormat Vtt { get; }
public readonly bool Equals(AudioTranslationFormat other);
[EditorBrowsable(EditorBrowsableState.Never)]
public override readonly bool Equals(object obj);
[EditorBrowsable(EditorBrowsableState.Never)]
public override readonly int GetHashCode();
public static bool operator ==(AudioTranslationFormat left, AudioTranslationFormat right);
public static implicit operator AudioTranslationFormat(string value);
public static implicit operator AudioTranslationFormat?(string value);
public static bool operator !=(AudioTranslationFormat left, AudioTranslationFormat right);
public override readonly string ToString();
}
public class AudioTranslationOptions : IJsonModel<AudioTranslationOptions>, IPersistableModel<AudioTranslationOptions> {
public string Prompt { get; set; }
public AudioTranslationFormat? ResponseFormat { get; set; }
public float? Temperature { get; set; }
}
public class DiarizedAudioTranscription : IJsonModel<DiarizedAudioTranscription>, IPersistableModel<DiarizedAudioTranscription> {
public TimeSpan Duration { get; }
public IReadOnlyList<DiarizedTranscriptionSegment> Segments { get; }
public string Text { get; }
public AudioTranscriptionUsage Usage { get; }
}
public readonly partial struct DiarizedTranscriptionSegment : IJsonModel<DiarizedTranscriptionSegment>, IPersistableModel<DiarizedTranscriptionSegment>, IJsonModel<object>, IPersistableModel<object> {
public TimeSpan EndTime { get; }
public string Id { get; }
public string SpeakerLabel { get; }
public TimeSpan StartTime { get; }
public string Text { get; }
}
public readonly partial struct GeneratedSpeechFormat : IEquatable<GeneratedSpeechFormat> {
public GeneratedSpeechFormat(string value);
public static GeneratedSpeechFormat Aac { get; }
public static GeneratedSpeechFormat Flac { get; }
public static GeneratedSpeechFormat Mp3 { get; }
public static GeneratedSpeechFormat Opus { get; }
public static GeneratedSpeechFormat Pcm { get; }
public static GeneratedSpeechFormat Wav { get; }
public readonly bool Equals(GeneratedSpeechFormat other);
[EditorBrowsable(EditorBrowsableState.Never)]
public override readonly bool Equals(object obj);
[EditorBrowsable(EditorBrowsableState.Never)]
public override readonly int GetHashCode();
public static bool operator ==(GeneratedSpeechFormat left, GeneratedSpeechFormat right);
public static implicit operator GeneratedSpeechFormat(string value);
public static implicit operator GeneratedSpeechFormat?(string value);
public static bool operator !=(GeneratedSpeechFormat left, GeneratedSpeechFormat right);
public override readonly string ToString();
}
public readonly partial struct GeneratedSpeechVoice : IEquatable<GeneratedSpeechVoice> {
public GeneratedSpeechVoice(string value);
public static GeneratedSpeechVoice Alloy { get; }
public static GeneratedSpeechVoice Ash { get; }
public static GeneratedSpeechVoice Ballad { get; }
public static GeneratedSpeechVoice Coral { get; }
public static GeneratedSpeechVoice Echo { get; }
public static GeneratedSpeechVoice Fable { get; }
public static GeneratedSpeechVoice Nova { get; }
public static GeneratedSpeechVoice Onyx { get; }
public static GeneratedSpeechVoice Sage { get; }
public static GeneratedSpeechVoice Shimmer { get; }
public static GeneratedSpeechVoice Verse { get; }
public readonly bool Equals(GeneratedSpeechVoice other);
[EditorBrowsable(EditorBrowsableState.Never)]
public override readonly bool Equals(object obj);
[EditorBrowsable(EditorBrowsableState.Never)]
public override readonly int GetHashCode();
public static bool operator ==(GeneratedSpeechVoice left, GeneratedSpeechVoice right);
public static implicit operator GeneratedSpeechVoice(string value);
public static implicit operator GeneratedSpeechVoice?(string value);
public static bool operator !=(GeneratedSpeechVoice left, GeneratedSpeechVoice right);
public override readonly string ToString();
}
public static class OpenAIAudioModelFactory {
public static AudioTranscription AudioTranscription(string language = null, TimeSpan? duration = null, string text = null, IEnumerable<TranscribedWord> words = null, IEnumerable<TranscribedSegment> segments = null, IEnumerable<AudioTokenLogProbabilityDetails> transcriptionTokenLogProbabilities = null);
[EditorBrowsable(EditorBrowsableState.Never)]
public static AudioTranscription AudioTranscription(string language, TimeSpan? duration, string text, IEnumerable<TranscribedWord> words, IEnumerable<TranscribedSegment> segments);
public static AudioTranslation AudioTranslation(string language = null, TimeSpan? duration = null, string text = null, IEnumerable<TranscribedSegment> segments = null);
public static TranscribedSegment TranscribedSegment(int id = 0, int seekOffset = 0, TimeSpan startTime = default, TimeSpan endTime = default, string text = null, ReadOnlyMemory<int> tokenIds = default, float temperature = 0, float averageLogProbability = 0, float compressionRatio = 0, float noSpeechProbability = 0);
public static TranscribedWord TranscribedWord(string word = null, TimeSpan startTime = default, TimeSpan endTime = default);
}
public class SpeechGenerationOptions : IJsonModel<SpeechGenerationOptions>, IPersistableModel<SpeechGenerationOptions> {
public string Instructions { get; set; }
public GeneratedSpeechFormat? ResponseFormat { get; set; }
public float? SpeedRatio { get; set; }
}
public class SpeechTokenUsage : IJsonModel<SpeechTokenUsage>, IPersistableModel<SpeechTokenUsage> {
public int InputTokenCount { get; }
public int OutputTokenCount { get; }
public int TotalTokenCount { get; }
}
public class StreamingAudioTranscriptionTextDeltaUpdate : StreamingAudioTranscriptionUpdate, IJsonModel<StreamingAudioTranscriptionTextDeltaUpdate>, IPersistableModel<StreamingAudioTranscriptionTextDeltaUpdate> {
public string Delta { get; }
public string SegmentId { get; }
public IReadOnlyList<AudioTokenLogProbabilityDetails> TranscriptionTokenLogProbabilities { get; }
}
public class StreamingAudioTranscriptionTextDoneUpdate : StreamingAudioTranscriptionUpdate, IJsonModel<StreamingAudioTranscriptionTextDoneUpdate>, IPersistableModel<StreamingAudioTranscriptionTextDoneUpdate> {
public string Text { get; }
public IReadOnlyList<AudioTokenLogProbabilityDetails> TranscriptionTokenLogProbabilities { get; }
public AudioTranscriptionTokenUsage Usage { get; }
}
public class StreamingAudioTranscriptionTextSegmentUpdate : StreamingAudioTranscriptionUpdate, IJsonModel<StreamingAudioTranscriptionTextSegmentUpdate>, IPersistableModel<StreamingAudioTranscriptionTextSegmentUpdate> {
public TimeSpan EndTime { get; }
public string SegmentId { get; }
public string SpeakerLabel { get; }
public TimeSpan StartTime { get; }
public string Text { get; }
}
public class StreamingAudioTranscriptionUpdate : IJsonModel<StreamingAudioTranscriptionUpdate>, IPersistableModel<StreamingAudioTranscriptionUpdate> {
}
public class StreamingSpeechAudioDeltaUpdate : StreamingSpeechUpdate, IJsonModel<StreamingSpeechAudioDeltaUpdate>, IPersistableModel<StreamingSpeechAudioDeltaUpdate> {
public BinaryData AudioBytes { get; }
}
public class StreamingSpeechAudioDoneUpdate : StreamingSpeechUpdate, IJsonModel<StreamingSpeechAudioDoneUpdate>, IPersistableModel<StreamingSpeechAudioDoneUpdate> {
public SpeechTokenUsage Usage { get; }
}
public class StreamingSpeechUpdate : IJsonModel<StreamingSpeechUpdate>, IPersistableModel<StreamingSpeechUpdate> {
}
public readonly partial struct TranscribedSegment : IJsonModel<TranscribedSegment>, IPersistableModel<TranscribedSegment>, IJsonModel<object>, IPersistableModel<object> {
public float AverageLogProbability { get; }
public float CompressionRatio { get; }
public TimeSpan EndTime { get; }
public int Id { get; }
public float NoSpeechProbability { get; }
public int SeekOffset { get; }
public TimeSpan StartTime { get; }
public float Temperature { get; }
public string Text { get; }
public ReadOnlyMemory<int> TokenIds { get; }
}
public readonly partial struct TranscribedWord : IJsonModel<TranscribedWord>, IPersistableModel<TranscribedWord>, IJsonModel<object>, IPersistableModel<object> {
public TimeSpan EndTime { get; }
public TimeSpan StartTime { get; }
public string Word { get; }
}
}
namespace OpenAI.Batch {
public class BatchClient {
protected BatchClient();
public BatchClient(BatchClientSettings settings);
public BatchClient(ApiKeyCredential credential, OpenAIClientOptions options);
public BatchClient(ApiKeyCredential credential);
public BatchClient(AuthenticationPolicy authenticationPolicy, OpenAIClientOptions options);
public BatchClient(AuthenticationPolicy authenticationPolicy);
protected internal BatchClient(ClientPipeline pipeline, OpenAIClientOptions options);
public BatchClient(string apiKey);
public Uri Endpoint { get; }
public ClientPipeline Pipeline { get; }
public virtual CreateBatchOperation CreateBatch(BinaryContent content, bool waitUntilCompleted, RequestOptions options = null);
public virtual Task<CreateBatchOperation> CreateBatchAsync(BinaryContent content, bool waitUntilCompleted, RequestOptions options = null);
public virtual ClientResult GetBatch(string batchId, RequestOptions options);
public virtual Task<ClientResult> GetBatchAsync(string batchId, RequestOptions options);
public virtual CollectionResult<BatchJob> GetBatches(BatchCollectionOptions options = null, CancellationToken cancellationToken = default);
public virtual CollectionResult GetBatches(string after, int? limit, RequestOptions options);
public virtual AsyncCollectionResult<BatchJob> GetBatchesAsync(BatchCollectionOptions options = null, CancellationToken cancellationToken = default);
public virtual AsyncCollectionResult GetBatchesAsync(string after, int? limit, RequestOptions options);
}
public sealed class BatchClientSettings : ClientSettings {
public OpenAIClientOptions Options { get; set; }
protected override void BindCore(Microsoft.Extensions.Configuration.IConfigurationSection section);
}
public class BatchCollectionOptions : IJsonModel<BatchCollectionOptions>, IPersistableModel<BatchCollectionOptions> {
public string AfterId { get; set; }
public int? PageSizeLimit { get; set; }
}
public class BatchJob : IJsonModel<BatchJob>, IPersistableModel<BatchJob> {
public DateTimeOffset? CancelledAt { get; }
public DateTimeOffset? CancellingAt { get; }
public DateTimeOffset? CompletedAt { get; }
public string CompletionWindow { get; }
public DateTimeOffset CreatedAt { get; }
public string Endpoint { get; }
public string ErrorFileId { get; }
public DateTimeOffset? ExpiredAt { get; }
public DateTimeOffset? ExpiresAt { get; }
public DateTimeOffset? FailedAt { get; }
public DateTimeOffset? FinalizingAt { get; }
public string Id { get; }
public DateTimeOffset? InProgressAt { get; }
public string InputFileId { get; }
public IDictionary<string, string> Metadata { get; }
public string Object { get; }
public string OutputFileId { get; }
public static explicit operator BatchJob(ClientResult result);
}
public class CreateBatchOperation : OperationResult {
public string BatchId { get; }
public override ContinuationToken? RehydrationToken { get; protected set; }
public virtual ClientResult Cancel(RequestOptions? options);
public virtual Task<ClientResult> CancelAsync(RequestOptions? options);
public virtual ClientResult GetBatch(RequestOptions? options);
public virtual Task<ClientResult> GetBatchAsync(RequestOptions? options);
public static CreateBatchOperation Rehydrate(BatchClient client, ContinuationToken rehydrationToken, CancellationToken cancellationToken = default);
public static CreateBatchOperation Rehydrate(BatchClient client, string batchId, CancellationToken cancellationToken = default);
public static Task<CreateBatchOperation> RehydrateAsync(BatchClient client, ContinuationToken rehydrationToken, CancellationToken cancellationToken = default);
public static Task<CreateBatchOperation> RehydrateAsync(BatchClient client, string batchId, CancellationToken cancellationToken = default);
public override ClientResult UpdateStatus(RequestOptions? options = null);
public override ValueTask<ClientResult> UpdateStatusAsync(RequestOptions? options = null);
}
}
namespace OpenAI.Chat {
public class AssistantChatMessage : ChatMessage, IJsonModel<AssistantChatMessage>, IPersistableModel<AssistantChatMessage> {
public AssistantChatMessage(ChatCompletion chatCompletion);
[Obsolete("This constructor is obsolete. Please use the constructor that takes an IEnumerable<ChatToolCall> parameter instead.")]
public AssistantChatMessage(ChatFunctionCall functionCall);
public AssistantChatMessage(params ChatMessageContentPart[] contentParts);
public AssistantChatMessage(ChatOutputAudioReference outputAudioReference);
public AssistantChatMessage(IEnumerable<ChatMessageContentPart> contentParts);
public AssistantChatMessage(IEnumerable<ChatToolCall> toolCalls);
public AssistantChatMessage(string content);
[Obsolete("This property is obsolete. Please use ToolCalls instead.")]
public ChatFunctionCall FunctionCall { get; set; }
public ChatOutputAudioReference OutputAudioReference { get; set; }
public string ParticipantName { get; set; }
public string Refusal { get; set; }
public IList<ChatToolCall> ToolCalls { get; }
}
public class ChatAudioOptions : IJsonModel<ChatAudioOptions>, IPersistableModel<ChatAudioOptions> {
public ChatAudioOptions(ChatOutputAudioVoice outputAudioVoice, ChatOutputAudioFormat outputAudioFormat);
public ChatOutputAudioFormat OutputAudioFormat { get; }
public ChatOutputAudioVoice OutputAudioVoice { get; }
[Serialization.JsonIgnore]
[EditorBrowsable(EditorBrowsableState.Never)]
public ref JsonPatch Patch { get; }
}
public class ChatClient {
protected ChatClient();
public ChatClient(ChatClientSettings settings);
protected internal ChatClient(ClientPipeline pipeline, string model, OpenAIClientOptions options);
public ChatClient(string model, ApiKeyCredential credential, OpenAIClientOptions options);
public ChatClient(string model, ApiKeyCredential credential);
public ChatClient(string model, AuthenticationPolicy authenticationPolicy, OpenAIClientOptions options);
public ChatClient(string model, AuthenticationPolicy authenticationPolicy);
public ChatClient(string model, string apiKey);
public Uri Endpoint { get; }
public string Model { get; }
public ClientPipeline Pipeline { get; }
public virtual ClientResult<ChatCompletion> CompleteChat(params ChatMessage[] messages);
public virtual ClientResult CompleteChat(BinaryContent content, RequestOptions options = null);
public virtual ClientResult<ChatCompletion> CompleteChat(IEnumerable<ChatMessage> messages, ChatCompletionOptions options = null, CancellationToken cancellationToken = default);
public virtual Task<ClientResult<ChatCompletion>> CompleteChatAsync(params ChatMessage[] messages);
public virtual Task<ClientResult> CompleteChatAsync(BinaryContent content, RequestOptions options = null);
public virtual Task<ClientResult<ChatCompletion>> CompleteChatAsync(IEnumerable<ChatMessage> messages, ChatCompletionOptions options = null, CancellationToken cancellationToken = default);
public virtual CollectionResult<StreamingChatCompletionUpdate> CompleteChatStreaming(params ChatMessage[] messages);
public virtual CollectionResult<StreamingChatCompletionUpdate> CompleteChatStreaming(IEnumerable<ChatMessage> messages, ChatCompletionOptions options = null, CancellationToken cancellationToken = default);
public virtual AsyncCollectionResult<StreamingChatCompletionUpdate> CompleteChatStreamingAsync(params ChatMessage[] messages);
public virtual AsyncCollectionResult<StreamingChatCompletionUpdate> CompleteChatStreamingAsync(IEnumerable<ChatMessage> messages, ChatCompletionOptions options = null, CancellationToken cancellationToken = default);
public virtual ClientResult DeleteChatCompletion(string completionId, RequestOptions options);
public virtual ClientResult<ChatCompletionDeletionResult> DeleteChatCompletion(string completionId, CancellationToken cancellationToken = default);
public virtual Task<ClientResult> DeleteChatCompletionAsync(string completionId, RequestOptions options);
public virtual Task<ClientResult<ChatCompletionDeletionResult>> DeleteChatCompletionAsync(string completionId, CancellationToken cancellationToken = default);
public virtual ClientResult GetChatCompletion(string completionId, RequestOptions options);
public virtual ClientResult<ChatCompletion> GetChatCompletion(string completionId, CancellationToken cancellationToken = default);
public virtual Task<ClientResult> GetChatCompletionAsync(string completionId, RequestOptions options);
public virtual Task<ClientResult<ChatCompletion>> GetChatCompletionAsync(string completionId, CancellationToken cancellationToken = default);
public virtual CollectionResult<ChatCompletionMessageListDatum> GetChatCompletionMessages(string completionId, ChatCompletionMessageCollectionOptions options = null, CancellationToken cancellationToken = default);
public virtual CollectionResult GetChatCompletionMessages(string completionId, string after, int? limit, string order, RequestOptions options);
public virtual AsyncCollectionResult<ChatCompletionMessageListDatum> GetChatCompletionMessagesAsync(string completionId, ChatCompletionMessageCollectionOptions options = null, CancellationToken cancellationToken = default);
public virtual AsyncCollectionResult GetChatCompletionMessagesAsync(string completionId, string after, int? limit, string order, RequestOptions options);
public virtual CollectionResult<ChatCompletion> GetChatCompletions(ChatCompletionCollectionOptions options = null, CancellationToken cancellationToken = default);
public virtual CollectionResult GetChatCompletions(string after, int? limit, string order, IDictionary<string, string> metadata, string model, RequestOptions options);
public virtual AsyncCollectionResult<ChatCompletion> GetChatCompletionsAsync(ChatCompletionCollectionOptions options = null, CancellationToken cancellationToken = default);
public virtual AsyncCollectionResult GetChatCompletionsAsync(string after, int? limit, string order, IDictionary<string, string> metadata, string model, RequestOptions options);
public virtual ClientResult UpdateChatCompletion(string completionId, BinaryContent content, RequestOptions options = null);
public virtual ClientResult<ChatCompletion> UpdateChatCompletion(string completionId, IDictionary<string, string> metadata, CancellationToken cancellationToken = default);
public virtual Task<ClientResult> UpdateChatCompletionAsync(string completionId, BinaryContent content, RequestOptions options = null);
public virtual Task<ClientResult<ChatCompletion>> UpdateChatCompletionAsync(string completionId, IDictionary<string, string> metadata, CancellationToken cancellationToken = default);
}
public sealed class ChatClientSettings : ClientSettings {
public string Model { get; set; }
public OpenAIClientOptions Options { get; set; }
protected override void BindCore(Microsoft.Extensions.Configuration.IConfigurationSection section);
}
public class ChatCompletion : IJsonModel<ChatCompletion>, IPersistableModel<ChatCompletion> {
public IReadOnlyList<ChatMessageAnnotation> Annotations { get; }
public ChatMessageContent Content { get; }
public IReadOnlyList<ChatTokenLogProbabilityDetails> ContentTokenLogProbabilities { get; }
public DateTimeOffset CreatedAt { get; }
public ChatFinishReason FinishReason { get; }
[Obsolete("This property is obsolete. Please use ToolCalls instead.")]
public ChatFunctionCall FunctionCall { get; }
public string Id { get; }
public string Model { get; }
public ChatOutputAudio OutputAudio { get; }
[Serialization.JsonIgnore]
[EditorBrowsable(EditorBrowsableState.Never)]
public ref JsonPatch Patch { get; }
public string Refusal { get; }
public IReadOnlyList<ChatTokenLogProbabilityDetails> RefusalTokenLogProbabilities { get; }
public ChatMessageRole Role { get; }
public ChatServiceTier? ServiceTier { get; }
public string SystemFingerprint { get; }
public IReadOnlyList<ChatToolCall> ToolCalls { get; }
public ChatTokenUsage Usage { get; }
public static explicit operator ChatCompletion(ClientResult result);
}
public class ChatCompletionCollectionOptions : IJsonModel<ChatCompletionCollectionOptions>, IPersistableModel<ChatCompletionCollectionOptions> {
public string AfterId { get; set; }
public IDictionary<string, string> Metadata { get; }
public string Model { get; set; }
public ChatCompletionCollectionOrder? Order { get; set; }
public int? PageSizeLimit { get; set; }
[Serialization.JsonIgnore]
[EditorBrowsable(EditorBrowsableState.Never)]
public ref JsonPatch Patch { get; }
}
public readonly partial struct ChatCompletionCollectionOrder : IEquatable<ChatCompletionCollectionOrder> {
public ChatCompletionCollectionOrder(string value);
public static ChatCompletionCollectionOrder Ascending { get; }
public static ChatCompletionCollectionOrder Descending { get; }
public readonly bool Equals(ChatCompletionCollectionOrder other);
[EditorBrowsable(EditorBrowsableState.Never)]
public override readonly bool Equals(object obj);
[EditorBrowsable(EditorBrowsableState.Never)]
public override readonly int GetHashCode();
public static bool operator ==(ChatCompletionCollectionOrder left, ChatCompletionCollectionOrder right);
public static implicit operator ChatCompletionCollectionOrder(string value);
public static implicit operator ChatCompletionCollectionOrder?(string value);
public static bool operator !=(ChatCompletionCollectionOrder left, ChatCompletionCollectionOrder right);
public override readonly string ToString();
}
public class ChatCompletionDeletionResult : IJsonModel<ChatCompletionDeletionResult>, IPersistableModel<ChatCompletionDeletionResult> {
public string ChatCompletionId { get; }
public bool Deleted { get; }
[Serialization.JsonIgnore]
[EditorBrowsable(EditorBrowsableState.Never)]
public ref JsonPatch Patch { get; }
public static explicit operator ChatCompletionDeletionResult(ClientResult result);
}
public class ChatCompletionMessageCollectionOptions : IJsonModel<ChatCompletionMessageCollectionOptions>, IPersistableModel<ChatCompletionMessageCollectionOptions> {
public string AfterId { get; set; }
public ChatCompletionMessageCollectionOrder? Order { get; set; }
public int? PageSizeLimit { get; set; }
[Serialization.JsonIgnore]
[EditorBrowsable(EditorBrowsableState.Never)]
public ref JsonPatch Patch { get; }
}
public readonly partial struct ChatCompletionMessageCollectionOrder : IEquatable<ChatCompletionMessageCollectionOrder> {
public ChatCompletionMessageCollectionOrder(string value);
public static ChatCompletionMessageCollectionOrder Ascending { get; }
public static ChatCompletionMessageCollectionOrder Descending { get; }
public readonly bool Equals(ChatCompletionMessageCollectionOrder other);
[EditorBrowsable(EditorBrowsableState.Never)]
public override readonly bool Equals(object obj);
[EditorBrowsable(EditorBrowsableState.Never)]
public override readonly int GetHashCode();
public static bool operator ==(ChatCompletionMessageCollectionOrder left, ChatCompletionMessageCollectionOrder right);
public static implicit operator ChatCompletionMessageCollectionOrder(string value);
public static implicit operator ChatCompletionMessageCollectionOrder?(string value);
public static bool operator !=(ChatCompletionMessageCollectionOrder left, ChatCompletionMessageCollectionOrder right);
public override readonly string ToString();
}
public class ChatCompletionMessageListDatum : IJsonModel<ChatCompletionMessageListDatum>, IPersistableModel<ChatCompletionMessageListDatum> {
public IReadOnlyList<ChatMessageAnnotation> Annotations { get; }
public string Content { get; }
public IList<ChatMessageContentPart> ContentParts { get; }
public string Id { get; }
public ChatOutputAudio OutputAudio { get; }
[Serialization.JsonIgnore]
[EditorBrowsable(EditorBrowsableState.Never)]
public ref JsonPatch Patch { get; }
public string Refusal { get; }
public IReadOnlyList<ChatToolCall> ToolCalls { get; }
}
public class ChatCompletionOptions : IJsonModel<ChatCompletionOptions>, IPersistableModel<ChatCompletionOptions> {
public bool? AllowParallelToolCalls { get; set; }
public ChatAudioOptions AudioOptions { get; set; }
public string EndUserId { get; set; }
public float? FrequencyPenalty { get; set; }
[Obsolete("This property is obsolete. Please use ToolChoice instead.")]
public ChatFunctionChoice FunctionChoice { get; set; }
[Obsolete("This property is obsolete. Please use Tools instead.")]
public IList<ChatFunction> Functions { get; }
public bool? IncludeLogProbabilities { get; set; }
public IDictionary<int, int> LogitBiases { get; }
public int? MaxOutputTokenCount { get; set; }
public IDictionary<string, string> Metadata { get; }
public ChatOutputPrediction OutputPrediction { get; set; }
[Serialization.JsonIgnore]
[EditorBrowsable(EditorBrowsableState.Never)]
public ref JsonPatch Patch { get; }
public float? PresencePenalty { get; set; }
public ChatReasoningEffortLevel? ReasoningEffortLevel { get; set; }
public ChatResponseFormat ResponseFormat { get; set; }
public ChatResponseModalities ResponseModalities { get; set; }
public string SafetyIdentifier { get; set; }
public long? Seed { get; set; }
public ChatServiceTier? ServiceTier { get; set; }
public IList<string> StopSequences { get; }
public bool? StoredOutputEnabled { get; set; }
public float? Temperature { get; set; }
public ChatToolChoice ToolChoice { get; set; }
public IList<ChatTool> Tools { get; }
public int? TopLogProbabilityCount { get; set; }
public float? TopP { get; set; }
public ChatWebSearchOptions WebSearchOptions { get; set; }
}
public enum ChatFinishReason {
Stop = 0,
Length = 1,
ContentFilter = 2,
ToolCalls = 3,
FunctionCall = 4
}
[Obsolete("This class is obsolete. Please use ChatTool instead.")]
public class ChatFunction : IJsonModel<ChatFunction>, IPersistableModel<ChatFunction> {
public ChatFunction(string functionName);
public string FunctionDescription { get; set; }
public string FunctionName { get; }
public BinaryData FunctionParameters { get; set; }
[Serialization.JsonIgnore]
[EditorBrowsable(EditorBrowsableState.Never)]
public ref JsonPatch Patch { get; }
}
[Obsolete("This class is obsolete. Please use ChatToolCall instead.")]
public class ChatFunctionCall : IJsonModel<ChatFunctionCall>, IPersistableModel<ChatFunctionCall> {
public ChatFunctionCall(string functionName, BinaryData functionArguments);
public BinaryData FunctionArguments { get; }
public string FunctionName { get; }
[Serialization.JsonIgnore]
[EditorBrowsable(EditorBrowsableState.Never)]
public ref JsonPatch Patch { get; }
}
[Obsolete("This class is obsolete. Please use ChatToolChoice instead.")]
public class ChatFunctionChoice : IJsonModel<ChatFunctionChoice>, IPersistableModel<ChatFunctionChoice> {
[Serialization.JsonIgnore]
[EditorBrowsable(EditorBrowsableState.Never)]
public ref JsonPatch Patch { get; }
public static ChatFunctionChoice CreateAutoChoice();
public static ChatFunctionChoice CreateNamedChoice(string functionName);
public static ChatFunctionChoice CreateNoneChoice();
}
public readonly partial struct ChatImageDetailLevel : IEquatable<ChatImageDetailLevel> {
public ChatImageDetailLevel(string value);
public static ChatImageDetailLevel Auto { get; }
public static ChatImageDetailLevel High { get; }
public static ChatImageDetailLevel Low { get; }
public readonly bool Equals(ChatImageDetailLevel other);
[EditorBrowsable(EditorBrowsableState.Never)]
public override readonly bool Equals(object obj);
[EditorBrowsable(EditorBrowsableState.Never)]
public override readonly int GetHashCode();
public static bool operator ==(ChatImageDetailLevel left, ChatImageDetailLevel right);
public static implicit operator ChatImageDetailLevel(string value);
public static implicit operator ChatImageDetailLevel?(string value);
public static bool operator !=(ChatImageDetailLevel left, ChatImageDetailLevel right);
public override readonly string ToString();
}
public readonly partial struct ChatInputAudioFormat : IEquatable<ChatInputAudioFormat> {
public ChatInputAudioFormat(string value);
public static ChatInputAudioFormat Mp3 { get; }
public static ChatInputAudioFormat Wav { get; }
public readonly bool Equals(ChatInputAudioFormat other);
[EditorBrowsable(EditorBrowsableState.Never)]
public override readonly bool Equals(object obj);
[EditorBrowsable(EditorBrowsableState.Never)]
public override readonly int GetHashCode();
public static bool operator ==(ChatInputAudioFormat left, ChatInputAudioFormat right);
public static implicit operator ChatInputAudioFormat(string value);
public static implicit operator ChatInputAudioFormat?(string value);
public static bool operator !=(ChatInputAudioFormat left, ChatInputAudioFormat right);
public override readonly string ToString();
}
public class ChatInputTokenUsageDetails : IJsonModel<ChatInputTokenUsageDetails>, IPersistableModel<ChatInputTokenUsageDetails> {
public int AudioTokenCount { get; }
public int CachedTokenCount { get; }
[Serialization.JsonIgnore]
[EditorBrowsable(EditorBrowsableState.Never)]
public ref JsonPatch Patch { get; }
}
public class ChatMessage : IJsonModel<ChatMessage>, IPersistableModel<ChatMessage> {
public ChatMessageContent Content { get; }
[Serialization.JsonIgnore]
[EditorBrowsable(EditorBrowsableState.Never)]
public ref JsonPatch Patch { get; }
public static AssistantChatMessage CreateAssistantMessage(ChatCompletion chatCompletion);
public static AssistantChatMessage CreateAssistantMessage(ChatFunctionCall functionCall);
public static AssistantChatMessage CreateAssistantMessage(params ChatMessageContentPart[] contentParts);
public static AssistantChatMessage CreateAssistantMessage(ChatOutputAudioReference outputAudioReference);
public static AssistantChatMessage CreateAssistantMessage(IEnumerable<ChatMessageContentPart> contentParts);
public static AssistantChatMessage CreateAssistantMessage(IEnumerable<ChatToolCall> toolCalls);
public static AssistantChatMessage CreateAssistantMessage(string content);
public static DeveloperChatMessage CreateDeveloperMessage(params ChatMessageContentPart[] contentParts);
public static DeveloperChatMessage CreateDeveloperMessage(IEnumerable<ChatMessageContentPart> contentParts);
public static DeveloperChatMessage CreateDeveloperMessage(string content);
[Obsolete("This method is obsolete. Please use CreateToolMessage instead.")]
public static FunctionChatMessage CreateFunctionMessage(string functionName, string content);
public static SystemChatMessage CreateSystemMessage(params ChatMessageContentPart[] contentParts);
public static SystemChatMessage CreateSystemMessage(IEnumerable<ChatMessageContentPart> contentParts);
public static SystemChatMessage CreateSystemMessage(string content);
public static ToolChatMessage CreateToolMessage(string toolCallId, params ChatMessageContentPart[] contentParts);
public static ToolChatMessage CreateToolMessage(string toolCallId, IEnumerable<ChatMessageContentPart> contentParts);
public static ToolChatMessage CreateToolMessage(string toolCallId, string content);
public static UserChatMessage CreateUserMessage(params ChatMessageContentPart[] contentParts);
public static UserChatMessage CreateUserMessage(IEnumerable<ChatMessageContentPart> contentParts);
public static UserChatMessage CreateUserMessage(string content);
public static implicit operator ChatMessage(string content);
}
public class ChatMessageAnnotation : IJsonModel<ChatMessageAnnotation>, IPersistableModel<ChatMessageAnnotation> {
public int EndIndex { get; }
[Serialization.JsonIgnore]
[EditorBrowsable(EditorBrowsableState.Never)]
public ref JsonPatch Patch { get; }
public int StartIndex { get; }
public string WebResourceTitle { get; }
public Uri WebResourceUri { get; }
}
public class ChatMessageContent : ObjectModel.Collection<ChatMessageContentPart> {
public ChatMessageContent();
public ChatMessageContent(params ChatMessageContentPart[] contentParts);
public ChatMessageContent(IEnumerable<ChatMessageContentPart> contentParts);
public ChatMessageContent(string content);
}
public class ChatMessageContentPart : IJsonModel<ChatMessageContentPart>, IPersistableModel<ChatMessageContentPart> {
public BinaryData FileBytes { get; }
public string FileBytesMediaType { get; }
public string FileId { get; }
public string Filename { get; }
public BinaryData ImageBytes { get; }
public string ImageBytesMediaType { get; }
public ChatImageDetailLevel? ImageDetailLevel { get; }
public Uri ImageUri { get; }
public BinaryData InputAudioBytes { get; }
public ChatInputAudioFormat? InputAudioFormat { get; }
public ChatMessageContentPartKind Kind { get; }
[Serialization.JsonIgnore]
[EditorBrowsable(EditorBrowsableState.Never)]
public ref JsonPatch Patch { get; }
public string Refusal { get; }
public string Text { get; }
public static ChatMessageContentPart CreateFilePart(BinaryData fileBytes, string fileBytesMediaType, string filename);
public static ChatMessageContentPart CreateFilePart(string fileId);
public static ChatMessageContentPart CreateImagePart(BinaryData imageBytes, string imageBytesMediaType, ChatImageDetailLevel? imageDetailLevel = null);
public static ChatMessageContentPart CreateImagePart(Uri imageUri, ChatImageDetailLevel? imageDetailLevel = null);
public static ChatMessageContentPart CreateInputAudioPart(BinaryData inputAudioBytes, ChatInputAudioFormat inputAudioFormat);
public static ChatMessageContentPart CreateRefusalPart(string refusal);
public static ChatMessageContentPart CreateTextPart(string text);
public static implicit operator ChatMessageContentPart(string text);
}
public enum ChatMessageContentPartKind {
Text = 0,
Refusal = 1,
Image = 2,
InputAudio = 3,
File = 4
}
public enum ChatMessageRole {
System = 0,
User = 1,
Assistant = 2,
Tool = 3,
Function = 4,
Developer = 5
}
public class ChatOutputAudio : IJsonModel<ChatOutputAudio>, IPersistableModel<ChatOutputAudio> {
public BinaryData AudioBytes { get; }
public DateTimeOffset ExpiresAt { get; }
public string Id { get; }
[Serialization.JsonIgnore]
[EditorBrowsable(EditorBrowsableState.Never)]
public ref JsonPatch Patch { get; }
public string Transcript { get; }
}
public readonly partial struct ChatOutputAudioFormat : IEquatable<ChatOutputAudioFormat> {
public ChatOutputAudioFormat(string value);
public static ChatOutputAudioFormat Aac { get; }
public static ChatOutputAudioFormat Flac { get; }
public static ChatOutputAudioFormat Mp3 { get; }
public static ChatOutputAudioFormat Opus { get; }
public static ChatOutputAudioFormat Pcm16 { get; }
public static ChatOutputAudioFormat Wav { get; }
public readonly bool Equals(ChatOutputAudioFormat other);
[EditorBrowsable(EditorBrowsableState.Never)]
public override readonly bool Equals(object obj);
[EditorBrowsable(EditorBrowsableState.Never)]
public override readonly int GetHashCode();
public static bool operator ==(ChatOutputAudioFormat left, ChatOutputAudioFormat right);
public static implicit operator ChatOutputAudioFormat(string value);
public static implicit operator ChatOutputAudioFormat?(string value);
public static bool operator !=(ChatOutputAudioFormat left, ChatOutputAudioFormat right);
public override readonly string ToString();
}
public class ChatOutputAudioReference : IJsonModel<ChatOutputAudioReference>, IPersistableModel<ChatOutputAudioReference> {
public ChatOutputAudioReference(string id);
public string Id { get; }
[Serialization.JsonIgnore]
[EditorBrowsable(EditorBrowsableState.Never)]
public ref JsonPatch Patch { get; }
}
public readonly partial struct ChatOutputAudioVoice : IEquatable<ChatOutputAudioVoice> {
public ChatOutputAudioVoice(string value);
public static ChatOutputAudioVoice Alloy { get; }
public static ChatOutputAudioVoice Ash { get; }
public static ChatOutputAudioVoice Ballad { get; }
public static ChatOutputAudioVoice Coral { get; }
public static ChatOutputAudioVoice Echo { get; }
public static ChatOutputAudioVoice Fable { get; }
public static ChatOutputAudioVoice Nova { get; }
public static ChatOutputAudioVoice Onyx { get; }
public static ChatOutputAudioVoice Sage { get; }
public static ChatOutputAudioVoice Shimmer { get; }
public static ChatOutputAudioVoice Verse { get; }
public readonly bool Equals(ChatOutputAudioVoice other);
[EditorBrowsable(EditorBrowsableState.Never)]
public override readonly bool Equals(object obj);
[EditorBrowsable(EditorBrowsableState.Never)]
public override readonly int GetHashCode();
public static bool operator ==(ChatOutputAudioVoice left, ChatOutputAudioVoice right);
public static implicit operator ChatOutputAudioVoice(string value);
public static implicit operator ChatOutputAudioVoice?(string value);
public static bool operator !=(ChatOutputAudioVoice left, ChatOutputAudioVoice right);
public override readonly string ToString();
}
public class ChatOutputPrediction : IJsonModel<ChatOutputPrediction>, IPersistableModel<ChatOutputPrediction> {
[Serialization.JsonIgnore]
[EditorBrowsable(EditorBrowsableState.Never)]
public ref JsonPatch Patch { get; }
public static ChatOutputPrediction CreateStaticContentPrediction(IEnumerable<ChatMessageContentPart> staticContentParts);
public static ChatOutputPrediction CreateStaticContentPrediction(string staticContent);
}
public class ChatOutputTokenUsageDetails : IJsonModel<ChatOutputTokenUsageDetails>, IPersistableModel<ChatOutputTokenUsageDetails> {
public int AcceptedPredictionTokenCount { get; }
public int AudioTokenCount { get; }
[Serialization.JsonIgnore]
[EditorBrowsable(EditorBrowsableState.Never)]
public ref JsonPatch Patch { get; }
public int ReasoningTokenCount { get; }
public int RejectedPredictionTokenCount { get; }
}
public readonly partial struct ChatReasoningEffortLevel : IEquatable<ChatReasoningEffortLevel> {
public ChatReasoningEffortLevel(string value);
public static ChatReasoningEffortLevel High { get; }
public static ChatReasoningEffortLevel Low { get; }
public static ChatReasoningEffortLevel Medium { get; }
public static ChatReasoningEffortLevel Minimal { get; }
public static ChatReasoningEffortLevel None { get; }
public readonly bool Equals(ChatReasoningEffortLevel other);
[EditorBrowsable(EditorBrowsableState.Never)]
public override readonly bool Equals(object obj);
[EditorBrowsable(EditorBrowsableState.Never)]
public override readonly int GetHashCode();
public static bool operator ==(ChatReasoningEffortLevel left, ChatReasoningEffortLevel right);
public static implicit operator ChatReasoningEffortLevel(string value);
public static implicit operator ChatReasoningEffortLevel?(string value);
public static bool operator !=(ChatReasoningEffortLevel left, ChatReasoningEffortLevel right);
public override readonly string ToString();
}
public class ChatResponseFormat : IJsonModel<ChatResponseFormat>, IPersistableModel<ChatResponseFormat> {
[Serialization.JsonIgnore]
[EditorBrowsable(EditorBrowsableState.Never)]
public ref JsonPatch Patch { get; }
public static ChatResponseFormat CreateJsonObjectFormat();
public static ChatResponseFormat CreateJsonSchemaFormat(string jsonSchemaFormatName, BinaryData jsonSchema, string jsonSchemaFormatDescription = null, bool? jsonSchemaIsStrict = null);
public static ChatResponseFormat CreateTextFormat();
}
[Flags]
public enum ChatResponseModalities {
Default = 0,
Text = 1,
Audio = 2
}
public readonly partial struct ChatServiceTier : IEquatable<ChatServiceTier> {
public ChatServiceTier(string value);
public static ChatServiceTier Auto { get; }
public static ChatServiceTier Default { get; }
public static ChatServiceTier Flex { get; }
public static ChatServiceTier Scale { get; }
public readonly bool Equals(ChatServiceTier other);
[EditorBrowsable(EditorBrowsableState.Never)]
public override readonly bool Equals(object obj);
[EditorBrowsable(EditorBrowsableState.Never)]
public override readonly int GetHashCode();
public static bool operator ==(ChatServiceTier left, ChatServiceTier right);
public static implicit operator ChatServiceTier(string value);
public static implicit operator ChatServiceTier?(string value);
public static bool operator !=(ChatServiceTier left, ChatServiceTier right);
public override readonly string ToString();
}
public class ChatTokenLogProbabilityDetails : IJsonModel<ChatTokenLogProbabilityDetails>, IPersistableModel<ChatTokenLogProbabilityDetails> {
public float LogProbability { get; }
[Serialization.JsonIgnore]
[EditorBrowsable(EditorBrowsableState.Never)]
public ref JsonPatch Patch { get; }
public string Token { get; }
public IReadOnlyList<ChatTokenTopLogProbabilityDetails> TopLogProbabilities { get; }
public ReadOnlyMemory<byte>? Utf8Bytes { get; }
}
public class ChatTokenTopLogProbabilityDetails : IJsonModel<ChatTokenTopLogProbabilityDetails>, IPersistableModel<ChatTokenTopLogProbabilityDetails> {
public float LogProbability { get; }
[Serialization.JsonIgnore]
[EditorBrowsable(EditorBrowsableState.Never)]
public ref JsonPatch Patch { get; }
public string Token { get; }
public ReadOnlyMemory<byte>? Utf8Bytes { get; }
}
public class ChatTokenUsage : IJsonModel<ChatTokenUsage>, IPersistableModel<ChatTokenUsage> {
public int InputTokenCount { get; }
public ChatInputTokenUsageDetails InputTokenDetails { get; }
public int OutputTokenCount { get; }
public ChatOutputTokenUsageDetails OutputTokenDetails { get; }
[Serialization.JsonIgnore]
[EditorBrowsable(EditorBrowsableState.Never)]
public ref JsonPatch Patch { get; }
public int TotalTokenCount { get; }
}
public class ChatTool : IJsonModel<ChatTool>, IPersistableModel<ChatTool> {
public string FunctionDescription { get; }
public string FunctionName { get; }
public BinaryData FunctionParameters { get; }
public bool? FunctionSchemaIsStrict { get; }
public ChatToolKind Kind { get; }
[Serialization.JsonIgnore]
[EditorBrowsable(EditorBrowsableState.Never)]
public ref JsonPatch Patch { get; }
public static ChatTool CreateFunctionTool(string functionName, string functionDescription = null, BinaryData functionParameters = null, bool? functionSchemaIsStrict = null);
}
public class ChatToolCall : IJsonModel<ChatToolCall>, IPersistableModel<ChatToolCall> {
public BinaryData FunctionArguments { get; }
public string FunctionName { get; }
public string Id { get; set; }
public ChatToolCallKind Kind { get; }
[Serialization.JsonIgnore]
[EditorBrowsable(EditorBrowsableState.Never)]
public ref JsonPatch Patch { get; }
public static ChatToolCall CreateFunctionToolCall(string id, string functionName, BinaryData functionArguments);
}
public enum ChatToolCallKind {
Function = 0
}
public class ChatToolChoice : IJsonModel<ChatToolChoice>, IPersistableModel<ChatToolChoice> {
[Serialization.JsonIgnore]
[EditorBrowsable(EditorBrowsableState.Never)]
public ref JsonPatch Patch { get; }
public static ChatToolChoice CreateAutoChoice();
public static ChatToolChoice CreateFunctionChoice(string functionName);
public static ChatToolChoice CreateNoneChoice();
public static ChatToolChoice CreateRequiredChoice();
}
public enum ChatToolKind {
Function = 0
}
public readonly partial struct ChatWebSearchContextSize : IEquatable<ChatWebSearchContextSize> {
public ChatWebSearchContextSize(string value);
public static ChatWebSearchContextSize High { get; }
public static ChatWebSearchContextSize Low { get; }
public static ChatWebSearchContextSize Medium { get; }
public readonly bool Equals(ChatWebSearchContextSize other);
[EditorBrowsable(EditorBrowsableState.Never)]
public override readonly bool Equals(object obj);
[EditorBrowsable(EditorBrowsableState.Never)]
public override readonly int GetHashCode();
public static bool operator ==(ChatWebSearchContextSize left, ChatWebSearchContextSize right);
public static implicit operator ChatWebSearchContextSize(string value);
public static implicit operator ChatWebSearchContextSize?(string value);
public static bool operator !=(ChatWebSearchContextSize left, ChatWebSearchContextSize right);
public override readonly string ToString();
}
public class ChatWebSearchOptions : IJsonModel<ChatWebSearchOptions>, IPersistableModel<ChatWebSearchOptions> {
[Serialization.JsonIgnore]
[EditorBrowsable(EditorBrowsableState.Never)]
public ref JsonPatch Patch { get; }
public ChatWebSearchContextSize? SearchContextSize { get; set; }
}
public class DeveloperChatMessage : ChatMessage, IJsonModel<DeveloperChatMessage>, IPersistableModel<DeveloperChatMessage> {
public DeveloperChatMessage(params ChatMessageContentPart[] contentParts);
public DeveloperChatMessage(IEnumerable<ChatMessageContentPart> contentParts);
public DeveloperChatMessage(string content);
public string ParticipantName { get; set; }
}
[Obsolete("This class is obsolete. Please use ToolChatMessage instead.")]
public class FunctionChatMessage : ChatMessage, IJsonModel<FunctionChatMessage>, IPersistableModel<FunctionChatMessage> {
public FunctionChatMessage(string functionName, string content);
public string FunctionName { get; }
}
public static class OpenAIChatModelFactory {
public static ChatCompletion ChatCompletion(string id = null, ChatFinishReason finishReason = ChatFinishReason.Stop, ChatMessageContent content = null, string refusal = null, IEnumerable<ChatToolCall> toolCalls = null, ChatMessageRole role = ChatMessageRole.System, ChatFunctionCall functionCall = null, IEnumerable<ChatTokenLogProbabilityDetails> contentTokenLogProbabilities = null, IEnumerable<ChatTokenLogProbabilityDetails> refusalTokenLogProbabilities = null, DateTimeOffset createdAt = default, string model = null, ChatServiceTier? serviceTier = null, string systemFingerprint = null, ChatTokenUsage usage = null, ChatOutputAudio outputAudio = null, IEnumerable<ChatMessageAnnotation> messageAnnotations = null);
[EditorBrowsable(EditorBrowsableState.Never)]
public static ChatCompletion ChatCompletion(string id, ChatFinishReason finishReason, ChatMessageContent content, string refusal, IEnumerable<ChatToolCall> toolCalls, ChatMessageRole role, ChatFunctionCall functionCall, IEnumerable<ChatTokenLogProbabilityDetails> contentTokenLogProbabilities, IEnumerable<ChatTokenLogProbabilityDetails> refusalTokenLogProbabilities, DateTimeOffset createdAt, string model, string systemFingerprint, ChatTokenUsage usage);
public static ChatCompletionMessageListDatum ChatCompletionMessageListDatum(string id, string content, string refusal, ChatMessageRole role, IList<ChatMessageContentPart> contentParts = null, IList<ChatToolCall> toolCalls = null, IList<ChatMessageAnnotation> annotations = null, string functionName = null, string functionArguments = null, ChatOutputAudio outputAudio = null);
public static ChatInputTokenUsageDetails ChatInputTokenUsageDetails(int audioTokenCount = 0, int cachedTokenCount = 0);
public static ChatMessageAnnotation ChatMessageAnnotation(int startIndex = 0, int endIndex = 0, Uri webResourceUri = null, string webResourceTitle = null);
public static ChatOutputAudio ChatOutputAudio(BinaryData audioBytes, string id = null, string transcript = null, DateTimeOffset expiresAt = default);
public static ChatOutputTokenUsageDetails ChatOutputTokenUsageDetails(int reasoningTokenCount = 0, int audioTokenCount = 0, int acceptedPredictionTokenCount = 0, int rejectedPredictionTokenCount = 0);
[EditorBrowsable(EditorBrowsableState.Never)]
public static ChatOutputTokenUsageDetails ChatOutputTokenUsageDetails(int reasoningTokenCount, int audioTokenCount);
[EditorBrowsable(EditorBrowsableState.Never)]
public static ChatOutputTokenUsageDetails ChatOutputTokenUsageDetails(int reasoningTokenCount);
public static ChatTokenLogProbabilityDetails ChatTokenLogProbabilityDetails(string token = null, float logProbability = 0, ReadOnlyMemory<byte>? utf8Bytes = null, IEnumerable<ChatTokenTopLogProbabilityDetails> topLogProbabilities = null);
public static ChatTokenTopLogProbabilityDetails ChatTokenTopLogProbabilityDetails(string token = null, float logProbability = 0, ReadOnlyMemory<byte>? utf8Bytes = null);
public static ChatTokenUsage ChatTokenUsage(int outputTokenCount = 0, int inputTokenCount = 0, int totalTokenCount = 0, ChatOutputTokenUsageDetails outputTokenDetails = null, ChatInputTokenUsageDetails inputTokenDetails = null);
[EditorBrowsable(EditorBrowsableState.Never)]
public static ChatTokenUsage ChatTokenUsage(int outputTokenCount, int inputTokenCount, int totalTokenCount, ChatOutputTokenUsageDetails outputTokenDetails);
public static StreamingChatCompletionUpdate StreamingChatCompletionUpdate(string completionId = null, ChatMessageContent contentUpdate = null, StreamingChatFunctionCallUpdate functionCallUpdate = null, IEnumerable<StreamingChatToolCallUpdate> toolCallUpdates = null, ChatMessageRole? role = null, string refusalUpdate = null, IEnumerable<ChatTokenLogProbabilityDetails> contentTokenLogProbabilities = null, IEnumerable<ChatTokenLogProbabilityDetails> refusalTokenLogProbabilities = null, ChatFinishReason? finishReason = null, DateTimeOffset createdAt = default, string model = null, ChatServiceTier? serviceTier = null, string systemFingerprint = null, ChatTokenUsage usage = null, StreamingChatOutputAudioUpdate outputAudioUpdate = null);
[EditorBrowsable(EditorBrowsableState.Never)]
public static StreamingChatCompletionUpdate StreamingChatCompletionUpdate(string completionId, ChatMessageContent contentUpdate, StreamingChatFunctionCallUpdate functionCallUpdate, IEnumerable<StreamingChatToolCallUpdate> toolCallUpdates, ChatMessageRole? role, string refusalUpdate, IEnumerable<ChatTokenLogProbabilityDetails> contentTokenLogProbabilities, IEnumerable<ChatTokenLogProbabilityDetails> refusalTokenLogProbabilities, ChatFinishReason? finishReason, DateTimeOffset createdAt, string model, string systemFingerprint, ChatTokenUsage usage);
[Obsolete("This class is obsolete. Please use StreamingChatToolCallUpdate instead.")]
public static StreamingChatFunctionCallUpdate StreamingChatFunctionCallUpdate(string functionName = null, BinaryData functionArgumentsUpdate = null);
public static StreamingChatOutputAudioUpdate StreamingChatOutputAudioUpdate(string id = null, DateTimeOffset? expiresAt = null, string transcriptUpdate = null, BinaryData audioBytesUpdate = null);
public static StreamingChatToolCallUpdate StreamingChatToolCallUpdate(int index = 0, string toolCallId = null, ChatToolCallKind kind = ChatToolCallKind.Function, string functionName = null, BinaryData functionArgumentsUpdate = null);
}
public class StreamingChatCompletionUpdate : IJsonModel<StreamingChatCompletionUpdate>, IPersistableModel<StreamingChatCompletionUpdate> {
public string CompletionId { get; }
public IReadOnlyList<ChatTokenLogProbabilityDetails> ContentTokenLogProbabilities { get; }
public ChatMessageContent ContentUpdate { get; }
public DateTimeOffset CreatedAt { get; }
public ChatFinishReason? FinishReason { get; }
[Obsolete("This property is obsolete. Please use ToolCallUpdates instead.")]
public StreamingChatFunctionCallUpdate FunctionCallUpdate { get; }
public string Model { get; }
public StreamingChatOutputAudioUpdate OutputAudioUpdate { get; }
[Serialization.JsonIgnore]
[EditorBrowsable(EditorBrowsableState.Never)]
public ref JsonPatch Patch { get; }
public IReadOnlyList<ChatTokenLogProbabilityDetails> RefusalTokenLogProbabilities { get; }
public string RefusalUpdate { get; }
public ChatMessageRole? Role { get; }
public ChatServiceTier? ServiceTier { get; }
public string SystemFingerprint { get; }
public IReadOnlyList<StreamingChatToolCallUpdate> ToolCallUpdates { get; }
public ChatTokenUsage Usage { get; }
}
[Obsolete("This class is obsolete. Please use StreamingChatToolCallUpdate instead.")]
public class StreamingChatFunctionCallUpdate : IJsonModel<StreamingChatFunctionCallUpdate>, IPersistableModel<StreamingChatFunctionCallUpdate> {
public BinaryData FunctionArgumentsUpdate { get; }
public string FunctionName { get; }
[Serialization.JsonIgnore]
[EditorBrowsable(EditorBrowsableState.Never)]
public ref JsonPatch Patch { get; }
}
public class StreamingChatOutputAudioUpdate : IJsonModel<StreamingChatOutputAudioUpdate>, IPersistableModel<StreamingChatOutputAudioUpdate> {
public BinaryData AudioBytesUpdate { get; }
public DateTimeOffset? ExpiresAt { get; }
public string Id { get; }
[Serialization.JsonIgnore]
[EditorBrowsable(EditorBrowsableState.Never)]
public ref JsonPatch Patch { get; }
public string TranscriptUpdate { get; }
}
public class StreamingChatToolCallUpdate : IJsonModel<StreamingChatToolCallUpdate>, IPersistableModel<StreamingChatToolCallUpdate> {
public BinaryData FunctionArgumentsUpdate { get; }
public string FunctionName { get; }
public int Index { get; }
public ChatToolCallKind Kind { get; }
[Serialization.JsonIgnore]
[EditorBrowsable(EditorBrowsableState.Never)]
public ref JsonPatch Patch { get; }
public string ToolCallId { get; }
}
public class SystemChatMessage : ChatMessage, IJsonModel<SystemChatMessage>, IPersistableModel<SystemChatMessage> {
public SystemChatMessage(params ChatMessageContentPart[] contentParts);
public SystemChatMessage(IEnumerable<ChatMessageContentPart> contentParts);
public SystemChatMessage(string content);
public string ParticipantName { get; set; }
}
public class ToolChatMessage : ChatMessage, IJsonModel<ToolChatMessage>, IPersistableModel<ToolChatMessage> {
public ToolChatMessage(string toolCallId, params ChatMessageContentPart[] contentParts);
public ToolChatMessage(string toolCallId, IEnumerable<ChatMessageContentPart> contentParts);
public ToolChatMessage(string toolCallId, string content);
public string ToolCallId { get; }
}
public class UserChatMessage : ChatMessage, IJsonModel<UserChatMessage>, IPersistableModel<UserChatMessage> {
public UserChatMessage(params ChatMessageContentPart[] contentParts);
public UserChatMessage(IEnumerable<ChatMessageContentPart> contentParts);
public UserChatMessage(string content);
public string ParticipantName { get; set; }
}
}
namespace OpenAI.Containers {
public class ContainerClient {
protected ContainerClient();
public ContainerClient(ContainerClientSettings settings);
public ContainerClient(ApiKeyCredential credential, OpenAIClientOptions options);
public ContainerClient(ApiKeyCredential credential);
public ContainerClient(AuthenticationPolicy authenticationPolicy, OpenAIClientOptions options);
public ContainerClient(AuthenticationPolicy authenticationPolicy);
protected internal ContainerClient(ClientPipeline pipeline, OpenAIClientOptions options);
public ContainerClient(string apiKey);
public Uri Endpoint { get; }
public ClientPipeline Pipeline { get; }
public virtual ClientResult<ContainerResource> CreateContainer(CreateContainerBody body, CancellationToken cancellationToken = default);
public virtual ClientResult CreateContainer(BinaryContent content, RequestOptions options = null);
public virtual Task<ClientResult<ContainerResource>> CreateContainerAsync(CreateContainerBody body, CancellationToken cancellationToken = default);
public virtual Task<ClientResult> CreateContainerAsync(BinaryContent content, RequestOptions options = null);
public virtual ClientResult DeleteContainer(string containerId, RequestOptions options);
public virtual ClientResult<DeleteContainerResponse> DeleteContainer(string containerId, CancellationToken cancellationToken = default);
public virtual Task<ClientResult> DeleteContainerAsync(string containerId, RequestOptions options);
public virtual Task<ClientResult<DeleteContainerResponse>> DeleteContainerAsync(string containerId, CancellationToken cancellationToken = default);
public virtual ClientResult DeleteContainerFile(string containerId, string fileId, RequestOptions options);
public virtual ClientResult<DeleteContainerFileResponse> DeleteContainerFile(string containerId, string fileId, CancellationToken cancellationToken = default);
public virtual Task<ClientResult> DeleteContainerFileAsync(string containerId, string fileId, RequestOptions options);
public virtual Task<ClientResult<DeleteContainerFileResponse>> DeleteContainerFileAsync(string containerId, string fileId, CancellationToken cancellationToken = default);
public virtual ClientResult DownloadContainerFile(string containerId, string fileId, RequestOptions options);
public virtual ClientResult<BinaryData> DownloadContainerFile(string containerId, string fileId, CancellationToken cancellationToken = default);
public virtual Task<ClientResult> DownloadContainerFileAsync(string containerId, string fileId, RequestOptions options);
public virtual Task<ClientResult<BinaryData>> DownloadContainerFileAsync(string containerId, string fileId, CancellationToken cancellationToken = default);
public virtual ClientResult GetContainer(string containerId, RequestOptions options);
public virtual ClientResult<ContainerResource> GetContainer(string containerId, CancellationToken cancellationToken = default);
public virtual Task<ClientResult> GetContainerAsync(string containerId, RequestOptions options);
public virtual Task<ClientResult<ContainerResource>> GetContainerAsync(string containerId, CancellationToken cancellationToken = default);
public virtual ClientResult GetContainerFile(string containerId, string fileId, RequestOptions options);
public virtual ClientResult<ContainerFileResource> GetContainerFile(string containerId, string fileId, CancellationToken cancellationToken = default);
public virtual Task<ClientResult> GetContainerFileAsync(string containerId, string fileId, RequestOptions options);
public virtual Task<ClientResult<ContainerFileResource>> GetContainerFileAsync(string containerId, string fileId, CancellationToken cancellationToken = default);
public virtual CollectionResult<ContainerFileResource> GetContainerFiles(string containerId, ContainerFileCollectionOptions options = null, CancellationToken cancellationToken = default);
public virtual CollectionResult GetContainerFiles(string containerId, int? limit, string order, string after, RequestOptions options);
public virtual AsyncCollectionResult<ContainerFileResource> GetContainerFilesAsync(string containerId, ContainerFileCollectionOptions options = null, CancellationToken cancellationToken = default);
public virtual AsyncCollectionResult GetContainerFilesAsync(string containerId, int? limit, string order, string after, RequestOptions options);
public virtual CollectionResult<ContainerResource> GetContainers(ContainerCollectionOptions options = null, CancellationToken cancellationToken = default);
public virtual CollectionResult GetContainers(int? limit, string order, string after, RequestOptions options);
public virtual AsyncCollectionResult<ContainerResource> GetContainersAsync(ContainerCollectionOptions options = null, CancellationToken cancellationToken = default);
public virtual AsyncCollectionResult GetContainersAsync(int? limit, string order, string after, RequestOptions options);
public virtual ClientResult UploadContainerFile(string containerId, BinaryContent content, string contentType, RequestOptions options = null);
public virtual Task<ClientResult> UploadContainerFileAsync(string containerId, BinaryContent content, string contentType, RequestOptions options = null);
}
public sealed class ContainerClientSettings : ClientSettings {
public OpenAIClientOptions Options { get; set; }
protected override void BindCore(Microsoft.Extensions.Configuration.IConfigurationSection section);
}
public class ContainerCollectionOptions : IJsonModel<ContainerCollectionOptions>, IPersistableModel<ContainerCollectionOptions> {
public string AfterId { get; set; }
public ContainerCollectionOrder? Order { get; set; }
public int? PageSizeLimit { get; set; }
}
public readonly partial struct ContainerCollectionOrder : IEquatable<ContainerCollectionOrder> {
public ContainerCollectionOrder(string value);
public static ContainerCollectionOrder Ascending { get; }
public static ContainerCollectionOrder Descending { get; }
public readonly bool Equals(ContainerCollectionOrder other);
[EditorBrowsable(EditorBrowsableState.Never)]
public override readonly bool Equals(object obj);
[EditorBrowsable(EditorBrowsableState.Never)]
public override readonly int GetHashCode();
public static bool operator ==(ContainerCollectionOrder left, ContainerCollectionOrder right);
public static implicit operator ContainerCollectionOrder(string value);
public static implicit operator ContainerCollectionOrder?(string value);
public static bool operator !=(ContainerCollectionOrder left, ContainerCollectionOrder right);
public override readonly string ToString();
}
public class ContainerFileCollectionOptions : IJsonModel<ContainerFileCollectionOptions>, IPersistableModel<ContainerFileCollectionOptions> {
public string AfterId { get; set; }
public ContainerFileCollectionOrder? Order { get; set; }
public int? PageSizeLimit { get; set; }
}
public readonly partial struct ContainerFileCollectionOrder : IEquatable<ContainerFileCollectionOrder> {
public ContainerFileCollectionOrder(string value);
public static ContainerFileCollectionOrder Ascending { get; }
public static ContainerFileCollectionOrder Descending { get; }
public readonly bool Equals(ContainerFileCollectionOrder other);
[EditorBrowsable(EditorBrowsableState.Never)]
public override readonly bool Equals(object obj);
[EditorBrowsable(EditorBrowsableState.Never)]
public override readonly int GetHashCode();
public static bool operator ==(ContainerFileCollectionOrder left, ContainerFileCollectionOrder right);
public static implicit operator ContainerFileCollectionOrder(string value);
public static implicit operator ContainerFileCollectionOrder?(string value);
public static bool operator !=(ContainerFileCollectionOrder left, ContainerFileCollectionOrder right);
public override readonly string ToString();
}
public class ContainerFileResource : IJsonModel<ContainerFileResource>, IPersistableModel<ContainerFileResource> {
public string ContainerId { get; }
public DateTimeOffset CreatedAt { get; }
public string Id { get; }
public string Object { get; }
public string Path { get; }
public long? SizeInBytes { get; }
public string Source { get; }
public static explicit operator ContainerFileResource(ClientResult result);
}
public class ContainerResource : IJsonModel<ContainerResource>, IPersistableModel<ContainerResource> {
public DateTimeOffset CreatedAt { get; }
public ContainerResourceExpiresAfter ExpiresAfter { get; }
public string Id { get; }
public string Name { get; }
public string Object { get; }
public string Status { get; }
public static explicit operator ContainerResource(ClientResult result);
}
public class ContainerResourceExpiresAfter : IJsonModel<ContainerResourceExpiresAfter>, IPersistableModel<ContainerResourceExpiresAfter> {
public string Anchor { get; }
public int? Minutes { get; }
}
public class CreateContainerBody : IJsonModel<CreateContainerBody>, IPersistableModel<CreateContainerBody> {
public CreateContainerBody(string name);
public CreateContainerBodyExpiresAfter ExpiresAfter { get; set; }
public IList<string> FileIds { get; }
public string Name { get; }
public static implicit operator BinaryContent(CreateContainerBody createContainerBody);
}
public class CreateContainerBodyExpiresAfter : IJsonModel<CreateContainerBodyExpiresAfter>, IPersistableModel<CreateContainerBodyExpiresAfter> {
public CreateContainerBodyExpiresAfter(int minutes);
public string Anchor { get; }
public int Minutes { get; }
}
public class CreateContainerFileBody : IJsonModel<CreateContainerFileBody>, IPersistableModel<CreateContainerFileBody> {
public BinaryData File { get; set; }
public string FileId { get; set; }
}
public class DeleteContainerFileResponse : IJsonModel<DeleteContainerFileResponse>, IPersistableModel<DeleteContainerFileResponse> {
public bool Deleted { get; }
public string Id { get; }
public string Object { get; }
public static explicit operator DeleteContainerFileResponse(ClientResult result);
}
public class DeleteContainerResponse : IJsonModel<DeleteContainerResponse>, IPersistableModel<DeleteContainerResponse> {
public bool Deleted { get; }
public string Id { get; }
public string Object { get; }
public static explicit operator DeleteContainerResponse(ClientResult result);
}
}
namespace OpenAI.Conversations {
public class ConversationClient {
protected ConversationClient();
public ConversationClient(ConversationClientSettings settings);
public ConversationClient(ApiKeyCredential credential, OpenAIClientOptions options);
public ConversationClient(ApiKeyCredential credential);
public ConversationClient(AuthenticationPolicy authenticationPolicy, OpenAIClientOptions options);
public ConversationClient(AuthenticationPolicy authenticationPolicy);
protected internal ConversationClient(ClientPipeline pipeline, OpenAIClientOptions options);
public ConversationClient(string apiKey);
public Uri Endpoint { get; }
public ClientPipeline Pipeline { get; }
public virtual ClientResult CreateConversation(BinaryContent content, RequestOptions options = null);
public virtual Task<ClientResult> CreateConversationAsync(BinaryContent content, RequestOptions options = null);
public virtual ClientResult CreateConversationItems(string conversationId, BinaryContent content, IEnumerable<IncludedConversationItemProperty> include = null, RequestOptions options = null);
public virtual Task<ClientResult> CreateConversationItemsAsync(string conversationId, BinaryContent content, IEnumerable<IncludedConversationItemProperty> include = null, RequestOptions options = null);
public virtual ClientResult DeleteConversation(string conversationId, RequestOptions options = null);
public virtual Task<ClientResult> DeleteConversationAsync(string conversationId, RequestOptions options = null);
public virtual ClientResult DeleteConversationItem(string conversationId, string itemId, RequestOptions options = null);
public virtual Task<ClientResult> DeleteConversationItemAsync(string conversationId, string itemId, RequestOptions options = null);
public virtual ClientResult GetConversation(string conversationId, RequestOptions options = null);
public virtual Task<ClientResult> GetConversationAsync(string conversationId, RequestOptions options = null);
public virtual ClientResult GetConversationItem(string conversationId, string itemId, IEnumerable<IncludedConversationItemProperty> include = null, RequestOptions options = null);
public virtual Task<ClientResult> GetConversationItemAsync(string conversationId, string itemId, IEnumerable<IncludedConversationItemProperty> include = null, RequestOptions options = null);
public virtual CollectionResult GetConversationItems(string conversationId, int? limit = null, string order = null, string after = null, IEnumerable<IncludedConversationItemProperty> include = null, RequestOptions options = null);
public virtual AsyncCollectionResult GetConversationItemsAsync(string conversationId, int? limit = null, string order = null, string after = null, IEnumerable<IncludedConversationItemProperty> include = null, RequestOptions options = null);
public virtual ClientResult UpdateConversation(string conversationId, BinaryContent content, RequestOptions options = null);
public virtual Task<ClientResult> UpdateConversationAsync(string conversationId, BinaryContent content, RequestOptions options = null);
}
public sealed class ConversationClientSettings : ClientSettings {
public OpenAIClientOptions Options { get; set; }
protected override void BindCore(Microsoft.Extensions.Configuration.IConfigurationSection section);
}
public readonly partial struct IncludedConversationItemProperty : IEquatable<IncludedConversationItemProperty> {
public IncludedConversationItemProperty(string value);
public static IncludedConversationItemProperty CodeInterpreterCallOutputs { get; }
public static IncludedConversationItemProperty ComputerCallOutputImageUri { get; }
public static IncludedConversationItemProperty FileSearchCallResults { get; }
public static IncludedConversationItemProperty MessageInputImageUri { get; }
public static IncludedConversationItemProperty MessageOutputTextLogProbabilities { get; }
public static IncludedConversationItemProperty ReasoningEncryptedContent { get; }
public static IncludedConversationItemProperty WebSearchCallActionSources { get; }
public static IncludedConversationItemProperty WebSearchCallResults { get; }
public readonly bool Equals(IncludedConversationItemProperty other);
[EditorBrowsable(EditorBrowsableState.Never)]
public override readonly bool Equals(object obj);
[EditorBrowsable(EditorBrowsableState.Never)]
public override readonly int GetHashCode();
public static bool operator ==(IncludedConversationItemProperty left, IncludedConversationItemProperty right);
public static implicit operator IncludedConversationItemProperty(string value);
public static implicit operator IncludedConversationItemProperty?(string value);
public static bool operator !=(IncludedConversationItemProperty left, IncludedConversationItemProperty right);
public override readonly string ToString();
}
}
namespace OpenAI.Embeddings {
public class EmbeddingClient {
protected EmbeddingClient();
public EmbeddingClient(EmbeddingClientSettings settings);
protected internal EmbeddingClient(ClientPipeline pipeline, string model, OpenAIClientOptions options);
public EmbeddingClient(string model, ApiKeyCredential credential, OpenAIClientOptions options);
public EmbeddingClient(string model, ApiKeyCredential credential);
public EmbeddingClient(string model, AuthenticationPolicy authenticationPolicy, OpenAIClientOptions options);
public EmbeddingClient(string model, AuthenticationPolicy authenticationPolicy);
public EmbeddingClient(string model, string apiKey);
public Uri Endpoint { get; }
public string Model { get; }
public ClientPipeline Pipeline { get; }
public virtual ClientResult<OpenAIEmbedding> GenerateEmbedding(string input, EmbeddingGenerationOptions options = null, CancellationToken cancellationToken = default);
public virtual Task<ClientResult<OpenAIEmbedding>> GenerateEmbeddingAsync(string input, EmbeddingGenerationOptions options = null, CancellationToken cancellationToken = default);
public virtual ClientResult GenerateEmbeddings(BinaryContent content, RequestOptions options = null);
public virtual ClientResult<OpenAIEmbeddingCollection> GenerateEmbeddings(IEnumerable<ReadOnlyMemory<int>> inputs, EmbeddingGenerationOptions options = null, CancellationToken cancellationToken = default);
public virtual ClientResult<OpenAIEmbeddingCollection> GenerateEmbeddings(IEnumerable<string> inputs, EmbeddingGenerationOptions options = null, CancellationToken cancellationToken = default);
public virtual Task<ClientResult> GenerateEmbeddingsAsync(BinaryContent content, RequestOptions options = null);
public virtual Task<ClientResult<OpenAIEmbeddingCollection>> GenerateEmbeddingsAsync(IEnumerable<ReadOnlyMemory<int>> inputs, EmbeddingGenerationOptions options = null, CancellationToken cancellationToken = default);
public virtual Task<ClientResult<OpenAIEmbeddingCollection>> GenerateEmbeddingsAsync(IEnumerable<string> inputs, EmbeddingGenerationOptions options = null, CancellationToken cancellationToken = default);
}
public sealed class EmbeddingClientSettings : ClientSettings {
public string Model { get; set; }
public OpenAIClientOptions Options { get; set; }
protected override void BindCore(Microsoft.Extensions.Configuration.IConfigurationSection section);
}
public class EmbeddingGenerationOptions : IJsonModel<EmbeddingGenerationOptions>, IPersistableModel<EmbeddingGenerationOptions> {
public int? Dimensions { get; set; }
public string EndUserId { get; set; }
[Serialization.JsonIgnore]
[EditorBrowsable(EditorBrowsableState.Never)]
public ref JsonPatch Patch { get; }
}
public class EmbeddingTokenUsage : IJsonModel<EmbeddingTokenUsage>, IPersistableModel<EmbeddingTokenUsage> {
public int InputTokenCount { get; }
[Serialization.JsonIgnore]
[EditorBrowsable(EditorBrowsableState.Never)]
public ref JsonPatch Patch { get; }
public int TotalTokenCount { get; }
}
public class OpenAIEmbedding : IJsonModel<OpenAIEmbedding>, IPersistableModel<OpenAIEmbedding> {
public int Index { get; }
[Serialization.JsonIgnore]
[EditorBrowsable(EditorBrowsableState.Never)]
public ref JsonPatch Patch { get; }
public ReadOnlyMemory<float> ToFloats();
}
public class OpenAIEmbeddingCollection : ObjectModel.ReadOnlyCollection<OpenAIEmbedding>, IJsonModel<OpenAIEmbeddingCollection>, IPersistableModel<OpenAIEmbeddingCollection> {
public string Model { get; }
[Serialization.JsonIgnore]
[EditorBrowsable(EditorBrowsableState.Never)]
public ref JsonPatch Patch { get; }
public EmbeddingTokenUsage Usage { get; }
public static explicit operator OpenAIEmbeddingCollection(ClientResult result);
}
public static class OpenAIEmbeddingsModelFactory {
public static EmbeddingTokenUsage EmbeddingTokenUsage(int inputTokenCount = 0, int totalTokenCount = 0);
public static OpenAIEmbedding OpenAIEmbedding(int index = 0, IEnumerable<float> vector = null);
public static OpenAIEmbeddingCollection OpenAIEmbeddingCollection(IEnumerable<OpenAIEmbedding> items = null, string model = null, EmbeddingTokenUsage usage = null);
}
}
namespace OpenAI.Evals {
public class EvaluationClient {
protected EvaluationClient();
public EvaluationClient(EvaluationClientSettings settings);
public EvaluationClient(ApiKeyCredential credential, OpenAIClientOptions options);
public EvaluationClient(ApiKeyCredential credential);
public EvaluationClient(AuthenticationPolicy authenticationPolicy, OpenAIClientOptions options);
public EvaluationClient(AuthenticationPolicy authenticationPolicy);
protected internal EvaluationClient(ClientPipeline pipeline, OpenAIClientOptions options);
public EvaluationClient(string apiKey);
public Uri Endpoint { get; }
public ClientPipeline Pipeline { get; }
public virtual ClientResult CancelEvaluationRun(string evaluationId, string evaluationRunId, RequestOptions options);
public virtual Task<ClientResult> CancelEvaluationRunAsync(string evaluationId, string evaluationRunId, RequestOptions options);
public virtual ClientResult CreateEvaluation(BinaryContent content, RequestOptions options = null);
public virtual Task<ClientResult> CreateEvaluationAsync(BinaryContent content, RequestOptions options = null);
public virtual ClientResult CreateEvaluationRun(string evaluationId, BinaryContent content, RequestOptions options = null);
public virtual Task<ClientResult> CreateEvaluationRunAsync(string evaluationId, BinaryContent content, RequestOptions options = null);
public virtual ClientResult DeleteEvaluation(string evaluationId, RequestOptions options);
public virtual Task<ClientResult> DeleteEvaluationAsync(string evaluationId, RequestOptions options);
public virtual ClientResult DeleteEvaluationRun(string evaluationId, string evaluationRunId, RequestOptions options);
public virtual Task<ClientResult> DeleteEvaluationRunAsync(string evaluationId, string evaluationRunId, RequestOptions options);
public virtual ClientResult GetEvaluation(string evaluationId, RequestOptions options);
public virtual Task<ClientResult> GetEvaluationAsync(string evaluationId, RequestOptions options);
public virtual ClientResult GetEvaluationRun(string evaluationId, string evaluationRunId, RequestOptions options);
public virtual Task<ClientResult> GetEvaluationRunAsync(string evaluationId, string evaluationRunId, RequestOptions options);
public virtual ClientResult GetEvaluationRunOutputItem(string evaluationId, string evaluationRunId, string outputItemId, RequestOptions options);
public virtual Task<ClientResult> GetEvaluationRunOutputItemAsync(string evaluationId, string evaluationRunId, string outputItemId, RequestOptions options);
public virtual ClientResult GetEvaluationRunOutputItems(string evaluationId, string evaluationRunId, int? limit, string order, string after, string outputItemStatus, RequestOptions options);
public virtual Task<ClientResult> GetEvaluationRunOutputItemsAsync(string evaluationId, string evaluationRunId, int? limit, string order, string after, string outputItemStatus, RequestOptions options);
public virtual ClientResult GetEvaluationRuns(string evaluationId, int? limit, string order, string after, string evaluationRunStatus, RequestOptions options);
public virtual Task<ClientResult> GetEvaluationRunsAsync(string evaluationId, int? limit, string order, string after, string evaluationRunStatus, RequestOptions options);
public virtual ClientResult GetEvaluations(int? limit, string orderBy, string order, string after, RequestOptions options);
public virtual Task<ClientResult> GetEvaluationsAsync(int? limit, string orderBy, string order, string after, RequestOptions options);
public virtual ClientResult UpdateEvaluation(string evaluationId, BinaryContent content, RequestOptions options = null);
public virtual Task<ClientResult> UpdateEvaluationAsync(string evaluationId, BinaryContent content, RequestOptions options = null);
}
public sealed class EvaluationClientSettings : ClientSettings {
public OpenAIClientOptions Options { get; set; }
protected override void BindCore(Microsoft.Extensions.Configuration.IConfigurationSection section);
}
}
namespace OpenAI.Files {
public class FileDeletionResult : IJsonModel<FileDeletionResult>, IPersistableModel<FileDeletionResult> {
public bool Deleted { get; }
public string FileId { get; }
public static explicit operator FileDeletionResult(ClientResult result);
}
public enum FilePurpose {
Assistants = 0,
AssistantsOutput = 1,
Batch = 2,
BatchOutput = 3,
FineTune = 4,
FineTuneResults = 5,
Vision = 6,
UserData = 7,
Evaluations = 8
}
[Obsolete("This struct is obsolete. If this is a fine-tuning training file, it may take some time to process after it has been uploaded. While the file is processing, you can still create a fine-tuning job but it will not start until the file processing has completed.")]
public enum FileStatus {
Uploaded = 0,
Processed = 1,
Error = 2
}
public readonly partial struct FileUploadPurpose : IEquatable<FileUploadPurpose> {
public FileUploadPurpose(string value);
public static FileUploadPurpose Assistants { get; }
public static FileUploadPurpose Batch { get; }
public static FileUploadPurpose Evaluations { get; }
public static FileUploadPurpose FineTune { get; }
public static FileUploadPurpose UserData { get; }
public static FileUploadPurpose Vision { get; }
public readonly bool Equals(FileUploadPurpose other);
[EditorBrowsable(EditorBrowsableState.Never)]
public override readonly bool Equals(object obj);
[EditorBrowsable(EditorBrowsableState.Never)]
public override readonly int GetHashCode();
public static bool operator ==(FileUploadPurpose left, FileUploadPurpose right);
public static implicit operator FileUploadPurpose(string value);
public static implicit operator FileUploadPurpose?(string value);
public static bool operator !=(FileUploadPurpose left, FileUploadPurpose right);
public override readonly string ToString();
}
public class OpenAIFile : IJsonModel<OpenAIFile>, IPersistableModel<OpenAIFile> {
public DateTimeOffset CreatedAt { get; }
public DateTimeOffset? ExpiresAt { get; }
public string Filename { get; }
public string Id { get; }
public FilePurpose Purpose { get; }
[EditorBrowsable(EditorBrowsableState.Never)]
public int? SizeInBytes { get; }
public long? SizeInBytesLong { get; }
[Obsolete("This property is obsolete. If this is a fine-tuning training file, it may take some time to process after it has been uploaded. While the file is processing, you can still create a fine-tuning job but it will not start until the file processing has completed.")]
public FileStatus Status { get; }
[Obsolete("This property is obsolete. For details on why a fine-tuning training file failed validation, see the `error` field on the fine-tuning job.")]
public string StatusDetails { get; }
public static explicit operator OpenAIFile(ClientResult result);
}
public class OpenAIFileClient {
protected OpenAIFileClient();
public OpenAIFileClient(OpenAIFileClientSettings settings);
public OpenAIFileClient(ApiKeyCredential credential, OpenAIClientOptions options);
public OpenAIFileClient(ApiKeyCredential credential);
public OpenAIFileClient(AuthenticationPolicy authenticationPolicy, OpenAIClientOptions options);
public OpenAIFileClient(AuthenticationPolicy authenticationPolicy);
protected internal OpenAIFileClient(ClientPipeline pipeline, OpenAIClientOptions options);
public OpenAIFileClient(string apiKey);
public Uri Endpoint { get; }
public ClientPipeline Pipeline { get; }
public virtual ClientResult AddUploadPart(string uploadId, BinaryContent content, string contentType, RequestOptions options = null);
public virtual Task<ClientResult> AddUploadPartAsync(string uploadId, BinaryContent content, string contentType, RequestOptions options = null);
public virtual ClientResult CancelUpload(string uploadId, RequestOptions options = null);
public virtual Task<ClientResult> CancelUploadAsync(string uploadId, RequestOptions options = null);
public virtual ClientResult CompleteUpload(string uploadId, BinaryContent content, RequestOptions options = null);
public virtual Task<ClientResult> CompleteUploadAsync(string uploadId, BinaryContent content, RequestOptions options = null);
public virtual ClientResult CreateUpload(BinaryContent content, RequestOptions options = null);
public virtual Task<ClientResult> CreateUploadAsync(BinaryContent content, RequestOptions options = null);
public virtual ClientResult DeleteFile(string fileId, RequestOptions options);
public virtual ClientResult<FileDeletionResult> DeleteFile(string fileId, CancellationToken cancellationToken = default);
public virtual Task<ClientResult> DeleteFileAsync(string fileId, RequestOptions options);
public virtual Task<ClientResult<FileDeletionResult>> DeleteFileAsync(string fileId, CancellationToken cancellationToken = default);
public virtual ClientResult DownloadFile(string fileId, RequestOptions options);
public virtual ClientResult<BinaryData> DownloadFile(string fileId, CancellationToken cancellationToken = default);
public virtual Task<ClientResult> DownloadFileAsync(string fileId, RequestOptions options);
public virtual Task<ClientResult<BinaryData>> DownloadFileAsync(string fileId, CancellationToken cancellationToken = default);
public virtual ClientResult GetFile(string fileId, RequestOptions options);
public virtual ClientResult<OpenAIFile> GetFile(string fileId, CancellationToken cancellationToken = default);
public virtual Task<ClientResult> GetFileAsync(string fileId, RequestOptions options);
public virtual Task<ClientResult<OpenAIFile>> GetFileAsync(string fileId, CancellationToken cancellationToken = default);
public virtual ClientResult<OpenAIFileCollection> GetFiles(FilePurpose purpose, CancellationToken cancellationToken = default);
public virtual ClientResult GetFiles(string purpose, RequestOptions options);
public virtual ClientResult GetFiles(string purpose, int? limit, string order, string after, RequestOptions options);
public virtual ClientResult<OpenAIFileCollection> GetFiles(CancellationToken cancellationToken = default);
public virtual Task<ClientResult<OpenAIFileCollection>> GetFilesAsync(FilePurpose purpose, CancellationToken cancellationToken = default);
public virtual Task<ClientResult> GetFilesAsync(string purpose, RequestOptions options);
public virtual Task<ClientResult> GetFilesAsync(string purpose, int? limit, string order, string after, RequestOptions options);
public virtual Task<ClientResult<OpenAIFileCollection>> GetFilesAsync(CancellationToken cancellationToken = default);
public virtual ClientResult<OpenAIFile> UploadFile(BinaryData file, string filename, FileUploadPurpose purpose);
public virtual ClientResult UploadFile(BinaryContent content, string contentType, RequestOptions options = null);
public virtual ClientResult<OpenAIFile> UploadFile(Stream file, string filename, FileUploadPurpose purpose, CancellationToken cancellationToken = default);
public virtual ClientResult<OpenAIFile> UploadFile(string filePath, FileUploadPurpose purpose);
public virtual Task<ClientResult<OpenAIFile>> UploadFileAsync(BinaryData file, string filename, FileUploadPurpose purpose);
public virtual Task<ClientResult> UploadFileAsync(BinaryContent content, string contentType, RequestOptions options = null);
public virtual Task<ClientResult<OpenAIFile>> UploadFileAsync(Stream file, string filename, FileUploadPurpose purpose, CancellationToken cancellationToken = default);
public virtual Task<ClientResult<OpenAIFile>> UploadFileAsync(string filePath, FileUploadPurpose purpose);
}
public sealed class OpenAIFileClientSettings : ClientSettings {
public OpenAIClientOptions Options { get; set; }
protected override void BindCore(Microsoft.Extensions.Configuration.IConfigurationSection section);
}
public class OpenAIFileCollection : ObjectModel.ReadOnlyCollection<OpenAIFile>, IJsonModel<OpenAIFileCollection>, IPersistableModel<OpenAIFileCollection> {
public static explicit operator OpenAIFileCollection(ClientResult result);
}
public static class OpenAIFilesModelFactory {
public static FileDeletionResult FileDeletionResult(string fileId = null, bool deleted = false);
public static OpenAIFileCollection OpenAIFileCollection(IEnumerable<OpenAIFile> items = null);
public static OpenAIFile OpenAIFileInfo(string id = null, int? sizeInBytes = null, DateTimeOffset createdAt = default, string filename = null, FilePurpose purpose = FilePurpose.Assistants, FileStatus status = FileStatus.Uploaded, string statusDetails = null, DateTimeOffset? expiresAt = null, long? sizeInBytesLong = null);
[EditorBrowsable(EditorBrowsableState.Never)]
public static OpenAIFile OpenAIFileInfo(string id, int? sizeInBytes, DateTimeOffset createdAt, string filename, FilePurpose purpose, FileStatus status, string statusDetails);
}
}
namespace OpenAI.FineTuning {
public class FineTuningCheckpoint : IJsonModel<FineTuningCheckpoint>, IPersistableModel<FineTuningCheckpoint> {
public DateTimeOffset CreatedAt { get; }
public string Id { get; }
public string JobId { get; }
public FineTuningCheckpointMetrics Metrics { get; }
public string ModelId { get; }
public int StepNumber { get; }
public override string ToString();
}
public class FineTuningCheckpointMetrics : IJsonModel<FineTuningCheckpointMetrics>, IPersistableModel<FineTuningCheckpointMetrics> {
public float? FullValidLoss { get; }
public float? FullValidMeanTokenAccuracy { get; }
public int StepNumber { get; }
public float? TrainLoss { get; }
public float? TrainMeanTokenAccuracy { get; }
public float? ValidLoss { get; }
public float? ValidMeanTokenAccuracy { get; }
}
public class FineTuningClient {
protected FineTuningClient();
public FineTuningClient(FineTuningClientSettings settings);
public FineTuningClient(ApiKeyCredential credential, OpenAIClientOptions options);
public FineTuningClient(ApiKeyCredential credential);
public FineTuningClient(AuthenticationPolicy authenticationPolicy, OpenAIClientOptions options);
public FineTuningClient(AuthenticationPolicy authenticationPolicy);
protected internal FineTuningClient(ClientPipeline pipeline, OpenAIClientOptions options);
protected internal FineTuningClient(ClientPipeline pipeline, Uri endpoint);
public FineTuningClient(string apiKey);
public Uri Endpoint { get; }
public ClientPipeline Pipeline { get; }
public virtual ClientResult CreateFineTuningCheckpointPermission(string fineTunedModelCheckpoint, BinaryContent content, RequestOptions options = null);
public virtual Task<ClientResult> CreateFineTuningCheckpointPermissionAsync(string fineTunedModelCheckpoint, BinaryContent content, RequestOptions options = null);
public virtual ClientResult DeleteFineTuningCheckpointPermission(string fineTunedModelCheckpoint, string permissionId, RequestOptions options);
public virtual Task<ClientResult> DeleteFineTuningCheckpointPermissionAsync(string fineTunedModelCheckpoint, string permissionId, RequestOptions options);
public virtual FineTuningJob FineTune(BinaryContent content, bool waitUntilCompleted, RequestOptions options);
public virtual FineTuningJob FineTune(string baseModel, string trainingFileId, bool waitUntilCompleted, FineTuningOptions options = null, CancellationToken cancellationToken = default);
public virtual Task<FineTuningJob> FineTuneAsync(BinaryContent content, bool waitUntilCompleted, RequestOptions options);
public virtual Task<FineTuningJob> FineTuneAsync(string baseModel, string trainingFileId, bool waitUntilCompleted, FineTuningOptions options = null, CancellationToken cancellationToken = default);
public virtual ClientResult GetFineTuningCheckpointPermissions(string fineTunedModelCheckpoint, string after, int? limit, string order, string projectId, RequestOptions options);
public virtual Task<ClientResult> GetFineTuningCheckpointPermissionsAsync(string fineTunedModelCheckpoint, string after, int? limit, string order, string projectId, RequestOptions options);
public virtual FineTuningJob GetJob(string jobId, CancellationToken cancellationToken = default);
public virtual Task<FineTuningJob> GetJobAsync(string jobId, CancellationToken cancellationToken = default);
public virtual CollectionResult<FineTuningJob> GetJobs(FineTuningJobCollectionOptions options = null, CancellationToken cancellationToken = default);
public virtual AsyncCollectionResult<FineTuningJob> GetJobsAsync(FineTuningJobCollectionOptions options = null, CancellationToken cancellationToken = default);
public virtual ClientResult PauseFineTuningJob(string fineTuningJobId, RequestOptions options);
public virtual Task<ClientResult> PauseFineTuningJobAsync(string fineTuningJobId, RequestOptions options);
public virtual ClientResult ResumeFineTuningJob(string fineTuningJobId, RequestOptions options);
public virtual Task<ClientResult> ResumeFineTuningJobAsync(string fineTuningJobId, RequestOptions options);
}
public sealed class FineTuningClientSettings : ClientSettings {
public OpenAIClientOptions Options { get; set; }
protected override void BindCore(Microsoft.Extensions.Configuration.IConfigurationSection section);
}
public class FineTuningError : IJsonModel<FineTuningError>, IPersistableModel<FineTuningError> {
public string Code { get; }
public string InvalidParameter { get; }
public string Message { get; }
}
public class FineTuningEvent : IJsonModel<FineTuningEvent>, IPersistableModel<FineTuningEvent> {
public string Level;
public DateTimeOffset CreatedAt { get; }
public BinaryData Data { get; }
public string Id { get; }
public FineTuningJobEventKind? Kind { get; }
public string Message { get; }
}
public readonly partial struct FineTuningHyperparameters : IJsonModel<FineTuningHyperparameters>, IPersistableModel<FineTuningHyperparameters>, IJsonModel<object>, IPersistableModel<object> {
public int BatchSize { get; }
public int EpochCount { get; }
public float LearningRateMultiplier { get; }
}
public class FineTuningIntegration : IJsonModel<FineTuningIntegration>, IPersistableModel<FineTuningIntegration> {
}
public class FineTuningJob : OperationResult {
public string? Value;
public string BaseModel { get; }
public int BillableTrainedTokenCount { get; }
public DateTimeOffset? EstimatedFinishAt { get; }
[Obsolete("This property is deprecated. Use the MethodHyperparameters property instead.")]
public FineTuningHyperparameters Hyperparameters { get; }
public IReadOnlyList<FineTuningIntegration> Integrations { get; }
public string JobId { get; }
public IDictionary<string, string> Metadata { get; }
public MethodHyperparameters? MethodHyperparameters { get; }
public override ContinuationToken? RehydrationToken { get; protected set; }
public IReadOnlyList<string> ResultFileIds { get; }
public int? Seed { get; }
public FineTuningStatus Status { get; }
public string TrainingFileId { get; }
public FineTuningTrainingMethod? TrainingMethod { get; }
public string? UserProvidedSuffix { get; }
public string ValidationFileId { get; }
public virtual ClientResult Cancel(RequestOptions options);
public virtual ClientResult CancelAndUpdate(CancellationToken cancellationToken = default);
public virtual Task<ClientResult> CancelAndUpdateAsync(CancellationToken cancellationToken = default);
public virtual Task<ClientResult> CancelAsync(RequestOptions options);
public virtual CollectionResult<FineTuningCheckpoint> GetCheckpoints(GetCheckpointsOptions? options = null, CancellationToken cancellationToken = default);
public virtual CollectionResult GetCheckpoints(string? after, int? limit, RequestOptions? options);
public virtual AsyncCollectionResult<FineTuningCheckpoint> GetCheckpointsAsync(GetCheckpointsOptions? options = null, CancellationToken cancellationToken = default);
public virtual AsyncCollectionResult GetCheckpointsAsync(string? after, int? limit, RequestOptions? options);
public virtual CollectionResult<FineTuningEvent> GetEvents(GetEventsOptions options, CancellationToken cancellationToken = default);
public virtual CollectionResult GetEvents(string? after, int? limit, RequestOptions options);
public virtual AsyncCollectionResult<FineTuningEvent> GetEventsAsync(GetEventsOptions options, CancellationToken cancellationToken = default);
public virtual AsyncCollectionResult GetEventsAsync(string? after, int? limit, RequestOptions options);
public static FineTuningJob Rehydrate(FineTuningClient client, ContinuationToken rehydrationToken, RequestOptions options);
public static FineTuningJob Rehydrate(FineTuningClient client, ContinuationToken rehydrationToken, CancellationToken cancellationToken = default);
public static FineTuningJob Rehydrate(FineTuningClient client, string JobId, RequestOptions options);
public static FineTuningJob Rehydrate(FineTuningClient client, string JobId, CancellationToken cancellationToken = default);
public static Task<FineTuningJob> RehydrateAsync(FineTuningClient client, ContinuationToken rehydrationToken, RequestOptions options);
public static Task<FineTuningJob> RehydrateAsync(FineTuningClient client, ContinuationToken rehydrationToken, CancellationToken cancellationToken = default);
public static Task<FineTuningJob> RehydrateAsync(FineTuningClient client, string JobId, RequestOptions options);
public static Task<FineTuningJob> RehydrateAsync(FineTuningClient client, string JobId, CancellationToken cancellationToken = default);
public override ClientResult UpdateStatus(RequestOptions? options);
public ClientResult UpdateStatus(CancellationToken cancellationToken = default);
public override ValueTask<ClientResult> UpdateStatusAsync(RequestOptions? options);
public ValueTask<ClientResult> UpdateStatusAsync(CancellationToken cancellationToken = default);
public override void WaitForCompletion(CancellationToken cancellationToken = default);
public override ValueTask WaitForCompletionAsync(CancellationToken cancellationToken = default);
}
public class FineTuningJobCollectionOptions {
public string AfterJobId { get; set; }
public int? PageSize { get; set; }
}
public readonly partial struct FineTuningJobEventKind : IEquatable<FineTuningJobEventKind> {
public FineTuningJobEventKind(string value);
public static FineTuningJobEventKind Message { get; }
public static FineTuningJobEventKind Metrics { get; }
public readonly bool Equals(FineTuningJobEventKind other);
[EditorBrowsable(EditorBrowsableState.Never)]
public override readonly bool Equals(object obj);
[EditorBrowsable(EditorBrowsableState.Never)]
public override readonly int GetHashCode();
public static bool operator ==(FineTuningJobEventKind left, FineTuningJobEventKind right);
public static implicit operator FineTuningJobEventKind(string value);
public static implicit operator FineTuningJobEventKind?(string value);
public static bool operator !=(FineTuningJobEventKind left, FineTuningJobEventKind right);
public override readonly string ToString();
}
public class FineTuningOptions : IJsonModel<FineTuningOptions>, IPersistableModel<FineTuningOptions> {
public IList<FineTuningIntegration> Integrations { get; }
public IDictionary<string, string> Metadata { get; }
public int? Seed { get; set; }
public string Suffix { get; set; }
public FineTuningTrainingMethod TrainingMethod { get; set; }
public string ValidationFile { get; set; }
}
public readonly partial struct FineTuningStatus : IEquatable<string>, IEquatable<FineTuningStatus> {
public FineTuningStatus(string value);
public static FineTuningStatus Cancelled { get; }
public static FineTuningStatus Failed { get; }
public bool InProgress { get; }
public static FineTuningStatus Queued { get; }
public static FineTuningStatus Running { get; }
public static FineTuningStatus Succeeded { get; }
public static FineTuningStatus ValidatingFiles { get; }
public readonly bool Equals(FineTuningStatus other);
[EditorBrowsable(EditorBrowsableState.Never)]
public override readonly bool Equals(object obj);
public readonly bool Equals(string other);
[EditorBrowsable(EditorBrowsableState.Never)]
public override readonly int GetHashCode();
public static bool operator ==(FineTuningStatus left, FineTuningStatus right);
public static implicit operator FineTuningStatus(string value);
public static implicit operator FineTuningStatus?(string value);
public static bool operator !=(FineTuningStatus left, FineTuningStatus right);
public override readonly string ToString();
}
public class FineTuningTrainingMethod : IJsonModel<FineTuningTrainingMethod>, IPersistableModel<FineTuningTrainingMethod> {
public static FineTuningTrainingMethod CreateDirectPreferenceOptimization(HyperparameterBatchSize batchSize = null, HyperparameterEpochCount epochCount = null, HyperparameterLearningRate learningRate = null, HyperparameterBetaFactor betaFactor = null);
public static FineTuningTrainingMethod CreateSupervised(HyperparameterBatchSize batchSize = null, HyperparameterEpochCount epochCount = null, HyperparameterLearningRate learningRate = null);
}
public class GetCheckpointsOptions {
public string AfterCheckpointId { get; set; }
public int? PageSize { get; set; }
}
public class GetEventsOptions {
public string AfterEventId { get; set; }
public int? PageSize { get; set; }
}
public class HyperparameterBatchSize : IEquatable<int>, IEquatable<string>, IJsonModel<HyperparameterBatchSize>, IPersistableModel<HyperparameterBatchSize> {
public HyperparameterBatchSize(int batchSize);
public static HyperparameterBatchSize CreateAuto();
public static HyperparameterBatchSize CreateSize(int batchSize);
[EditorBrowsable(EditorBrowsableState.Never)]
public bool Equals(int other);
[EditorBrowsable(EditorBrowsableState.Never)]
public override bool Equals(object other);
[EditorBrowsable(EditorBrowsableState.Never)]
public bool Equals(string other);
[EditorBrowsable(EditorBrowsableState.Never)]
public override int GetHashCode();
[EditorBrowsable(EditorBrowsableState.Never)]
public static bool operator ==(HyperparameterBatchSize first, HyperparameterBatchSize second);
public static implicit operator HyperparameterBatchSize(int batchSize);
[EditorBrowsable(EditorBrowsableState.Never)]
public static bool operator !=(HyperparameterBatchSize first, HyperparameterBatchSize second);
}
public class HyperparameterBetaFactor : IEquatable<int>, IEquatable<string>, IJsonModel<HyperparameterBetaFactor>, IPersistableModel<HyperparameterBetaFactor> {
public HyperparameterBetaFactor(int beta);
public static HyperparameterBetaFactor CreateAuto();
public static HyperparameterBetaFactor CreateBeta(int beta);
[EditorBrowsable(EditorBrowsableState.Never)]
public bool Equals(int other);
[EditorBrowsable(EditorBrowsableState.Never)]
public override bool Equals(object other);
[EditorBrowsable(EditorBrowsableState.Never)]
public bool Equals(string other);
[EditorBrowsable(EditorBrowsableState.Never)]
public override int GetHashCode();
[EditorBrowsable(EditorBrowsableState.Never)]
public static bool operator ==(HyperparameterBetaFactor first, HyperparameterBetaFactor second);
public static implicit operator HyperparameterBetaFactor(int beta);
[EditorBrowsable(EditorBrowsableState.Never)]
public static bool operator !=(HyperparameterBetaFactor first, HyperparameterBetaFactor second);
}
public class HyperparameterEpochCount : IEquatable<int>, IEquatable<string>, IJsonModel<HyperparameterEpochCount>, IPersistableModel<HyperparameterEpochCount> {
public HyperparameterEpochCount(int epochCount);
public static HyperparameterEpochCount CreateAuto();
public static HyperparameterEpochCount CreateEpochCount(int epochCount);
[EditorBrowsable(EditorBrowsableState.Never)]
public bool Equals(int other);
[EditorBrowsable(EditorBrowsableState.Never)]
public override bool Equals(object other);
[EditorBrowsable(EditorBrowsableState.Never)]
public bool Equals(string other);
[EditorBrowsable(EditorBrowsableState.Never)]
public override int GetHashCode();
[EditorBrowsable(EditorBrowsableState.Never)]
public static bool operator ==(HyperparameterEpochCount first, HyperparameterEpochCount second);
public static implicit operator HyperparameterEpochCount(int epochCount);
[EditorBrowsable(EditorBrowsableState.Never)]
public static bool operator !=(HyperparameterEpochCount first, HyperparameterEpochCount second);
}
public class HyperparameterLearningRate : IEquatable<double>, IEquatable<int>, IEquatable<string>, IJsonModel<HyperparameterLearningRate>, IPersistableModel<HyperparameterLearningRate> {
public HyperparameterLearningRate(double learningRateMultiplier);
public static HyperparameterLearningRate CreateAuto();
public static HyperparameterLearningRate CreateMultiplier(double learningRateMultiplier);
[EditorBrowsable(EditorBrowsableState.Never)]
public bool Equals(double other);
[EditorBrowsable(EditorBrowsableState.Never)]
public bool Equals(int other);
[EditorBrowsable(EditorBrowsableState.Never)]
public override bool Equals(object other);
[EditorBrowsable(EditorBrowsableState.Never)]
public bool Equals(string other);
[EditorBrowsable(EditorBrowsableState.Never)]
public override int GetHashCode();
[EditorBrowsable(EditorBrowsableState.Never)]
public static bool operator ==(HyperparameterLearningRate first, HyperparameterLearningRate second);
public static implicit operator HyperparameterLearningRate(double learningRateMultiplier);
[EditorBrowsable(EditorBrowsableState.Never)]
public static bool operator !=(HyperparameterLearningRate first, HyperparameterLearningRate second);
}
public class HyperparametersForDPO : MethodHyperparameters, IJsonModel<HyperparametersForDPO>, IPersistableModel<HyperparametersForDPO> {
public int BatchSize { get; }
public float Beta { get; }
public int EpochCount { get; }
public float LearningRateMultiplier { get; }
}
public class HyperparametersForSupervised : MethodHyperparameters, IJsonModel<HyperparametersForSupervised>, IPersistableModel<HyperparametersForSupervised> {
public int BatchSize { get; }
public int EpochCount { get; }
public float LearningRateMultiplier { get; }
}
public class MethodHyperparameters {
}
public class WeightsAndBiasesIntegration : FineTuningIntegration, IJsonModel<WeightsAndBiasesIntegration>, IPersistableModel<WeightsAndBiasesIntegration> {
public WeightsAndBiasesIntegration(string projectName);
public string DisplayName { get; set; }
public string EntityName { get; set; }
public string ProjectName { get; set; }
public IList<string> Tags { get; }
}
}
namespace OpenAI.Graders {
public class FineTuneReinforcementHyperparameters : IJsonModel<FineTuneReinforcementHyperparameters>, IPersistableModel<FineTuneReinforcementHyperparameters> {
public BinaryData BatchSize { get; set; }
public BinaryData ComputeMultiplier { get; set; }
public BinaryData EvalInterval { get; set; }
public BinaryData EvalSamples { get; set; }
public BinaryData LearningRateMultiplier { get; set; }
public BinaryData NEpochs { get; set; }
}
[PersistableModelProxy(typeof(UnknownGrader))]
public class Grader : IJsonModel<Grader>, IPersistableModel<Grader> {
}
public class GraderClient {
protected GraderClient();
public GraderClient(GraderClientSettings settings);
public GraderClient(ApiKeyCredential credential, OpenAIClientOptions options);
public GraderClient(ApiKeyCredential credential);
public GraderClient(AuthenticationPolicy authenticationPolicy, OpenAIClientOptions options);
public GraderClient(AuthenticationPolicy authenticationPolicy);
protected internal GraderClient(ClientPipeline pipeline, OpenAIClientOptions options);
public GraderClient(string apiKey);
public Uri Endpoint { get; }
public ClientPipeline Pipeline { get; }
public virtual ClientResult RunGrader(BinaryContent content, RequestOptions options = null);
public virtual Task<ClientResult> RunGraderAsync(BinaryContent content, RequestOptions options = null);
public virtual ClientResult ValidateGrader(BinaryContent content, RequestOptions options = null);
public virtual Task<ClientResult> ValidateGraderAsync(BinaryContent content, RequestOptions options = null);
}
public sealed class GraderClientSettings : ClientSettings {
public OpenAIClientOptions Options { get; set; }
protected override void BindCore(Microsoft.Extensions.Configuration.IConfigurationSection section);
}
public class GraderLabelModel : Grader, IJsonModel<GraderLabelModel>, IPersistableModel<GraderLabelModel> {
public IList<string> Labels { get; }
public string Model { get; set; }
public string Name { get; set; }
public IList<string> PassingLabels { get; }
}
public class GraderMulti : Grader, IJsonModel<GraderMulti>, IPersistableModel<GraderMulti> {
public GraderMulti(string name, BinaryData graders, string calculateOutput);
public string CalculateOutput { get; set; }
public BinaryData Graders { get; set; }
public string Name { get; set; }
}
public class GraderPython : Grader, IJsonModel<GraderPython>, IPersistableModel<GraderPython> {
public GraderPython(string name, string source);
public string ImageTag { get; set; }
public string Name { get; set; }
public string Source { get; set; }
}
public class GraderScoreModel : Grader, IJsonModel<GraderScoreModel>, IPersistableModel<GraderScoreModel> {
public string Model { get; set; }
public string Name { get; set; }
public IList<float> Range { get; }
public BinaryData SamplingParams { get; set; }
}
public class GraderStringCheck : Grader, IJsonModel<GraderStringCheck>, IPersistableModel<GraderStringCheck> {
public GraderStringCheck(string name, string input, string reference, GraderStringCheckOperation operation);
public string Input { get; set; }
public string Name { get; set; }
public GraderStringCheckOperation Operation { get; set; }
public string Reference { get; set; }
}
public readonly partial struct GraderStringCheckOperation : IEquatable<GraderStringCheckOperation> {
public GraderStringCheckOperation(string value);
public static GraderStringCheckOperation Eq { get; }
public static GraderStringCheckOperation Ilike { get; }
public static GraderStringCheckOperation Like { get; }
public static GraderStringCheckOperation Ne { get; }
public readonly bool Equals(GraderStringCheckOperation other);
[EditorBrowsable(EditorBrowsableState.Never)]
public override readonly bool Equals(object obj);
[EditorBrowsable(EditorBrowsableState.Never)]
public override readonly int GetHashCode();
public static bool operator ==(GraderStringCheckOperation left, GraderStringCheckOperation right);
public static implicit operator GraderStringCheckOperation(string value);
public static implicit operator GraderStringCheckOperation?(string value);
public static bool operator !=(GraderStringCheckOperation left, GraderStringCheckOperation right);
public override readonly string ToString();
}
public class GraderTextSimilarity : Grader, IJsonModel<GraderTextSimilarity>, IPersistableModel<GraderTextSimilarity> {
public GraderTextSimilarity(string name, string input, string reference, GraderTextSimilarityEvaluationMetric evaluationMetric);
public GraderTextSimilarityEvaluationMetric EvaluationMetric { get; set; }
public string Input { get; set; }
public string Name { get; set; }
public string Reference { get; set; }
}
public readonly partial struct GraderTextSimilarityEvaluationMetric : IEquatable<GraderTextSimilarityEvaluationMetric> {
public GraderTextSimilarityEvaluationMetric(string value);
public static GraderTextSimilarityEvaluationMetric Bleu { get; }
public static GraderTextSimilarityEvaluationMetric FuzzyMatch { get; }
public static GraderTextSimilarityEvaluationMetric Gleu { get; }
public static GraderTextSimilarityEvaluationMetric Meteor { get; }
public static GraderTextSimilarityEvaluationMetric Rouge1 { get; }
public static GraderTextSimilarityEvaluationMetric Rouge2 { get; }
public static GraderTextSimilarityEvaluationMetric Rouge3 { get; }
public static GraderTextSimilarityEvaluationMetric Rouge4 { get; }
public static GraderTextSimilarityEvaluationMetric Rouge5 { get; }
public static GraderTextSimilarityEvaluationMetric RougeL { get; }
public readonly bool Equals(GraderTextSimilarityEvaluationMetric other);
[EditorBrowsable(EditorBrowsableState.Never)]
public override readonly bool Equals(object obj);
[EditorBrowsable(EditorBrowsableState.Never)]
public override readonly int GetHashCode();
public static bool operator ==(GraderTextSimilarityEvaluationMetric left, GraderTextSimilarityEvaluationMetric right);
public static implicit operator GraderTextSimilarityEvaluationMetric(string value);
public static implicit operator GraderTextSimilarityEvaluationMetric?(string value);
public static bool operator !=(GraderTextSimilarityEvaluationMetric left, GraderTextSimilarityEvaluationMetric right);
public override readonly string ToString();
}
public readonly partial struct GraderType : IEquatable<GraderType> {
public GraderType(string value);
public static GraderType LabelModel { get; }
public static GraderType Multi { get; }
public static GraderType Python { get; }
public static GraderType ScoreModel { get; }
public static GraderType StringCheck { get; }
public static GraderType TextSimilarity { get; }
public readonly bool Equals(GraderType other);
[EditorBrowsable(EditorBrowsableState.Never)]
public override readonly bool Equals(object obj);
[EditorBrowsable(EditorBrowsableState.Never)]
public override readonly int GetHashCode();
public static bool operator ==(GraderType left, GraderType right);
public static implicit operator GraderType(string value);
public static implicit operator GraderType?(string value);
public static bool operator !=(GraderType left, GraderType right);
public override readonly string ToString();
}
public class RunGraderRequest : IJsonModel<RunGraderRequest>, IPersistableModel<RunGraderRequest> {
public BinaryData Grader { get; }
public BinaryData Item { get; }
public string ModelSample { get; }
}
public class RunGraderResponse : IJsonModel<RunGraderResponse>, IPersistableModel<RunGraderResponse> {
public RunGraderResponseMetadata Metadata { get; }
public BinaryData ModelGraderTokenUsagePerModel { get; }
public float Reward { get; }
public BinaryData SubRewards { get; }
public static explicit operator RunGraderResponse(ClientResult result);
}
public class RunGraderResponseMetadata : IJsonModel<RunGraderResponseMetadata>, IPersistableModel<RunGraderResponseMetadata> {
public RunGraderResponseMetadataErrors Errors { get; }
public float ExecutionTime { get; }
public string Kind { get; }
public string Name { get; }
public string SampledModelName { get; }
public BinaryData Scores { get; }
public int? TokenUsage { get; }
}
public class RunGraderResponseMetadataErrors : IJsonModel<RunGraderResponseMetadataErrors>, IPersistableModel<RunGraderResponseMetadataErrors> {
public bool FormulaParseError { get; }
public bool InvalidVariableError { get; }
public bool ModelGraderParseError { get; }
public bool ModelGraderRefusalError { get; }
public bool ModelGraderServerError { get; }
public string ModelGraderServerErrorDetails { get; }
public bool OtherError { get; }
public bool PythonGraderRuntimeError { get; }
public string PythonGraderRuntimeErrorDetails { get; }
public bool PythonGraderServerError { get; }
public string PythonGraderServerErrorType { get; }
public bool SampleParseError { get; }
public bool TruncatedObservationError { get; }
public bool UnresponsiveRewardError { get; }
}
public class UnknownGrader : Grader, IJsonModel<Grader>, IPersistableModel<Grader> {
}
public class ValidateGraderRequest : IJsonModel<ValidateGraderRequest>, IPersistableModel<ValidateGraderRequest> {
public BinaryData Grader { get; }
}
public class ValidateGraderResponse : IJsonModel<ValidateGraderResponse>, IPersistableModel<ValidateGraderResponse> {
public BinaryData Grader { get; }
public static explicit operator ValidateGraderResponse(ClientResult result);
}
}
namespace OpenAI.Images {
public class GeneratedImage : IJsonModel<GeneratedImage>, IPersistableModel<GeneratedImage> {
public BinaryData ImageBytes { get; }
public Uri ImageUri { get; }
public string RevisedPrompt { get; }
}
public readonly partial struct GeneratedImageBackground : IEquatable<GeneratedImageBackground> {
public GeneratedImageBackground(string value);
public static GeneratedImageBackground Auto { get; }
public static GeneratedImageBackground Opaque { get; }
public static GeneratedImageBackground Transparent { get; }
public readonly bool Equals(GeneratedImageBackground other);
[EditorBrowsable(EditorBrowsableState.Never)]
public override readonly bool Equals(object obj);
[EditorBrowsable(EditorBrowsableState.Never)]
public override readonly int GetHashCode();
public static bool operator ==(GeneratedImageBackground left, GeneratedImageBackground right);
public static implicit operator GeneratedImageBackground(string value);
public static implicit operator GeneratedImageBackground?(string value);
public static bool operator !=(GeneratedImageBackground left, GeneratedImageBackground right);
public override readonly string ToString();
}
public class GeneratedImageCollection : ObjectModel.ReadOnlyCollection<GeneratedImage>, IJsonModel<GeneratedImageCollection>, IPersistableModel<GeneratedImageCollection> {
public GeneratedImageBackground? Background { get; }
public DateTimeOffset CreatedAt { get; }
public GeneratedImageFileFormat? OutputFileFormat { get; }
public GeneratedImageQuality? Quality { get; }
public GeneratedImageSize? Size { get; }
public ImageTokenUsage Usage { get; }
public static explicit operator GeneratedImageCollection(ClientResult result);
}
public readonly partial struct GeneratedImageFileFormat : IEquatable<GeneratedImageFileFormat> {
public GeneratedImageFileFormat(string value);
public static GeneratedImageFileFormat Jpeg { get; }
public static GeneratedImageFileFormat Png { get; }
public static GeneratedImageFileFormat Webp { get; }
public readonly bool Equals(GeneratedImageFileFormat other);
[EditorBrowsable(EditorBrowsableState.Never)]
public override readonly bool Equals(object obj);
[EditorBrowsable(EditorBrowsableState.Never)]
public override readonly int GetHashCode();
public static bool operator ==(GeneratedImageFileFormat left, GeneratedImageFileFormat right);
public static implicit operator GeneratedImageFileFormat(string value);
public static implicit operator GeneratedImageFileFormat?(string value);
public static bool operator !=(GeneratedImageFileFormat left, GeneratedImageFileFormat right);
public override readonly string ToString();
}
public readonly partial struct GeneratedImageFormat : IEquatable<GeneratedImageFormat> {
public GeneratedImageFormat(string value);
public static GeneratedImageFormat Bytes { get; }
public static GeneratedImageFormat Uri { get; }
public readonly bool Equals(GeneratedImageFormat other);
[EditorBrowsable(EditorBrowsableState.Never)]
public override readonly bool Equals(object obj);
[EditorBrowsable(EditorBrowsableState.Never)]
public override readonly int GetHashCode();
public static bool operator ==(GeneratedImageFormat left, GeneratedImageFormat right);
public static implicit operator GeneratedImageFormat(string value);
public static implicit operator GeneratedImageFormat?(string value);
public static bool operator !=(GeneratedImageFormat left, GeneratedImageFormat right);
public override readonly string ToString();
}
public readonly partial struct GeneratedImageModerationLevel : IEquatable<GeneratedImageModerationLevel> {
public GeneratedImageModerationLevel(string value);
public static GeneratedImageModerationLevel Auto { get; }
public static GeneratedImageModerationLevel Low { get; }
public readonly bool Equals(GeneratedImageModerationLevel other);
[EditorBrowsable(EditorBrowsableState.Never)]
public override readonly bool Equals(object obj);
[EditorBrowsable(EditorBrowsableState.Never)]
public override readonly int GetHashCode();
public static bool operator ==(GeneratedImageModerationLevel left, GeneratedImageModerationLevel right);
public static implicit operator GeneratedImageModerationLevel(string value);
public static implicit operator GeneratedImageModerationLevel?(string value);
public static bool operator !=(GeneratedImageModerationLevel left, GeneratedImageModerationLevel right);
public override readonly string ToString();
}
public readonly partial struct GeneratedImageQuality : IEquatable<GeneratedImageQuality> {
public GeneratedImageQuality(string value);
public static GeneratedImageQuality Auto { get; }
public static GeneratedImageQuality High { get; }
public static GeneratedImageQuality HighQuality { get; }
public static GeneratedImageQuality LowQuality { get; }
public static GeneratedImageQuality MediumQuality { get; }
public static GeneratedImageQuality Standard { get; }
public readonly bool Equals(GeneratedImageQuality other);
[EditorBrowsable(EditorBrowsableState.Never)]
public override readonly bool Equals(object obj);
[EditorBrowsable(EditorBrowsableState.Never)]
public override readonly int GetHashCode();
public static bool operator ==(GeneratedImageQuality left, GeneratedImageQuality right);
public static implicit operator GeneratedImageQuality(string value);
public static implicit operator GeneratedImageQuality?(string value);
public static bool operator !=(GeneratedImageQuality left, GeneratedImageQuality right);
public override readonly string ToString();
}
public readonly partial struct GeneratedImageSize : IEquatable<GeneratedImageSize> {
public static readonly GeneratedImageSize W1024xH1024;
public static readonly GeneratedImageSize W1024xH1536;
public static readonly GeneratedImageSize W1024xH1792;
public static readonly GeneratedImageSize W1536xH1024;
public static readonly GeneratedImageSize W1792xH1024;
public static readonly GeneratedImageSize W256xH256;
public static readonly GeneratedImageSize W512xH512;
public GeneratedImageSize(int width, int height);
public static GeneratedImageSize Auto { get; }
public readonly bool Equals(GeneratedImageSize other);
[EditorBrowsable(EditorBrowsableState.Never)]
public override readonly bool Equals(object obj);
[EditorBrowsable(EditorBrowsableState.Never)]
public override readonly int GetHashCode();
public static bool operator ==(GeneratedImageSize left, GeneratedImageSize right);
public static bool operator !=(GeneratedImageSize left, GeneratedImageSize right);
public override readonly string ToString();
}
public readonly partial struct GeneratedImageStyle : IEquatable<GeneratedImageStyle> {
public GeneratedImageStyle(string value);
public static GeneratedImageStyle Natural { get; }
public static GeneratedImageStyle Vivid { get; }
public readonly bool Equals(GeneratedImageStyle other);
[EditorBrowsable(EditorBrowsableState.Never)]
public override readonly bool Equals(object obj);
[EditorBrowsable(EditorBrowsableState.Never)]
public override readonly int GetHashCode();
public static bool operator ==(GeneratedImageStyle left, GeneratedImageStyle right);
public static implicit operator GeneratedImageStyle(string value);
public static implicit operator GeneratedImageStyle?(string value);
public static bool operator !=(GeneratedImageStyle left, GeneratedImageStyle right);
public override readonly string ToString();
}
public class ImageClient {
protected ImageClient();
public ImageClient(ImageClientSettings settings);
protected internal ImageClient(ClientPipeline pipeline, string model, OpenAIClientOptions options);
public ImageClient(string model, ApiKeyCredential credential, OpenAIClientOptions options);
public ImageClient(string model, ApiKeyCredential credential);
public ImageClient(string model, AuthenticationPolicy authenticationPolicy, OpenAIClientOptions options);
public ImageClient(string model, AuthenticationPolicy authenticationPolicy);
public ImageClient(string model, string apiKey);
public Uri Endpoint { get; }
public string Model { get; }
public ClientPipeline Pipeline { get; }
public virtual ClientResult<GeneratedImage> GenerateImage(string prompt, ImageGenerationOptions options = null, CancellationToken cancellationToken = default);
public virtual Task<ClientResult<GeneratedImage>> GenerateImageAsync(string prompt, ImageGenerationOptions options = null, CancellationToken cancellationToken = default);
public virtual ClientResult<GeneratedImage> GenerateImageEdit(Stream image, string imageFilename, string prompt, ImageEditOptions options = null, CancellationToken cancellationToken = default);
public virtual ClientResult<GeneratedImage> GenerateImageEdit(Stream image, string imageFilename, string prompt, Stream mask, string maskFilename, ImageEditOptions options = null, CancellationToken cancellationToken = default);
public virtual ClientResult<GeneratedImage> GenerateImageEdit(string imageFilePath, string prompt, ImageEditOptions options = null);
public virtual ClientResult<GeneratedImage> GenerateImageEdit(string imageFilePath, string prompt, string maskFilePath, ImageEditOptions options = null);
public virtual Task<ClientResult<GeneratedImage>> GenerateImageEditAsync(Stream image, string imageFilename, string prompt, ImageEditOptions options = null, CancellationToken cancellationToken = default);
public virtual Task<ClientResult<GeneratedImage>> GenerateImageEditAsync(Stream image, string imageFilename, string prompt, Stream mask, string maskFilename, ImageEditOptions options = null, CancellationToken cancellationToken = default);
public virtual Task<ClientResult<GeneratedImage>> GenerateImageEditAsync(string imageFilePath, string prompt, ImageEditOptions options = null);
public virtual Task<ClientResult<GeneratedImage>> GenerateImageEditAsync(string imageFilePath, string prompt, string maskFilePath, ImageEditOptions options = null);
public virtual ClientResult GenerateImageEdits(BinaryContent content, string contentType, RequestOptions options = null);
public virtual ClientResult<GeneratedImageCollection> GenerateImageEdits(Stream image, string imageFilename, string prompt, int imageCount, ImageEditOptions options = null, CancellationToken cancellationToken = default);
public virtual ClientResult<GeneratedImageCollection> GenerateImageEdits(Stream image, string imageFilename, string prompt, Stream mask, string maskFilename, int imageCount, ImageEditOptions options = null, CancellationToken cancellationToken = default);
public virtual ClientResult<GeneratedImageCollection> GenerateImageEdits(string imageFilePath, string prompt, int imageCount, ImageEditOptions options = null);
public virtual ClientResult<GeneratedImageCollection> GenerateImageEdits(string imageFilePath, string prompt, string maskFilePath, int imageCount, ImageEditOptions options = null);
public virtual Task<ClientResult> GenerateImageEditsAsync(BinaryContent content, string contentType, RequestOptions options = null);
public virtual Task<ClientResult<GeneratedImageCollection>> GenerateImageEditsAsync(Stream image, string imageFilename, string prompt, int imageCount, ImageEditOptions options = null, CancellationToken cancellationToken = default);
public virtual Task<ClientResult<GeneratedImageCollection>> GenerateImageEditsAsync(Stream image, string imageFilename, string prompt, Stream mask, string maskFilename, int imageCount, ImageEditOptions options = null, CancellationToken cancellationToken = default);
public virtual Task<ClientResult<GeneratedImageCollection>> GenerateImageEditsAsync(string imageFilePath, string prompt, int imageCount, ImageEditOptions options = null);
public virtual Task<ClientResult<GeneratedImageCollection>> GenerateImageEditsAsync(string imageFilePath, string prompt, string maskFilePath, int imageCount, ImageEditOptions options = null);
public virtual ClientResult GenerateImages(BinaryContent content, RequestOptions options = null);
public virtual ClientResult<GeneratedImageCollection> GenerateImages(string prompt, int imageCount, ImageGenerationOptions options = null, CancellationToken cancellationToken = default);
public virtual Task<ClientResult> GenerateImagesAsync(BinaryContent content, RequestOptions options = null);
public virtual Task<ClientResult<GeneratedImageCollection>> GenerateImagesAsync(string prompt, int imageCount, ImageGenerationOptions options = null, CancellationToken cancellationToken = default);
public virtual ClientResult<GeneratedImage> GenerateImageVariation(Stream image, string imageFilename, ImageVariationOptions options = null, CancellationToken cancellationToken = default);
public virtual ClientResult<GeneratedImage> GenerateImageVariation(string imageFilePath, ImageVariationOptions options = null);
public virtual Task<ClientResult<GeneratedImage>> GenerateImageVariationAsync(Stream image, string imageFilename, ImageVariationOptions options = null, CancellationToken cancellationToken = default);
public virtual Task<ClientResult<GeneratedImage>> GenerateImageVariationAsync(string imageFilePath, ImageVariationOptions options = null);
public virtual ClientResult GenerateImageVariations(BinaryContent content, string contentType, RequestOptions options = null);
public virtual ClientResult<GeneratedImageCollection> GenerateImageVariations(Stream image, string imageFilename, int imageCount, ImageVariationOptions options = null, CancellationToken cancellationToken = default);
public virtual ClientResult<GeneratedImageCollection> GenerateImageVariations(string imageFilePath, int imageCount, ImageVariationOptions options = null);
public virtual Task<ClientResult> GenerateImageVariationsAsync(BinaryContent content, string contentType, RequestOptions options = null);
public virtual Task<ClientResult<GeneratedImageCollection>> GenerateImageVariationsAsync(Stream image, string imageFilename, int imageCount, ImageVariationOptions options = null, CancellationToken cancellationToken = default);
public virtual Task<ClientResult<GeneratedImageCollection>> GenerateImageVariationsAsync(string imageFilePath, int imageCount, ImageVariationOptions options = null);
}
public sealed class ImageClientSettings : ClientSettings {
public string Model { get; set; }
public OpenAIClientOptions Options { get; set; }
protected override void BindCore(Microsoft.Extensions.Configuration.IConfigurationSection section);
}
public class ImageEditOptions : IJsonModel<ImageEditOptions>, IPersistableModel<ImageEditOptions> {
public GeneratedImageBackground? Background { get; set; }
public string EndUserId { get; set; }
public ImageInputFidelity? InputFidelity { get; set; }
public int? OutputCompressionFactor { get; set; }
public GeneratedImageFileFormat? OutputFileFormat { get; set; }
public GeneratedImageQuality? Quality { get; set; }
public GeneratedImageFormat? ResponseFormat { get; set; }
public GeneratedImageSize? Size { get; set; }
}
public class ImageGenerationOptions : IJsonModel<ImageGenerationOptions>, IPersistableModel<ImageGenerationOptions> {
public GeneratedImageBackground? Background { get; set; }
public string EndUserId { get; set; }
public GeneratedImageModerationLevel? ModerationLevel { get; set; }
public int? OutputCompressionFactor { get; set; }
public GeneratedImageFileFormat? OutputFileFormat { get; set; }
public GeneratedImageQuality? Quality { get; set; }
public GeneratedImageFormat? ResponseFormat { get; set; }
public GeneratedImageSize? Size { get; set; }
public GeneratedImageStyle? Style { get; set; }
}
public readonly partial struct ImageInputFidelity : IEquatable<ImageInputFidelity> {
public ImageInputFidelity(string value);
public static ImageInputFidelity High { get; }
public static ImageInputFidelity Low { get; }
public readonly bool Equals(ImageInputFidelity other);
[EditorBrowsable(EditorBrowsableState.Never)]
public override readonly bool Equals(object obj);
[EditorBrowsable(EditorBrowsableState.Never)]
public override readonly int GetHashCode();
public static bool operator ==(ImageInputFidelity left, ImageInputFidelity right);
public static implicit operator ImageInputFidelity(string value);
public static implicit operator ImageInputFidelity?(string value);
public static bool operator !=(ImageInputFidelity left, ImageInputFidelity right);
public override readonly string ToString();
}
public class ImageInputTokenUsageDetails : IJsonModel<ImageInputTokenUsageDetails>, IPersistableModel<ImageInputTokenUsageDetails> {
public long ImageTokenCount { get; }
public long TextTokenCount { get; }
}
public class ImageOutputTokenUsageDetails : IJsonModel<ImageOutputTokenUsageDetails>, IPersistableModel<ImageOutputTokenUsageDetails> {
public long ImageTokenCount { get; }
public long TextTokenCount { get; }
}
public class ImageTokenUsage : IJsonModel<ImageTokenUsage>, IPersistableModel<ImageTokenUsage> {
public long InputTokenCount { get; }
public ImageInputTokenUsageDetails InputTokenDetails { get; }
public long OutputTokenCount { get; }
public ImageOutputTokenUsageDetails OutputTokenDetails { get; }
public long TotalTokenCount { get; }
}
public class ImageVariationOptions : IJsonModel<ImageVariationOptions>, IPersistableModel<ImageVariationOptions> {
public string EndUserId { get; set; }
public GeneratedImageFormat? ResponseFormat { get; set; }
public GeneratedImageSize? Size { get; set; }
}
public static class OpenAIImagesModelFactory {
public static GeneratedImage GeneratedImage(BinaryData imageBytes = null, Uri imageUri = null, string revisedPrompt = null);
public static GeneratedImageCollection GeneratedImageCollection(DateTimeOffset createdAt = default, IEnumerable<GeneratedImage> items = null, GeneratedImageBackground? background = null, GeneratedImageFileFormat? outputFileFormat = null, GeneratedImageSize? size = null, GeneratedImageQuality? quality = null, ImageTokenUsage usage = null);
[EditorBrowsable(EditorBrowsableState.Never)]
public static GeneratedImageCollection GeneratedImageCollection(DateTimeOffset createdAt, IEnumerable<GeneratedImage> items);
public static ImageInputTokenUsageDetails ImageInputTokenUsageDetails(long textTokenCount = 0, long imageTokenCount = 0);
public static ImageTokenUsage ImageTokenUsage(long inputTokenCount = 0, long outputTokenCount = 0, long totalTokenCount = 0, ImageInputTokenUsageDetails inputTokenDetails = null, ImageOutputTokenUsageDetails outputTokenDetails = null);
}
}
namespace OpenAI.Models {
public class ModelDeletionResult : IJsonModel<ModelDeletionResult>, IPersistableModel<ModelDeletionResult> {
public bool Deleted { get; }
public string ModelId { get; }
public static explicit operator ModelDeletionResult(ClientResult result);
}
public class OpenAIModel : IJsonModel<OpenAIModel>, IPersistableModel<OpenAIModel> {
public DateTimeOffset CreatedAt { get; }
public string Id { get; }
public string OwnedBy { get; }
public static explicit operator OpenAIModel(ClientResult result);
}
public class OpenAIModelClient {
protected OpenAIModelClient();
public OpenAIModelClient(OpenAIModelClientSettings settings);
public OpenAIModelClient(ApiKeyCredential credential, OpenAIClientOptions options);
public OpenAIModelClient(ApiKeyCredential credential);
public OpenAIModelClient(AuthenticationPolicy authenticationPolicy, OpenAIClientOptions options);
public OpenAIModelClient(AuthenticationPolicy authenticationPolicy);
protected internal OpenAIModelClient(ClientPipeline pipeline, OpenAIClientOptions options);
public OpenAIModelClient(string apiKey);
public Uri Endpoint { get; }
public ClientPipeline Pipeline { get; }
public virtual ClientResult DeleteModel(string model, RequestOptions options);
public virtual ClientResult<ModelDeletionResult> DeleteModel(string model, CancellationToken cancellationToken = default);
public virtual Task<ClientResult> DeleteModelAsync(string model, RequestOptions options);
public virtual Task<ClientResult<ModelDeletionResult>> DeleteModelAsync(string model, CancellationToken cancellationToken = default);
public virtual ClientResult GetModel(string model, RequestOptions options);
public virtual ClientResult<OpenAIModel> GetModel(string model, CancellationToken cancellationToken = default);
public virtual Task<ClientResult> GetModelAsync(string model, RequestOptions options);
public virtual Task<ClientResult<OpenAIModel>> GetModelAsync(string model, CancellationToken cancellationToken = default);
public virtual ClientResult GetModels(RequestOptions options);
public virtual ClientResult<OpenAIModelCollection> GetModels(CancellationToken cancellationToken = default);
public virtual Task<ClientResult> GetModelsAsync(RequestOptions options);
public virtual Task<ClientResult<OpenAIModelCollection>> GetModelsAsync(CancellationToken cancellationToken = default);
}
public sealed class OpenAIModelClientSettings : ClientSettings {
public OpenAIClientOptions Options { get; set; }
protected override void BindCore(Microsoft.Extensions.Configuration.IConfigurationSection section);
}
public class OpenAIModelCollection : ObjectModel.ReadOnlyCollection<OpenAIModel>, IJsonModel<OpenAIModelCollection>, IPersistableModel<OpenAIModelCollection> {
public static explicit operator OpenAIModelCollection(ClientResult result);
}
public static class OpenAIModelsModelFactory {
public static ModelDeletionResult ModelDeletionResult(string modelId = null, bool deleted = false);
public static OpenAIModel OpenAIModel(string id = null, DateTimeOffset createdAt = default, string ownedBy = null);
public static OpenAIModelCollection OpenAIModelCollection(IEnumerable<OpenAIModel> items = null);
}
}
namespace OpenAI.Moderations {
[Flags]
public enum ModerationApplicableInputKinds {
None = 0,
Other = 1,
Text = 2,
Image = 4
}
public class ModerationCategory {
public ModerationApplicableInputKinds ApplicableInputKinds { get; }
public bool Flagged { get; }
public float Score { get; }
}
public class ModerationClient {
protected ModerationClient();
public ModerationClient(ModerationClientSettings settings);
protected internal ModerationClient(ClientPipeline pipeline, string model, OpenAIClientOptions options);
public ModerationClient(string model, ApiKeyCredential credential, OpenAIClientOptions options);
public ModerationClient(string model, ApiKeyCredential credential);
public ModerationClient(string model, AuthenticationPolicy authenticationPolicy, OpenAIClientOptions options);
public ModerationClient(string model, AuthenticationPolicy authenticationPolicy);
public ModerationClient(string model, string apiKey);
public Uri Endpoint { get; }
public string Model { get; }
public ClientPipeline Pipeline { get; }
public virtual ClientResult ClassifyInputs(BinaryContent content, RequestOptions options = null);
public virtual ClientResult<ModerationResult> ClassifyInputs(IEnumerable<ModerationInputPart> inputParts, CancellationToken cancellationToken = default);
public virtual Task<ClientResult> ClassifyInputsAsync(BinaryContent content, RequestOptions options = null);
public virtual Task<ClientResult<ModerationResult>> ClassifyInputsAsync(IEnumerable<ModerationInputPart> inputParts, CancellationToken cancellationToken = default);
public virtual ClientResult ClassifyText(BinaryContent content, RequestOptions options = null);
public virtual ClientResult<ModerationResultCollection> ClassifyText(IEnumerable<string> inputs, CancellationToken cancellationToken = default);
public virtual ClientResult<ModerationResult> ClassifyText(string input, CancellationToken cancellationToken = default);
public virtual Task<ClientResult> ClassifyTextAsync(BinaryContent content, RequestOptions options = null);
public virtual Task<ClientResult<ModerationResultCollection>> ClassifyTextAsync(IEnumerable<string> inputs, CancellationToken cancellationToken = default);
public virtual Task<ClientResult<ModerationResult>> ClassifyTextAsync(string input, CancellationToken cancellationToken = default);
}
public sealed class ModerationClientSettings : ClientSettings {
public string Model { get; set; }
public OpenAIClientOptions Options { get; set; }
protected override void BindCore(Microsoft.Extensions.Configuration.IConfigurationSection section);
}
public class ModerationInputPart : IJsonModel<ModerationInputPart>, IPersistableModel<ModerationInputPart> {
public Uri ImageUri { get; }
public ModerationInputPartKind Kind { get; }
public string Text { get; }
public static ModerationInputPart CreateImagePart(Uri imageUri);
public static ModerationInputPart CreateTextPart(string text);
}
public enum ModerationInputPartKind {
Text = 0,
Image = 1
}
public class ModerationResult : IJsonModel<ModerationResult>, IPersistableModel<ModerationResult> {
public bool Flagged { get; }
public ModerationCategory Harassment { get; }
public ModerationCategory HarassmentThreatening { get; }
public ModerationCategory Hate { get; }
public ModerationCategory HateThreatening { get; }
public ModerationCategory Illicit { get; }
public ModerationCategory IllicitViolent { get; }
public ModerationCategory SelfHarm { get; }
public ModerationCategory SelfHarmInstructions { get; }
public ModerationCategory SelfHarmIntent { get; }
public ModerationCategory Sexual { get; }
public ModerationCategory SexualMinors { get; }
public ModerationCategory Violence { get; }
public ModerationCategory ViolenceGraphic { get; }
}
public class ModerationResultCollection : ObjectModel.ReadOnlyCollection<ModerationResult>, IJsonModel<ModerationResultCollection>, IPersistableModel<ModerationResultCollection> {
public string Id { get; }
public string Model { get; }
public static explicit operator ModerationResultCollection(ClientResult result);
}
public static class OpenAIModerationsModelFactory {
public static ModerationCategory ModerationCategory(bool flagged = false, float score = 0);
public static ModerationResult ModerationResult(bool flagged = false, ModerationCategory hate = null, ModerationCategory hateThreatening = null, ModerationCategory harassment = null, ModerationCategory harassmentThreatening = null, ModerationCategory selfHarm = null, ModerationCategory selfHarmIntent = null, ModerationCategory selfHarmInstructions = null, ModerationCategory sexual = null, ModerationCategory sexualMinors = null, ModerationCategory violence = null, ModerationCategory violenceGraphic = null, ModerationCategory illicit = null, ModerationCategory illicitViolent = null);
[EditorBrowsable(EditorBrowsableState.Never)]
public static ModerationResult ModerationResult(bool flagged, ModerationCategory hate, ModerationCategory hateThreatening, ModerationCategory harassment, ModerationCategory harassmentThreatening, ModerationCategory selfHarm, ModerationCategory selfHarmIntent, ModerationCategory selfHarmInstructions, ModerationCategory sexual, ModerationCategory sexualMinors, ModerationCategory violence, ModerationCategory violenceGraphic);
public static ModerationResultCollection ModerationResultCollection(string id = null, string model = null, IEnumerable<ModerationResult> items = null);
}
}
namespace OpenAI.Realtime {
public class CreateClientSecretOptions : IJsonModel<CreateClientSecretOptions>, IPersistableModel<CreateClientSecretOptions> {
public RealtimeClientSecretExpirationPolicy ExpirationPolicy { get; set; }
[Serialization.JsonIgnore]
[EditorBrowsable(EditorBrowsableState.Never)]
public ref JsonPatch Patch { get; }
public RealtimeSessionOptions SessionOptions { get; set; }
public static implicit operator BinaryContent(CreateClientSecretOptions createClientSecretOptions);
}
public class CreateClientSecretResult : IJsonModel<CreateClientSecretResult>, IPersistableModel<CreateClientSecretResult> {
public DateTimeOffset ExpiresAt { get; }
[Serialization.JsonIgnore]
[EditorBrowsable(EditorBrowsableState.Never)]
public ref JsonPatch Patch { get; }
public RealtimeSession Session { get; }
public string Value { get; }
public static explicit operator CreateClientSecretResult(ClientResult result);
}
public class RealtimeAudioFormat : IJsonModel<RealtimeAudioFormat>, IPersistableModel<RealtimeAudioFormat> {
[Serialization.JsonIgnore]
[EditorBrowsable(EditorBrowsableState.Never)]
public ref JsonPatch Patch { get; }
}
public class RealtimeAudioTranscriptionOptions : IJsonModel<RealtimeAudioTranscriptionOptions>, IPersistableModel<RealtimeAudioTranscriptionOptions> {
public string Language { get; set; }
public string Model { get; set; }
[Serialization.JsonIgnore]
[EditorBrowsable(EditorBrowsableState.Never)]
public ref JsonPatch Patch { get; }
public string Prompt { get; set; }
}
public class RealtimeClient {
protected RealtimeClient();
public RealtimeClient(RealtimeClientSettings settings);
public RealtimeClient(ApiKeyCredential credential, RealtimeClientOptions options);
public RealtimeClient(ApiKeyCredential credential);
public RealtimeClient(AuthenticationPolicy authenticationPolicy, RealtimeClientOptions options);
public RealtimeClient(AuthenticationPolicy authenticationPolicy);
protected internal RealtimeClient(ClientPipeline pipeline, RealtimeClientOptions options);
public RealtimeClient(string apiKey);
public Uri Endpoint { get; }
public ClientPipeline Pipeline { get; }
public event EventHandler<BinaryData> OnReceivingCommand {
add;
remove;
}
public event EventHandler<BinaryData> OnSendingCommand {
add;
remove;
}
public virtual ClientResult<CreateClientSecretResult> CreateRealtimeClientSecret(CreateClientSecretOptions options, CancellationToken cancellationToken = default);
public virtual ClientResult CreateRealtimeClientSecret(BinaryContent content, RequestOptions options = null);
public virtual Task<ClientResult<CreateClientSecretResult>> CreateRealtimeClientSecretAsync(CreateClientSecretOptions options, CancellationToken cancellationToken = default);
public virtual Task<ClientResult> CreateRealtimeClientSecretAsync(BinaryContent content, RequestOptions options = null);
public virtual RealtimeSessionClient StartConversationSession(string model, RealtimeSessionClientOptions options = null, CancellationToken cancellationToken = default);
public virtual Task<RealtimeSessionClient> StartConversationSessionAsync(string model, RealtimeSessionClientOptions options = null, CancellationToken cancellationToken = default);
public virtual RealtimeSessionClient StartSession(string model, string intent, RealtimeSessionClientOptions options = null, CancellationToken cancellationToken = default);
public virtual Task<RealtimeSessionClient> StartSessionAsync(string model, string intent, RealtimeSessionClientOptions options = null, CancellationToken cancellationToken = default);
public virtual RealtimeSessionClient StartTranscriptionSession(RealtimeSessionClientOptions options = null, CancellationToken cancellationToken = default);
public virtual Task<RealtimeSessionClient> StartTranscriptionSessionAsync(RealtimeSessionClientOptions options = null, CancellationToken cancellationToken = default);
}
public class RealtimeClientCommand : IJsonModel<RealtimeClientCommand>, IPersistableModel<RealtimeClientCommand> {
[Serialization.JsonIgnore]
[EditorBrowsable(EditorBrowsableState.Never)]
public ref JsonPatch Patch { get; }
}
public class RealtimeClientCommandConversationItemCreate : RealtimeClientCommand, IJsonModel<RealtimeClientCommandConversationItemCreate>, IPersistableModel<RealtimeClientCommandConversationItemCreate> {
public RealtimeClientCommandConversationItemCreate(RealtimeItem item);
public string EventId { get; set; }
public RealtimeItem Item { get; }
public string PreviousItemId { get; set; }
}
public class RealtimeClientCommandConversationItemDelete : RealtimeClientCommand, IJsonModel<RealtimeClientCommandConversationItemDelete>, IPersistableModel<RealtimeClientCommandConversationItemDelete> {
public RealtimeClientCommandConversationItemDelete(string itemId);
public string EventId { get; set; }
public string ItemId { get; }
}
public class RealtimeClientCommandConversationItemRetrieve : RealtimeClientCommand, IJsonModel<RealtimeClientCommandConversationItemRetrieve>, IPersistableModel<RealtimeClientCommandConversationItemRetrieve> {
public RealtimeClientCommandConversationItemRetrieve(string itemId);
public string EventId { get; set; }
public string ItemId { get; }
}
public class RealtimeClientCommandConversationItemTruncate : RealtimeClientCommand, IJsonModel<RealtimeClientCommandConversationItemTruncate>, IPersistableModel<RealtimeClientCommandConversationItemTruncate> {
public RealtimeClientCommandConversationItemTruncate(string itemId, int contentIndex, TimeSpan audioEndTime);
public TimeSpan AudioEndTime { get; }
public int ContentIndex { get; }
public string EventId { get; set; }
public string ItemId { get; }
}
public class RealtimeClientCommandInputAudioBufferAppend : RealtimeClientCommand, IJsonModel<RealtimeClientCommandInputAudioBufferAppend>, IPersistableModel<RealtimeClientCommandInputAudioBufferAppend> {
public RealtimeClientCommandInputAudioBufferAppend(BinaryData audioBytes);
public BinaryData AudioBytes { get; }
public string EventId { get; set; }
}
public class RealtimeClientCommandInputAudioBufferClear : RealtimeClientCommand, IJsonModel<RealtimeClientCommandInputAudioBufferClear>, IPersistableModel<RealtimeClientCommandInputAudioBufferClear> {
public RealtimeClientCommandInputAudioBufferClear();
public string EventId { get; set; }
}
public class RealtimeClientCommandInputAudioBufferCommit : RealtimeClientCommand, IJsonModel<RealtimeClientCommandInputAudioBufferCommit>, IPersistableModel<RealtimeClientCommandInputAudioBufferCommit> {
public RealtimeClientCommandInputAudioBufferCommit();
public string EventId { get; set; }
}
public class RealtimeClientCommandOutputAudioBufferClear : RealtimeClientCommand, IJsonModel<RealtimeClientCommandOutputAudioBufferClear>, IPersistableModel<RealtimeClientCommandOutputAudioBufferClear> {
public RealtimeClientCommandOutputAudioBufferClear();
public string EventId { get; set; }
}
public class RealtimeClientCommandResponseCancel : RealtimeClientCommand, IJsonModel<RealtimeClientCommandResponseCancel>, IPersistableModel<RealtimeClientCommandResponseCancel> {
public RealtimeClientCommandResponseCancel();
public string EventId { get; set; }
public string ResponseId { get; set; }
}
public class RealtimeClientCommandResponseCreate : RealtimeClientCommand, IJsonModel<RealtimeClientCommandResponseCreate>, IPersistableModel<RealtimeClientCommandResponseCreate> {
public RealtimeClientCommandResponseCreate();
public string EventId { get; set; }
public RealtimeResponseOptions ResponseOptions { get; set; }
}
public class RealtimeClientCommandSessionUpdate : RealtimeClientCommand, IJsonModel<RealtimeClientCommandSessionUpdate>, IPersistableModel<RealtimeClientCommandSessionUpdate> {
public RealtimeClientCommandSessionUpdate(RealtimeSessionOptions sessionOptions);
public string EventId { get; set; }
public RealtimeSessionOptions SessionOptions { get; }
}
public class RealtimeClientOptions : ClientPipelineOptions {
public Uri Endpoint { get; set; }
public string OrganizationId { get; set; }
public string ProjectId { get; set; }
public string UserAgentApplicationId { get; set; }
}
public class RealtimeClientSecret : IJsonModel<RealtimeClientSecret>, IPersistableModel<RealtimeClientSecret> {
public DateTimeOffset ExpiresAt { get; }
[Serialization.JsonIgnore]
[EditorBrowsable(EditorBrowsableState.Never)]
public ref JsonPatch Patch { get; }
public string Value { get; }
}
public readonly partial struct RealtimeClientSecretExpirationAnchor : IEquatable<RealtimeClientSecretExpirationAnchor> {
public RealtimeClientSecretExpirationAnchor(string value);
public static RealtimeClientSecretExpirationAnchor CreatedAt { get; }
public readonly bool Equals(RealtimeClientSecretExpirationAnchor other);
[EditorBrowsable(EditorBrowsableState.Never)]
public override readonly bool Equals(object obj);
[EditorBrowsable(EditorBrowsableState.Never)]
public override readonly int GetHashCode();
public static bool operator ==(RealtimeClientSecretExpirationAnchor left, RealtimeClientSecretExpirationAnchor right);
public static implicit operator RealtimeClientSecretExpirationAnchor(string value);
public static implicit operator RealtimeClientSecretExpirationAnchor?(string value);
public static bool operator !=(RealtimeClientSecretExpirationAnchor left, RealtimeClientSecretExpirationAnchor right);
public override readonly string ToString();
}
public class RealtimeClientSecretExpirationPolicy : IJsonModel<RealtimeClientSecretExpirationPolicy>, IPersistableModel<RealtimeClientSecretExpirationPolicy> {
public RealtimeClientSecretExpirationAnchor? Anchor { get; set; }
[Serialization.JsonIgnore]
[EditorBrowsable(EditorBrowsableState.Never)]
public ref JsonPatch Patch { get; }
public int? Seconds { get; set; }
}
public sealed class RealtimeClientSettings : ClientSettings {
public RealtimeClientOptions Options { get; set; }
protected override void BindCore(Microsoft.Extensions.Configuration.IConfigurationSection section);
}
public class RealtimeConversation : IJsonModel<RealtimeConversation>, IPersistableModel<RealtimeConversation> {
public string Id { get; }
[Serialization.JsonIgnore]
[EditorBrowsable(EditorBrowsableState.Never)]
public ref JsonPatch Patch { get; }
}
public class RealtimeConversationSession : RealtimeSession, IJsonModel<RealtimeConversationSession>, IPersistableModel<RealtimeConversationSession> {
public RealtimeConversationSessionAudioOptions AudioOptions { get; set; }
public RealtimeClientSecret ClientSecret { get; }
public IList<RealtimeIncludedProperty> IncludedProperties { get; }
public string Instructions { get; }
public RealtimeMaxOutputTokenCount MaxOutputTokenCount { get; set; }
public string Model { get; set; }
public IList<RealtimeOutputModality> OutputModalities { get; }
public RealtimeToolChoice ToolChoice { get; set; }
public IList<RealtimeTool> Tools { get; }
public RealtimeTracing Tracing { get; set; }
public RealtimeTruncation Truncation { get; set; }
}
public class RealtimeConversationSessionAudioOptions : IJsonModel<RealtimeConversationSessionAudioOptions>, IPersistableModel<RealtimeConversationSessionAudioOptions> {
public RealtimeConversationSessionInputAudioOptions InputAudioOptions { get; set; }
public RealtimeConversationSessionOutputAudioOptions OutputAudioOptions { get; set; }
[Serialization.JsonIgnore]
[EditorBrowsable(EditorBrowsableState.Never)]
public ref JsonPatch Patch { get; }
}
public class RealtimeConversationSessionInputAudioOptions : IJsonModel<RealtimeConversationSessionInputAudioOptions>, IPersistableModel<RealtimeConversationSessionInputAudioOptions> {
public RealtimeAudioFormat AudioFormat { get; set; }
public RealtimeAudioTranscriptionOptions AudioTranscriptionOptions { get; set; }
public RealtimeNoiseReduction NoiseReduction { get; set; }
[Serialization.JsonIgnore]
[EditorBrowsable(EditorBrowsableState.Never)]
public ref JsonPatch Patch { get; }
public RealtimeTurnDetection TurnDetection { get; set; }
public void DisableTurnDetection();
}
public class RealtimeConversationSessionOptions : RealtimeSessionOptions, IJsonModel<RealtimeConversationSessionOptions>, IPersistableModel<RealtimeConversationSessionOptions> {
public RealtimeConversationSessionOptions();
public RealtimeConversationSessionAudioOptions AudioOptions { get; set; }
public IList<RealtimeIncludedProperty> IncludedProperties { get; }
public string Instructions { get; set; }
public RealtimeMaxOutputTokenCount MaxOutputTokenCount { get; set; }
public string Model { get; set; }
public IList<RealtimeOutputModality> OutputModalities { get; }
public RealtimeToolChoice ToolChoice { get; set; }
public IList<RealtimeTool> Tools { get; }
public RealtimeTracing Tracing { get; set; }
public RealtimeTruncation Truncation { get; set; }
}
public class RealtimeConversationSessionOutputAudioOptions : IJsonModel<RealtimeConversationSessionOutputAudioOptions>, IPersistableModel<RealtimeConversationSessionOutputAudioOptions> {
public RealtimeAudioFormat AudioFormat { get; set; }
[Serialization.JsonIgnore]
[EditorBrowsable(EditorBrowsableState.Never)]
public ref JsonPatch Patch { get; }
public float? Speed { get; set; }
public RealtimeVoice? Voice { get; set; }
}
public class RealtimeCustomFunctionToolChoice : RealtimeCustomToolChoice, IJsonModel<RealtimeCustomFunctionToolChoice>, IPersistableModel<RealtimeCustomFunctionToolChoice> {
public RealtimeCustomFunctionToolChoice(string functionName);
public string FunctionName { get; set; }
}
public class RealtimeCustomMcpToolCallApprovalPolicy : IJsonModel<RealtimeCustomMcpToolCallApprovalPolicy>, IPersistableModel<RealtimeCustomMcpToolCallApprovalPolicy> {
[Serialization.JsonIgnore]
[EditorBrowsable(EditorBrowsableState.Never)]
public ref JsonPatch Patch { get; }
public RealtimeMcpToolFilter ToolsAlwaysRequiringApproval { get; set; }
public RealtimeMcpToolFilter ToolsNeverRequiringApproval { get; set; }
}
public class RealtimeCustomMcpToolChoice : RealtimeCustomToolChoice, IJsonModel<RealtimeCustomMcpToolChoice>, IPersistableModel<RealtimeCustomMcpToolChoice> {
public RealtimeCustomMcpToolChoice(string serverLabel);
public string McpToolName { get; set; }
public string ServerLabel { get; set; }
}
public class RealtimeCustomRetentionRatioTruncation : RealtimeCustomTruncation, IJsonModel<RealtimeCustomRetentionRatioTruncation>, IPersistableModel<RealtimeCustomRetentionRatioTruncation> {
public RealtimeCustomRetentionRatioTruncation(float retentionRatio);
public float RetentionRatio { get; set; }
public RealtimeRetentionRatioTokenLimitDetails TokenLimitDetails { get; set; }
}
public class RealtimeCustomToolChoice : IJsonModel<RealtimeCustomToolChoice>, IPersistableModel<RealtimeCustomToolChoice> {
[Serialization.JsonIgnore]
[EditorBrowsable(EditorBrowsableState.Never)]
public ref JsonPatch Patch { get; }
}
public class RealtimeCustomTracing : IJsonModel<RealtimeCustomTracing>, IPersistableModel<RealtimeCustomTracing> {
public string GroupId { get; set; }
public IDictionary<string, BinaryData> Metadata { get; }
[Serialization.JsonIgnore]
[EditorBrowsable(EditorBrowsableState.Never)]
public ref JsonPatch Patch { get; }
public string WorkflowName { get; set; }
}
public class RealtimeCustomTruncation : IJsonModel<RealtimeCustomTruncation>, IPersistableModel<RealtimeCustomTruncation> {
[Serialization.JsonIgnore]
[EditorBrowsable(EditorBrowsableState.Never)]
public ref JsonPatch Patch { get; }
}
public readonly partial struct RealtimeDefaultMaxOutputTokenCount : IEquatable<RealtimeDefaultMaxOutputTokenCount> {
public RealtimeDefaultMaxOutputTokenCount(string value);
public static RealtimeDefaultMaxOutputTokenCount Infinity { get; }
public readonly bool Equals(RealtimeDefaultMaxOutputTokenCount other);
[EditorBrowsable(EditorBrowsableState.Never)]
public override readonly bool Equals(object obj);
[EditorBrowsable(EditorBrowsableState.Never)]
public override readonly int GetHashCode();
public static bool operator ==(RealtimeDefaultMaxOutputTokenCount left, RealtimeDefaultMaxOutputTokenCount right);
public static implicit operator RealtimeDefaultMaxOutputTokenCount(string value);
public static implicit operator RealtimeDefaultMaxOutputTokenCount?(string value);
public static bool operator !=(RealtimeDefaultMaxOutputTokenCount left, RealtimeDefaultMaxOutputTokenCount right);
public override readonly string ToString();
}
public readonly partial struct RealtimeDefaultMcpToolCallApprovalPolicy : IEquatable<RealtimeDefaultMcpToolCallApprovalPolicy> {
public RealtimeDefaultMcpToolCallApprovalPolicy(string value);
public static RealtimeDefaultMcpToolCallApprovalPolicy AlwaysRequireApproval { get; }
public static RealtimeDefaultMcpToolCallApprovalPolicy NeverRequireApproval { get; }
public readonly bool Equals(RealtimeDefaultMcpToolCallApprovalPolicy other);
[EditorBrowsable(EditorBrowsableState.Never)]
public override readonly bool Equals(object obj);
[EditorBrowsable(EditorBrowsableState.Never)]
public override readonly int GetHashCode();
public static bool operator ==(RealtimeDefaultMcpToolCallApprovalPolicy left, RealtimeDefaultMcpToolCallApprovalPolicy right);
public static implicit operator RealtimeDefaultMcpToolCallApprovalPolicy(string value);
public static implicit operator RealtimeDefaultMcpToolCallApprovalPolicy?(string value);
public static bool operator !=(RealtimeDefaultMcpToolCallApprovalPolicy left, RealtimeDefaultMcpToolCallApprovalPolicy right);
public override readonly string ToString();
}
public readonly partial struct RealtimeDefaultToolChoice : IEquatable<RealtimeDefaultToolChoice> {
public RealtimeDefaultToolChoice(string value);
public static RealtimeDefaultToolChoice Auto { get; }
public static RealtimeDefaultToolChoice None { get; }
public static RealtimeDefaultToolChoice Required { get; }
public readonly bool Equals(RealtimeDefaultToolChoice other);
[EditorBrowsable(EditorBrowsableState.Never)]
public override readonly bool Equals(object obj);
[EditorBrowsable(EditorBrowsableState.Never)]
public override readonly int GetHashCode();
public static bool operator ==(RealtimeDefaultToolChoice left, RealtimeDefaultToolChoice right);
public static implicit operator RealtimeDefaultToolChoice(string value);
public static implicit operator RealtimeDefaultToolChoice?(string value);
public static bool operator !=(RealtimeDefaultToolChoice left, RealtimeDefaultToolChoice right);
public override readonly string ToString();
}
public readonly partial struct RealtimeDefaultTracing : IEquatable<RealtimeDefaultTracing> {
public RealtimeDefaultTracing(string value);
public static RealtimeDefaultTracing Auto { get; }
public readonly bool Equals(RealtimeDefaultTracing other);
[EditorBrowsable(EditorBrowsableState.Never)]
public override readonly bool Equals(object obj);
[EditorBrowsable(EditorBrowsableState.Never)]
public override readonly int GetHashCode();
public static bool operator ==(RealtimeDefaultTracing left, RealtimeDefaultTracing right);
public static implicit operator RealtimeDefaultTracing(string value);
public static implicit operator RealtimeDefaultTracing?(string value);
public static bool operator !=(RealtimeDefaultTracing left, RealtimeDefaultTracing right);
public override readonly string ToString();
}
public readonly partial struct RealtimeDefaultTruncation : IEquatable<RealtimeDefaultTruncation> {
public RealtimeDefaultTruncation(string value);
public static RealtimeDefaultTruncation Auto { get; }
public static RealtimeDefaultTruncation Disabled { get; }
public readonly bool Equals(RealtimeDefaultTruncation other);
[EditorBrowsable(EditorBrowsableState.Never)]
public override readonly bool Equals(object obj);
[EditorBrowsable(EditorBrowsableState.Never)]
public override readonly int GetHashCode();
public static bool operator ==(RealtimeDefaultTruncation left, RealtimeDefaultTruncation right);
public static implicit operator RealtimeDefaultTruncation(string value);
public static implicit operator RealtimeDefaultTruncation?(string value);
public static bool operator !=(RealtimeDefaultTruncation left, RealtimeDefaultTruncation right);
public override readonly string ToString();
}
public class RealtimeError : IJsonModel<RealtimeError>, IPersistableModel<RealtimeError> {
public string Code { get; set; }
public string EventId { get; set; }
public string Kind { get; set; }
public string Message { get; set; }
public string ParameterName { get; }
[Serialization.JsonIgnore]
[EditorBrowsable(EditorBrowsableState.Never)]
public ref JsonPatch Patch { get; }
}
public class RealtimeFunctionCallItem : RealtimeItem, IJsonModel<RealtimeFunctionCallItem>, IPersistableModel<RealtimeFunctionCallItem> {
public RealtimeFunctionCallItem(string callId, string functionName, BinaryData functionArguments);
public string CallId { get; set; }
public BinaryData FunctionArguments { get; set; }
public string FunctionName { get; set; }
public string Id { get; set; }
public RealtimeFunctionCallStatus? Status { get; set; }
}
public class RealtimeFunctionCallOutputItem : RealtimeItem, IJsonModel<RealtimeFunctionCallOutputItem>, IPersistableModel<RealtimeFunctionCallOutputItem> {
public RealtimeFunctionCallOutputItem(string callId, string functionOutput);
public string CallId { get; set; }
public string FunctionOutput { get; set; }
public string Id { get; set; }
public RealtimeFunctionCallOutputStatus? Status { get; set; }
}
public readonly partial struct RealtimeFunctionCallOutputStatus : IEquatable<RealtimeFunctionCallOutputStatus> {
public RealtimeFunctionCallOutputStatus(string value);
public static RealtimeFunctionCallOutputStatus Completed { get; }
public static RealtimeFunctionCallOutputStatus Incomplete { get; }
public static RealtimeFunctionCallOutputStatus InProgress { get; }
public readonly bool Equals(RealtimeFunctionCallOutputStatus other);
[EditorBrowsable(EditorBrowsableState.Never)]
public override readonly bool Equals(object obj);
[EditorBrowsable(EditorBrowsableState.Never)]
public override readonly int GetHashCode();
public static bool operator ==(RealtimeFunctionCallOutputStatus left, RealtimeFunctionCallOutputStatus right);
public static implicit operator RealtimeFunctionCallOutputStatus(string value);
public static implicit operator RealtimeFunctionCallOutputStatus?(string value);
public static bool operator !=(RealtimeFunctionCallOutputStatus left, RealtimeFunctionCallOutputStatus right);
public override readonly string ToString();
}
public readonly partial struct RealtimeFunctionCallStatus : IEquatable<RealtimeFunctionCallStatus> {
public RealtimeFunctionCallStatus(string value);
public static RealtimeFunctionCallStatus Completed { get; }
public static RealtimeFunctionCallStatus Incomplete { get; }
public static RealtimeFunctionCallStatus InProgress { get; }
public readonly bool Equals(RealtimeFunctionCallStatus other);
[EditorBrowsable(EditorBrowsableState.Never)]
public override readonly bool Equals(object obj);
[EditorBrowsable(EditorBrowsableState.Never)]
public override readonly int GetHashCode();
public static bool operator ==(RealtimeFunctionCallStatus left, RealtimeFunctionCallStatus right);
public static implicit operator RealtimeFunctionCallStatus(string value);
public static implicit operator RealtimeFunctionCallStatus?(string value);
public static bool operator !=(RealtimeFunctionCallStatus left, RealtimeFunctionCallStatus right);
public override readonly string ToString();
}
public class RealtimeFunctionTool : RealtimeTool, IJsonModel<RealtimeFunctionTool>, IPersistableModel<RealtimeFunctionTool> {
public RealtimeFunctionTool(string functionName);
public string FunctionDescription { get; set; }
public string FunctionName { get; }
public BinaryData FunctionParameters { get; set; }
}
public readonly partial struct RealtimeImageDetailLevel : IEquatable<RealtimeImageDetailLevel> {
public RealtimeImageDetailLevel(string value);
public static RealtimeImageDetailLevel Auto { get; }
public static RealtimeImageDetailLevel High { get; }
public static RealtimeImageDetailLevel Low { get; }
public readonly bool Equals(RealtimeImageDetailLevel other);
[EditorBrowsable(EditorBrowsableState.Never)]
public override readonly bool Equals(object obj);
[EditorBrowsable(EditorBrowsableState.Never)]
public override readonly int GetHashCode();
public static bool operator ==(RealtimeImageDetailLevel left, RealtimeImageDetailLevel right);
public static implicit operator RealtimeImageDetailLevel(string value);
public static implicit operator RealtimeImageDetailLevel?(string value);
public static bool operator !=(RealtimeImageDetailLevel left, RealtimeImageDetailLevel right);
public override readonly string ToString();
}
public readonly partial struct RealtimeIncludedProperty : IEquatable<RealtimeIncludedProperty> {
public RealtimeIncludedProperty(string value);
public static RealtimeIncludedProperty ItemInputAudioTranscriptionLogProbabilities { get; }
public readonly bool Equals(RealtimeIncludedProperty other);
[EditorBrowsable(EditorBrowsableState.Never)]
public override readonly bool Equals(object obj);
[EditorBrowsable(EditorBrowsableState.Never)]
public override readonly int GetHashCode();
public static bool operator ==(RealtimeIncludedProperty left, RealtimeIncludedProperty right);
public static implicit operator RealtimeIncludedProperty(string value);
public static implicit operator RealtimeIncludedProperty?(string value);
public static bool operator !=(RealtimeIncludedProperty left, RealtimeIncludedProperty right);
public override readonly string ToString();
}
public class RealtimeInputAudioMessageContentPart : RealtimeMessageContentPart, IJsonModel<RealtimeInputAudioMessageContentPart>, IPersistableModel<RealtimeInputAudioMessageContentPart> {
public RealtimeInputAudioMessageContentPart(BinaryData audioBytes);
public BinaryData AudioBytes { get; set; }
public string Transcript { get; set; }
}
public class RealtimeInputImageMessageContentPart : RealtimeMessageContentPart, IJsonModel<RealtimeInputImageMessageContentPart>, IPersistableModel<RealtimeInputImageMessageContentPart> {
public RealtimeInputImageMessageContentPart(Uri imageUri);
public RealtimeImageDetailLevel? Detail { get; set; }
public Uri ImageUri { get; set; }
}
public class RealtimeInputTextMessageContentPart : RealtimeMessageContentPart, IJsonModel<RealtimeInputTextMessageContentPart>, IPersistableModel<RealtimeInputTextMessageContentPart> {
public RealtimeInputTextMessageContentPart(string text);
public string Text { get; set; }
}
public class RealtimeItem : IJsonModel<RealtimeItem>, IPersistableModel<RealtimeItem> {
[Serialization.JsonIgnore]
[EditorBrowsable(EditorBrowsableState.Never)]
public ref JsonPatch Patch { get; }
public static RealtimeMessageItem CreateAssistantMessageItem(IEnumerable<RealtimeMessageContentPart> contentParts);
public static RealtimeMessageItem CreateAssistantMessageItem(string outputTextContent);
public static RealtimeFunctionCallItem CreateFunctionCallItem(string callId, string functionName, BinaryData functionArguments);
public static RealtimeFunctionCallOutputItem CreateFunctionCallOutputItem(string callId, string functionOutput);
public static RealtimeMcpToolCallApprovalRequestItem CreateMcpApprovalRequestItem(string id, string serverLabel, string name, BinaryData arguments);
public static RealtimeMcpToolCallApprovalResponseItem CreateMcpApprovalResponseItem(string approvalRequestId, bool approved);
public static RealtimeMcpToolCallItem CreateMcpToolCallItem(string serverLabel, string name, BinaryData arguments);
public static RealtimeMcpToolDefinitionListItem CreateMcpToolDefinitionListItem(string serverLabel, IEnumerable<RealtimeMcpToolDefinition> toolDefinitions);
public static RealtimeMessageItem CreateSystemMessageItem(IEnumerable<RealtimeMessageContentPart> contentParts);
public static RealtimeMessageItem CreateSystemMessageItem(string inputTextContent);
public static RealtimeMessageItem CreateUserMessageItem(IEnumerable<RealtimeMessageContentPart> contentParts);
public static RealtimeMessageItem CreateUserMessageItem(string inputTextContent);
}
public class RealtimeLogProbabilityDetails : IJsonModel<RealtimeLogProbabilityDetails>, IPersistableModel<RealtimeLogProbabilityDetails> {
public float LogProbability { get; }
[Serialization.JsonIgnore]
[EditorBrowsable(EditorBrowsableState.Never)]
public ref JsonPatch Patch { get; }
public string Token { get; }
public ReadOnlyMemory<byte> Utf8Bytes { get; }
}
public class RealtimeMaxOutputTokenCount : IJsonModel<RealtimeMaxOutputTokenCount>, IPersistableModel<RealtimeMaxOutputTokenCount> {
public RealtimeMaxOutputTokenCount(RealtimeDefaultMaxOutputTokenCount defaultMaxOutputTokenCount);
public RealtimeMaxOutputTokenCount(int customMaxOutputTokenCount);
public int? CustomMaxOutputTokenCount { get; }
public RealtimeDefaultMaxOutputTokenCount? DefaultMaxOutputTokenCount { get; }
[Serialization.JsonIgnore]
[EditorBrowsable(EditorBrowsableState.Never)]
public ref JsonPatch Patch { get; }
public static implicit operator RealtimeMaxOutputTokenCount(RealtimeDefaultMaxOutputTokenCount defaultMaxOutputTokenCount);
public static implicit operator RealtimeMaxOutputTokenCount(int customMaxOutputTokenCount);
}
public class RealtimeMcpTool : RealtimeTool, IJsonModel<RealtimeMcpTool>, IPersistableModel<RealtimeMcpTool> {
public RealtimeMcpTool(string serverLabel, RealtimeMcpToolConnectorId connectorId);
public RealtimeMcpTool(string serverLabel, Uri serverUri);
public RealtimeMcpToolFilter AllowedTools { get; set; }
public string AuthorizationToken { get; set; }
public RealtimeMcpToolConnectorId? ConnectorId { get; set; }
public IDictionary<string, string> Headers { get; set; }
public string ServerDescription { get; set; }
public string ServerLabel { get; set; }
public Uri ServerUri { get; set; }
public RealtimeMcpToolCallApprovalPolicy ToolCallApprovalPolicy { get; set; }
}
public class RealtimeMcpToolCallApprovalPolicy : IJsonModel<RealtimeMcpToolCallApprovalPolicy>, IPersistableModel<RealtimeMcpToolCallApprovalPolicy> {
public RealtimeMcpToolCallApprovalPolicy(RealtimeCustomMcpToolCallApprovalPolicy customPolicy);
public RealtimeMcpToolCallApprovalPolicy(RealtimeDefaultMcpToolCallApprovalPolicy defaultPolicy);
public RealtimeCustomMcpToolCallApprovalPolicy CustomPolicy { get; }
public RealtimeDefaultMcpToolCallApprovalPolicy? DefaultPolicy { get; }
[Serialization.JsonIgnore]
[EditorBrowsable(EditorBrowsableState.Never)]
public ref JsonPatch Patch { get; }
public static implicit operator RealtimeMcpToolCallApprovalPolicy(RealtimeCustomMcpToolCallApprovalPolicy customPolicy);
public static implicit operator RealtimeMcpToolCallApprovalPolicy(RealtimeDefaultMcpToolCallApprovalPolicy defaultPolicy);
}
public class RealtimeMcpToolCallApprovalRequestItem : RealtimeItem, IJsonModel<RealtimeMcpToolCallApprovalRequestItem>, IPersistableModel<RealtimeMcpToolCallApprovalRequestItem> {
public RealtimeMcpToolCallApprovalRequestItem(string id, string serverLabel, string toolName, BinaryData toolArguments);
public string Id { get; set; }
public string ServerLabel { get; set; }
public BinaryData ToolArguments { get; set; }
public string ToolName { get; set; }
}
public class RealtimeMcpToolCallApprovalResponseItem : RealtimeItem, IJsonModel<RealtimeMcpToolCallApprovalResponseItem>, IPersistableModel<RealtimeMcpToolCallApprovalResponseItem> {
public RealtimeMcpToolCallApprovalResponseItem(string approvalRequestId, bool approved);
public string ApprovalRequestId { get; set; }
public bool Approved { get; set; }
public string Id { get; set; }
public string Reason { get; set; }
}
public class RealtimeMcpToolCallItem : RealtimeItem, IJsonModel<RealtimeMcpToolCallItem>, IPersistableModel<RealtimeMcpToolCallItem> {
public RealtimeMcpToolCallItem(string serverLabel, string toolName, BinaryData toolArguments);
public string ApprovalRequestId { get; set; }
public RealtimeError Error { get; set; }
public string Id { get; set; }
public string ServerLabel { get; set; }
public BinaryData ToolArguments { get; set; }
public string ToolName { get; set; }
public string ToolOutput { get; set; }
}
public readonly partial struct RealtimeMcpToolConnectorId : IEquatable<RealtimeMcpToolConnectorId> {
public RealtimeMcpToolConnectorId(string value);
public static RealtimeMcpToolConnectorId Dropbox { get; }
public static RealtimeMcpToolConnectorId Gmail { get; }
public static RealtimeMcpToolConnectorId GoogleCalendar { get; }
public static RealtimeMcpToolConnectorId GoogleDrive { get; }
public static RealtimeMcpToolConnectorId MicrosoftTeams { get; }
public static RealtimeMcpToolConnectorId OutlookCalendar { get; }
public static RealtimeMcpToolConnectorId OutlookEmail { get; }
public static RealtimeMcpToolConnectorId SharePoint { get; }
public readonly bool Equals(RealtimeMcpToolConnectorId other);
[EditorBrowsable(EditorBrowsableState.Never)]
public override readonly bool Equals(object obj);
[EditorBrowsable(EditorBrowsableState.Never)]
public override readonly int GetHashCode();
public static bool operator ==(RealtimeMcpToolConnectorId left, RealtimeMcpToolConnectorId right);
public static implicit operator RealtimeMcpToolConnectorId(string value);
public static implicit operator RealtimeMcpToolConnectorId?(string value);
public static bool operator !=(RealtimeMcpToolConnectorId left, RealtimeMcpToolConnectorId right);
public override readonly string ToString();
}
public class RealtimeMcpToolDefinition : IJsonModel<RealtimeMcpToolDefinition>, IPersistableModel<RealtimeMcpToolDefinition> {
public RealtimeMcpToolDefinition(string name, BinaryData inputSchema);
public BinaryData Annotations { get; set; }
public string Description { get; set; }
public BinaryData InputSchema { get; set; }
public string Name { get; set; }
[Serialization.JsonIgnore]
[EditorBrowsable(EditorBrowsableState.Never)]
public ref JsonPatch Patch { get; }
}
public class RealtimeMcpToolDefinitionListItem : RealtimeItem, IJsonModel<RealtimeMcpToolDefinitionListItem>, IPersistableModel<RealtimeMcpToolDefinitionListItem> {
public RealtimeMcpToolDefinitionListItem(string serverLabel, IEnumerable<RealtimeMcpToolDefinition> toolDefinitions);
public string Id { get; set; }
public string ServerLabel { get; set; }
public IList<RealtimeMcpToolDefinition> ToolDefinitions { get; }
}
public class RealtimeMcpToolFilter : IJsonModel<RealtimeMcpToolFilter>, IPersistableModel<RealtimeMcpToolFilter> {
public bool? IsReadOnly { get; set; }
[Serialization.JsonIgnore]
[EditorBrowsable(EditorBrowsableState.Never)]
public ref JsonPatch Patch { get; }
public IList<string> ToolNames { get; }
}
public class RealtimeMessageContentPart : IJsonModel<RealtimeMessageContentPart>, IPersistableModel<RealtimeMessageContentPart> {
[Serialization.JsonIgnore]
[EditorBrowsable(EditorBrowsableState.Never)]
public ref JsonPatch Patch { get; }
}
public class RealtimeMessageItem : RealtimeItem, IJsonModel<RealtimeMessageItem>, IPersistableModel<RealtimeMessageItem> {
public RealtimeMessageItem(RealtimeMessageRole role, IEnumerable<RealtimeMessageContentPart> content);
public IList<RealtimeMessageContentPart> Content { get; }
public string Id { get; set; }
public RealtimeMessageRole Role { get; set; }
public RealtimeMessageStatus? Status { get; set; }
}
public readonly partial struct RealtimeMessageRole : IEquatable<RealtimeMessageRole> {
public RealtimeMessageRole(string value);
public static RealtimeMessageRole Assistant { get; }
public static RealtimeMessageRole System { get; }
public static RealtimeMessageRole User { get; }
public readonly bool Equals(RealtimeMessageRole other);
[EditorBrowsable(global::EditorBrowsableState.Never)]
public override readonly bool Equals(object obj);
[EditorBrowsable(global::EditorBrowsableState.Never)]
public override readonly int GetHashCode();
public static bool operator ==(RealtimeMessageRole left, RealtimeMessageRole right);
public static implicit operator RealtimeMessageRole(string value);
public static implicit operator RealtimeMessageRole?(string value);
public static bool operator !=(RealtimeMessageRole left, RealtimeMessageRole right);
public override readonly string ToString();
}
public readonly partial struct RealtimeMessageStatus : IEquatable<RealtimeMessageStatus> {
public RealtimeMessageStatus(string value);
public static RealtimeMessageStatus Completed { get; }
public static RealtimeMessageStatus Incomplete { get; }
public static RealtimeMessageStatus InProgress { get; }
public readonly bool Equals(RealtimeMessageStatus other);
[EditorBrowsable(EditorBrowsableState.Never)]
public override readonly bool Equals(object obj);
[EditorBrowsable(EditorBrowsableState.Never)]
public override readonly int GetHashCode();
public static bool operator ==(RealtimeMessageStatus left, RealtimeMessageStatus right);
public static implicit operator RealtimeMessageStatus(string value);
public static implicit operator RealtimeMessageStatus?(string value);
public static bool operator !=(RealtimeMessageStatus left, RealtimeMessageStatus right);
public override readonly string ToString();
}
public class RealtimeNoiseReduction : IJsonModel<RealtimeNoiseReduction>, IPersistableModel<RealtimeNoiseReduction> {
public RealtimeNoiseReduction(RealtimeNoiseReductionKind kind);
public RealtimeNoiseReductionKind Kind { get; set; }
[Serialization.JsonIgnore]
[EditorBrowsable(EditorBrowsableState.Never)]
public ref JsonPatch Patch { get; }
}
public readonly partial struct RealtimeNoiseReductionKind : IEquatable<RealtimeNoiseReductionKind> {
public RealtimeNoiseReductionKind(string value);
public static RealtimeNoiseReductionKind FarField { get; }
public static RealtimeNoiseReductionKind NearField { get; }
public readonly bool Equals(RealtimeNoiseReductionKind other);
[EditorBrowsable(EditorBrowsableState.Never)]
public override readonly bool Equals(object obj);
[EditorBrowsable(EditorBrowsableState.Never)]
public override readonly int GetHashCode();
public static bool operator ==(RealtimeNoiseReductionKind left, RealtimeNoiseReductionKind right);
public static implicit operator RealtimeNoiseReductionKind(string value);
public static implicit operator RealtimeNoiseReductionKind?(string value);
public static bool operator !=(RealtimeNoiseReductionKind left, RealtimeNoiseReductionKind right);
public override readonly string ToString();
}
public class RealtimeOutputAudioMessageContentPart : RealtimeMessageContentPart, IJsonModel<RealtimeOutputAudioMessageContentPart>, IPersistableModel<RealtimeOutputAudioMessageContentPart> {
public RealtimeOutputAudioMessageContentPart(BinaryData audioBytes, string transcript);
public BinaryData AudioBytes { get; set; }
public string Transcript { get; set; }
}
public readonly partial struct RealtimeOutputModality : IEquatable<RealtimeOutputModality> {
public RealtimeOutputModality(string value);
public static RealtimeOutputModality Audio { get; }
public static RealtimeOutputModality Text { get; }
public readonly bool Equals(RealtimeOutputModality other);
[EditorBrowsable(EditorBrowsableState.Never)]
public override readonly bool Equals(object obj);
[EditorBrowsable(EditorBrowsableState.Never)]
public override readonly int GetHashCode();
public static bool operator ==(RealtimeOutputModality left, RealtimeOutputModality right);
public static implicit operator RealtimeOutputModality(string value);
public static implicit operator RealtimeOutputModality?(string value);
public static bool operator !=(RealtimeOutputModality left, RealtimeOutputModality right);
public override readonly string ToString();
}
public class RealtimeOutputTextMessageContentPart : RealtimeMessageContentPart, IJsonModel<RealtimeOutputTextMessageContentPart>, IPersistableModel<RealtimeOutputTextMessageContentPart> {
public RealtimeOutputTextMessageContentPart(string text);
public string Text { get; set; }
}
public class RealtimePcmaAudioFormat : RealtimeAudioFormat, IJsonModel<RealtimePcmaAudioFormat>, IPersistableModel<RealtimePcmaAudioFormat> {
public RealtimePcmaAudioFormat();
}
public class RealtimePcmAudioFormat : RealtimeAudioFormat, IJsonModel<RealtimePcmAudioFormat>, IPersistableModel<RealtimePcmAudioFormat> {
public RealtimePcmAudioFormat();
public int Rate { get; }
}
public class RealtimePcmuAudioFormat : RealtimeAudioFormat, IJsonModel<RealtimePcmuAudioFormat>, IPersistableModel<RealtimePcmuAudioFormat> {
public RealtimePcmuAudioFormat();
}
public class RealtimeRateLimitDetails : IJsonModel<RealtimeRateLimitDetails>, IPersistableModel<RealtimeRateLimitDetails> {
public int? Limit { get; }
public RealtimeRateLimitName? Name { get; }
[Serialization.JsonIgnore]
[EditorBrowsable(EditorBrowsableState.Never)]
public ref JsonPatch Patch { get; }
public int? RemainingCount { get; }
public TimeSpan? TimeUntilReset { get; }
}
public readonly partial struct RealtimeRateLimitName : IEquatable<RealtimeRateLimitName> {
public RealtimeRateLimitName(string value);
public static RealtimeRateLimitName Requests { get; }
public static RealtimeRateLimitName Tokens { get; }
public readonly bool Equals(RealtimeRateLimitName other);
[EditorBrowsable(EditorBrowsableState.Never)]
public override readonly bool Equals(object obj);
[EditorBrowsable(EditorBrowsableState.Never)]
public override readonly int GetHashCode();
public static bool operator ==(RealtimeRateLimitName left, RealtimeRateLimitName right);
public static implicit operator RealtimeRateLimitName(string value);
public static implicit operator RealtimeRateLimitName?(string value);
public static bool operator !=(RealtimeRateLimitName left, RealtimeRateLimitName right);
public override readonly string ToString();
}
public class RealtimeResponse : IJsonModel<RealtimeResponse>, IPersistableModel<RealtimeResponse> {
public RealtimeResponseAudioOptions AudioOptions { get; }
public string ConversationId { get; }
public string Id { get; }
public RealtimeMaxOutputTokenCount MaxOutputTokenCount { get; }
public IDictionary<string, BinaryData> Metadata { get; }
public IList<RealtimeItem> OutputItems { get; }
public IList<RealtimeOutputModality> OutputModalities { get; }
[Serialization.JsonIgnore]
[EditorBrowsable(EditorBrowsableState.Never)]
public ref JsonPatch Patch { get; }
public RealtimeResponseStatus? Status { get; }
public RealtimeResponseStatusDetails StatusDetails { get; }
public RealtimeResponseUsage Usage { get; }
}
public class RealtimeResponseAudioOptions : IJsonModel<RealtimeResponseAudioOptions>, IPersistableModel<RealtimeResponseAudioOptions> {
public RealtimeResponseOutputAudioOptions OutputAudioOptions { get; }
[Serialization.JsonIgnore]
[EditorBrowsable(EditorBrowsableState.Never)]
public ref JsonPatch Patch { get; }
}
public class RealtimeResponseContentPart : IJsonModel<RealtimeResponseContentPart>, IPersistableModel<RealtimeResponseContentPart> {
public BinaryData Audio { get; }
public RealtimeResponseContentPartKind? Kind { get; }
[Serialization.JsonIgnore]
[EditorBrowsable(EditorBrowsableState.Never)]
public ref JsonPatch Patch { get; }
public string Text { get; }
public string Transcript { get; }
}
public readonly partial struct RealtimeResponseContentPartKind : IEquatable<RealtimeResponseContentPartKind> {
public RealtimeResponseContentPartKind(string value);
public static RealtimeResponseContentPartKind Audio { get; }
public static RealtimeResponseContentPartKind Text { get; }
public readonly bool Equals(RealtimeResponseContentPartKind other);
[EditorBrowsable(EditorBrowsableState.Never)]
public override readonly bool Equals(object obj);
[EditorBrowsable(EditorBrowsableState.Never)]
public override readonly int GetHashCode();
public static bool operator ==(RealtimeResponseContentPartKind left, RealtimeResponseContentPartKind right);
public static implicit operator RealtimeResponseContentPartKind(string value);
public static implicit operator RealtimeResponseContentPartKind?(string value);
public static bool operator !=(RealtimeResponseContentPartKind left, RealtimeResponseContentPartKind right);
public override readonly string ToString();
}
public readonly partial struct RealtimeResponseDefaultConversationConfiguration : IEquatable<RealtimeResponseDefaultConversationConfiguration> {
public RealtimeResponseDefaultConversationConfiguration(string value);
public static RealtimeResponseDefaultConversationConfiguration Auto { get; }
public static RealtimeResponseDefaultConversationConfiguration None { get; }
public readonly bool Equals(RealtimeResponseDefaultConversationConfiguration other);
[EditorBrowsable(EditorBrowsableState.Never)]
public override readonly bool Equals(object obj);
[EditorBrowsable(EditorBrowsableState.Never)]
public override readonly int GetHashCode();
public static bool operator ==(RealtimeResponseDefaultConversationConfiguration left, RealtimeResponseDefaultConversationConfiguration right);
public static implicit operator RealtimeResponseDefaultConversationConfiguration(string value);
public static implicit operator RealtimeResponseDefaultConversationConfiguration?(string value);
public static bool operator !=(RealtimeResponseDefaultConversationConfiguration left, RealtimeResponseDefaultConversationConfiguration right);
public override readonly string ToString();
}
public class RealtimeResponseInputCachedTokenUsageDetails : IJsonModel<RealtimeResponseInputCachedTokenUsageDetails>, IPersistableModel<RealtimeResponseInputCachedTokenUsageDetails> {
public int? AudioTokenCount { get; }
public int? ImageTokenCount { get; }
[Serialization.JsonIgnore]
[EditorBrowsable(EditorBrowsableState.Never)]
public ref JsonPatch Patch { get; }
public int? TextTokenCount { get; }
}
public class RealtimeResponseInputTokenUsageDetails : IJsonModel<RealtimeResponseInputTokenUsageDetails>, IPersistableModel<RealtimeResponseInputTokenUsageDetails> {
public int? AudioTokenCount { get; }
public int? CachedTokenCount { get; }
public RealtimeResponseInputCachedTokenUsageDetails CachedTokenDetails { get; }
public int? ImageTokenCount { get; }
[Serialization.JsonIgnore]
[EditorBrowsable(EditorBrowsableState.Never)]
public ref JsonPatch Patch { get; }
public int? TextTokenCount { get; }
}
public class RealtimeResponseOptions : IJsonModel<RealtimeResponseOptions>, IPersistableModel<RealtimeResponseOptions> {
public RealtimeResponseAudioOptions AudioOptions { get; set; }
public RealtimeResponseDefaultConversationConfiguration? DefaultConversationConfiguration { get; set; }
public IList<RealtimeItem> InputItems { get; }
public string Instructions { get; set; }
public RealtimeMaxOutputTokenCount MaxOutputTokenCount { get; set; }
public IDictionary<string, BinaryData> Metadata { get; set; }
public IList<RealtimeOutputModality> OutputModalities { get; }
[Serialization.JsonIgnore]
[EditorBrowsable(EditorBrowsableState.Never)]
public ref JsonPatch Patch { get; }
public RealtimeToolChoice ToolChoice { get; set; }
public IList<RealtimeTool> Tools { get; }
}
public class RealtimeResponseOutputAudioOptions : IJsonModel<RealtimeResponseOutputAudioOptions>, IPersistableModel<RealtimeResponseOutputAudioOptions> {
public RealtimeAudioFormat AudioFormat { get; set; }
[Serialization.JsonIgnore]
[EditorBrowsable(EditorBrowsableState.Never)]
public ref JsonPatch Patch { get; }
public RealtimeVoice? Voice { get; set; }
}
public class RealtimeResponseOutputTokenUsageDetails : IJsonModel<RealtimeResponseOutputTokenUsageDetails>, IPersistableModel<RealtimeResponseOutputTokenUsageDetails> {
public int? AudioTokenCount { get; }
[Serialization.JsonIgnore]
[EditorBrowsable(EditorBrowsableState.Never)]
public ref JsonPatch Patch { get; }
public int? TextTokenCount { get; }
}
public readonly partial struct RealtimeResponseStatus : IEquatable<RealtimeResponseStatus> {
public RealtimeResponseStatus(string value);
public static RealtimeResponseStatus Cancelled { get; }
public static RealtimeResponseStatus Completed { get; }
public static RealtimeResponseStatus Failed { get; }
public static RealtimeResponseStatus Incomplete { get; }
public static RealtimeResponseStatus InProgress { get; }
public readonly bool Equals(RealtimeResponseStatus other);
[EditorBrowsable(EditorBrowsableState.Never)]
public override readonly bool Equals(object obj);
[EditorBrowsable(EditorBrowsableState.Never)]
public override readonly int GetHashCode();
public static bool operator ==(RealtimeResponseStatus left, RealtimeResponseStatus right);
public static implicit operator RealtimeResponseStatus(string value);
public static implicit operator RealtimeResponseStatus?(string value);
public static bool operator !=(RealtimeResponseStatus left, RealtimeResponseStatus right);
public override readonly string ToString();
}
public class RealtimeResponseStatusDetails : IJsonModel<RealtimeResponseStatusDetails>, IPersistableModel<RealtimeResponseStatusDetails> {
public RealtimeError Error { get; }
public RealtimeResponseStatusErrorKind? Kind { get; }
[Serialization.JsonIgnore]
[EditorBrowsable(EditorBrowsableState.Never)]
public ref JsonPatch Patch { get; }
public RealtimeResponseStatusReason? Reason { get; }
}
public readonly partial struct RealtimeResponseStatusErrorKind : IEquatable<RealtimeResponseStatusErrorKind> {
public RealtimeResponseStatusErrorKind(string value);
public static RealtimeResponseStatusErrorKind Cancelled { get; }
public static RealtimeResponseStatusErrorKind Completed { get; }
public static RealtimeResponseStatusErrorKind Failed { get; }
public static RealtimeResponseStatusErrorKind Incomplete { get; }
public readonly bool Equals(RealtimeResponseStatusErrorKind other);
[EditorBrowsable(EditorBrowsableState.Never)]
public override readonly bool Equals(object obj);
[EditorBrowsable(EditorBrowsableState.Never)]
public override readonly int GetHashCode();
public static bool operator ==(RealtimeResponseStatusErrorKind left, RealtimeResponseStatusErrorKind right);
public static implicit operator RealtimeResponseStatusErrorKind(string value);
public static implicit operator RealtimeResponseStatusErrorKind?(string value);
public static bool operator !=(RealtimeResponseStatusErrorKind left, RealtimeResponseStatusErrorKind right);
public override readonly string ToString();
}
public readonly partial struct RealtimeResponseStatusReason : IEquatable<RealtimeResponseStatusReason> {
public RealtimeResponseStatusReason(string value);
public static RealtimeResponseStatusReason ClientCancelled { get; }
public static RealtimeResponseStatusReason ContentFilter { get; }
public static RealtimeResponseStatusReason MaxOutputTokens { get; }
public static RealtimeResponseStatusReason TurnDetected { get; }
public readonly bool Equals(RealtimeResponseStatusReason other);
[EditorBrowsable(EditorBrowsableState.Never)]
public override readonly bool Equals(object obj);
[EditorBrowsable(EditorBrowsableState.Never)]
public override readonly int GetHashCode();
public static bool operator ==(RealtimeResponseStatusReason left, RealtimeResponseStatusReason right);
public static implicit operator RealtimeResponseStatusReason(string value);
public static implicit operator RealtimeResponseStatusReason?(string value);
public static bool operator !=(RealtimeResponseStatusReason left, RealtimeResponseStatusReason right);
public override readonly string ToString();
}
public class RealtimeResponseUsage : IJsonModel<RealtimeResponseUsage>, IPersistableModel<RealtimeResponseUsage> {
public int? InputTokenCount { get; }
public RealtimeResponseInputTokenUsageDetails InputTokenDetails { get; }
public int? OutputTokenCount { get; }
public RealtimeResponseOutputTokenUsageDetails OutputTokenDetails { get; }
[Serialization.JsonIgnore]
[EditorBrowsable(EditorBrowsableState.Never)]
public ref JsonPatch Patch { get; }
public int? TotalTokenCount { get; }
}
public class RealtimeRetentionRatioTokenLimitDetails : IJsonModel<RealtimeRetentionRatioTokenLimitDetails>, IPersistableModel<RealtimeRetentionRatioTokenLimitDetails> {
public int? MaxPostInstructionsTokenCount { get; set; }
[Serialization.JsonIgnore]
[EditorBrowsable(EditorBrowsableState.Never)]
public ref JsonPatch Patch { get; }
}
public readonly partial struct RealtimeSemanticVadEagernessLevel : IEquatable<RealtimeSemanticVadEagernessLevel> {
public RealtimeSemanticVadEagernessLevel(string value);
public static RealtimeSemanticVadEagernessLevel Auto { get; }
public static RealtimeSemanticVadEagernessLevel High { get; }
public static RealtimeSemanticVadEagernessLevel Low { get; }
public static RealtimeSemanticVadEagernessLevel Medium { get; }
public readonly bool Equals(RealtimeSemanticVadEagernessLevel other);
[EditorBrowsable(EditorBrowsableState.Never)]
public override readonly bool Equals(object obj);
[EditorBrowsable(EditorBrowsableState.Never)]
public override readonly int GetHashCode();
public static bool operator ==(RealtimeSemanticVadEagernessLevel left, RealtimeSemanticVadEagernessLevel right);
public static implicit operator RealtimeSemanticVadEagernessLevel(string value);
public static implicit operator RealtimeSemanticVadEagernessLevel?(string value);
public static bool operator !=(RealtimeSemanticVadEagernessLevel left, RealtimeSemanticVadEagernessLevel right);
public override readonly string ToString();
}
public class RealtimeSemanticVadTurnDetection : RealtimeTurnDetection, IJsonModel<RealtimeSemanticVadTurnDetection>, IPersistableModel<RealtimeSemanticVadTurnDetection> {
public RealtimeSemanticVadTurnDetection();
public bool? CreateResponseEnabled { get; set; }
public RealtimeSemanticVadEagernessLevel? EagernessLevel { get; set; }
public bool? InterruptResponseEnabled { get; set; }
}
public class RealtimeServerUpdate : IJsonModel<RealtimeServerUpdate>, IPersistableModel<RealtimeServerUpdate> {
[Serialization.JsonIgnore]
[EditorBrowsable(EditorBrowsableState.Never)]
public ref JsonPatch Patch { get; }
}
public class RealtimeServerUpdateConversationCreated : RealtimeServerUpdate, IJsonModel<RealtimeServerUpdateConversationCreated>, IPersistableModel<RealtimeServerUpdateConversationCreated> {
public RealtimeConversation Conversation { get; }
public string EventId { get; }
}
public class RealtimeServerUpdateConversationItemAdded : RealtimeServerUpdate, IJsonModel<RealtimeServerUpdateConversationItemAdded>, IPersistableModel<RealtimeServerUpdateConversationItemAdded> {
public string EventId { get; }
public RealtimeItem Item { get; }
public string PreviousItemId { get; }
}
public class RealtimeServerUpdateConversationItemCreated : RealtimeServerUpdate, IJsonModel<RealtimeServerUpdateConversationItemCreated>, IPersistableModel<RealtimeServerUpdateConversationItemCreated> {
public string EventId { get; }
public RealtimeItem Item { get; }
public string PreviousItemId { get; }
}
public class RealtimeServerUpdateConversationItemDeleted : RealtimeServerUpdate, IJsonModel<RealtimeServerUpdateConversationItemDeleted>, IPersistableModel<RealtimeServerUpdateConversationItemDeleted> {
public string EventId { get; }
public string ItemId { get; }
}
public class RealtimeServerUpdateConversationItemDone : RealtimeServerUpdate, IJsonModel<RealtimeServerUpdateConversationItemDone>, IPersistableModel<RealtimeServerUpdateConversationItemDone> {
public string EventId { get; }
public RealtimeItem Item { get; }
public string PreviousItemId { get; }
}
public class RealtimeServerUpdateConversationItemInputAudioTranscriptionCompleted : RealtimeServerUpdate, IJsonModel<RealtimeServerUpdateConversationItemInputAudioTranscriptionCompleted>, IPersistableModel<RealtimeServerUpdateConversationItemInputAudioTranscriptionCompleted> {
public int ContentIndex { get; }
public string EventId { get; }
public string ItemId { get; }
public IList<RealtimeLogProbabilityDetails> Logprobs { get; }
public string Transcript { get; }
public RealtimeTranscriptionUsage Usage { get; }
}
public class RealtimeServerUpdateConversationItemInputAudioTranscriptionDelta : RealtimeServerUpdate, IJsonModel<RealtimeServerUpdateConversationItemInputAudioTranscriptionDelta>, IPersistableModel<RealtimeServerUpdateConversationItemInputAudioTranscriptionDelta> {
public int? ContentIndex { get; }
public string Delta { get; }
public string EventId { get; }
public string ItemId { get; }
public IList<RealtimeLogProbabilityDetails> Logprobs { get; }
}
public class RealtimeServerUpdateConversationItemInputAudioTranscriptionFailed : RealtimeServerUpdate, IJsonModel<RealtimeServerUpdateConversationItemInputAudioTranscriptionFailed>, IPersistableModel<RealtimeServerUpdateConversationItemInputAudioTranscriptionFailed> {
public int ContentIndex { get; }
public RealtimeError Error { get; }
public string EventId { get; }
public string ItemId { get; }
}
public class RealtimeServerUpdateConversationItemInputAudioTranscriptionSegment : RealtimeServerUpdate, IJsonModel<RealtimeServerUpdateConversationItemInputAudioTranscriptionSegment>, IPersistableModel<RealtimeServerUpdateConversationItemInputAudioTranscriptionSegment> {
public int ContentIndex { get; }
public float End { get; }
public string EventId { get; }
public string Id { get; }
public string ItemId { get; }
public string Speaker { get; }
public float Start { get; }
public string Text { get; }
}
public class RealtimeServerUpdateConversationItemRetrieved : RealtimeServerUpdate, IJsonModel<RealtimeServerUpdateConversationItemRetrieved>, IPersistableModel<RealtimeServerUpdateConversationItemRetrieved> {
public string EventId { get; }
public RealtimeItem Item { get; }
}
public class RealtimeServerUpdateConversationItemTruncated : RealtimeServerUpdate, IJsonModel<RealtimeServerUpdateConversationItemTruncated>, IPersistableModel<RealtimeServerUpdateConversationItemTruncated> {
public TimeSpan AudioEndTime { get; }
public int ContentIndex { get; }
public string EventId { get; }
public string ItemId { get; }
}
public class RealtimeServerUpdateError : RealtimeServerUpdate, IJsonModel<RealtimeServerUpdateError>, IPersistableModel<RealtimeServerUpdateError> {
public RealtimeError Error { get; }
public string EventId { get; }
}
public class RealtimeServerUpdateInputAudioBufferCleared : RealtimeServerUpdate, IJsonModel<RealtimeServerUpdateInputAudioBufferCleared>, IPersistableModel<RealtimeServerUpdateInputAudioBufferCleared> {
public string EventId { get; }
}
public class RealtimeServerUpdateInputAudioBufferCommitted : RealtimeServerUpdate, IJsonModel<RealtimeServerUpdateInputAudioBufferCommitted>, IPersistableModel<RealtimeServerUpdateInputAudioBufferCommitted> {
public string EventId { get; }
public string ItemId { get; }
public string PreviousItemId { get; }
}
public class RealtimeServerUpdateInputAudioBufferDtmfEventReceived : RealtimeServerUpdate, IJsonModel<RealtimeServerUpdateInputAudioBufferDtmfEventReceived>, IPersistableModel<RealtimeServerUpdateInputAudioBufferDtmfEventReceived> {
public string Event { get; }
public DateTimeOffset ReceivedAt { get; }
}
public class RealtimeServerUpdateInputAudioBufferSpeechStarted : RealtimeServerUpdate, IJsonModel<RealtimeServerUpdateInputAudioBufferSpeechStarted>, IPersistableModel<RealtimeServerUpdateInputAudioBufferSpeechStarted> {
public TimeSpan AudioStartTime { get; }
public string EventId { get; }
public string ItemId { get; }
}
public class RealtimeServerUpdateInputAudioBufferSpeechStopped : RealtimeServerUpdate, IJsonModel<RealtimeServerUpdateInputAudioBufferSpeechStopped>, IPersistableModel<RealtimeServerUpdateInputAudioBufferSpeechStopped> {
public TimeSpan AudioEndTime { get; }
public string EventId { get; }
public string ItemId { get; }
}
public class RealtimeServerUpdateInputAudioBufferTimeoutTriggered : RealtimeServerUpdate, IJsonModel<RealtimeServerUpdateInputAudioBufferTimeoutTriggered>, IPersistableModel<RealtimeServerUpdateInputAudioBufferTimeoutTriggered> {
public TimeSpan AudioEndTime { get; }
public TimeSpan AudioStartTime { get; }
public string EventId { get; }
public string ItemId { get; }
}
public class RealtimeServerUpdateMcpListToolsCompleted : RealtimeServerUpdate, IJsonModel<RealtimeServerUpdateMcpListToolsCompleted>, IPersistableModel<RealtimeServerUpdateMcpListToolsCompleted> {
public string EventId { get; }
public string ItemId { get; }
}
public class RealtimeServerUpdateMcpListToolsFailed : RealtimeServerUpdate, IJsonModel<RealtimeServerUpdateMcpListToolsFailed>, IPersistableModel<RealtimeServerUpdateMcpListToolsFailed> {
public string EventId { get; }
public string ItemId { get; }
}
public class RealtimeServerUpdateMcpListToolsInProgress : RealtimeServerUpdate, IJsonModel<RealtimeServerUpdateMcpListToolsInProgress>, IPersistableModel<RealtimeServerUpdateMcpListToolsInProgress> {
public string EventId { get; }
public string ItemId { get; }
}
public class RealtimeServerUpdateOutputAudioBufferCleared : RealtimeServerUpdate, IJsonModel<RealtimeServerUpdateOutputAudioBufferCleared>, IPersistableModel<RealtimeServerUpdateOutputAudioBufferCleared> {
public string EventId { get; }
public string ResponseId { get; }
}
public class RealtimeServerUpdateOutputAudioBufferStarted : RealtimeServerUpdate, IJsonModel<RealtimeServerUpdateOutputAudioBufferStarted>, IPersistableModel<RealtimeServerUpdateOutputAudioBufferStarted> {
public string EventId { get; }
public string ResponseId { get; }
}
public class RealtimeServerUpdateOutputAudioBufferStopped : RealtimeServerUpdate, IJsonModel<RealtimeServerUpdateOutputAudioBufferStopped>, IPersistableModel<RealtimeServerUpdateOutputAudioBufferStopped> {
public string EventId { get; }
public string ResponseId { get; }
}
public class RealtimeServerUpdateRateLimitsUpdated : RealtimeServerUpdate, IJsonModel<RealtimeServerUpdateRateLimitsUpdated>, IPersistableModel<RealtimeServerUpdateRateLimitsUpdated> {
public string EventId { get; }
public IList<RealtimeRateLimitDetails> RateLimitDetails { get; }
}
public class RealtimeServerUpdateResponseContentPartAdded : RealtimeServerUpdate, IJsonModel<RealtimeServerUpdateResponseContentPartAdded>, IPersistableModel<RealtimeServerUpdateResponseContentPartAdded> {
public int ContentIndex { get; }
public string EventId { get; }
public string ItemId { get; }
public int OutputIndex { get; }
public RealtimeResponseContentPart Part { get; }
public string ResponseId { get; }
}
public class RealtimeServerUpdateResponseContentPartDone : RealtimeServerUpdate, IJsonModel<RealtimeServerUpdateResponseContentPartDone>, IPersistableModel<RealtimeServerUpdateResponseContentPartDone> {
public int ContentIndex { get; }
public string EventId { get; }
public string ItemId { get; }
public int OutputIndex { get; }
public RealtimeResponseContentPart Part { get; }
public string ResponseId { get; }
}
public class RealtimeServerUpdateResponseCreated : RealtimeServerUpdate, IJsonModel<RealtimeServerUpdateResponseCreated>, IPersistableModel<RealtimeServerUpdateResponseCreated> {
public string EventId { get; }
public RealtimeResponse Response { get; }
}
public class RealtimeServerUpdateResponseDone : RealtimeServerUpdate, IJsonModel<RealtimeServerUpdateResponseDone>, IPersistableModel<RealtimeServerUpdateResponseDone> {
public string EventId { get; }
public RealtimeResponse Response { get; }
}
public class RealtimeServerUpdateResponseFunctionCallArgumentsDelta : RealtimeServerUpdate, IJsonModel<RealtimeServerUpdateResponseFunctionCallArgumentsDelta>, IPersistableModel<RealtimeServerUpdateResponseFunctionCallArgumentsDelta> {
public string CallId { get; }
public BinaryData Delta { get; }
public string EventId { get; }
public string ItemId { get; }
public int OutputIndex { get; }
public string ResponseId { get; }
}
public class RealtimeServerUpdateResponseFunctionCallArgumentsDone : RealtimeServerUpdate, IJsonModel<RealtimeServerUpdateResponseFunctionCallArgumentsDone>, IPersistableModel<RealtimeServerUpdateResponseFunctionCallArgumentsDone> {
public string CallId { get; }
public string EventId { get; }
public BinaryData FunctionArguments { get; }
public string FunctionName { get; }
public string ItemId { get; }
public int OutputIndex { get; }
public string ResponseId { get; }
}
public class RealtimeServerUpdateResponseMcpCallArgumentsDelta : RealtimeServerUpdate, IJsonModel<RealtimeServerUpdateResponseMcpCallArgumentsDelta>, IPersistableModel<RealtimeServerUpdateResponseMcpCallArgumentsDelta> {
public BinaryData Delta { get; }
public string EventId { get; }
public string ItemId { get; }
public string Obfuscation { get; }
public int OutputIndex { get; }
public string ResponseId { get; }
}
public class RealtimeServerUpdateResponseMcpCallArgumentsDone : RealtimeServerUpdate, IJsonModel<RealtimeServerUpdateResponseMcpCallArgumentsDone>, IPersistableModel<RealtimeServerUpdateResponseMcpCallArgumentsDone> {
public string EventId { get; }
public string ItemId { get; }
public int OutputIndex { get; }
public string ResponseId { get; }
public BinaryData ToolArguments { get; }
}
public class RealtimeServerUpdateResponseMcpCallCompleted : RealtimeServerUpdate, IJsonModel<RealtimeServerUpdateResponseMcpCallCompleted>, IPersistableModel<RealtimeServerUpdateResponseMcpCallCompleted> {
public string EventId { get; }
public string ItemId { get; }
public int OutputIndex { get; }
}
public class RealtimeServerUpdateResponseMcpCallFailed : RealtimeServerUpdate, IJsonModel<RealtimeServerUpdateResponseMcpCallFailed>, IPersistableModel<RealtimeServerUpdateResponseMcpCallFailed> {
public string EventId { get; }
public string ItemId { get; }
public int OutputIndex { get; }
}
public class RealtimeServerUpdateResponseMcpCallInProgress : RealtimeServerUpdate, IJsonModel<RealtimeServerUpdateResponseMcpCallInProgress>, IPersistableModel<RealtimeServerUpdateResponseMcpCallInProgress> {
public string EventId { get; }
public string ItemId { get; }
public int OutputIndex { get; }
}
public class RealtimeServerUpdateResponseOutputAudioDelta : RealtimeServerUpdate, IJsonModel<RealtimeServerUpdateResponseOutputAudioDelta>, IPersistableModel<RealtimeServerUpdateResponseOutputAudioDelta> {
public int ContentIndex { get; }
public BinaryData Delta { get; }
public string EventId { get; }
public string ItemId { get; }
public int OutputIndex { get; }
public string ResponseId { get; }
}
public class RealtimeServerUpdateResponseOutputAudioDone : RealtimeServerUpdate, IJsonModel<RealtimeServerUpdateResponseOutputAudioDone>, IPersistableModel<RealtimeServerUpdateResponseOutputAudioDone> {
public int ContentIndex { get; }
public string EventId { get; }
public string ItemId { get; }
public int OutputIndex { get; }
public string ResponseId { get; }
}
public class RealtimeServerUpdateResponseOutputAudioTranscriptDelta : RealtimeServerUpdate, IJsonModel<RealtimeServerUpdateResponseOutputAudioTranscriptDelta>, IPersistableModel<RealtimeServerUpdateResponseOutputAudioTranscriptDelta> {
public int ContentIndex { get; }
public string Delta { get; }
public string EventId { get; }
public string ItemId { get; }
public int OutputIndex { get; }
public string ResponseId { get; }
}
public class RealtimeServerUpdateResponseOutputAudioTranscriptDone : RealtimeServerUpdate, IJsonModel<RealtimeServerUpdateResponseOutputAudioTranscriptDone>, IPersistableModel<RealtimeServerUpdateResponseOutputAudioTranscriptDone> {
public int ContentIndex { get; }
public string EventId { get; }
public string ItemId { get; }
public int OutputIndex { get; }
public string ResponseId { get; }
public string Transcript { get; }
}
public class RealtimeServerUpdateResponseOutputItemAdded : RealtimeServerUpdate, IJsonModel<RealtimeServerUpdateResponseOutputItemAdded>, IPersistableModel<RealtimeServerUpdateResponseOutputItemAdded> {
public string EventId { get; }
public RealtimeItem Item { get; }
public int OutputIndex { get; }
public string ResponseId { get; }
}
public class RealtimeServerUpdateResponseOutputItemDone : RealtimeServerUpdate, IJsonModel<RealtimeServerUpdateResponseOutputItemDone>, IPersistableModel<RealtimeServerUpdateResponseOutputItemDone> {
public string EventId { get; }
public RealtimeItem Item { get; }
public int OutputIndex { get; }
public string ResponseId { get; }
}
public class RealtimeServerUpdateResponseOutputTextDelta : RealtimeServerUpdate, IJsonModel<RealtimeServerUpdateResponseOutputTextDelta>, IPersistableModel<RealtimeServerUpdateResponseOutputTextDelta> {
public int ContentIndex { get; }
public string Delta { get; }
public string EventId { get; }
public string ItemId { get; }
public int OutputIndex { get; }
public string ResponseId { get; }
}
public class RealtimeServerUpdateResponseOutputTextDone : RealtimeServerUpdate, IJsonModel<RealtimeServerUpdateResponseOutputTextDone>, IPersistableModel<RealtimeServerUpdateResponseOutputTextDone> {
public int ContentIndex { get; }
public string EventId { get; }
public string ItemId { get; }
public int OutputIndex { get; }
public string ResponseId { get; }
public string Text { get; }
}
public class RealtimeServerUpdateSessionCreated : RealtimeServerUpdate, IJsonModel<RealtimeServerUpdateSessionCreated>, IPersistableModel<RealtimeServerUpdateSessionCreated> {
public string EventId { get; }
public RealtimeSession Session { get; }
}
public class RealtimeServerUpdateSessionUpdated : RealtimeServerUpdate, IJsonModel<RealtimeServerUpdateSessionUpdated>, IPersistableModel<RealtimeServerUpdateSessionUpdated> {
public string EventId { get; }
public RealtimeSession Session { get; }
}
public class RealtimeServerVadTurnDetection : RealtimeTurnDetection, IJsonModel<RealtimeServerVadTurnDetection>, IPersistableModel<RealtimeServerVadTurnDetection> {
public RealtimeServerVadTurnDetection();
public bool? CreateResponseEnabled { get; set; }
public float? DetectionThreshold { get; set; }
public TimeSpan? IdleTimeout { get; set; }
public bool? InterruptResponseEnabled { get; set; }
public TimeSpan? PrefixPadding { get; set; }
public TimeSpan? SilenceDuration { get; set; }
}
public class RealtimeSession : IJsonModel<RealtimeSession>, IPersistableModel<RealtimeSession> {
[Serialization.JsonIgnore]
[EditorBrowsable(EditorBrowsableState.Never)]
public ref JsonPatch Patch { get; }
}
public class RealtimeSessionClient : IDisposable {
protected internal RealtimeSessionClient(ApiKeyCredential credential, Uri endpoint, string model, string intent, RealtimeClient parentClient);
public Net.WebSockets.WebSocket WebSocket { get; protected set; }
public virtual void AddItem(RealtimeItem item, string previousItemId, CancellationToken cancellationToken = default);
public virtual void AddItem(RealtimeItem item, CancellationToken cancellationToken = default);
public virtual Task AddItemAsync(RealtimeItem item, string previousItemId, CancellationToken cancellationToken = default);
public virtual Task AddItemAsync(RealtimeItem item, CancellationToken cancellationToken = default);
public virtual void CancelResponse(CancellationToken cancellationToken = default);
public virtual Task CancelResponseAsync(CancellationToken cancellationToken = default);
public virtual void ClearInputAudio(CancellationToken cancellationToken = default);
public virtual Task ClearInputAudioAsync(CancellationToken cancellationToken = default);
public virtual void CommitPendingAudio(CancellationToken cancellationToken = default);
public virtual Task CommitPendingAudioAsync(CancellationToken cancellationToken = default);
public virtual void ConfigureConversationSession(RealtimeConversationSessionOptions sessionOptions, CancellationToken cancellationToken = default);
public virtual Task ConfigureConversationSessionAsync(RealtimeConversationSessionOptions sessionOptions, CancellationToken cancellationToken = default);
public virtual void ConfigureTranscriptionSession(RealtimeTranscriptionSessionOptions sessionOptions, CancellationToken cancellationToken = default);
public virtual Task ConfigureTranscriptionSessionAsync(RealtimeTranscriptionSessionOptions sessionOptions, CancellationToken cancellationToken = default);
protected internal virtual void Connect(string queryString = null, IDictionary<string, string> headers = null, CancellationToken cancellationToken = default);
protected internal virtual Task ConnectAsync(string queryString = null, IDictionary<string, string> headers = null, CancellationToken cancellationToken = default);
public virtual void DeleteItem(string itemId, CancellationToken cancellationToken = default);
public virtual Task DeleteItemAsync(string itemId, CancellationToken cancellationToken = default);
public void Dispose();
public virtual IEnumerable<ClientResult> ReceiveUpdates(RequestOptions options);
public virtual IEnumerable<RealtimeServerUpdate> ReceiveUpdates(CancellationToken cancellationToken = default);
public virtual IAsyncEnumerable<ClientResult> ReceiveUpdatesAsync(RequestOptions options);
public virtual IAsyncEnumerable<RealtimeServerUpdate> ReceiveUpdatesAsync(CancellationToken cancellationToken = default);
public virtual void RequestItemRetrieval(string itemId, CancellationToken cancellationToken = default);
public virtual Task RequestItemRetrievalAsync(string itemId, CancellationToken cancellationToken = default);
public virtual void SendCommand(RealtimeClientCommand command, CancellationToken cancellationToken = default);
public virtual void SendCommand(BinaryData data, RequestOptions options);
public virtual Task SendCommandAsync(RealtimeClientCommand command, CancellationToken cancellationToken = default);
public virtual Task SendCommandAsync(BinaryData data, RequestOptions options);
public virtual void SendInputAudio(BinaryData audio, CancellationToken cancellationToken = default);
public virtual void SendInputAudio(Stream audio, CancellationToken cancellationToken = default);
public virtual Task SendInputAudioAsync(BinaryData audio, CancellationToken cancellationToken = default);
public virtual Task SendInputAudioAsync(Stream audio, CancellationToken cancellationToken = default);
public virtual void StartResponse(RealtimeResponseOptions responseOptions, CancellationToken cancellationToken = default);
public virtual void StartResponse(CancellationToken cancellationToken = default);
public virtual Task StartResponseAsync(RealtimeResponseOptions responseOptions, CancellationToken cancellationToken = default);
public virtual Task StartResponseAsync(CancellationToken cancellationToken = default);
public virtual void TruncateItem(string itemId, int contentPartIndex, TimeSpan audioDuration, CancellationToken cancellationToken = default);
public virtual Task TruncateItemAsync(string itemId, int contentPartIndex, TimeSpan audioDuration, CancellationToken cancellationToken = default);
}
public class RealtimeSessionClientOptions {
public string ClientSecret { get; set; }
public IDictionary<string, string> Headers { get; }
public string QueryString { get; set; }
}
public class RealtimeSessionOptions : IJsonModel<RealtimeSessionOptions>, IPersistableModel<RealtimeSessionOptions> {
[Serialization.JsonIgnore]
[EditorBrowsable(EditorBrowsableState.Never)]
public ref JsonPatch Patch { get; }
}
public class RealtimeTool : IJsonModel<RealtimeTool>, IPersistableModel<RealtimeTool> {
[Serialization.JsonIgnore]
[EditorBrowsable(EditorBrowsableState.Never)]
public ref JsonPatch Patch { get; }
}
public class RealtimeToolChoice : IJsonModel<RealtimeToolChoice>, IPersistableModel<RealtimeToolChoice> {
public RealtimeToolChoice(RealtimeCustomToolChoice customToolChoice);
public RealtimeToolChoice(RealtimeDefaultToolChoice defaultToolChoice);
public RealtimeCustomToolChoice CustomToolChoice { get; }
public RealtimeDefaultToolChoice? DefaultToolChoice { get; }
[Serialization.JsonIgnore]
[EditorBrowsable(EditorBrowsableState.Never)]
public ref JsonPatch Patch { get; }
public static implicit operator RealtimeToolChoice(RealtimeCustomToolChoice customToolChoice);
public static implicit operator RealtimeToolChoice(RealtimeDefaultToolChoice defaultToolChoice);
}
public class RealtimeTracing : IJsonModel<RealtimeTracing>, IPersistableModel<RealtimeTracing> {
public RealtimeTracing(RealtimeCustomTracing customTracing);
public RealtimeTracing(RealtimeDefaultTracing defaultTracing);
public RealtimeCustomTracing CustomTracing { get; }
public RealtimeDefaultTracing? DefaultTracing { get; }
[Serialization.JsonIgnore]
[EditorBrowsable(EditorBrowsableState.Never)]
public ref JsonPatch Patch { get; }
public static implicit operator RealtimeTracing(RealtimeCustomTracing customTracing);
public static implicit operator RealtimeTracing(RealtimeDefaultTracing defaultTracing);
}
public class RealtimeTranscriptionDurationUsage : RealtimeTranscriptionUsage, IJsonModel<RealtimeTranscriptionDurationUsage>, IPersistableModel<RealtimeTranscriptionDurationUsage> {
public TimeSpan Duration { get; }
}
public class RealtimeTranscriptionInputTokenUsageDetails : IJsonModel<RealtimeTranscriptionInputTokenUsageDetails>, IPersistableModel<RealtimeTranscriptionInputTokenUsageDetails> {
public int? AudioTokenCount { get; }
[Serialization.JsonIgnore]
[EditorBrowsable(EditorBrowsableState.Never)]
public ref JsonPatch Patch { get; }
public int? TextTokenCount { get; }
}
public class RealtimeTranscriptionSession : RealtimeSession, IJsonModel<RealtimeTranscriptionSession>, IPersistableModel<RealtimeTranscriptionSession> {
public RealtimeTranscriptionSessionAudioOptions AudioOptions { get; set; }
public DateTimeOffset? ExpiresAt { get; }
public string Id { get; }
public IList<RealtimeIncludedProperty> IncludedProperties { get; }
public string Object { get; }
}
public class RealtimeTranscriptionSessionAudioOptions : IJsonModel<RealtimeTranscriptionSessionAudioOptions>, IPersistableModel<RealtimeTranscriptionSessionAudioOptions> {
public RealtimeTranscriptionSessionInputAudioOptions InputAudioOptions { get; set; }
[Serialization.JsonIgnore]
[EditorBrowsable(EditorBrowsableState.Never)]
public ref JsonPatch Patch { get; }
}
public class RealtimeTranscriptionSessionInputAudioOptions : IJsonModel<RealtimeTranscriptionSessionInputAudioOptions>, IPersistableModel<RealtimeTranscriptionSessionInputAudioOptions> {
public RealtimeAudioFormat AudioFormat { get; set; }
public RealtimeAudioTranscriptionOptions AudioTranscriptionOptions { get; set; }
public RealtimeNoiseReduction NoiseReduction { get; set; }
[Serialization.JsonIgnore]
[EditorBrowsable(EditorBrowsableState.Never)]
public ref JsonPatch Patch { get; }
public RealtimeTurnDetection TurnDetection { get; set; }
public void DisableTurnDetection();
}
public class RealtimeTranscriptionSessionOptions : RealtimeSessionOptions, IJsonModel<RealtimeTranscriptionSessionOptions>, IPersistableModel<RealtimeTranscriptionSessionOptions> {
public RealtimeTranscriptionSessionOptions();
public RealtimeTranscriptionSessionAudioOptions AudioOptions { get; set; }
public IList<RealtimeIncludedProperty> IncludedProperties { get; }
}
public class RealtimeTranscriptionTokenUsage : RealtimeTranscriptionUsage, IJsonModel<RealtimeTranscriptionTokenUsage>, IPersistableModel<RealtimeTranscriptionTokenUsage> {
public int InputTokenCount { get; }
public RealtimeTranscriptionInputTokenUsageDetails InputTokenDetails { get; }
public int OutputTokenCount { get; }
public int TotalTokenCount { get; }
}
public class RealtimeTranscriptionUsage : IJsonModel<RealtimeTranscriptionUsage>, IPersistableModel<RealtimeTranscriptionUsage> {
[Serialization.JsonIgnore]
[EditorBrowsable(EditorBrowsableState.Never)]
public ref JsonPatch Patch { get; }
}
public class RealtimeTruncation : IJsonModel<RealtimeTruncation>, IPersistableModel<RealtimeTruncation> {
public RealtimeTruncation(RealtimeCustomTruncation customTruncation);
public RealtimeTruncation(RealtimeDefaultTruncation defaultTruncation);
public RealtimeCustomTruncation CustomTruncation { get; }
public RealtimeDefaultTruncation? DefaultTruncation { get; }
[Serialization.JsonIgnore]
[EditorBrowsable(EditorBrowsableState.Never)]
public ref JsonPatch Patch { get; }
public static implicit operator RealtimeTruncation(RealtimeCustomTruncation customTruncation);
public static implicit operator RealtimeTruncation(RealtimeDefaultTruncation defaultTruncation);
}
public class RealtimeTurnDetection : IJsonModel<RealtimeTurnDetection>, IPersistableModel<RealtimeTurnDetection> {
[Serialization.JsonIgnore]
[EditorBrowsable(EditorBrowsableState.Never)]
public ref JsonPatch Patch { get; }
}
public readonly partial struct RealtimeVoice : IEquatable<RealtimeVoice> {
public RealtimeVoice(string value);
public static RealtimeVoice Alloy { get; }
public static RealtimeVoice Ash { get; }
public static RealtimeVoice Ballad { get; }
public static RealtimeVoice Cedar { get; }
public static RealtimeVoice Coral { get; }
public static RealtimeVoice Echo { get; }
public static RealtimeVoice Marin { get; }
public static RealtimeVoice Sage { get; }
public static RealtimeVoice Shimmer { get; }
public static RealtimeVoice Verse { get; }
public readonly bool Equals(RealtimeVoice other);
[EditorBrowsable(EditorBrowsableState.Never)]
public override readonly bool Equals(object obj);
[EditorBrowsable(EditorBrowsableState.Never)]
public override readonly int GetHashCode();
public static bool operator ==(RealtimeVoice left, RealtimeVoice right);
public static implicit operator RealtimeVoice(string value);
public static implicit operator RealtimeVoice?(string value);
public static bool operator !=(RealtimeVoice left, RealtimeVoice right);
public override readonly string ToString();
}
}
namespace OpenAI.Responses {
public class ApplyPatchCallItem : ResponseItem, IJsonModel<ApplyPatchCallItem>, IPersistableModel<ApplyPatchCallItem> {
public ApplyPatchCallItem(string callId, ApplyPatchOperation operation) : base(default);
public string CallId { get; set; }
public string CreatedBy { get; set; }
public ApplyPatchOperation Operation { get; set; }
public ApplyPatchCallStatus? Status { get; set; }
}
public class ApplyPatchCallOutputItem : ResponseItem, IJsonModel<ApplyPatchCallOutputItem>, IPersistableModel<ApplyPatchCallOutputItem> {
public ApplyPatchCallOutputItem(string callId, ApplyPatchCallOutputStatus status) : base(default);
public string CallId { get; set; }
public string CreatedBy { get; set; }
public string Output { get; set; }
public ApplyPatchCallOutputStatus Status { get; set; }
}
public readonly partial struct ApplyPatchCallOutputStatus : IEquatable<ApplyPatchCallOutputStatus> {
public ApplyPatchCallOutputStatus(string value);
public static ApplyPatchCallOutputStatus Completed { get; }
public static ApplyPatchCallOutputStatus Failed { get; }
public readonly bool Equals(ApplyPatchCallOutputStatus other);
[EditorBrowsable(EditorBrowsableState.Never)]
public override readonly bool Equals(object obj);
[EditorBrowsable(EditorBrowsableState.Never)]
public override readonly int GetHashCode();
public static bool operator ==(ApplyPatchCallOutputStatus left, ApplyPatchCallOutputStatus right);
public static implicit operator ApplyPatchCallOutputStatus(string value);
public static implicit operator ApplyPatchCallOutputStatus?(string value);
public static bool operator !=(ApplyPatchCallOutputStatus left, ApplyPatchCallOutputStatus right);
public override readonly string ToString();
}
public readonly partial struct ApplyPatchCallStatus : IEquatable<ApplyPatchCallStatus> {
public ApplyPatchCallStatus(string value);
public static ApplyPatchCallStatus Completed { get; }
public static ApplyPatchCallStatus InProgress { get; }
public readonly bool Equals(ApplyPatchCallStatus other);
[EditorBrowsable(EditorBrowsableState.Never)]
public override readonly bool Equals(object obj);
[EditorBrowsable(EditorBrowsableState.Never)]
public override readonly int GetHashCode();
public static bool operator ==(ApplyPatchCallStatus left, ApplyPatchCallStatus right);
public static implicit operator ApplyPatchCallStatus(string value);
public static implicit operator ApplyPatchCallStatus?(string value);
public static bool operator !=(ApplyPatchCallStatus left, ApplyPatchCallStatus right);
public override readonly string ToString();
}
public class ApplyPatchCreateFileOperation : ApplyPatchOperation, IJsonModel<ApplyPatchCreateFileOperation>, IPersistableModel<ApplyPatchCreateFileOperation> {
public ApplyPatchCreateFileOperation(string filePath, string diff);
public string Diff { get; set; }
public string FilePath { get; set; }
}
public class ApplyPatchDeleteFileOperation : ApplyPatchOperation, IJsonModel<ApplyPatchDeleteFileOperation>, IPersistableModel<ApplyPatchDeleteFileOperation> {
public ApplyPatchDeleteFileOperation(string filePath);
public string FilePath { get; set; }
}
public class ApplyPatchOperation : IJsonModel<ApplyPatchOperation>, IPersistableModel<ApplyPatchOperation> {
[Serialization.JsonIgnore]
[EditorBrowsable(EditorBrowsableState.Never)]
public ref JsonPatch Patch { get; }
}
public class ApplyPatchTool : ResponseTool, IJsonModel<ApplyPatchTool>, IPersistableModel<ApplyPatchTool> {
public ApplyPatchTool() : base(default);
}
public class ApplyPatchUpdateFileOperation : ApplyPatchOperation, IJsonModel<ApplyPatchUpdateFileOperation>, IPersistableModel<ApplyPatchUpdateFileOperation> {
public ApplyPatchUpdateFileOperation(string filePath, string diff);
public string Diff { get; set; }
public string FilePath { get; set; }
}
public class AutomaticCodeInterpreterToolContainerConfiguration : CodeInterpreterToolContainerConfiguration, IJsonModel<AutomaticCodeInterpreterToolContainerConfiguration>, IPersistableModel<AutomaticCodeInterpreterToolContainerConfiguration> {
public AutomaticCodeInterpreterToolContainerConfiguration();
public IList<string> FileIds { get; }
}
public class CodeInterpreterCallImageOutput : CodeInterpreterCallOutput, IJsonModel<CodeInterpreterCallImageOutput>, IPersistableModel<CodeInterpreterCallImageOutput> {
public CodeInterpreterCallImageOutput(Uri imageUri);
public Uri ImageUri { get; set; }
}
public class CodeInterpreterCallLogsOutput : CodeInterpreterCallOutput, IJsonModel<CodeInterpreterCallLogsOutput>, IPersistableModel<CodeInterpreterCallLogsOutput> {
public CodeInterpreterCallLogsOutput(string logs);
public string Logs { get; set; }
}
public class CodeInterpreterCallOutput : IJsonModel<CodeInterpreterCallOutput>, IPersistableModel<CodeInterpreterCallOutput> {
[Serialization.JsonIgnore]
[EditorBrowsable(EditorBrowsableState.Never)]
public ref JsonPatch Patch { get; }
}
public class CodeInterpreterCallResponseItem : ResponseItem, IJsonModel<CodeInterpreterCallResponseItem>, IPersistableModel<CodeInterpreterCallResponseItem> {
public CodeInterpreterCallResponseItem(string code) : base(default);
public string Code { get; set; }
public string ContainerId { get; set; }
public IList<CodeInterpreterCallOutput> Outputs { get; }
public CodeInterpreterCallStatus? Status { get; set; }
}
public enum CodeInterpreterCallStatus {
InProgress = 0,
Interpreting = 1,
Completed = 2,
Incomplete = 3,
Failed = 4
}
public class CodeInterpreterTool : ResponseTool, IJsonModel<CodeInterpreterTool>, IPersistableModel<CodeInterpreterTool> {
public CodeInterpreterTool(CodeInterpreterToolContainer container) : base(default);
public CodeInterpreterToolContainer Container { get; }
}
public class CodeInterpreterToolContainer : IJsonModel<CodeInterpreterToolContainer>, IPersistableModel<CodeInterpreterToolContainer> {
public CodeInterpreterToolContainer(CodeInterpreterToolContainerConfiguration containerConfiguration);
public CodeInterpreterToolContainer(string containerId);
public CodeInterpreterToolContainerConfiguration ContainerConfiguration { get; }
public string ContainerId { get; }
[Serialization.JsonIgnore]
[EditorBrowsable(EditorBrowsableState.Never)]
public ref JsonPatch Patch { get; }
}
public class CodeInterpreterToolContainerConfiguration : IJsonModel<CodeInterpreterToolContainerConfiguration>, IPersistableModel<CodeInterpreterToolContainerConfiguration> {
[Serialization.JsonIgnore]
[EditorBrowsable(EditorBrowsableState.Never)]
public ref JsonPatch Patch { get; }
public static AutomaticCodeInterpreterToolContainerConfiguration CreateAutomaticContainerConfiguration(IEnumerable<string> fileIds = null);
}
public class ComputerCallAction : IJsonModel<ComputerCallAction>, IPersistableModel<ComputerCallAction> {
public Drawing.Point? ClickCoordinates { get; }
public ComputerCallActionMouseButton? ClickMouseButton { get; }
public Drawing.Point? DoubleClickCoordinates { get; }
public IList<Drawing.Point> DragPath { get; }
public IList<string> KeyPressKeyCodes { get; }
public ComputerCallActionKind Kind { get; }
public Drawing.Point? MoveCoordinates { get; }
[Serialization.JsonIgnore]
[EditorBrowsable(EditorBrowsableState.Never)]
public ref JsonPatch Patch { get; }
public Drawing.Point? ScrollCoordinates { get; }
public int? ScrollHorizontalOffset { get; }
public int? ScrollVerticalOffset { get; }
public string TypeText { get; }
public static ComputerCallAction CreateClickAction(Drawing.Point clickCoordinates, ComputerCallActionMouseButton clickMouseButton);
public static ComputerCallAction CreateDoubleClickAction(Drawing.Point doubleClickCoordinates, ComputerCallActionMouseButton doubleClickMouseButton);
public static ComputerCallAction CreateDragAction(IList<Drawing.Point> dragPath);
public static ComputerCallAction CreateKeyPressAction(IList<string> keyCodes);
public static ComputerCallAction CreateMoveAction(Drawing.Point moveCoordinates);
public static ComputerCallAction CreateScreenshotAction();
public static ComputerCallAction CreateScrollAction(Drawing.Point scrollCoordinates, int horizontalOffset, int verticalOffset);
public static ComputerCallAction CreateTypeAction(string typeText);
public static ComputerCallAction CreateWaitAction();
}
public enum ComputerCallActionKind {
Click = 0,
DoubleClick = 1,
Drag = 2,
KeyPress = 3,
Move = 4,
Screenshot = 5,
Scroll = 6,
Type = 7,
Wait = 8
}
public enum ComputerCallActionMouseButton {
Left = 0,
Right = 1,
Wheel = 2,
Back = 3,
Forward = 4
}
public class ComputerCallOutput : IJsonModel<ComputerCallOutput>, IPersistableModel<ComputerCallOutput> {
[Serialization.JsonIgnore]
[EditorBrowsable(EditorBrowsableState.Never)]
public ref JsonPatch Patch { get; }
public static ComputerCallOutput CreateScreenshotOutput(BinaryData screenshotImageBytes, string screenshotImageBytesMediaType);
public static ComputerCallOutput CreateScreenshotOutput(string screenshotImageFileId);
public static ComputerCallOutput CreateScreenshotOutput(Uri screenshotImageUri);
}
public class ComputerCallOutputResponseItem : ResponseItem, IJsonModel<ComputerCallOutputResponseItem>, IPersistableModel<ComputerCallOutputResponseItem> {
public ComputerCallOutputResponseItem(string callId, ComputerCallOutput output) : base(default);
public IList<ComputerCallSafetyCheck> AcknowledgedSafetyChecks { get; }
public string CallId { get; set; }
public ComputerCallOutput Output { get; set; }
public ComputerCallOutputStatus? Status { get; set; }
}
public enum ComputerCallOutputStatus {
InProgress = 0,
Completed = 1,
Incomplete = 2
}
public class ComputerCallResponseItem : ResponseItem, IJsonModel<ComputerCallResponseItem>, IPersistableModel<ComputerCallResponseItem> {
public ComputerCallResponseItem(string callId, ComputerCallAction action, IEnumerable<ComputerCallSafetyCheck> pendingSafetyChecks) : base(default);
public ComputerCallAction Action { get; set; }
public string CallId { get; set; }
public IList<ComputerCallSafetyCheck> PendingSafetyChecks { get; }
public ComputerCallStatus? Status { get; set; }
}
public class ComputerCallSafetyCheck : IJsonModel<ComputerCallSafetyCheck>, IPersistableModel<ComputerCallSafetyCheck> {
public ComputerCallSafetyCheck(string id, string code, string message);
public string Code { get; set; }
public string Id { get; set; }
public string Message { get; set; }
[Serialization.JsonIgnore]
[EditorBrowsable(EditorBrowsableState.Never)]
public ref JsonPatch Patch { get; }
}
public enum ComputerCallStatus {
InProgress = 0,
Completed = 1,
Incomplete = 2
}
public class ComputerTool : ResponseTool, IJsonModel<ComputerTool>, IPersistableModel<ComputerTool> {
public ComputerTool(ComputerToolEnvironment environment, int displayWidth, int displayHeight) : base(default);
public int DisplayHeight { get; set; }
public int DisplayWidth { get; set; }
public ComputerToolEnvironment Environment { get; set; }
}
public readonly partial struct ComputerToolEnvironment : IEquatable<ComputerToolEnvironment> {
public ComputerToolEnvironment(string value);
public static ComputerToolEnvironment Browser { get; }
public static ComputerToolEnvironment Linux { get; }
public static ComputerToolEnvironment Mac { get; }
public static ComputerToolEnvironment Ubuntu { get; }
public static ComputerToolEnvironment Windows { get; }
public readonly bool Equals(ComputerToolEnvironment other);
[EditorBrowsable(EditorBrowsableState.Never)]
public override readonly bool Equals(object obj);
[EditorBrowsable(EditorBrowsableState.Never)]
public override readonly int GetHashCode();
public static bool operator ==(ComputerToolEnvironment left, ComputerToolEnvironment right);
public static implicit operator ComputerToolEnvironment(string value);
public static implicit operator ComputerToolEnvironment?(string value);
public static bool operator !=(ComputerToolEnvironment left, ComputerToolEnvironment right);
public override readonly string ToString();
}
public class ContainerFileCitationMessageAnnotation : ResponseMessageAnnotation, IJsonModel<ContainerFileCitationMessageAnnotation>, IPersistableModel<ContainerFileCitationMessageAnnotation> {
public ContainerFileCitationMessageAnnotation(string containerId, string fileId, int startIndex, int endIndex, string filename);
public string ContainerId { get; set; }
public int EndIndex { get; set; }
public string FileId { get; set; }
public string Filename { get; set; }
public int StartIndex { get; set; }
}
public class CreateResponseOptions : IJsonModel<CreateResponseOptions>, IPersistableModel<CreateResponseOptions> {
public CreateResponseOptions();
public CreateResponseOptions(string model, IEnumerable<ResponseItem> inputItems);
public bool? BackgroundModeEnabled { get; set; }
public ResponseConversationOptions ConversationOptions { get; set; }
public string EndUserId { get; set; }
public IList<IncludedResponseProperty> IncludedProperties { get; }
public IList<ResponseItem> InputItems { get; }
public string Instructions { get; set; }
public int? MaxOutputTokenCount { get; set; }
public int? MaxToolCallCount { get; set; }
public IDictionary<string, string> Metadata { get; }
public string Model { get; set; }
public bool? ParallelToolCallsEnabled { get; set; }
[Serialization.JsonIgnore]
[EditorBrowsable(EditorBrowsableState.Never)]
public ref JsonPatch Patch { get; }
public string PreviousResponseId { get; set; }
public ResponseReasoningOptions ReasoningOptions { get; set; }
public string SafetyIdentifier { get; set; }
public ResponseServiceTier? ServiceTier { get; set; }
public bool? StoredOutputEnabled { get; set; }
public bool? StreamingEnabled { get; set; }
public float? Temperature { get; set; }
public ResponseTextOptions TextOptions { get; set; }
public ResponseToolChoice ToolChoice { get; set; }
public IList<ResponseTool> Tools { get; }
public int? TopLogProbabilityCount { get; set; }
public float? TopP { get; set; }
public ResponseTruncationMode? TruncationMode { get; set; }
public static implicit operator BinaryContent(CreateResponseOptions createResponseOptions);
}
public class CustomMcpToolCallApprovalPolicy : IJsonModel<CustomMcpToolCallApprovalPolicy>, IPersistableModel<CustomMcpToolCallApprovalPolicy> {
[Serialization.JsonIgnore]
[EditorBrowsable(EditorBrowsableState.Never)]
public ref JsonPatch Patch { get; }
public McpToolFilter ToolsAlwaysRequiringApproval { get; set; }
public McpToolFilter ToolsNeverRequiringApproval { get; set; }
}
public class FileCitationMessageAnnotation : ResponseMessageAnnotation, IJsonModel<FileCitationMessageAnnotation>, IPersistableModel<FileCitationMessageAnnotation> {
public FileCitationMessageAnnotation(string fileId, int index, string filename);
public string FileId { get; set; }
public string Filename { get; set; }
public int Index { get; set; }
}
public class FilePathMessageAnnotation : ResponseMessageAnnotation, IJsonModel<FilePathMessageAnnotation>, IPersistableModel<FilePathMessageAnnotation> {
public FilePathMessageAnnotation(string fileId, int index);
public string FileId { get; set; }
public int Index { get; set; }
}
public class FileSearchCallResponseItem : ResponseItem, IJsonModel<FileSearchCallResponseItem>, IPersistableModel<FileSearchCallResponseItem> {
public FileSearchCallResponseItem(IEnumerable<string> queries) : base(default);
public IList<string> Queries { get; }
public IList<FileSearchCallResult> Results { get; set; }
public FileSearchCallStatus? Status { get; set; }
}
public class FileSearchCallResult : IJsonModel<FileSearchCallResult>, IPersistableModel<FileSearchCallResult> {
public IDictionary<string, BinaryData> Attributes { get; }
public string FileId { get; set; }
public string Filename { get; set; }
[Serialization.JsonIgnore]
[EditorBrowsable(EditorBrowsableState.Never)]
public ref JsonPatch Patch { get; }
public float? Score { get; set; }
public string Text { get; set; }
}
public enum FileSearchCallStatus {
InProgress = 0,
Searching = 1,
Completed = 2,
Incomplete = 3,
Failed = 4
}
public class FileSearchTool : ResponseTool, IJsonModel<FileSearchTool>, IPersistableModel<FileSearchTool> {
public FileSearchTool(IEnumerable<string> vectorStoreIds) : base(default);
public BinaryData Filters { get; set; }
public int? MaxResultCount { get; set; }
public FileSearchToolRankingOptions RankingOptions { get; set; }
public IList<string> VectorStoreIds { get; }
}
public readonly partial struct FileSearchToolRanker : IEquatable<FileSearchToolRanker> {
public FileSearchToolRanker(string value);
public static FileSearchToolRanker Auto { get; }
public static FileSearchToolRanker Default20241115 { get; }
public readonly bool Equals(FileSearchToolRanker other);
[EditorBrowsable(EditorBrowsableState.Never)]
public override readonly bool Equals(object obj);
[EditorBrowsable(EditorBrowsableState.Never)]
public override readonly int GetHashCode();
public static bool operator ==(FileSearchToolRanker left, FileSearchToolRanker right);
public static implicit operator FileSearchToolRanker(string value);
public static implicit operator FileSearchToolRanker?(string value);
public static bool operator !=(FileSearchToolRanker left, FileSearchToolRanker right);
public override readonly string ToString();
}
public class FileSearchToolRankingOptions : IJsonModel<FileSearchToolRankingOptions>, IPersistableModel<FileSearchToolRankingOptions> {
[Serialization.JsonIgnore]
[EditorBrowsable(EditorBrowsableState.Never)]
public ref JsonPatch Patch { get; }
public FileSearchToolRanker? Ranker { get; set; }
public float? ScoreThreshold { get; set; }
}
public class FunctionCallOutputResponseItem : ResponseItem, IJsonModel<FunctionCallOutputResponseItem>, IPersistableModel<FunctionCallOutputResponseItem> {
public FunctionCallOutputResponseItem(string callId, string functionOutput) : base(default);
public string CallId { get; set; }
public string FunctionOutput { get; set; }
public FunctionCallOutputStatus? Status { get; set; }
}
public enum FunctionCallOutputStatus {
InProgress = 0,
Completed = 1,
Incomplete = 2
}
public class FunctionCallResponseItem : ResponseItem, IJsonModel<FunctionCallResponseItem>, IPersistableModel<FunctionCallResponseItem> {
public FunctionCallResponseItem(string callId, string functionName, BinaryData functionArguments) : base(default);
public string CallId { get; set; }
public BinaryData FunctionArguments { get; set; }
public string FunctionName { get; set; }
public FunctionCallStatus? Status { get; set; }
}
public enum FunctionCallStatus {
InProgress = 0,
Completed = 1,
Incomplete = 2
}
public class FunctionTool : ResponseTool, IJsonModel<FunctionTool>, IPersistableModel<FunctionTool> {
public FunctionTool(string functionName, BinaryData functionParameters, bool? strictModeEnabled) : base(default);
public string FunctionDescription { get; set; }
public string FunctionName { get; set; }
public BinaryData FunctionParameters { get; set; }
public bool? StrictModeEnabled { get; set; }
}
public class GetResponseOptions : IJsonModel<GetResponseOptions>, IPersistableModel<GetResponseOptions> {
public GetResponseOptions(string responseId);
public IList<IncludedResponseProperty> IncludedProperties { get; set; }
public bool? IncludeObfuscation { get; set; }
[Serialization.JsonIgnore]
[EditorBrowsable(EditorBrowsableState.Never)]
public ref JsonPatch Patch { get; }
public string ResponseId { get; }
public int? StartingAfter { get; set; }
public bool? StreamingEnabled { get; set; }
}
public readonly partial struct GlobalMcpToolCallApprovalPolicy : IEquatable<GlobalMcpToolCallApprovalPolicy> {
public GlobalMcpToolCallApprovalPolicy(string value);
public static GlobalMcpToolCallApprovalPolicy AlwaysRequireApproval { get; }
public static GlobalMcpToolCallApprovalPolicy NeverRequireApproval { get; }
public readonly bool Equals(GlobalMcpToolCallApprovalPolicy other);
[EditorBrowsable(EditorBrowsableState.Never)]
public override readonly bool Equals(object obj);
[EditorBrowsable(EditorBrowsableState.Never)]
public override readonly int GetHashCode();
public static bool operator ==(GlobalMcpToolCallApprovalPolicy left, GlobalMcpToolCallApprovalPolicy right);
public static implicit operator GlobalMcpToolCallApprovalPolicy(string value);
public static implicit operator GlobalMcpToolCallApprovalPolicy?(string value);
public static bool operator !=(GlobalMcpToolCallApprovalPolicy left, GlobalMcpToolCallApprovalPolicy right);
public override readonly string ToString();
}
public class ImageGenerationCallResponseItem : ResponseItem, IJsonModel<ImageGenerationCallResponseItem>, IPersistableModel<ImageGenerationCallResponseItem> {
public ImageGenerationCallResponseItem(BinaryData imageResultBytes) : base(default);
public ImageGenerationToolAction? Action { get; set; }
public ImageGenerationToolBackground? Background { get; set; }
public BinaryData ImageResultBytes { get; set; }
public ImageGenerationToolOutputFileFormat? OutputFileFormat { get; set; }
public ImageGenerationToolQuality? Quality { get; set; }
public string RevisedPrompt { get; set; }
public ImageGenerationToolSize? Size { get; set; }
public ImageGenerationCallStatus? Status { get; set; }
}
public enum ImageGenerationCallStatus {
InProgress = 0,
Completed = 1,
Generating = 2,
Failed = 3
}
public class ImageGenerationTool : ResponseTool, IJsonModel<ImageGenerationTool>, IPersistableModel<ImageGenerationTool> {
public ImageGenerationTool() : base(default);
public ImageGenerationToolAction? Action { get; set; }
public ImageGenerationToolBackground? Background { get; set; }
public ImageGenerationToolInputFidelity? InputFidelity { get; set; }
public ImageGenerationToolInputImageMask InputImageMask { get; set; }
public string Model { get; set; }
public ImageGenerationToolModerationLevel? ModerationLevel { get; set; }
public int? OutputCompressionFactor { get; set; }
public ImageGenerationToolOutputFileFormat? OutputFileFormat { get; set; }
public int? PartialImageCount { get; set; }
public ImageGenerationToolQuality? Quality { get; set; }
public ImageGenerationToolSize? Size { get; set; }
}
public readonly partial struct ImageGenerationToolAction : IEquatable<ImageGenerationToolAction> {
public ImageGenerationToolAction(string value);
public static ImageGenerationToolAction Auto { get; }
public static ImageGenerationToolAction Edit { get; }
public static ImageGenerationToolAction Generate { get; }
public readonly bool Equals(ImageGenerationToolAction other);
[EditorBrowsable(EditorBrowsableState.Never)]
public override readonly bool Equals(object obj);
[EditorBrowsable(EditorBrowsableState.Never)]
public override readonly int GetHashCode();
public static bool operator ==(ImageGenerationToolAction left, ImageGenerationToolAction right);
public static implicit operator ImageGenerationToolAction(string value);
public static implicit operator ImageGenerationToolAction?(string value);
public static bool operator !=(ImageGenerationToolAction left, ImageGenerationToolAction right);
public override readonly string ToString();
}
public readonly partial struct ImageGenerationToolBackground : IEquatable<ImageGenerationToolBackground> {
public ImageGenerationToolBackground(string value);
public static ImageGenerationToolBackground Auto { get; }
public static ImageGenerationToolBackground Opaque { get; }
public static ImageGenerationToolBackground Transparent { get; }
public readonly bool Equals(ImageGenerationToolBackground other);
[EditorBrowsable(EditorBrowsableState.Never)]
public override readonly bool Equals(object obj);
[EditorBrowsable(EditorBrowsableState.Never)]
public override readonly int GetHashCode();
public static bool operator ==(ImageGenerationToolBackground left, ImageGenerationToolBackground right);
public static implicit operator ImageGenerationToolBackground(string value);
public static implicit operator ImageGenerationToolBackground?(string value);
public static bool operator !=(ImageGenerationToolBackground left, ImageGenerationToolBackground right);
public override readonly string ToString();
}
public readonly partial struct ImageGenerationToolInputFidelity : IEquatable<ImageGenerationToolInputFidelity> {
public ImageGenerationToolInputFidelity(string value);
public static ImageGenerationToolInputFidelity High { get; }
public static ImageGenerationToolInputFidelity Low { get; }
public readonly bool Equals(ImageGenerationToolInputFidelity other);
[EditorBrowsable(EditorBrowsableState.Never)]
public override readonly bool Equals(object obj);
[EditorBrowsable(EditorBrowsableState.Never)]
public override readonly int GetHashCode();
public static bool operator ==(ImageGenerationToolInputFidelity left, ImageGenerationToolInputFidelity right);
public static implicit operator ImageGenerationToolInputFidelity(string value);
public static implicit operator ImageGenerationToolInputFidelity?(string value);
public static bool operator !=(ImageGenerationToolInputFidelity left, ImageGenerationToolInputFidelity right);
public override readonly string ToString();
}
public class ImageGenerationToolInputImageMask : IJsonModel<ImageGenerationToolInputImageMask>, IPersistableModel<ImageGenerationToolInputImageMask> {
public ImageGenerationToolInputImageMask(BinaryData imageBytes);
public ImageGenerationToolInputImageMask(string fileId);
public ImageGenerationToolInputImageMask(Uri imageUri);
public string FileId { get; set; }
public string ImageUri { get; set; }
[Serialization.JsonIgnore]
[EditorBrowsable(EditorBrowsableState.Never)]
public ref JsonPatch Patch { get; }
}
public readonly partial struct ImageGenerationToolModerationLevel : IEquatable<ImageGenerationToolModerationLevel> {
public ImageGenerationToolModerationLevel(string value);
public static ImageGenerationToolModerationLevel Auto { get; }
public static ImageGenerationToolModerationLevel Low { get; }
public readonly bool Equals(ImageGenerationToolModerationLevel other);
[EditorBrowsable(EditorBrowsableState.Never)]
public override readonly bool Equals(object obj);
[EditorBrowsable(EditorBrowsableState.Never)]
public override readonly int GetHashCode();
public static bool operator ==(ImageGenerationToolModerationLevel left, ImageGenerationToolModerationLevel right);
public static implicit operator ImageGenerationToolModerationLevel(string value);
public static implicit operator ImageGenerationToolModerationLevel?(string value);
public static bool operator !=(ImageGenerationToolModerationLevel left, ImageGenerationToolModerationLevel right);
public override readonly string ToString();
}
public readonly partial struct ImageGenerationToolOutputFileFormat : IEquatable<ImageGenerationToolOutputFileFormat> {
public ImageGenerationToolOutputFileFormat(string value);
public static ImageGenerationToolOutputFileFormat Jpeg { get; }
public static ImageGenerationToolOutputFileFormat Png { get; }
public static ImageGenerationToolOutputFileFormat Webp { get; }
public readonly bool Equals(ImageGenerationToolOutputFileFormat other);
[EditorBrowsable(EditorBrowsableState.Never)]
public override readonly bool Equals(object obj);
[EditorBrowsable(EditorBrowsableState.Never)]
public override readonly int GetHashCode();
public static bool operator ==(ImageGenerationToolOutputFileFormat left, ImageGenerationToolOutputFileFormat right);
public static implicit operator ImageGenerationToolOutputFileFormat(string value);
public static implicit operator ImageGenerationToolOutputFileFormat?(string value);
public static bool operator !=(ImageGenerationToolOutputFileFormat left, ImageGenerationToolOutputFileFormat right);
public override readonly string ToString();
}
public readonly partial struct ImageGenerationToolQuality : IEquatable<ImageGenerationToolQuality> {
public ImageGenerationToolQuality(string value);
public static ImageGenerationToolQuality Auto { get; }
public static ImageGenerationToolQuality High { get; }
public static ImageGenerationToolQuality Low { get; }
public static ImageGenerationToolQuality Medium { get; }
public readonly bool Equals(ImageGenerationToolQuality other);
[EditorBrowsable(EditorBrowsableState.Never)]
public override readonly bool Equals(object obj);
[EditorBrowsable(EditorBrowsableState.Never)]
public override readonly int GetHashCode();
public static bool operator ==(ImageGenerationToolQuality left, ImageGenerationToolQuality right);
public static implicit operator ImageGenerationToolQuality(string value);
public static implicit operator ImageGenerationToolQuality?(string value);
public static bool operator !=(ImageGenerationToolQuality left, ImageGenerationToolQuality right);
public override readonly string ToString();
}
public readonly partial struct ImageGenerationToolSize : IEquatable<ImageGenerationToolSize> {
public static readonly ImageGenerationToolSize W1024xH1024;
public static readonly ImageGenerationToolSize W1024xH1536;
public static readonly ImageGenerationToolSize W1536xH1024;
public ImageGenerationToolSize(int width, int height);
public static ImageGenerationToolSize Auto { get; }
public readonly bool Equals(ImageGenerationToolSize other);
[EditorBrowsable(EditorBrowsableState.Never)]
public override readonly bool Equals(object obj);
[EditorBrowsable(EditorBrowsableState.Never)]
public override readonly int GetHashCode();
public static bool operator ==(ImageGenerationToolSize left, ImageGenerationToolSize right);
public static bool operator !=(ImageGenerationToolSize left, ImageGenerationToolSize right);
public override readonly string ToString();
}
public readonly partial struct IncludedResponseProperty : IEquatable<IncludedResponseProperty> {
public IncludedResponseProperty(string value);
public static IncludedResponseProperty CodeInterpreterCallOutputs { get; }
public static IncludedResponseProperty ComputerCallOutputImageUri { get; }
public static IncludedResponseProperty FileSearchCallResults { get; }
public static IncludedResponseProperty MessageInputImageUri { get; }
public static IncludedResponseProperty MessageOutputTextLogProbabilities { get; }
public static IncludedResponseProperty ReasoningEncryptedContent { get; }
public static IncludedResponseProperty WebSearchCallActionSources { get; }
public static IncludedResponseProperty WebSearchCallResults { get; }
public readonly bool Equals(IncludedResponseProperty other);
[EditorBrowsable(EditorBrowsableState.Never)]
public override readonly bool Equals(object obj);
[EditorBrowsable(EditorBrowsableState.Never)]
public override readonly int GetHashCode();
public static bool operator ==(IncludedResponseProperty left, IncludedResponseProperty right);
public static implicit operator IncludedResponseProperty(string value);
public static implicit operator IncludedResponseProperty?(string value);
public static bool operator !=(IncludedResponseProperty left, IncludedResponseProperty right);
public override readonly string ToString();
}
public class McpTool : ResponseTool, IJsonModel<McpTool>, IPersistableModel<McpTool> {
public McpTool(string serverLabel, McpToolConnectorId connectorId) : base(default);
public McpTool(string serverLabel, Uri serverUri) : base(default);
public McpToolFilter AllowedTools { get; set; }
public string AuthorizationToken { get; set; }
public McpToolConnectorId? ConnectorId { get; set; }
public IDictionary<string, string> Headers { get; set; }
public string ServerDescription { get; set; }
public string ServerLabel { get; set; }
public Uri ServerUri { get; set; }
public McpToolCallApprovalPolicy ToolCallApprovalPolicy { get; set; }
}
public class McpToolCallApprovalPolicy : IJsonModel<McpToolCallApprovalPolicy>, IPersistableModel<McpToolCallApprovalPolicy> {
public McpToolCallApprovalPolicy(CustomMcpToolCallApprovalPolicy customPolicy);
public McpToolCallApprovalPolicy(GlobalMcpToolCallApprovalPolicy globalPolicy);
public CustomMcpToolCallApprovalPolicy CustomPolicy { get; }
public GlobalMcpToolCallApprovalPolicy? GlobalPolicy { get; }
[Serialization.JsonIgnore]
[EditorBrowsable(EditorBrowsableState.Never)]
public ref JsonPatch Patch { get; }
public static implicit operator McpToolCallApprovalPolicy(CustomMcpToolCallApprovalPolicy customPolicy);
public static implicit operator McpToolCallApprovalPolicy(GlobalMcpToolCallApprovalPolicy globalPolicy);
}
public class McpToolCallApprovalRequestItem : ResponseItem, IJsonModel<McpToolCallApprovalRequestItem>, IPersistableModel<McpToolCallApprovalRequestItem> {
public McpToolCallApprovalRequestItem(string id, string serverLabel, string toolName, BinaryData toolArguments) : base(default);
public string ServerLabel { get; set; }
public BinaryData ToolArguments { get; set; }
public string ToolName { get; set; }
}
public class McpToolCallApprovalResponseItem : ResponseItem, IJsonModel<McpToolCallApprovalResponseItem>, IPersistableModel<McpToolCallApprovalResponseItem> {
public McpToolCallApprovalResponseItem(string approvalRequestId, bool approved) : base(default);
public string ApprovalRequestId { get; set; }
public bool Approved { get; set; }
public string Reason { get; set; }
}
public class McpToolCallItem : ResponseItem, IJsonModel<McpToolCallItem>, IPersistableModel<McpToolCallItem> {
public McpToolCallItem(string serverLabel, string toolName, BinaryData toolArguments) : base(default);
public BinaryData Error { get; set; }
public string ServerLabel { get; set; }
public BinaryData ToolArguments { get; set; }
public string ToolName { get; set; }
public string ToolOutput { get; set; }
}
public readonly partial struct McpToolConnectorId : IEquatable<McpToolConnectorId> {
public McpToolConnectorId(string value);
public static McpToolConnectorId Dropbox { get; }
public static McpToolConnectorId Gmail { get; }
public static McpToolConnectorId GoogleCalendar { get; }
public static McpToolConnectorId GoogleDrive { get; }
public static McpToolConnectorId MicrosoftTeams { get; }
public static McpToolConnectorId OutlookCalendar { get; }
public static McpToolConnectorId OutlookEmail { get; }
public static McpToolConnectorId SharePoint { get; }
public readonly bool Equals(McpToolConnectorId other);
[EditorBrowsable(EditorBrowsableState.Never)]
public override readonly bool Equals(object obj);
[EditorBrowsable(EditorBrowsableState.Never)]
public override readonly int GetHashCode();
public static bool operator ==(McpToolConnectorId left, McpToolConnectorId right);
public static implicit operator McpToolConnectorId(string value);
public static implicit operator McpToolConnectorId?(string value);
public static bool operator !=(McpToolConnectorId left, McpToolConnectorId right);
public override readonly string ToString();
}
public class McpToolDefinition : IJsonModel<McpToolDefinition>, IPersistableModel<McpToolDefinition> {
public McpToolDefinition(string name, BinaryData inputSchema);
public BinaryData Annotations { get; set; }
public string Description { get; set; }
public BinaryData InputSchema { get; set; }
public string Name { get; set; }
[Serialization.JsonIgnore]
[EditorBrowsable(EditorBrowsableState.Never)]
public ref JsonPatch Patch { get; }
}
public class McpToolDefinitionListItem : ResponseItem, IJsonModel<McpToolDefinitionListItem>, IPersistableModel<McpToolDefinitionListItem> {
public McpToolDefinitionListItem(string serverLabel, IEnumerable<McpToolDefinition> toolDefinitions) : base(default);
public BinaryData Error { get; set; }
public string ServerLabel { get; set; }
public IList<McpToolDefinition> ToolDefinitions { get; }
}
public class McpToolFilter : IJsonModel<McpToolFilter>, IPersistableModel<McpToolFilter> {
public bool? IsReadOnly { get; set; }
[Serialization.JsonIgnore]
[EditorBrowsable(EditorBrowsableState.Never)]
public ref JsonPatch Patch { get; }
public IList<string> ToolNames { get; }
}
public class MessageResponseItem : ResponseItem, IJsonModel<MessageResponseItem>, IPersistableModel<MessageResponseItem> {
public IList<ResponseContentPart> Content { get; }
public MessageRole Role { get; }
public MessageStatus? Status { get; set; }
}
public enum MessageRole {
Unknown = 0,
Assistant = 1,
Developer = 2,
System = 3,
User = 4
}
public enum MessageStatus {
InProgress = 0,
Completed = 1,
Incomplete = 2
}
public static class OpenAIResponsesHostBuilderExtensions {
public static IClientBuilder AddKeyedResponsesClient(this Microsoft.Extensions.Hosting.IHostApplicationBuilder builder, string serviceKey, string sectionName);
public static IClientBuilder AddResponsesClient(this Microsoft.Extensions.Hosting.IHostApplicationBuilder builder, string sectionName);
}
public class ReasoningResponseItem : ResponseItem, IJsonModel<ReasoningResponseItem>, IPersistableModel<ReasoningResponseItem> {
public ReasoningResponseItem(IEnumerable<ReasoningSummaryPart> summaryParts) : base(default);
public ReasoningResponseItem(string summaryText) : base(default);
public string EncryptedContent { get; set; }
public ReasoningStatus? Status { get; set; }
public IList<ReasoningSummaryPart> SummaryParts { get; }
public string GetSummaryText();
}
public enum ReasoningStatus {
InProgress = 0,
Completed = 1,
Incomplete = 2
}
public class ReasoningSummaryPart : IJsonModel<ReasoningSummaryPart>, IPersistableModel<ReasoningSummaryPart> {
[Serialization.JsonIgnore]
[EditorBrowsable(EditorBrowsableState.Never)]
public ref JsonPatch Patch { get; }
public static ReasoningSummaryTextPart CreateTextPart(string text);
}
public class ReasoningSummaryTextPart : ReasoningSummaryPart, IJsonModel<ReasoningSummaryTextPart>, IPersistableModel<ReasoningSummaryTextPart> {
public ReasoningSummaryTextPart(string text);
public string Text { get; set; }
}
public class ReferenceResponseItem : ResponseItem, IJsonModel<ReferenceResponseItem>, IPersistableModel<ReferenceResponseItem> {
public ReferenceResponseItem(string id) : base(default);
}
public class ResponseContentPart : IJsonModel<ResponseContentPart>, IPersistableModel<ResponseContentPart> {
public BinaryData InputFileBytes { get; }
public string InputFileBytesMediaType { get; }
public string InputFileId { get; }
public string InputFilename { get; }
public Uri InputFileUri { get; }
public ResponseImageDetailLevel? InputImageDetailLevel { get; }
public string InputImageFileId { get; }
public string InputImageUri { get; }
public ResponseContentPartKind Kind { get; }
public IReadOnlyList<ResponseMessageAnnotation> OutputTextAnnotations { get; }
public IReadOnlyList<ResponseTokenLogProbabilityDetails> OutputTextTokenLogProbabilities { get; }
[Serialization.JsonIgnore]
[EditorBrowsable(EditorBrowsableState.Never)]
public ref JsonPatch Patch { get; }
public string Refusal { get; }
public string Text { get; }
public static ResponseContentPart CreateInputFilePart(BinaryData fileBytes, string fileBytesMediaType, string filename);
public static ResponseContentPart CreateInputFilePart(string fileId);
public static ResponseContentPart CreateInputFilePart(Uri fileUri);
public static ResponseContentPart CreateInputImagePart(BinaryData imageBytes, ResponseImageDetailLevel? imageDetailLevel = null);
public static ResponseContentPart CreateInputImagePart(string imageFileId, ResponseImageDetailLevel? imageDetailLevel = null);
public static ResponseContentPart CreateInputImagePart(Uri imageUri, ResponseImageDetailLevel? imageDetailLevel = null);
public static ResponseContentPart CreateInputTextPart(string text);
public static ResponseContentPart CreateOutputTextPart(string text, IEnumerable<ResponseMessageAnnotation> annotations);
public static ResponseContentPart CreateRefusalPart(string refusal);
}
public enum ResponseContentPartKind {
Unknown = 0,
InputText = 1,
InputImage = 2,
InputFile = 3,
OutputText = 4,
Refusal = 5
}
public class ResponseConversationOptions : IJsonModel<ResponseConversationOptions>, IPersistableModel<ResponseConversationOptions> {
public ResponseConversationOptions(string conversationId);
public string ConversationId { get; set; }
[Serialization.JsonIgnore]
[EditorBrowsable(EditorBrowsableState.Never)]
public ref JsonPatch Patch { get; }
}
public class ResponseDeletionResult : IJsonModel<ResponseDeletionResult>, IPersistableModel<ResponseDeletionResult> {
public bool Deleted { get; set; }
[EditorBrowsable(EditorBrowsableState.Never)]
public string Object { get; set; }
[Serialization.JsonIgnore]
[EditorBrowsable(EditorBrowsableState.Never)]
public ref JsonPatch Patch { get; }
public string ResponseId { get; set; }
public static explicit operator ResponseDeletionResult(ClientResult result);
}
public class ResponseError : IJsonModel<ResponseError>, IPersistableModel<ResponseError> {
public ResponseErrorCode Code { get; }
public string Kind { get; }
public string Message { get; }
public string Param { get; }
[Serialization.JsonIgnore]
[EditorBrowsable(EditorBrowsableState.Never)]
public ref JsonPatch Patch { get; }
}
public readonly partial struct ResponseErrorCode : IEquatable<ResponseErrorCode> {
public ResponseErrorCode(string value);
public static ResponseErrorCode EmptyImageFile { get; }
public static ResponseErrorCode FailedToDownloadImage { get; }
public static ResponseErrorCode ImageContentPolicyViolation { get; }
public static ResponseErrorCode ImageFileNotFound { get; }
public static ResponseErrorCode ImageFileTooLarge { get; }
public static ResponseErrorCode ImageParseError { get; }
public static ResponseErrorCode ImageTooLarge { get; }
public static ResponseErrorCode ImageTooSmall { get; }
public static ResponseErrorCode InvalidBase64Image { get; }
public static ResponseErrorCode InvalidImage { get; }
public static ResponseErrorCode InvalidImageFormat { get; }
public static ResponseErrorCode InvalidImageMode { get; }
public static ResponseErrorCode InvalidImageUrl { get; }
public static ResponseErrorCode InvalidPrompt { get; }
public static ResponseErrorCode RateLimitExceeded { get; }
public static ResponseErrorCode ServerError { get; }
public static ResponseErrorCode UnsupportedImageMediaType { get; }
public static ResponseErrorCode VectorStoreTimeout { get; }
public readonly bool Equals(ResponseErrorCode other);
[EditorBrowsable(EditorBrowsableState.Never)]
public override readonly bool Equals(object obj);
[EditorBrowsable(EditorBrowsableState.Never)]
public override readonly int GetHashCode();
public static bool operator ==(ResponseErrorCode left, ResponseErrorCode right);
public static implicit operator ResponseErrorCode(string value);
public static implicit operator ResponseErrorCode?(string value);
public static bool operator !=(ResponseErrorCode left, ResponseErrorCode right);
public override readonly string ToString();
}
public readonly partial struct ResponseImageDetailLevel : IEquatable<ResponseImageDetailLevel> {
public ResponseImageDetailLevel(string value);
public static ResponseImageDetailLevel Auto { get; }
public static ResponseImageDetailLevel High { get; }
public static ResponseImageDetailLevel Low { get; }
public readonly bool Equals(ResponseImageDetailLevel other);
[EditorBrowsable(EditorBrowsableState.Never)]
public override readonly bool Equals(object obj);
[EditorBrowsable(EditorBrowsableState.Never)]
public override readonly int GetHashCode();
public static bool operator ==(ResponseImageDetailLevel left, ResponseImageDetailLevel right);
public static implicit operator ResponseImageDetailLevel(string value);
public static implicit operator ResponseImageDetailLevel?(string value);
public static bool operator !=(ResponseImageDetailLevel left, ResponseImageDetailLevel right);
public override readonly string ToString();
}
public class ResponseIncompleteStatusDetails : IJsonModel<ResponseIncompleteStatusDetails>, IPersistableModel<ResponseIncompleteStatusDetails> {
[Serialization.JsonIgnore]
[EditorBrowsable(EditorBrowsableState.Never)]
public ref JsonPatch Patch { get; }
public ResponseIncompleteStatusReason? Reason { get; }
}
public readonly partial struct ResponseIncompleteStatusReason : IEquatable<ResponseIncompleteStatusReason> {
public ResponseIncompleteStatusReason(string value);
public static ResponseIncompleteStatusReason ContentFilter { get; }
public static ResponseIncompleteStatusReason MaxOutputTokens { get; }
public readonly bool Equals(ResponseIncompleteStatusReason other);
[EditorBrowsable(EditorBrowsableState.Never)]
public override readonly bool Equals(object obj);
[EditorBrowsable(EditorBrowsableState.Never)]
public override readonly int GetHashCode();
public static bool operator ==(ResponseIncompleteStatusReason left, ResponseIncompleteStatusReason right);
public static implicit operator ResponseIncompleteStatusReason(string value);
public static implicit operator ResponseIncompleteStatusReason?(string value);
public static bool operator !=(ResponseIncompleteStatusReason left, ResponseIncompleteStatusReason right);
public override readonly string ToString();
}
public class ResponseInputTokenUsageDetails : IJsonModel<ResponseInputTokenUsageDetails>, IPersistableModel<ResponseInputTokenUsageDetails> {
public int CachedTokenCount { get; set; }
[Serialization.JsonIgnore]
[EditorBrowsable(EditorBrowsableState.Never)]
public ref JsonPatch Patch { get; }
}
public class ResponseItem : IJsonModel<ResponseItem>, IPersistableModel<ResponseItem> {
protected internal ResponseItem(ResponseItemKind kind);
public string Id { get; set; }
public ResponseItemKind Kind { get; }
[Serialization.JsonIgnore]
[EditorBrowsable(EditorBrowsableState.Never)]
public ref JsonPatch Patch { get; }
public static ApplyPatchCallItem CreateApplyPatchCallItem(string callId, ApplyPatchOperation operation);
public static ApplyPatchCallOutputItem CreateApplyPatchCallOutputItem(string callId, ApplyPatchCallOutputStatus status);
public static MessageResponseItem CreateAssistantMessageItem(IEnumerable<ResponseContentPart> contentParts);
public static MessageResponseItem CreateAssistantMessageItem(string outputTextContent, IEnumerable<ResponseMessageAnnotation> annotations = null);
public static ComputerCallResponseItem CreateComputerCallItem(string callId, ComputerCallAction action, IEnumerable<ComputerCallSafetyCheck> pendingSafetyChecks);
public static ComputerCallOutputResponseItem CreateComputerCallOutputItem(string callId, ComputerCallOutput output);
public static MessageResponseItem CreateDeveloperMessageItem(IEnumerable<ResponseContentPart> contentParts);
public static MessageResponseItem CreateDeveloperMessageItem(string inputTextContent);
public static FileSearchCallResponseItem CreateFileSearchCallItem(IEnumerable<string> queries);
public static FunctionCallResponseItem CreateFunctionCallItem(string callId, string functionName, BinaryData functionArguments);
public static FunctionCallOutputResponseItem CreateFunctionCallOutputItem(string callId, string functionOutput);
public static McpToolCallApprovalRequestItem CreateMcpApprovalRequestItem(string id, string serverLabel, string name, BinaryData arguments);
public static McpToolCallApprovalResponseItem CreateMcpApprovalResponseItem(string approvalRequestId, bool approved);
public static McpToolCallItem CreateMcpToolCallItem(string serverLabel, string name, BinaryData arguments);
public static McpToolDefinitionListItem CreateMcpToolDefinitionListItem(string serverLabel, IEnumerable<McpToolDefinition> toolDefinitions);
public static ReasoningResponseItem CreateReasoningItem(IEnumerable<ReasoningSummaryPart> summaryParts);
public static ReasoningResponseItem CreateReasoningItem(string summaryText);
public static ReferenceResponseItem CreateReferenceItem(string id);
public static MessageResponseItem CreateSystemMessageItem(IEnumerable<ResponseContentPart> contentParts);
public static MessageResponseItem CreateSystemMessageItem(string inputTextContent);
public static MessageResponseItem CreateUserMessageItem(IEnumerable<ResponseContentPart> contentParts);
public static MessageResponseItem CreateUserMessageItem(string inputTextContent);
public static WebSearchCallResponseItem CreateWebSearchCallItem();
}
public class ResponseItemCollectionOptions : IJsonModel<ResponseItemCollectionOptions>, IPersistableModel<ResponseItemCollectionOptions> {
public ResponseItemCollectionOptions(string responseId);
public string AfterId { get; set; }
public string BeforeId { get; set; }
public ResponseItemCollectionOrder? Order { get; set; }
public int? PageSizeLimit { get; set; }
public string ResponseId { get; }
}
public readonly partial struct ResponseItemCollectionOrder : IEquatable<ResponseItemCollectionOrder> {
public ResponseItemCollectionOrder(string value);
public static ResponseItemCollectionOrder Ascending { get; }
public static ResponseItemCollectionOrder Descending { get; }
public readonly bool Equals(ResponseItemCollectionOrder other);
[EditorBrowsable(EditorBrowsableState.Never)]
public override readonly bool Equals(object obj);
[EditorBrowsable(EditorBrowsableState.Never)]
public override readonly int GetHashCode();
public static bool operator ==(ResponseItemCollectionOrder left, ResponseItemCollectionOrder right);
public static implicit operator ResponseItemCollectionOrder(string value);
public static implicit operator ResponseItemCollectionOrder?(string value);
public static bool operator !=(ResponseItemCollectionOrder left, ResponseItemCollectionOrder right);
public override readonly string ToString();
}
public class ResponseItemCollectionPage : IJsonModel<ResponseItemCollectionPage>, IPersistableModel<ResponseItemCollectionPage> {
public IList<ResponseItem> Data { get; }
public string FirstId { get; set; }
public bool HasMore { get; set; }
public string LastId { get; set; }
[EditorBrowsable(EditorBrowsableState.Never)]
public string Object { get; set; }
[Serialization.JsonIgnore]
[EditorBrowsable(EditorBrowsableState.Never)]
public ref JsonPatch Patch { get; }
public static explicit operator ResponseItemCollectionPage(ClientResult result);
}
public readonly partial struct ResponseItemKind : IEquatable<ResponseItemKind> {
public ResponseItemKind(string value);
public static ResponseItemKind ApplyPatchCall { get; }
public static ResponseItemKind ApplyPatchCallOutput { get; }
public static ResponseItemKind CodeInterpreterCall { get; }
public static ResponseItemKind ComputerCall { get; }
public static ResponseItemKind ComputerCallOutput { get; }
public static ResponseItemKind FileSearchCall { get; }
public static ResponseItemKind FunctionCall { get; }
public static ResponseItemKind FunctionCallOutput { get; }
public static ResponseItemKind ImageGenerationCall { get; }
public static ResponseItemKind ItemReference { get; }
public static ResponseItemKind McpApprovalRequest { get; }
public static ResponseItemKind McpApprovalResponse { get; }
public static ResponseItemKind McpCall { get; }
public static ResponseItemKind McpListTools { get; }
public static ResponseItemKind Message { get; }
public static ResponseItemKind Reasoning { get; }
public static ResponseItemKind WebSearchCall { get; }
public readonly bool Equals(ResponseItemKind other);
[EditorBrowsable(EditorBrowsableState.Never)]
public override readonly bool Equals(object obj);
[EditorBrowsable(EditorBrowsableState.Never)]
public override readonly int GetHashCode();
public static bool operator ==(ResponseItemKind left, ResponseItemKind right);
public static implicit operator ResponseItemKind(string value);
public static implicit operator ResponseItemKind?(string value);
public static bool operator !=(ResponseItemKind left, ResponseItemKind right);
public override readonly string ToString();
}
public class ResponseMessageAnnotation : IJsonModel<ResponseMessageAnnotation>, IPersistableModel<ResponseMessageAnnotation> {
public ResponseMessageAnnotationKind Kind { get; }
[Serialization.JsonIgnore]
[EditorBrowsable(EditorBrowsableState.Never)]
public ref JsonPatch Patch { get; }
}
public enum ResponseMessageAnnotationKind {
FileCitation = 0,
UriCitation = 1,
FilePath = 2,
ContainerFileCitation = 3
}
public class ResponseOutputTokenUsageDetails : IJsonModel<ResponseOutputTokenUsageDetails>, IPersistableModel<ResponseOutputTokenUsageDetails> {
[Serialization.JsonIgnore]
[EditorBrowsable(EditorBrowsableState.Never)]
public ref JsonPatch Patch { get; }
public int ReasoningTokenCount { get; set; }
}
public readonly partial struct ResponseReasoningEffortLevel : IEquatable<ResponseReasoningEffortLevel> {
public ResponseReasoningEffortLevel(string value);
public static ResponseReasoningEffortLevel High { get; }
public static ResponseReasoningEffortLevel Low { get; }
public static ResponseReasoningEffortLevel Medium { get; }
public static ResponseReasoningEffortLevel Minimal { get; }
public static ResponseReasoningEffortLevel None { get; }
public readonly bool Equals(ResponseReasoningEffortLevel other);
[EditorBrowsable(EditorBrowsableState.Never)]
public override readonly bool Equals(object obj);
[EditorBrowsable(EditorBrowsableState.Never)]
public override readonly int GetHashCode();
public static bool operator ==(ResponseReasoningEffortLevel left, ResponseReasoningEffortLevel right);
public static implicit operator ResponseReasoningEffortLevel(string value);
public static implicit operator ResponseReasoningEffortLevel?(string value);
public static bool operator !=(ResponseReasoningEffortLevel left, ResponseReasoningEffortLevel right);
public override readonly string ToString();
}
public class ResponseReasoningOptions : IJsonModel<ResponseReasoningOptions>, IPersistableModel<ResponseReasoningOptions> {
[Serialization.JsonIgnore]
[EditorBrowsable(EditorBrowsableState.Never)]
public ref JsonPatch Patch { get; }
public ResponseReasoningEffortLevel? ReasoningEffortLevel { get; set; }
public ResponseReasoningSummaryVerbosity? ReasoningSummaryVerbosity { get; set; }
}
public readonly partial struct ResponseReasoningSummaryVerbosity : IEquatable<ResponseReasoningSummaryVerbosity> {
public ResponseReasoningSummaryVerbosity(string value);
public static ResponseReasoningSummaryVerbosity Auto { get; }
public static ResponseReasoningSummaryVerbosity Concise { get; }
public static ResponseReasoningSummaryVerbosity Detailed { get; }
public readonly bool Equals(ResponseReasoningSummaryVerbosity other);
[EditorBrowsable(EditorBrowsableState.Never)]
public override readonly bool Equals(object obj);
[EditorBrowsable(EditorBrowsableState.Never)]
public override readonly int GetHashCode();
public static bool operator ==(ResponseReasoningSummaryVerbosity left, ResponseReasoningSummaryVerbosity right);
public static implicit operator ResponseReasoningSummaryVerbosity(string value);
public static implicit operator ResponseReasoningSummaryVerbosity?(string value);
public static bool operator !=(ResponseReasoningSummaryVerbosity left, ResponseReasoningSummaryVerbosity right);
public override readonly string ToString();
}
public class ResponseResult : IJsonModel<ResponseResult>, IPersistableModel<ResponseResult> {
public bool? BackgroundModeEnabled { get; set; }
public ResponseConversationOptions ConversationOptions { get; set; }
public DateTimeOffset CreatedAt { get; set; }
public string EndUserId { get; set; }
public ResponseError Error { get; set; }
public string Id { get; set; }
public ResponseIncompleteStatusDetails IncompleteStatusDetails { get; set; }
public IList<ResponseItem> Instructions { get; }
public int? MaxOutputTokenCount { get; set; }
public int? MaxToolCallCount { get; set; }
public IDictionary<string, string> Metadata { get; }
public string Model { get; set; }
[EditorBrowsable(EditorBrowsableState.Never)]
public string Object { get; set; }
public IList<ResponseItem> OutputItems { get; }
public bool ParallelToolCallsEnabled { get; set; }
[Serialization.JsonIgnore]
[EditorBrowsable(EditorBrowsableState.Never)]
public ref JsonPatch Patch { get; }
public string PreviousResponseId { get; set; }
public ResponseReasoningOptions ReasoningOptions { get; set; }
public string SafetyIdentifier { get; set; }
public ResponseServiceTier? ServiceTier { get; set; }
public ResponseStatus? Status { get; set; }
public float? Temperature { get; set; }
public ResponseTextOptions TextOptions { get; set; }
public ResponseToolChoice ToolChoice { get; set; }
public IList<ResponseTool> Tools { get; }
public int? TopLogProbabilityCount { get; set; }
public float? TopP { get; set; }
public ResponseTruncationMode? TruncationMode { get; set; }
public ResponseTokenUsage Usage { get; set; }
public string GetOutputText();
public static explicit operator ResponseResult(ClientResult result);
}
public class ResponsesClient {
protected ResponsesClient();
public ResponsesClient(ResponsesClientSettings settings);
public ResponsesClient(ApiKeyCredential credential, ResponsesClientOptions options);
public ResponsesClient(ApiKeyCredential credential);
public ResponsesClient(AuthenticationPolicy authenticationPolicy, ResponsesClientOptions options);
public ResponsesClient(AuthenticationPolicy authenticationPolicy);
protected internal ResponsesClient(ClientPipeline pipeline, ResponsesClientOptions options);
public ResponsesClient(string apiKey);
public virtual Uri Endpoint { get; }
public ClientPipeline Pipeline { get; }
public virtual ClientResult CancelResponse(string responseId, RequestOptions options);
public virtual ClientResult<ResponseResult> CancelResponse(string responseId, CancellationToken cancellationToken = default);
public virtual Task<ClientResult> CancelResponseAsync(string responseId, RequestOptions options);
public virtual Task<ClientResult<ResponseResult>> CancelResponseAsync(string responseId, CancellationToken cancellationToken = default);
public virtual ClientResult CompactResponse(BinaryContent content, string contentType, RequestOptions options = null);
public virtual Task<ClientResult> CompactResponseAsync(BinaryContent content, string contentType, RequestOptions options = null);
public virtual ClientResult<ResponseResult> CreateResponse(CreateResponseOptions options, CancellationToken cancellationToken = default);
public virtual ClientResult CreateResponse(BinaryContent content, RequestOptions options = null);
public virtual ClientResult<ResponseResult> CreateResponse(string model, IEnumerable<ResponseItem> inputItems, string previousResponseId = null, CancellationToken cancellationToken = default);
public virtual ClientResult<ResponseResult> CreateResponse(string model, string userInputText, string previousResponseId = null, CancellationToken cancellationToken = default);
public virtual Task<ClientResult<ResponseResult>> CreateResponseAsync(CreateResponseOptions options, CancellationToken cancellationToken = default);
public virtual Task<ClientResult> CreateResponseAsync(BinaryContent content, RequestOptions options = null);
public virtual Task<ClientResult<ResponseResult>> CreateResponseAsync(string model, IEnumerable<ResponseItem> inputItems, string previousResponseId = null, CancellationToken cancellationToken = default);
public virtual Task<ClientResult<ResponseResult>> CreateResponseAsync(string model, string userInputText, string previousResponseId = null, CancellationToken cancellationToken = default);
public virtual CollectionResult<StreamingResponseUpdate> CreateResponseStreaming(CreateResponseOptions options, CancellationToken cancellationToken = default);
public virtual CollectionResult<StreamingResponseUpdate> CreateResponseStreaming(string model, IEnumerable<ResponseItem> inputItems, string previousResponseId = null, CancellationToken cancellationToken = default);
public virtual CollectionResult<StreamingResponseUpdate> CreateResponseStreaming(string model, string userInputText, string previousResponseId = null, CancellationToken cancellationToken = default);
public virtual AsyncCollectionResult<StreamingResponseUpdate> CreateResponseStreamingAsync(CreateResponseOptions options, CancellationToken cancellationToken = default);
public virtual AsyncCollectionResult<StreamingResponseUpdate> CreateResponseStreamingAsync(string model, IEnumerable<ResponseItem> inputItems, string previousResponseId = null, CancellationToken cancellationToken = default);
public virtual AsyncCollectionResult<StreamingResponseUpdate> CreateResponseStreamingAsync(string model, string userInputText, string previousResponseId = null, CancellationToken cancellationToken = default);
public virtual ClientResult DeleteResponse(string responseId, RequestOptions options);
public virtual ClientResult<ResponseDeletionResult> DeleteResponse(string responseId, CancellationToken cancellationToken = default);
public virtual Task<ClientResult> DeleteResponseAsync(string responseId, RequestOptions options);
public virtual Task<ClientResult<ResponseDeletionResult>> DeleteResponseAsync(string responseId, CancellationToken cancellationToken = default);
public virtual ClientResult GetInputTokenCount(BinaryContent content, string contentType, RequestOptions options = null);
public virtual Task<ClientResult> GetInputTokenCountAsync(BinaryContent content, string contentType, RequestOptions options = null);
public virtual ClientResult<ResponseResult> GetResponse(GetResponseOptions options, CancellationToken cancellationToken = default);
public virtual ClientResult GetResponse(string responseId, IEnumerable<IncludedResponseProperty> include, bool? stream, int? startingAfter, bool? includeObfuscation, RequestOptions options);
public virtual ClientResult<ResponseResult> GetResponse(string responseId, CancellationToken cancellationToken = default);
public virtual Task<ClientResult<ResponseResult>> GetResponseAsync(GetResponseOptions options, CancellationToken cancellationToken = default);
public virtual Task<ClientResult> GetResponseAsync(string responseId, IEnumerable<IncludedResponseProperty> include, bool? stream, int? startingAfter, bool? includeObfuscation, RequestOptions options);
public virtual Task<ClientResult<ResponseResult>> GetResponseAsync(string responseId, CancellationToken cancellationToken = default);
public virtual ClientResult<ResponseItemCollectionPage> GetResponseInputItemCollectionPage(ResponseItemCollectionOptions options, CancellationToken cancellationToken = default);
public virtual ClientResult GetResponseInputItemCollectionPage(string responseId, int? limit, string order, string after, string before, RequestOptions options);
public virtual Task<ClientResult<ResponseItemCollectionPage>> GetResponseInputItemCollectionPageAsync(ResponseItemCollectionOptions options, CancellationToken cancellationToken = default);
public virtual Task<ClientResult> GetResponseInputItemCollectionPageAsync(string responseId, int? limit, string order, string after, string before, RequestOptions options);
public virtual CollectionResult<ResponseItem> GetResponseInputItems(ResponseItemCollectionOptions options, CancellationToken cancellationToken = default);
public virtual CollectionResult<ResponseItem> GetResponseInputItems(string responseId, CancellationToken cancellationToken = default);
public virtual AsyncCollectionResult<ResponseItem> GetResponseInputItemsAsync(ResponseItemCollectionOptions options, CancellationToken cancellationToken = default);
public virtual AsyncCollectionResult<ResponseItem> GetResponseInputItemsAsync(string responseId, CancellationToken cancellationToken = default);
public virtual CollectionResult<StreamingResponseUpdate> GetResponseStreaming(GetResponseOptions options, CancellationToken cancellationToken = default);
public virtual CollectionResult<StreamingResponseUpdate> GetResponseStreaming(string responseId, CancellationToken cancellationToken = default);
public virtual AsyncCollectionResult<StreamingResponseUpdate> GetResponseStreamingAsync(GetResponseOptions options, CancellationToken cancellationToken = default);
public virtual AsyncCollectionResult<StreamingResponseUpdate> GetResponseStreamingAsync(string responseId, CancellationToken cancellationToken = default);
}
public class ResponsesClientOptions : ClientPipelineOptions {
public Uri Endpoint { get; set; }
public string OrganizationId { get; set; }
public string ProjectId { get; set; }
public string UserAgentApplicationId { get; set; }
}
public sealed class ResponsesClientSettings : ClientSettings {
public ResponsesClientOptions Options { get; set; }
protected override void BindCore(Microsoft.Extensions.Configuration.IConfigurationSection section);
}
public readonly partial struct ResponseServiceTier : IEquatable<ResponseServiceTier> {
public ResponseServiceTier(string value);
public static ResponseServiceTier Auto { get; }
public static ResponseServiceTier Default { get; }
public static ResponseServiceTier Flex { get; }
public static ResponseServiceTier Scale { get; }
public readonly bool Equals(ResponseServiceTier other);
[EditorBrowsable(EditorBrowsableState.Never)]
public override readonly bool Equals(object obj);
[EditorBrowsable(EditorBrowsableState.Never)]
public override readonly int GetHashCode();
public static bool operator ==(ResponseServiceTier left, ResponseServiceTier right);
public static implicit operator ResponseServiceTier(string value);
public static implicit operator ResponseServiceTier?(string value);
public static bool operator !=(ResponseServiceTier left, ResponseServiceTier right);
public override readonly string ToString();
}
public enum ResponseStatus {
InProgress = 0,
Completed = 1,
Cancelled = 2,
Queued = 3,
Incomplete = 4,
Failed = 5
}
public class ResponseTextFormat : IJsonModel<ResponseTextFormat>, IPersistableModel<ResponseTextFormat> {
public ResponseTextFormatKind Kind { get; set; }
[Serialization.JsonIgnore]
[EditorBrowsable(EditorBrowsableState.Never)]
public ref JsonPatch Patch { get; }
public static ResponseTextFormat CreateJsonObjectFormat();
public static ResponseTextFormat CreateJsonSchemaFormat(string jsonSchemaFormatName, BinaryData jsonSchema, string jsonSchemaFormatDescription = null, bool? jsonSchemaIsStrict = null);
public static ResponseTextFormat CreateTextFormat();
}
public enum ResponseTextFormatKind {
Unknown = 0,
Text = 1,
JsonObject = 2,
JsonSchema = 3
}
public class ResponseTextOptions : IJsonModel<ResponseTextOptions>, IPersistableModel<ResponseTextOptions> {
[Serialization.JsonIgnore]
[EditorBrowsable(EditorBrowsableState.Never)]
public ref JsonPatch Patch { get; }
public ResponseTextFormat TextFormat { get; set; }
}
public class ResponseTokenLogProbabilityDetails : IJsonModel<ResponseTokenLogProbabilityDetails>, IPersistableModel<ResponseTokenLogProbabilityDetails> {
public ResponseTokenLogProbabilityDetails();
public ResponseTokenLogProbabilityDetails(string token, float logProbability, ReadOnlyMemory<byte>? utf8Bytes, IEnumerable<ResponseTokenTopLogProbabilityDetails> topLogProbabilities);
public float LogProbability { get; set; }
[Serialization.JsonIgnore]
[EditorBrowsable(EditorBrowsableState.Never)]
public ref JsonPatch Patch { get; }
public string Token { get; set; }
public IReadOnlyList<ResponseTokenTopLogProbabilityDetails> TopLogProbabilities { get; }
public ReadOnlyMemory<byte>? Utf8Bytes { get; set; }
}
public class ResponseTokenTopLogProbabilityDetails : IJsonModel<ResponseTokenTopLogProbabilityDetails>, IPersistableModel<ResponseTokenTopLogProbabilityDetails> {
public ResponseTokenTopLogProbabilityDetails();
public ResponseTokenTopLogProbabilityDetails(string token, float logProbability, ReadOnlyMemory<byte>? utf8Bytes);
public float LogProbability { get; set; }
[Serialization.JsonIgnore]
[EditorBrowsable(EditorBrowsableState.Never)]
public ref JsonPatch Patch { get; }
public string Token { get; set; }
public ReadOnlyMemory<byte>? Utf8Bytes { get; set; }
}
public class ResponseTokenUsage : IJsonModel<ResponseTokenUsage>, IPersistableModel<ResponseTokenUsage> {
public int InputTokenCount { get; set; }
public ResponseInputTokenUsageDetails InputTokenDetails { get; set; }
public int OutputTokenCount { get; set; }
public ResponseOutputTokenUsageDetails OutputTokenDetails { get; set; }
[Serialization.JsonIgnore]
[EditorBrowsable(EditorBrowsableState.Never)]
public ref JsonPatch Patch { get; }
public int TotalTokenCount { get; set; }
}
public class ResponseTool : IJsonModel<ResponseTool>, IPersistableModel<ResponseTool> {
protected internal ResponseTool(ResponseToolKind kind);
public ResponseToolKind Kind { get; }
[Serialization.JsonIgnore]
[EditorBrowsable(EditorBrowsableState.Never)]
public ref JsonPatch Patch { get; }
public static ApplyPatchTool CreateApplyPatchTool();
public static CodeInterpreterTool CreateCodeInterpreterTool(CodeInterpreterToolContainer container);
public static ComputerTool CreateComputerTool(ComputerToolEnvironment environment, int displayWidth, int displayHeight);
public static FileSearchTool CreateFileSearchTool(IEnumerable<string> vectorStoreIds, int? maxResultCount = null, FileSearchToolRankingOptions rankingOptions = null, BinaryData filters = null);
public static FunctionTool CreateFunctionTool(string functionName, BinaryData functionParameters, bool? strictModeEnabled, string functionDescription = null);
public static ImageGenerationTool CreateImageGenerationTool(string model, ImageGenerationToolQuality? quality = null, ImageGenerationToolSize? size = null, ImageGenerationToolOutputFileFormat? outputFileFormat = null, int? outputCompressionFactor = null, ImageGenerationToolModerationLevel? moderationLevel = null, ImageGenerationToolBackground? background = null, ImageGenerationToolInputFidelity? inputFidelity = null, ImageGenerationToolInputImageMask inputImageMask = null, int? partialImageCount = null, ImageGenerationToolAction? action = null);
public static McpTool CreateMcpTool(string serverLabel, McpToolConnectorId connectorId, string authorizationToken = null, string serverDescription = null, IDictionary<string, string> headers = null, McpToolFilter allowedTools = null, McpToolCallApprovalPolicy toolCallApprovalPolicy = null);
public static McpTool CreateMcpTool(string serverLabel, Uri serverUri, string authorizationToken = null, string serverDescription = null, IDictionary<string, string> headers = null, McpToolFilter allowedTools = null, McpToolCallApprovalPolicy toolCallApprovalPolicy = null);
public static WebSearchPreviewTool CreateWebSearchPreviewTool(WebSearchToolLocation userLocation = null, WebSearchToolContextSize? searchContextSize = null);
public static WebSearchTool CreateWebSearchTool(WebSearchToolLocation userLocation = null, WebSearchToolContextSize? searchContextSize = null, WebSearchToolFilters filters = null);
}
public class ResponseToolChoice : IJsonModel<ResponseToolChoice>, IPersistableModel<ResponseToolChoice> {
public string FunctionName { get; }
public ResponseToolChoiceKind Kind { get; }
public static ResponseToolChoice CreateAutoChoice();
public static ResponseToolChoice CreateComputerChoice();
public static ResponseToolChoice CreateFileSearchChoice();
public static ResponseToolChoice CreateFunctionChoice(string functionName);
public static ResponseToolChoice CreateNoneChoice();
public static ResponseToolChoice CreateRequiredChoice();
public static ResponseToolChoice CreateWebSearchChoice();
}
public enum ResponseToolChoiceKind {
Unknown = 0,
Auto = 1,
None = 2,
Required = 3,
Function = 4,
FileSearch = 5,
WebSearch = 6,
Computer = 7
}
public readonly partial struct ResponseToolKind : IEquatable<ResponseToolKind> {
public ResponseToolKind(string value);
public static ResponseToolKind ApplyPatch { get; }
public static ResponseToolKind CodeInterpreter { get; }
public static ResponseToolKind ComputerUsePreview { get; }
public static ResponseToolKind FileSearch { get; }
public static ResponseToolKind Function { get; }
public static ResponseToolKind ImageGeneration { get; }
public static ResponseToolKind Mcp { get; }
public static ResponseToolKind WebSearch { get; }
public static ResponseToolKind WebSearchPreview { get; }
public readonly bool Equals(ResponseToolKind other);
[EditorBrowsable(EditorBrowsableState.Never)]
public override readonly bool Equals(object obj);
[EditorBrowsable(EditorBrowsableState.Never)]
public override readonly int GetHashCode();
public static bool operator ==(ResponseToolKind left, ResponseToolKind right);
public static implicit operator ResponseToolKind(string value);
public static implicit operator ResponseToolKind?(string value);
public static bool operator !=(ResponseToolKind left, ResponseToolKind right);
public override readonly string ToString();
}
public readonly partial struct ResponseTruncationMode : IEquatable<ResponseTruncationMode> {
public ResponseTruncationMode(string value);
public static ResponseTruncationMode Auto { get; }
public static ResponseTruncationMode Disabled { get; }
public readonly bool Equals(ResponseTruncationMode other);
[EditorBrowsable(EditorBrowsableState.Never)]
public override readonly bool Equals(object obj);
[EditorBrowsable(EditorBrowsableState.Never)]
public override readonly int GetHashCode();
public static bool operator ==(ResponseTruncationMode left, ResponseTruncationMode right);
public static implicit operator ResponseTruncationMode(string value);
public static implicit operator ResponseTruncationMode?(string value);
public static bool operator !=(ResponseTruncationMode left, ResponseTruncationMode right);
public override readonly string ToString();
}
public class StreamingResponseCodeInterpreterCallCodeDeltaUpdate : StreamingResponseUpdate, IJsonModel<StreamingResponseCodeInterpreterCallCodeDeltaUpdate>, IPersistableModel<StreamingResponseCodeInterpreterCallCodeDeltaUpdate> {
public StreamingResponseCodeInterpreterCallCodeDeltaUpdate() : base(default, default);
public string Delta { get; set; }
public string ItemId { get; set; }
public int OutputIndex { get; set; }
}
public class StreamingResponseCodeInterpreterCallCodeDoneUpdate : StreamingResponseUpdate, IJsonModel<StreamingResponseCodeInterpreterCallCodeDoneUpdate>, IPersistableModel<StreamingResponseCodeInterpreterCallCodeDoneUpdate> {
public StreamingResponseCodeInterpreterCallCodeDoneUpdate() : base(default, default);
public string Code { get; set; }
public string ItemId { get; set; }
public int OutputIndex { get; set; }
}
public class StreamingResponseCodeInterpreterCallCompletedUpdate : StreamingResponseUpdate, IJsonModel<StreamingResponseCodeInterpreterCallCompletedUpdate>, IPersistableModel<StreamingResponseCodeInterpreterCallCompletedUpdate> {
public StreamingResponseCodeInterpreterCallCompletedUpdate() : base(default, default);
public string ItemId { get; set; }
public int OutputIndex { get; set; }
}
public class StreamingResponseCodeInterpreterCallInProgressUpdate : StreamingResponseUpdate, IJsonModel<StreamingResponseCodeInterpreterCallInProgressUpdate>, IPersistableModel<StreamingResponseCodeInterpreterCallInProgressUpdate> {
public StreamingResponseCodeInterpreterCallInProgressUpdate() : base(default, default);
public string ItemId { get; set; }
public int OutputIndex { get; set; }
}
public class StreamingResponseCodeInterpreterCallInterpretingUpdate : StreamingResponseUpdate, IJsonModel<StreamingResponseCodeInterpreterCallInterpretingUpdate>, IPersistableModel<StreamingResponseCodeInterpreterCallInterpretingUpdate> {
public StreamingResponseCodeInterpreterCallInterpretingUpdate() : base(default, default);
public string ItemId { get; set; }
public int OutputIndex { get; set; }
}
public class StreamingResponseCompletedUpdate : StreamingResponseUpdate, IJsonModel<StreamingResponseCompletedUpdate>, IPersistableModel<StreamingResponseCompletedUpdate> {
public StreamingResponseCompletedUpdate() : base(default, default);
public ResponseResult Response { get; set; }
}
public class StreamingResponseContentPartAddedUpdate : StreamingResponseUpdate, IJsonModel<StreamingResponseContentPartAddedUpdate>, IPersistableModel<StreamingResponseContentPartAddedUpdate> {
public StreamingResponseContentPartAddedUpdate() : base(default, default);
public int ContentIndex { get; set; }
public string ItemId { get; set; }
public int OutputIndex { get; set; }
public ResponseContentPart Part { get; set; }
}
public class StreamingResponseContentPartDoneUpdate : StreamingResponseUpdate, IJsonModel<StreamingResponseContentPartDoneUpdate>, IPersistableModel<StreamingResponseContentPartDoneUpdate> {
public StreamingResponseContentPartDoneUpdate() : base(default, default);
public int ContentIndex { get; set; }
public string ItemId { get; set; }
public int OutputIndex { get; set; }
public ResponseContentPart Part { get; set; }
}
public class StreamingResponseCreatedUpdate : StreamingResponseUpdate, IJsonModel<StreamingResponseCreatedUpdate>, IPersistableModel<StreamingResponseCreatedUpdate> {
public StreamingResponseCreatedUpdate() : base(default, default);
public ResponseResult Response { get; set; }
}
public class StreamingResponseErrorUpdate : StreamingResponseUpdate, IJsonModel<StreamingResponseErrorUpdate>, IPersistableModel<StreamingResponseErrorUpdate> {
public StreamingResponseErrorUpdate() : base(default, default);
public string Code { get; set; }
public string Message { get; set; }
public string Param { get; set; }
}
public class StreamingResponseFailedUpdate : StreamingResponseUpdate, IJsonModel<StreamingResponseFailedUpdate>, IPersistableModel<StreamingResponseFailedUpdate> {
public StreamingResponseFailedUpdate() : base(default, default);
public ResponseResult Response { get; set; }
}
public class StreamingResponseFileSearchCallCompletedUpdate : StreamingResponseUpdate, IJsonModel<StreamingResponseFileSearchCallCompletedUpdate>, IPersistableModel<StreamingResponseFileSearchCallCompletedUpdate> {
public StreamingResponseFileSearchCallCompletedUpdate() : base(default, default);
public string ItemId { get; set; }
public int OutputIndex { get; set; }
}
public class StreamingResponseFileSearchCallInProgressUpdate : StreamingResponseUpdate, IJsonModel<StreamingResponseFileSearchCallInProgressUpdate>, IPersistableModel<StreamingResponseFileSearchCallInProgressUpdate> {
public StreamingResponseFileSearchCallInProgressUpdate() : base(default, default);
public string ItemId { get; set; }
public int OutputIndex { get; set; }
}
public class StreamingResponseFileSearchCallSearchingUpdate : StreamingResponseUpdate, IJsonModel<StreamingResponseFileSearchCallSearchingUpdate>, IPersistableModel<StreamingResponseFileSearchCallSearchingUpdate> {
public StreamingResponseFileSearchCallSearchingUpdate() : base(default, default);
public string ItemId { get; set; }
public int OutputIndex { get; set; }
}
public class StreamingResponseFunctionCallArgumentsDeltaUpdate : StreamingResponseUpdate, IJsonModel<StreamingResponseFunctionCallArgumentsDeltaUpdate>, IPersistableModel<StreamingResponseFunctionCallArgumentsDeltaUpdate> {
public StreamingResponseFunctionCallArgumentsDeltaUpdate() : base(default, default);
public BinaryData Delta { get; set; }
public string ItemId { get; set; }
public int OutputIndex { get; set; }
}
public class StreamingResponseFunctionCallArgumentsDoneUpdate : StreamingResponseUpdate, IJsonModel<StreamingResponseFunctionCallArgumentsDoneUpdate>, IPersistableModel<StreamingResponseFunctionCallArgumentsDoneUpdate> {
public StreamingResponseFunctionCallArgumentsDoneUpdate() : base(default, default);
public BinaryData FunctionArguments { get; set; }
public string FunctionName { get; set; }
public string ItemId { get; set; }
public int OutputIndex { get; set; }
}
public class StreamingResponseImageGenerationCallCompletedUpdate : StreamingResponseUpdate, IJsonModel<StreamingResponseImageGenerationCallCompletedUpdate>, IPersistableModel<StreamingResponseImageGenerationCallCompletedUpdate> {
public StreamingResponseImageGenerationCallCompletedUpdate() : base(default, default);
public string ItemId { get; set; }
public int OutputIndex { get; set; }
}
public class StreamingResponseImageGenerationCallGeneratingUpdate : StreamingResponseUpdate, IJsonModel<StreamingResponseImageGenerationCallGeneratingUpdate>, IPersistableModel<StreamingResponseImageGenerationCallGeneratingUpdate> {
public StreamingResponseImageGenerationCallGeneratingUpdate() : base(default, default);
public string ItemId { get; set; }
public int OutputIndex { get; set; }
}
public class StreamingResponseImageGenerationCallInProgressUpdate : StreamingResponseUpdate, IJsonModel<StreamingResponseImageGenerationCallInProgressUpdate>, IPersistableModel<StreamingResponseImageGenerationCallInProgressUpdate> {
public StreamingResponseImageGenerationCallInProgressUpdate() : base(default, default);
public string ItemId { get; set; }
public int OutputIndex { get; set; }
}
public class StreamingResponseImageGenerationCallPartialImageUpdate : StreamingResponseUpdate, IJsonModel<StreamingResponseImageGenerationCallPartialImageUpdate>, IPersistableModel<StreamingResponseImageGenerationCallPartialImageUpdate> {
public StreamingResponseImageGenerationCallPartialImageUpdate() : base(default, default);
public string ItemId { get; set; }
public int OutputIndex { get; set; }
public BinaryData PartialImageBytes { get; set; }
public int PartialImageIndex { get; set; }
}
public class StreamingResponseIncompleteUpdate : StreamingResponseUpdate, IJsonModel<StreamingResponseIncompleteUpdate>, IPersistableModel<StreamingResponseIncompleteUpdate> {
public StreamingResponseIncompleteUpdate() : base(default, default);
public ResponseResult Response { get; set; }
}
public class StreamingResponseInProgressUpdate : StreamingResponseUpdate, IJsonModel<StreamingResponseInProgressUpdate>, IPersistableModel<StreamingResponseInProgressUpdate> {
public StreamingResponseInProgressUpdate() : base(default, default);
public ResponseResult Response { get; set; }
}
public class StreamingResponseMcpCallArgumentsDeltaUpdate : StreamingResponseUpdate, IJsonModel<StreamingResponseMcpCallArgumentsDeltaUpdate>, IPersistableModel<StreamingResponseMcpCallArgumentsDeltaUpdate> {
public StreamingResponseMcpCallArgumentsDeltaUpdate() : base(default, default);
public BinaryData Delta { get; set; }
public string ItemId { get; set; }
public int OutputIndex { get; set; }
}
public class StreamingResponseMcpCallArgumentsDoneUpdate : StreamingResponseUpdate, IJsonModel<StreamingResponseMcpCallArgumentsDoneUpdate>, IPersistableModel<StreamingResponseMcpCallArgumentsDoneUpdate> {
public StreamingResponseMcpCallArgumentsDoneUpdate() : base(default, default);
public string ItemId { get; set; }
public int OutputIndex { get; set; }
public BinaryData ToolArguments { get; set; }
}
public class StreamingResponseMcpCallCompletedUpdate : StreamingResponseUpdate, IJsonModel<StreamingResponseMcpCallCompletedUpdate>, IPersistableModel<StreamingResponseMcpCallCompletedUpdate> {
public StreamingResponseMcpCallCompletedUpdate() : base(default, default);
public string ItemId { get; set; }
public int OutputIndex { get; set; }
}
public class StreamingResponseMcpCallFailedUpdate : StreamingResponseUpdate, IJsonModel<StreamingResponseMcpCallFailedUpdate>, IPersistableModel<StreamingResponseMcpCallFailedUpdate> {
public StreamingResponseMcpCallFailedUpdate() : base(default, default);
public string ItemId { get; set; }
public int OutputIndex { get; set; }
}
public class StreamingResponseMcpCallInProgressUpdate : StreamingResponseUpdate, IJsonModel<StreamingResponseMcpCallInProgressUpdate>, IPersistableModel<StreamingResponseMcpCallInProgressUpdate> {
public StreamingResponseMcpCallInProgressUpdate() : base(default, default);
public string ItemId { get; set; }
public int OutputIndex { get; set; }
}
public class StreamingResponseMcpListToolsCompletedUpdate : StreamingResponseUpdate, IJsonModel<StreamingResponseMcpListToolsCompletedUpdate>, IPersistableModel<StreamingResponseMcpListToolsCompletedUpdate> {
public StreamingResponseMcpListToolsCompletedUpdate() : base(default, default);
public string ItemId { get; set; }
public int OutputIndex { get; set; }
}
public class StreamingResponseMcpListToolsFailedUpdate : StreamingResponseUpdate, IJsonModel<StreamingResponseMcpListToolsFailedUpdate>, IPersistableModel<StreamingResponseMcpListToolsFailedUpdate> {
public StreamingResponseMcpListToolsFailedUpdate() : base(default, default);
public string ItemId { get; set; }
public int OutputIndex { get; set; }
}
public class StreamingResponseMcpListToolsInProgressUpdate : StreamingResponseUpdate, IJsonModel<StreamingResponseMcpListToolsInProgressUpdate>, IPersistableModel<StreamingResponseMcpListToolsInProgressUpdate> {
public StreamingResponseMcpListToolsInProgressUpdate() : base(default, default);
public string ItemId { get; set; }
public int OutputIndex { get; set; }
}
public class StreamingResponseOutputItemAddedUpdate : StreamingResponseUpdate, IJsonModel<StreamingResponseOutputItemAddedUpdate>, IPersistableModel<StreamingResponseOutputItemAddedUpdate> {
public StreamingResponseOutputItemAddedUpdate() : base(default, default);
public ResponseItem Item { get; set; }
public int OutputIndex { get; set; }
}
public class StreamingResponseOutputItemDoneUpdate : StreamingResponseUpdate, IJsonModel<StreamingResponseOutputItemDoneUpdate>, IPersistableModel<StreamingResponseOutputItemDoneUpdate> {
public StreamingResponseOutputItemDoneUpdate() : base(default, default);
public ResponseItem Item { get; set; }
public int OutputIndex { get; set; }
}
public class StreamingResponseOutputTextAnnotationAddedUpdate : StreamingResponseUpdate, IJsonModel<StreamingResponseOutputTextAnnotationAddedUpdate>, IPersistableModel<StreamingResponseOutputTextAnnotationAddedUpdate> {
public StreamingResponseOutputTextAnnotationAddedUpdate() : base(default, default);
public ResponseMessageAnnotation Annotation { get; set; }
public int AnnotationIndex { get; set; }
public int ContentIndex { get; set; }
public string ItemId { get; set; }
public int OutputIndex { get; set; }
}
public class StreamingResponseOutputTextDeltaUpdate : StreamingResponseUpdate, IJsonModel<StreamingResponseOutputTextDeltaUpdate>, IPersistableModel<StreamingResponseOutputTextDeltaUpdate> {
public StreamingResponseOutputTextDeltaUpdate() : base(default, default);
public int ContentIndex { get; set; }
public string Delta { get; set; }
public string ItemId { get; set; }
public int OutputIndex { get; set; }
public IList<ResponseTokenLogProbabilityDetails> TokenLogProbabilities { get; }
}
public class StreamingResponseOutputTextDoneUpdate : StreamingResponseUpdate, IJsonModel<StreamingResponseOutputTextDoneUpdate>, IPersistableModel<StreamingResponseOutputTextDoneUpdate> {
public StreamingResponseOutputTextDoneUpdate() : base(default, default);
public int ContentIndex { get; set; }
public string ItemId { get; set; }
public int OutputIndex { get; set; }
public string Text { get; set; }
public IList<ResponseTokenLogProbabilityDetails> TokenLogProbabilities { get; }
}
public class StreamingResponseQueuedUpdate : StreamingResponseUpdate, IJsonModel<StreamingResponseQueuedUpdate>, IPersistableModel<StreamingResponseQueuedUpdate> {
public StreamingResponseQueuedUpdate() : base(default, default);
public ResponseResult Response { get; set; }
}
public class StreamingResponseReasoningSummaryPartAddedUpdate : StreamingResponseUpdate, IJsonModel<StreamingResponseReasoningSummaryPartAddedUpdate>, IPersistableModel<StreamingResponseReasoningSummaryPartAddedUpdate> {
public StreamingResponseReasoningSummaryPartAddedUpdate() : base(default, default);
public string ItemId { get; set; }
public int OutputIndex { get; set; }
public ReasoningSummaryPart Part { get; set; }
public int SummaryIndex { get; set; }
}
public class StreamingResponseReasoningSummaryPartDoneUpdate : StreamingResponseUpdate, IJsonModel<StreamingResponseReasoningSummaryPartDoneUpdate>, IPersistableModel<StreamingResponseReasoningSummaryPartDoneUpdate> {
public StreamingResponseReasoningSummaryPartDoneUpdate() : base(default, default);
public string ItemId { get; set; }
public int OutputIndex { get; set; }
public ReasoningSummaryPart Part { get; set; }
public int SummaryIndex { get; set; }
}
public class StreamingResponseReasoningSummaryTextDeltaUpdate : StreamingResponseUpdate, IJsonModel<StreamingResponseReasoningSummaryTextDeltaUpdate>, IPersistableModel<StreamingResponseReasoningSummaryTextDeltaUpdate> {
public StreamingResponseReasoningSummaryTextDeltaUpdate() : base(default, default);
public string Delta { get; set; }
public string ItemId { get; set; }
public int OutputIndex { get; set; }
public int SummaryIndex { get; set; }
}
public class StreamingResponseReasoningSummaryTextDoneUpdate : StreamingResponseUpdate, IJsonModel<StreamingResponseReasoningSummaryTextDoneUpdate>, IPersistableModel<StreamingResponseReasoningSummaryTextDoneUpdate> {
public StreamingResponseReasoningSummaryTextDoneUpdate() : base(default, default);
public string ItemId { get; set; }
public int OutputIndex { get; set; }
public int SummaryIndex { get; set; }
public string Text { get; set; }
}
public class StreamingResponseReasoningTextDeltaUpdate : StreamingResponseUpdate, IJsonModel<StreamingResponseReasoningTextDeltaUpdate>, IPersistableModel<StreamingResponseReasoningTextDeltaUpdate> {
public StreamingResponseReasoningTextDeltaUpdate() : base(default, default);
public int ContentIndex { get; set; }
public string Delta { get; set; }
public string ItemId { get; set; }
public int OutputIndex { get; set; }
}
public class StreamingResponseReasoningTextDoneUpdate : StreamingResponseUpdate, IJsonModel<StreamingResponseReasoningTextDoneUpdate>, IPersistableModel<StreamingResponseReasoningTextDoneUpdate> {
public StreamingResponseReasoningTextDoneUpdate() : base(default, default);
public int ContentIndex { get; set; }
public string ItemId { get; set; }
public int OutputIndex { get; set; }
public string Text { get; set; }
}
public class StreamingResponseRefusalDeltaUpdate : StreamingResponseUpdate, IJsonModel<StreamingResponseRefusalDeltaUpdate>, IPersistableModel<StreamingResponseRefusalDeltaUpdate> {
public StreamingResponseRefusalDeltaUpdate() : base(default, default);
public int ContentIndex { get; set; }
public string Delta { get; set; }
public string ItemId { get; set; }
public int OutputIndex { get; set; }
}
public class StreamingResponseRefusalDoneUpdate : StreamingResponseUpdate, IJsonModel<StreamingResponseRefusalDoneUpdate>, IPersistableModel<StreamingResponseRefusalDoneUpdate> {
public StreamingResponseRefusalDoneUpdate() : base(default, default);
public int ContentIndex { get; set; }
public string ItemId { get; set; }
public int OutputIndex { get; set; }
public string Refusal { get; set; }
}
public class StreamingResponseUpdate : IJsonModel<StreamingResponseUpdate>, IPersistableModel<StreamingResponseUpdate> {
protected internal StreamingResponseUpdate(StreamingResponseUpdateKind kind, int sequenceNumber);
public StreamingResponseUpdateKind Kind { get; }
[Serialization.JsonIgnore]
[EditorBrowsable(EditorBrowsableState.Never)]
public ref JsonPatch Patch { get; }
public int SequenceNumber { get; set; }
}
public readonly partial struct StreamingResponseUpdateKind : IEquatable<StreamingResponseUpdateKind> {
public StreamingResponseUpdateKind(string value);
public static StreamingResponseUpdateKind Error { get; }
public static StreamingResponseUpdateKind ResponseAudioDelta { get; }
public static StreamingResponseUpdateKind ResponseAudioDone { get; }
public static StreamingResponseUpdateKind ResponseAudioTranscriptDelta { get; }
public static StreamingResponseUpdateKind ResponseAudioTranscriptDone { get; }
public static StreamingResponseUpdateKind ResponseCodeInterpreterCallCodeDelta { get; }
public static StreamingResponseUpdateKind ResponseCodeInterpreterCallCodeDone { get; }
public static StreamingResponseUpdateKind ResponseCodeInterpreterCallCompleted { get; }
public static StreamingResponseUpdateKind ResponseCodeInterpreterCallInProgress { get; }
public static StreamingResponseUpdateKind ResponseCodeInterpreterCallInterpreting { get; }
public static StreamingResponseUpdateKind ResponseCompleted { get; }
public static StreamingResponseUpdateKind ResponseContentPartAdded { get; }
public static StreamingResponseUpdateKind ResponseContentPartDone { get; }
public static StreamingResponseUpdateKind ResponseCreated { get; }
public static StreamingResponseUpdateKind ResponseCustomToolCallInputDelta { get; }
public static StreamingResponseUpdateKind ResponseCustomToolCallInputDone { get; }
public static StreamingResponseUpdateKind ResponseFailed { get; }
public static StreamingResponseUpdateKind ResponseFileSearchCallCompleted { get; }
public static StreamingResponseUpdateKind ResponseFileSearchCallInProgress { get; }
public static StreamingResponseUpdateKind ResponseFileSearchCallSearching { get; }
public static StreamingResponseUpdateKind ResponseFunctionCallArgumentsDelta { get; }
public static StreamingResponseUpdateKind ResponseFunctionCallArgumentsDone { get; }
public static StreamingResponseUpdateKind ResponseImageGenerationCallCompleted { get; }
public static StreamingResponseUpdateKind ResponseImageGenerationCallGenerating { get; }
public static StreamingResponseUpdateKind ResponseImageGenerationCallInProgress { get; }
public static StreamingResponseUpdateKind ResponseImageGenerationCallPartialImage { get; }
public static StreamingResponseUpdateKind ResponseIncomplete { get; }
public static StreamingResponseUpdateKind ResponseInProgress { get; }
public static StreamingResponseUpdateKind ResponseMcpCallArgumentsDelta { get; }
public static StreamingResponseUpdateKind ResponseMcpCallArgumentsDone { get; }
public static StreamingResponseUpdateKind ResponseMcpCallCompleted { get; }
public static StreamingResponseUpdateKind ResponseMcpCallFailed { get; }
public static StreamingResponseUpdateKind ResponseMcpCallInProgress { get; }
public static StreamingResponseUpdateKind ResponseMcpListToolsCompleted { get; }
public static StreamingResponseUpdateKind ResponseMcpListToolsFailed { get; }
public static StreamingResponseUpdateKind ResponseMcpListToolsInProgress { get; }
public static StreamingResponseUpdateKind ResponseOutputItemAdded { get; }
public static StreamingResponseUpdateKind ResponseOutputItemDone { get; }
public static StreamingResponseUpdateKind ResponseOutputTextAnnotationAdded { get; }
public static StreamingResponseUpdateKind ResponseOutputTextDelta { get; }
public static StreamingResponseUpdateKind ResponseOutputTextDone { get; }
public static StreamingResponseUpdateKind ResponseQueued { get; }
public static StreamingResponseUpdateKind ResponseReasoningSummaryPartAdded { get; }
public static StreamingResponseUpdateKind ResponseReasoningSummaryPartDone { get; }
public static StreamingResponseUpdateKind ResponseReasoningSummaryTextDelta { get; }
public static StreamingResponseUpdateKind ResponseReasoningSummaryTextDone { get; }
public static StreamingResponseUpdateKind ResponseReasoningTextDelta { get; }
public static StreamingResponseUpdateKind ResponseReasoningTextDone { get; }
public static StreamingResponseUpdateKind ResponseRefusalDelta { get; }
public static StreamingResponseUpdateKind ResponseRefusalDone { get; }
public static StreamingResponseUpdateKind ResponseWebSearchCallCompleted { get; }
public static StreamingResponseUpdateKind ResponseWebSearchCallInProgress { get; }
public static StreamingResponseUpdateKind ResponseWebSearchCallSearching { get; }
public readonly bool Equals(StreamingResponseUpdateKind other);
[EditorBrowsable(EditorBrowsableState.Never)]
public override readonly bool Equals(object obj);
[EditorBrowsable(EditorBrowsableState.Never)]
public override readonly int GetHashCode();
public static bool operator ==(StreamingResponseUpdateKind left, StreamingResponseUpdateKind right);
public static implicit operator StreamingResponseUpdateKind(string value);
public static implicit operator StreamingResponseUpdateKind?(string value);
public static bool operator !=(StreamingResponseUpdateKind left, StreamingResponseUpdateKind right);
public override readonly string ToString();
}
public class StreamingResponseWebSearchCallCompletedUpdate : StreamingResponseUpdate, IJsonModel<StreamingResponseWebSearchCallCompletedUpdate>, IPersistableModel<StreamingResponseWebSearchCallCompletedUpdate> {
public StreamingResponseWebSearchCallCompletedUpdate() : base(default, default);
public string ItemId { get; set; }
public int OutputIndex { get; set; }
}
public class StreamingResponseWebSearchCallInProgressUpdate : StreamingResponseUpdate, IJsonModel<StreamingResponseWebSearchCallInProgressUpdate>, IPersistableModel<StreamingResponseWebSearchCallInProgressUpdate> {
public StreamingResponseWebSearchCallInProgressUpdate() : base(default, default);
public string ItemId { get; set; }
public int OutputIndex { get; set; }
}
public class StreamingResponseWebSearchCallSearchingUpdate : StreamingResponseUpdate, IJsonModel<StreamingResponseWebSearchCallSearchingUpdate>, IPersistableModel<StreamingResponseWebSearchCallSearchingUpdate> {
public StreamingResponseWebSearchCallSearchingUpdate() : base(default, default);
public string ItemId { get; set; }
public int OutputIndex { get; set; }
}
public class UriCitationMessageAnnotation : ResponseMessageAnnotation, IJsonModel<UriCitationMessageAnnotation>, IPersistableModel<UriCitationMessageAnnotation> {
public UriCitationMessageAnnotation(Uri uri, int startIndex, int endIndex, string title);
public int EndIndex { get; set; }
public int StartIndex { get; set; }
public string Title { get; set; }
public Uri Uri { get; set; }
}
public class WebSearchAction : IJsonModel<WebSearchAction>, IPersistableModel<WebSearchAction> {
[Serialization.JsonIgnore]
[EditorBrowsable(EditorBrowsableState.Never)]
public ref JsonPatch Patch { get; }
}
public class WebSearchActionSource : IJsonModel<WebSearchActionSource>, IPersistableModel<WebSearchActionSource> {
[Serialization.JsonIgnore]
[EditorBrowsable(EditorBrowsableState.Never)]
public ref JsonPatch Patch { get; }
}
public class WebSearchActionUriSource : WebSearchActionSource, IJsonModel<WebSearchActionUriSource>, IPersistableModel<WebSearchActionUriSource> {
public WebSearchActionUriSource(Uri uri);
public Uri Uri { get; set; }
}
public class WebSearchCallResponseItem : ResponseItem, IJsonModel<WebSearchCallResponseItem>, IPersistableModel<WebSearchCallResponseItem> {
public WebSearchCallResponseItem() : base(default);
public WebSearchAction Action { get; set; }
public WebSearchCallStatus? Status { get; set; }
}
public enum WebSearchCallStatus {
InProgress = 0,
Searching = 1,
Completed = 2,
Failed = 3
}
public class WebSearchFindInPageAction : WebSearchAction, IJsonModel<WebSearchFindInPageAction>, IPersistableModel<WebSearchFindInPageAction> {
public WebSearchFindInPageAction(Uri uri, string pattern);
public string Pattern { get; set; }
public Uri Uri { get; set; }
}
public class WebSearchOpenPageAction : WebSearchAction, IJsonModel<WebSearchOpenPageAction>, IPersistableModel<WebSearchOpenPageAction> {
public WebSearchOpenPageAction();
public Uri Uri { get; set; }
}
public class WebSearchPreviewTool : ResponseTool, IJsonModel<WebSearchPreviewTool>, IPersistableModel<WebSearchPreviewTool> {
public WebSearchPreviewTool() : base(default);
public WebSearchToolContextSize? SearchContextSize { get; set; }
public WebSearchToolLocation UserLocation { get; set; }
}
public class WebSearchSearchAction : WebSearchAction, IJsonModel<WebSearchSearchAction>, IPersistableModel<WebSearchSearchAction> {
public WebSearchSearchAction();
public IList<string> Queries { get; }
[Obsolete("This property is obsolete. Use the Queries property instead.")]
public string Query { get; set; }
public IList<WebSearchActionSource> Sources { get; }
}
public class WebSearchTool : ResponseTool, IJsonModel<WebSearchTool>, IPersistableModel<WebSearchTool> {
public WebSearchTool() : base(default);
public WebSearchToolFilters Filters { get; set; }
public WebSearchToolContextSize? SearchContextSize { get; set; }
public WebSearchToolLocation UserLocation { get; set; }
}
public class WebSearchToolApproximateLocation : WebSearchToolLocation, IJsonModel<WebSearchToolApproximateLocation>, IPersistableModel<WebSearchToolApproximateLocation> {
public WebSearchToolApproximateLocation();
public string City { get; set; }
public string Country { get; set; }
public string Region { get; set; }
public string Timezone { get; set; }
}
public readonly partial struct WebSearchToolContextSize : IEquatable<WebSearchToolContextSize> {
public WebSearchToolContextSize(string value);
public static WebSearchToolContextSize High { get; }
public static WebSearchToolContextSize Low { get; }
public static WebSearchToolContextSize Medium { get; }
public readonly bool Equals(WebSearchToolContextSize other);
[EditorBrowsable(EditorBrowsableState.Never)]
public override readonly bool Equals(object obj);
[EditorBrowsable(EditorBrowsableState.Never)]
public override readonly int GetHashCode();
public static bool operator ==(WebSearchToolContextSize left, WebSearchToolContextSize right);
public static implicit operator WebSearchToolContextSize(string value);
public static implicit operator WebSearchToolContextSize?(string value);
public static bool operator !=(WebSearchToolContextSize left, WebSearchToolContextSize right);
public override readonly string ToString();
}
public class WebSearchToolFilters : IJsonModel<WebSearchToolFilters>, IPersistableModel<WebSearchToolFilters> {
public IList<string> AllowedDomains { get; set; }
[Serialization.JsonIgnore]
[EditorBrowsable(EditorBrowsableState.Never)]
public ref JsonPatch Patch { get; }
}
public class WebSearchToolLocation : IJsonModel<WebSearchToolLocation>, IPersistableModel<WebSearchToolLocation> {
[Serialization.JsonIgnore]
[EditorBrowsable(EditorBrowsableState.Never)]
public ref JsonPatch Patch { get; }
public static WebSearchToolApproximateLocation CreateApproximateLocation(string country = null, string region = null, string city = null, string timezone = null);
}
}
namespace OpenAI.Skills {
public class SkillClient {
protected SkillClient();
public SkillClient(SkillClientSettings settings);
public SkillClient(ApiKeyCredential credential, OpenAIClientOptions options);
public SkillClient(ApiKeyCredential credential);
public SkillClient(AuthenticationPolicy authenticationPolicy, OpenAIClientOptions options);
public SkillClient(AuthenticationPolicy authenticationPolicy);
protected internal SkillClient(ClientPipeline pipeline, OpenAIClientOptions options);
public SkillClient(string apiKey);
public Uri Endpoint { get; }
public ClientPipeline Pipeline { get; }
public virtual ClientResult DeleteSkill(string skillId, RequestOptions options = null);
public virtual Task<ClientResult> DeleteSkillAsync(string skillId, RequestOptions options = null);
public virtual ClientResult DeleteSkillVersion(string skillId, string version, RequestOptions options = null);
public virtual Task<ClientResult> DeleteSkillVersionAsync(string skillId, string version, RequestOptions options = null);
public virtual ClientResult DownloadSkill(string skillId, RequestOptions options = null);
public virtual Task<ClientResult> DownloadSkillAsync(string skillId, RequestOptions options = null);
public virtual ClientResult DownloadSkillVersion(string skillId, string version, RequestOptions options = null);
public virtual Task<ClientResult> DownloadSkillVersionAsync(string skillId, string version, RequestOptions options = null);
public virtual ClientResult GetSkill(string skillId, RequestOptions options = null);
public virtual Task<ClientResult> GetSkillAsync(string skillId, RequestOptions options = null);
public virtual ClientResult GetSkills(int? limit = null, string order = null, string after = null, RequestOptions options = null);
public virtual Task<ClientResult> GetSkillsAsync(int? limit = null, string order = null, string after = null, RequestOptions options = null);
public virtual ClientResult GetSkillVersion(string skillId, string version, RequestOptions options = null);
public virtual Task<ClientResult> GetSkillVersionAsync(string skillId, string version, RequestOptions options = null);
public virtual ClientResult GetSkillVersions(string skillId, int? limit = null, string order = null, string after = null, RequestOptions options = null);
public virtual Task<ClientResult> GetSkillVersionsAsync(string skillId, int? limit = null, string order = null, string after = null, RequestOptions options = null);
public virtual ClientResult UpdateSkill(string skillId, BinaryContent content, string contentType, RequestOptions options = null);
public virtual Task<ClientResult> UpdateSkillAsync(string skillId, BinaryContent content, string contentType, RequestOptions options = null);
public virtual ClientResult UploadSkill(BinaryContent content, string contentType, RequestOptions options = null);
public virtual Task<ClientResult> UploadSkillAsync(BinaryContent content, string contentType, RequestOptions options = null);
public virtual ClientResult UploadSkillVersion(string skillId, BinaryContent content, string contentType, RequestOptions options = null);
public virtual Task<ClientResult> UploadSkillVersionAsync(string skillId, BinaryContent content, string contentType, RequestOptions options = null);
}
public sealed class SkillClientSettings : ClientSettings {
public OpenAIClientOptions Options { get; set; }
protected override void BindCore(Microsoft.Extensions.Configuration.IConfigurationSection section);
}
}
namespace OpenAI.VectorStores {
public abstract class FileChunkingStrategy : IJsonModel<FileChunkingStrategy>, IPersistableModel<FileChunkingStrategy> {
public static FileChunkingStrategy Auto { get; }
public static FileChunkingStrategy Unknown { get; }
public static FileChunkingStrategy CreateStaticStrategy(int maxTokensPerChunk, int overlappingTokenCount);
}
public class FileFromStoreRemovalResult : IJsonModel<FileFromStoreRemovalResult>, IPersistableModel<FileFromStoreRemovalResult> {
public string FileId { get; }
public bool Removed { get; }
public static explicit operator FileFromStoreRemovalResult(ClientResult result);
}
public class StaticFileChunkingStrategy : FileChunkingStrategy, IJsonModel<StaticFileChunkingStrategy>, IPersistableModel<StaticFileChunkingStrategy> {
public StaticFileChunkingStrategy(int maxTokensPerChunk, int overlappingTokenCount);
public int MaxTokensPerChunk { get; }
public int OverlappingTokenCount { get; }
}
public class VectorStore : IJsonModel<VectorStore>, IPersistableModel<VectorStore> {
public DateTimeOffset CreatedAt { get; }
public VectorStoreExpirationPolicy ExpirationPolicy { get; }
public DateTimeOffset? ExpiresAt { get; }
public VectorStoreFileCounts FileCounts { get; }
public string Id { get; }
public DateTimeOffset? LastActiveAt { get; }
public IReadOnlyDictionary<string, string> Metadata { get; }
public string Name { get; }
public VectorStoreStatus Status { get; }
public int UsageBytes { get; }
public static explicit operator VectorStore(ClientResult result);
}
public class VectorStoreClient {
protected VectorStoreClient();
public VectorStoreClient(VectorStoreClientSettings settings);
public VectorStoreClient(ApiKeyCredential credential, OpenAIClientOptions options);
public VectorStoreClient(ApiKeyCredential credential);
public VectorStoreClient(AuthenticationPolicy authenticationPolicy, OpenAIClientOptions options);
public VectorStoreClient(AuthenticationPolicy authenticationPolicy);
protected internal VectorStoreClient(ClientPipeline pipeline, OpenAIClientOptions options);
public VectorStoreClient(string apiKey);
public Uri Endpoint { get; }
public ClientPipeline Pipeline { get; }
public virtual ClientResult AddFileBatchToVectorStore(string vectorStoreId, BinaryContent content, RequestOptions options = null);
public virtual ClientResult<VectorStoreFileBatch> AddFileBatchToVectorStore(string vectorStoreId, IEnumerable<string> fileIds, CancellationToken cancellationToken = default);
public virtual Task<ClientResult> AddFileBatchToVectorStoreAsync(string vectorStoreId, BinaryContent content, RequestOptions options = null);
public virtual Task<ClientResult<VectorStoreFileBatch>> AddFileBatchToVectorStoreAsync(string vectorStoreId, IEnumerable<string> fileIds, CancellationToken cancellationToken = default);
public virtual ClientResult AddFileToVectorStore(string vectorStoreId, BinaryContent content, RequestOptions options = null);
public virtual ClientResult<VectorStoreFile> AddFileToVectorStore(string vectorStoreId, string fileId, CancellationToken cancellationToken = default);
public virtual Task<ClientResult> AddFileToVectorStoreAsync(string vectorStoreId, BinaryContent content, RequestOptions options = null);
public virtual Task<ClientResult<VectorStoreFile>> AddFileToVectorStoreAsync(string vectorStoreId, string fileId, CancellationToken cancellationToken = default);
public virtual ClientResult CancelVectorStoreFileBatch(string vectorStoreId, string batchId, RequestOptions options);
public virtual ClientResult<VectorStoreFileBatch> CancelVectorStoreFileBatch(string vectorStoreId, string batchId, CancellationToken cancellationToken = default);
public virtual Task<ClientResult> CancelVectorStoreFileBatchAsync(string vectorStoreId, string batchId, RequestOptions options);
public virtual Task<ClientResult<VectorStoreFileBatch>> CancelVectorStoreFileBatchAsync(string vectorStoreId, string batchId, CancellationToken cancellationToken = default);
public virtual ClientResult<VectorStore> CreateVectorStore(VectorStoreCreationOptions options = null, CancellationToken cancellationToken = default);
public virtual ClientResult CreateVectorStore(BinaryContent content, RequestOptions options = null);
public virtual Task<ClientResult<VectorStore>> CreateVectorStoreAsync(VectorStoreCreationOptions options = null, CancellationToken cancellationToken = default);
public virtual Task<ClientResult> CreateVectorStoreAsync(BinaryContent content, RequestOptions options = null);
public virtual ClientResult DeleteVectorStore(string vectorStoreId, RequestOptions options);
public virtual ClientResult<VectorStoreDeletionResult> DeleteVectorStore(string vectorStoreId, CancellationToken cancellationToken = default);
public virtual Task<ClientResult> DeleteVectorStoreAsync(string vectorStoreId, RequestOptions options);
public virtual Task<ClientResult<VectorStoreDeletionResult>> DeleteVectorStoreAsync(string vectorStoreId, CancellationToken cancellationToken = default);
public virtual ClientResult GetVectorStore(string vectorStoreId, RequestOptions options);
public virtual ClientResult<VectorStore> GetVectorStore(string vectorStoreId, CancellationToken cancellationToken = default);
public virtual Task<ClientResult> GetVectorStoreAsync(string vectorStoreId, RequestOptions options);
public virtual Task<ClientResult<VectorStore>> GetVectorStoreAsync(string vectorStoreId, CancellationToken cancellationToken = default);
public virtual ClientResult GetVectorStoreFile(string vectorStoreId, string fileId, RequestOptions options);
public virtual ClientResult<VectorStoreFile> GetVectorStoreFile(string vectorStoreId, string fileId, CancellationToken cancellationToken = default);
public virtual Task<ClientResult> GetVectorStoreFileAsync(string vectorStoreId, string fileId, RequestOptions options);
public virtual Task<ClientResult<VectorStoreFile>> GetVectorStoreFileAsync(string vectorStoreId, string fileId, CancellationToken cancellationToken = default);
public virtual ClientResult GetVectorStoreFileBatch(string vectorStoreId, string batchId, RequestOptions options);
public virtual ClientResult<VectorStoreFileBatch> GetVectorStoreFileBatch(string vectorStoreId, string batchId, CancellationToken cancellationToken = default);
public virtual Task<ClientResult> GetVectorStoreFileBatchAsync(string vectorStoreId, string batchId, RequestOptions options);
public virtual Task<ClientResult<VectorStoreFileBatch>> GetVectorStoreFileBatchAsync(string vectorStoreId, string batchId, CancellationToken cancellationToken = default);
public virtual CollectionResult<VectorStoreFile> GetVectorStoreFiles(string vectorStoreId, VectorStoreFileCollectionOptions options = null, CancellationToken cancellationToken = default);
public virtual CollectionResult GetVectorStoreFiles(string vectorStoreId, int? limit, string order, string after, string before, string filter, RequestOptions options);
public virtual AsyncCollectionResult<VectorStoreFile> GetVectorStoreFilesAsync(string vectorStoreId, VectorStoreFileCollectionOptions options = null, CancellationToken cancellationToken = default);
public virtual AsyncCollectionResult GetVectorStoreFilesAsync(string vectorStoreId, int? limit, string order, string after, string before, string filter, RequestOptions options);
public virtual CollectionResult<VectorStoreFile> GetVectorStoreFilesInBatch(string vectorStoreId, string batchId, VectorStoreFileCollectionOptions options = null, CancellationToken cancellationToken = default);
public virtual CollectionResult GetVectorStoreFilesInBatch(string vectorStoreId, string batchId, int? limit, string order, string after, string before, string filter, RequestOptions options);
public virtual AsyncCollectionResult<VectorStoreFile> GetVectorStoreFilesInBatchAsync(string vectorStoreId, string batchId, VectorStoreFileCollectionOptions options = null, CancellationToken cancellationToken = default);
public virtual AsyncCollectionResult GetVectorStoreFilesInBatchAsync(string vectorStoreId, string batchId, int? limit, string order, string after, string before, string filter, RequestOptions options);
public virtual CollectionResult<VectorStore> GetVectorStores(VectorStoreCollectionOptions options = null, CancellationToken cancellationToken = default);
public virtual CollectionResult GetVectorStores(int? limit, string order, string after, string before, RequestOptions options);
public virtual AsyncCollectionResult<VectorStore> GetVectorStoresAsync(VectorStoreCollectionOptions options = null, CancellationToken cancellationToken = default);
public virtual AsyncCollectionResult GetVectorStoresAsync(int? limit, string order, string after, string before, RequestOptions options);
public virtual ClientResult<VectorStore> ModifyVectorStore(string vectorStoreId, VectorStoreModificationOptions options, CancellationToken cancellationToken = default);
public virtual ClientResult ModifyVectorStore(string vectorStoreId, BinaryContent content, RequestOptions options = null);
public virtual Task<ClientResult<VectorStore>> ModifyVectorStoreAsync(string vectorStoreId, VectorStoreModificationOptions options, CancellationToken cancellationToken = default);
public virtual Task<ClientResult> ModifyVectorStoreAsync(string vectorStoreId, BinaryContent content, RequestOptions options = null);
public virtual ClientResult RemoveFileFromVectorStore(string vectorStoreId, string fileId, RequestOptions options);
public virtual ClientResult<FileFromStoreRemovalResult> RemoveFileFromVectorStore(string vectorStoreId, string fileId, CancellationToken cancellationToken = default);
public virtual Task<ClientResult> RemoveFileFromVectorStoreAsync(string vectorStoreId, string fileId, RequestOptions options);
public virtual Task<ClientResult<FileFromStoreRemovalResult>> RemoveFileFromVectorStoreAsync(string vectorStoreId, string fileId, CancellationToken cancellationToken = default);
public virtual ClientResult RetrieveVectorStoreFileContent(string vectorStoreId, string fileId, RequestOptions options);
public virtual Task<ClientResult> RetrieveVectorStoreFileContentAsync(string vectorStoreId, string fileId, RequestOptions options);
public virtual ClientResult SearchVectorStore(string vectorStoreId, BinaryContent content, RequestOptions options = null);
public virtual Task<ClientResult> SearchVectorStoreAsync(string vectorStoreId, BinaryContent content, RequestOptions options = null);
public virtual ClientResult UpdateVectorStoreFileAttributes(string vectorStoreId, string fileId, BinaryContent content, RequestOptions options = null);
public virtual ClientResult<VectorStoreFile> UpdateVectorStoreFileAttributes(string vectorStoreId, string fileId, IDictionary<string, BinaryData> attributes, CancellationToken cancellationToken = default);
public virtual Task<ClientResult> UpdateVectorStoreFileAttributesAsync(string vectorStoreId, string fileId, BinaryContent content, RequestOptions options = null);
public virtual Task<ClientResult<VectorStoreFile>> UpdateVectorStoreFileAttributesAsync(string vectorStoreId, string fileId, IDictionary<string, BinaryData> attributes, CancellationToken cancellationToken = default);
}
public sealed class VectorStoreClientSettings : ClientSettings {
public OpenAIClientOptions Options { get; set; }
protected override void BindCore(Microsoft.Extensions.Configuration.IConfigurationSection section);
}
public class VectorStoreCollectionOptions : IJsonModel<VectorStoreCollectionOptions>, IPersistableModel<VectorStoreCollectionOptions> {
public string AfterId { get; set; }
public string BeforeId { get; set; }
public VectorStoreCollectionOrder? Order { get; set; }
public int? PageSizeLimit { get; set; }
}
public readonly partial struct VectorStoreCollectionOrder : IEquatable<VectorStoreCollectionOrder> {
public VectorStoreCollectionOrder(string value);
public static VectorStoreCollectionOrder Ascending { get; }
public static VectorStoreCollectionOrder Descending { get; }
public readonly bool Equals(VectorStoreCollectionOrder other);
[EditorBrowsable(EditorBrowsableState.Never)]
public override readonly bool Equals(object obj);
[EditorBrowsable(EditorBrowsableState.Never)]
public override readonly int GetHashCode();
public static bool operator ==(VectorStoreCollectionOrder left, VectorStoreCollectionOrder right);
public static implicit operator VectorStoreCollectionOrder(string value);
public static implicit operator VectorStoreCollectionOrder?(string value);
public static bool operator !=(VectorStoreCollectionOrder left, VectorStoreCollectionOrder right);
public override readonly string ToString();
}
public class VectorStoreCreationOptions : IJsonModel<VectorStoreCreationOptions>, IPersistableModel<VectorStoreCreationOptions> {
public FileChunkingStrategy ChunkingStrategy { get; set; }
public string Description { get; set; }
public VectorStoreExpirationPolicy ExpirationPolicy { get; set; }
public IList<string> FileIds { get; }
public IDictionary<string, string> Metadata { get; }
public string Name { get; set; }
}
public class VectorStoreDeletionResult : IJsonModel<VectorStoreDeletionResult>, IPersistableModel<VectorStoreDeletionResult> {
public bool Deleted { get; }
public string VectorStoreId { get; }
public static explicit operator VectorStoreDeletionResult(ClientResult result);
}
public enum VectorStoreExpirationAnchor {
Unknown = 0,
LastActiveAt = 1
}
public class VectorStoreExpirationPolicy : IJsonModel<VectorStoreExpirationPolicy>, IPersistableModel<VectorStoreExpirationPolicy> {
public VectorStoreExpirationPolicy(VectorStoreExpirationAnchor anchor, int days);
public VectorStoreExpirationAnchor Anchor { get; set; }
public int Days { get; set; }
}
public class VectorStoreFile : IJsonModel<VectorStoreFile>, IPersistableModel<VectorStoreFile> {
public IDictionary<string, BinaryData> Attributes { get; }
public FileChunkingStrategy ChunkingStrategy { get; }
public DateTimeOffset CreatedAt { get; }
public string FileId { get; }
public VectorStoreFileError LastError { get; }
public VectorStoreFileStatus Status { get; }
public long? UsageInBytes { get; }
public string VectorStoreId { get; }
public static explicit operator VectorStoreFile(ClientResult result);
}
public class VectorStoreFileBatch : IJsonModel<VectorStoreFileBatch>, IPersistableModel<VectorStoreFileBatch> {
public string BatchId { get; }
public DateTimeOffset CreatedAt { get; }
public VectorStoreFileCounts FileCounts { get; }
public VectorStoreFileBatchStatus Status { get; }
public string VectorStoreId { get; }
public static explicit operator VectorStoreFileBatch(ClientResult result);
}
public readonly partial struct VectorStoreFileBatchStatus : IEquatable<VectorStoreFileBatchStatus> {
public VectorStoreFileBatchStatus(string value);
public static VectorStoreFileBatchStatus Cancelled { get; }
public static VectorStoreFileBatchStatus Completed { get; }
public static VectorStoreFileBatchStatus Failed { get; }
public static VectorStoreFileBatchStatus InProgress { get; }
public readonly bool Equals(VectorStoreFileBatchStatus other);
[EditorBrowsable(EditorBrowsableState.Never)]
public override readonly bool Equals(object obj);
[EditorBrowsable(EditorBrowsableState.Never)]
public override readonly int GetHashCode();
public static bool operator ==(VectorStoreFileBatchStatus left, VectorStoreFileBatchStatus right);
public static implicit operator VectorStoreFileBatchStatus(string value);
public static implicit operator VectorStoreFileBatchStatus?(string value);
public static bool operator !=(VectorStoreFileBatchStatus left, VectorStoreFileBatchStatus right);
public override readonly string ToString();
}
public class VectorStoreFileCollectionOptions : IJsonModel<VectorStoreFileCollectionOptions>, IPersistableModel<VectorStoreFileCollectionOptions> {
public string AfterId { get; set; }
public string BeforeId { get; set; }
public VectorStoreFileStatusFilter? Filter { get; set; }
public VectorStoreFileCollectionOrder? Order { get; set; }
public int? PageSizeLimit { get; set; }
}
public readonly partial struct VectorStoreFileCollectionOrder : IEquatable<VectorStoreFileCollectionOrder> {
public VectorStoreFileCollectionOrder(string value);
public static VectorStoreFileCollectionOrder Ascending { get; }
public static VectorStoreFileCollectionOrder Descending { get; }
public readonly bool Equals(VectorStoreFileCollectionOrder other);
[EditorBrowsable(EditorBrowsableState.Never)]
public override readonly bool Equals(object obj);
[EditorBrowsable(EditorBrowsableState.Never)]
public override readonly int GetHashCode();
public static bool operator ==(VectorStoreFileCollectionOrder left, VectorStoreFileCollectionOrder right);
public static implicit operator VectorStoreFileCollectionOrder(string value);
public static implicit operator VectorStoreFileCollectionOrder?(string value);
public static bool operator !=(VectorStoreFileCollectionOrder left, VectorStoreFileCollectionOrder right);
public override readonly string ToString();
}
public class VectorStoreFileCounts : IJsonModel<VectorStoreFileCounts>, IPersistableModel<VectorStoreFileCounts> {
public int Cancelled { get; }
public int Completed { get; }
public int Failed { get; }
public int InProgress { get; }
public int Total { get; }
}
public class VectorStoreFileError : IJsonModel<VectorStoreFileError>, IPersistableModel<VectorStoreFileError> {
public VectorStoreFileErrorCode Code { get; }
public string Message { get; }
}
public readonly partial struct VectorStoreFileErrorCode : IEquatable<VectorStoreFileErrorCode> {
public VectorStoreFileErrorCode(string value);
public static VectorStoreFileErrorCode InvalidFile { get; }
public static VectorStoreFileErrorCode ServerError { get; }
public static VectorStoreFileErrorCode UnsupportedFile { get; }
public readonly bool Equals(VectorStoreFileErrorCode other);
[EditorBrowsable(EditorBrowsableState.Never)]
public override readonly bool Equals(object obj);
[EditorBrowsable(EditorBrowsableState.Never)]
public override readonly int GetHashCode();
public static bool operator ==(VectorStoreFileErrorCode left, VectorStoreFileErrorCode right);
public static implicit operator VectorStoreFileErrorCode(string value);
public static implicit operator VectorStoreFileErrorCode?(string value);
public static bool operator !=(VectorStoreFileErrorCode left, VectorStoreFileErrorCode right);
public override readonly string ToString();
}
public enum VectorStoreFileStatus {
Unknown = 0,
InProgress = 1,
Completed = 2,
Cancelled = 3,
Failed = 4
}
public readonly partial struct VectorStoreFileStatusFilter : IEquatable<VectorStoreFileStatusFilter> {
public VectorStoreFileStatusFilter(string value);
public static VectorStoreFileStatusFilter Cancelled { get; }
public static VectorStoreFileStatusFilter Completed { get; }
public static VectorStoreFileStatusFilter Failed { get; }
public static VectorStoreFileStatusFilter InProgress { get; }
public readonly bool Equals(VectorStoreFileStatusFilter other);
[EditorBrowsable(EditorBrowsableState.Never)]
public override readonly bool Equals(object obj);
[EditorBrowsable(EditorBrowsableState.Never)]
public override readonly int GetHashCode();
public static bool operator ==(VectorStoreFileStatusFilter left, VectorStoreFileStatusFilter right);
public static implicit operator VectorStoreFileStatusFilter(string value);
public static implicit operator VectorStoreFileStatusFilter?(string value);
public static bool operator !=(VectorStoreFileStatusFilter left, VectorStoreFileStatusFilter right);
public override readonly string ToString();
}
public class VectorStoreModificationOptions : IJsonModel<VectorStoreModificationOptions>, IPersistableModel<VectorStoreModificationOptions> {
public VectorStoreExpirationPolicy ExpirationPolicy { get; set; }
public IDictionary<string, string> Metadata { get; }
public string Name { get; set; }
}
public enum VectorStoreStatus {
Unknown = 0,
InProgress = 1,
Completed = 2,
Expired = 3
}
}
namespace OpenAI.Videos {
public class VideoClient {
protected VideoClient();
public VideoClient(VideoClientSettings settings);
public VideoClient(ApiKeyCredential credential, OpenAIClientOptions options);
public VideoClient(ApiKeyCredential credential);
public VideoClient(AuthenticationPolicy authenticationPolicy, OpenAIClientOptions options);
public VideoClient(AuthenticationPolicy authenticationPolicy);
protected internal VideoClient(ClientPipeline pipeline, OpenAIClientOptions options);
public VideoClient(string apiKey);
public Uri Endpoint { get; }
public ClientPipeline Pipeline { get; }
public virtual ClientResult CreateVideo(BinaryContent content, string contentType, RequestOptions options = null);
public virtual Task<ClientResult> CreateVideoAsync(BinaryContent content, string contentType, RequestOptions options = null);
public virtual ClientResult CreateVideoRemix(string videoId, BinaryContent content, string contentType, RequestOptions options = null);
public virtual Task<ClientResult> CreateVideoRemixAsync(string videoId, BinaryContent content, string contentType, RequestOptions options = null);
public virtual ClientResult DeleteVideo(string videoId, RequestOptions options = null);
public virtual Task<ClientResult> DeleteVideoAsync(string videoId, RequestOptions options = null);
public virtual ClientResult DownloadVideo(string videoId, string variant = null, RequestOptions options = null);
public virtual Task<ClientResult> DownloadVideoAsync(string videoId, string variant = null, RequestOptions options = null);
public virtual ClientResult GetVideo(string videoId, RequestOptions options = null);
public virtual Task<ClientResult> GetVideoAsync(string videoId, RequestOptions options = null);
public virtual CollectionResult GetVideos(int? limit = null, string order = null, string after = null, RequestOptions options = null);
public virtual AsyncCollectionResult GetVideosAsync(int? limit = null, string order = null, string after = null, RequestOptions options = null);
}
public sealed class VideoClientSettings : ClientSettings {
public OpenAIClientOptions Options { get; set; }
protected override void BindCore(Microsoft.Extensions.Configuration.IConfigurationSection section);
}
}openai/openai-dotnet
Publicmirrored from https://github.com/openai/openai-dotnetAvailable
api/OpenAI.netstandard2.0.cs
6510lines · modepreview