feat: OpenAI Web Search Annotations #2460
Open
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR adds support for retrieving web search annotations from the OpenAI API, as described in their web search documentation. This allows us to access citation URLs and their context within generated responses when using models like
gpt-4o-search-preview
.Changes:
annotations
(withAnnotation
andUrlCitation
records) toChatCompletionMessage
inOpenAiApi.java
.OpenAiChatModel
to populate theannotations
field (via metadata) for both regular and streaming responses.webSearchAnnotationsTest
,streamWebSearchAnnotationsTest
) toOpenAiChatModelIT.java
.GPT_4_O_SEARCH_PREVIEW
andGPT_4_O_MINI_SEARCH_PREVIEW
toOpenAiApi.ChatModel
.WebSearchOptions
and related records toOpenAiApi
.ChatCompletionRequest
and itsBuilder
.Resolves #2449