Skip to content

Expose role-specific message items in Responses #846

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from
Draft

Expose role-specific message items in Responses #846

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
62 changes: 48 additions & 14 deletions api/OpenAI.net8.0.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4839,6 +4839,15 @@ public class TurnDetectionOptions : IJsonModel<TurnDetectionOptions>, IPersistab
}
}
namespace OpenAI.Responses {
[Experimental("OPENAI001")]
public class AssistantMessageResponseItem : MessageResponseItem, IJsonModel<AssistantMessageResponseItem>, IPersistableModel<AssistantMessageResponseItem> {
public AssistantMessageResponseItem(IEnumerable<ResponseContentPart> content);
public AssistantMessageResponseItem(string outputTextContent);
protected override ResponseItem JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
protected override void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
protected override ResponseItem PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
protected override BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
}
[Experimental("OPENAI001")]
public class AutomaticCodeInterpreterToolContainerConfiguration : CodeInterpreterToolContainerConfiguration, IJsonModel<AutomaticCodeInterpreterToolContainerConfiguration>, IPersistableModel<AutomaticCodeInterpreterToolContainerConfiguration> {
public AutomaticCodeInterpreterToolContainerConfiguration();
Expand Down Expand Up @@ -5106,6 +5115,15 @@ public class CustomMcpToolCallApprovalPolicy : IJsonModel<CustomMcpToolCallAppro
protected virtual BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
}
[Experimental("OPENAI001")]
public class DeveloperMessageResponseItem : MessageResponseItem, IJsonModel<DeveloperMessageResponseItem>, IPersistableModel<DeveloperMessageResponseItem> {
public DeveloperMessageResponseItem(IEnumerable<ResponseContentPart> content);
public DeveloperMessageResponseItem(string inputTextContent);
protected override ResponseItem JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
protected override void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
protected override ResponseItem PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
protected override BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
}
[Experimental("OPENAI001")]
public class FileCitationMessageAnnotation : ResponseMessageAnnotation, IJsonModel<FileCitationMessageAnnotation>, IPersistableModel<FileCitationMessageAnnotation> {
public FileCitationMessageAnnotation(string fileId, int index, string filename);
public string FileId { get; set; }
Expand Down Expand Up @@ -5669,19 +5687,17 @@ public class OpenAIResponseClient {
}
[Experimental("OPENAI001")]
public static class OpenAIResponsesModelFactory {
public static MessageResponseItem MessageResponseItem(string id = null, MessageRole role = MessageRole.Assistant, MessageStatus? status = null);
public static OpenAIResponse OpenAIResponse(string id = null, DateTimeOffset createdAt = default, ResponseStatus? status = null, ResponseError error = null, ResponseTokenUsage usage = null, string endUserId = null, ResponseReasoningOptions reasoningOptions = null, int? maxOutputTokenCount = null, ResponseTextOptions textOptions = null, ResponseTruncationMode? truncationMode = null, ResponseIncompleteStatusDetails incompleteStatusDetails = null, IEnumerable<ResponseItem> outputItems = null, bool parallelToolCallsEnabled = false, ResponseToolChoice toolChoice = null, string model = null, IDictionary<string, string> metadata = null, float? temperature = null, float? topP = null, ResponseServiceTier? serviceTier = null, string previousResponseId = null, bool? backgroundModeEnabled = null, string instructions = null, IEnumerable<ResponseTool> tools = null);
public static ReasoningResponseItem ReasoningResponseItem(string id = null, string encryptedContent = null, ReasoningStatus? status = null, IEnumerable<ReasoningSummaryPart> summaryParts = null);
public static ReasoningResponseItem ReasoningResponseItem(string id = null, string encryptedContent = null, ReasoningStatus? status = null, string summaryText = null);
public static ReasoningResponseItem ReasoningResponseItem(string id = null, string encryptedContent = null, ReasoningStatus? status = null, IEnumerable<ReasoningSummaryPart> summary = null);
public static ReferenceResponseItem ReferenceResponseItem(string id = null);
}
[Experimental("OPENAI001")]
public class ReasoningResponseItem : ResponseItem, IJsonModel<ReasoningResponseItem>, IPersistableModel<ReasoningResponseItem> {
public ReasoningResponseItem(IEnumerable<ReasoningSummaryPart> summaryParts);
public ReasoningResponseItem(IEnumerable<ReasoningSummaryPart> summary);
public ReasoningResponseItem(string summaryText);
public string EncryptedContent { get; set; }
public ReasoningStatus? Status { get; }
public IList<ReasoningSummaryPart> SummaryParts { get; }
public IList<ReasoningSummaryPart> Summary { get; }
public string GetSummaryText();
protected override ResponseItem JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
protected override void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
Expand Down Expand Up @@ -5912,28 +5928,28 @@ public class ResponseItem : IJsonModel<ResponseItem>, IPersistableModel<Response
[EditorBrowsable(EditorBrowsableState.Never)]
[Experimental("SCME0001")]
public ref JsonPatch Patch { get; }
public static MessageResponseItem CreateAssistantMessageItem(IEnumerable<ResponseContentPart> contentParts);
public static MessageResponseItem CreateAssistantMessageItem(string outputTextContent, IEnumerable<ResponseMessageAnnotation> annotations = null);
public static AssistantMessageResponseItem CreateAssistantMessageItem(IEnumerable<ResponseContentPart> content);
public static AssistantMessageResponseItem CreateAssistantMessageItem(string outputTextContent);
[Experimental("OPENAICUA001")]
public static ComputerCallResponseItem CreateComputerCallItem(string callId, ComputerCallAction action, IEnumerable<ComputerCallSafetyCheck> pendingSafetyChecks);
[Experimental("OPENAICUA001")]
public static ComputerCallOutputResponseItem CreateComputerCallOutputItem(string callId, ComputerCallOutput output);
public static MessageResponseItem CreateDeveloperMessageItem(IEnumerable<ResponseContentPart> contentParts);
public static MessageResponseItem CreateDeveloperMessageItem(string inputTextContent);
public static DeveloperMessageResponseItem CreateDeveloperMessageItem(IEnumerable<ResponseContentPart> content);
public static DeveloperMessageResponseItem 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(IEnumerable<ReasoningSummaryPart> summary);
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 SystemMessageResponseItem CreateSystemMessageItem(IEnumerable<ResponseContentPart> content);
public static SystemMessageResponseItem CreateSystemMessageItem(string inputTextContent);
public static UserMessageResponseItem CreateUserMessageItem(IEnumerable<ResponseContentPart> content);
public static UserMessageResponseItem CreateUserMessageItem(string inputTextContent);
public static WebSearchCallResponseItem CreateWebSearchCallItem();
protected virtual ResponseItem JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
Expand Down Expand Up @@ -6655,6 +6671,15 @@ public class StreamingResponseWebSearchCallSearchingUpdate : StreamingResponseUp
protected override BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
}
[Experimental("OPENAI001")]
public class SystemMessageResponseItem : MessageResponseItem, IJsonModel<SystemMessageResponseItem>, IPersistableModel<SystemMessageResponseItem> {
public SystemMessageResponseItem(IEnumerable<ResponseContentPart> content);
public SystemMessageResponseItem(string inputTextContent);
protected override ResponseItem JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
protected override void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
protected override ResponseItem PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
protected override BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
}
[Experimental("OPENAI001")]
public class UriCitationMessageAnnotation : ResponseMessageAnnotation, IJsonModel<UriCitationMessageAnnotation>, IPersistableModel<UriCitationMessageAnnotation> {
public UriCitationMessageAnnotation(Uri uri, int startIndex, int endIndex, string title);
public int EndIndex { get; set; }
Expand All @@ -6667,6 +6692,15 @@ public class UriCitationMessageAnnotation : ResponseMessageAnnotation, IJsonMode
protected override BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
}
[Experimental("OPENAI001")]
public class UserMessageResponseItem : MessageResponseItem, IJsonModel<UserMessageResponseItem>, IPersistableModel<UserMessageResponseItem> {
public UserMessageResponseItem(IEnumerable<ResponseContentPart> content);
public UserMessageResponseItem(string inputTextContent);
protected override ResponseItem JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
protected override void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
protected override ResponseItem PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
protected override BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
}
[Experimental("OPENAI001")]
public class WebSearchCallResponseItem : ResponseItem, IJsonModel<WebSearchCallResponseItem>, IPersistableModel<WebSearchCallResponseItem> {
public WebSearchCallResponseItem();
public WebSearchCallStatus? Status { get; }
Expand Down
Loading
Loading