struct AI::OpenAI::Tools::WebSearch

• AI::OpenAI::Tools::WebSearch
• Struct
• Value
• Object

Overview

Web Search tool.

Allows models to access up-to-date information from the internet and provide answers with sourced citations.

Defined in:

ai/openai/tool/openai_tools.cr

Constant Summary

ID = "openai.web_search"

NAME = "web_search"

Constructors

• .new(external_web_access : Bool | Nil = nil, filters : WebSearchFilters | Nil = nil, search_context_size : String | Nil = nil, user_location : UserLocation | Nil = nil)

Instance Method Summary

• #args : Hash(String, JSON::Any)
• #external_web_access : Bool | Nil

  Whether to use external web access for fetching live content.

• #filters : WebSearchFilters | Nil

  Filters for the search.

• #id : String
• #name : String
• #search_context_size : String | Nil

  Search context size: low, medium, high.

• #type : String
• #user_location : UserLocation | Nil

  User location information for geographically relevant results.

Constructor Detail

Instance Method Detail