feat(api): add web_search_options and annotations to API schema

Signed-off-by: devmanishofficial <[email protected]>

Author: DEVMANISHOFFL

core/schema/message.go

@@ -11,17 +11,18 @@ import (
 type Message struct {
 	// The message role
 	Role string `json:"role,omitempty" yaml:"role"`
-
 	// The message name (used for tools calls)
 	Name string `json:"name,omitempty" yaml:"name"`
 
 	// The message content
 	Content interface{} `json:"content" yaml:"content"`
 
-	StringContent string   `json:"string_content,omitempty" yaml:"string_content,omitempty"`
-	StringImages  []string `json:"string_images,omitempty" yaml:"string_images,omitempty"`
-	StringVideos  []string `json:"string_videos,omitempty" yaml:"string_videos,omitempty"`
-	StringAudios  []string `json:"string_audios,omitempty" yaml:"string_audios,omitempty"`
+	// Annotations for citations
+	Annotations   []Annotation `json:"annotations,omitempty"`
+	StringContent string       `json:"string_content,omitempty" yaml:"string_content,omitempty"`
+	StringImages  []string     `json:"string_images,omitempty" yaml:"string_images,omitempty"`
+	StringVideos  []string     `json:"string_videos,omitempty" yaml:"string_videos,omitempty"`
+	StringAudios  []string     `json:"string_audios,omitempty" yaml:"string_audios,omitempty"`
 
 	// A result of a function call
 	FunctionCall interface{} `json:"function_call,omitempty" yaml:"function_call,omitempty"`

core/schema/openai.go

@@ -6,6 +6,33 @@ import (
 	functions "github.com/mudler/LocalAI/pkg/functions"
 )
 
+type ApproximateLocation struct {
+	Country string `json:"country,omitempty"`
+	City    string `json:"city,omitempty"`
+	Region  string `json:"region,omitempty"`
+}
+
+type UserLocation struct {
+	Type        string               `json:"type,omitempty"`
+	Approximate *ApproximateLocation `json:"approximate,omitempty"`
+}
+
+type WebSearchOptions struct {
+	UserLocation *UserLocation `json:"user_location,omitempty"`
+}
+
+type UrlCitation struct {
+	EndIndex   int    `json:"end_index,omitempty"`
+	StartIndex int    `json:"start_index,omitempty"`
+	Title      string `json:"title,omitempty"`
+	URL        string `json:"url,omitempty"`
+}
+
+type Annotation struct {
+	Type        string       `json:"type,omitempty"`
+	UrlCitation *UrlCitation `json:"url_citation,omitempty"`
+}
+
 // APIError provides error information returned by the OpenAI API.
 type APIError struct {
 	Code    any     `json:"code,omitempty"`
@@ -150,6 +177,9 @@ type OpenAIRequest struct {
 	// Messages is read only by chat/completion API calls
 	Messages []Message `json:"messages" yaml:"messages"`
 
+	// WebSearchOptions for Deep Research
+	WebSearchOptions *WebSearchOptions `json:"web_search_options,omitempty"`
+
 	// A list of available functions to call
 	Functions    functions.Functions `json:"functions" yaml:"functions"`
 	FunctionCall interface{}         `json:"function_call" yaml:"function_call"` // might be a string or an object