Definition
Assembly: CloudNimble.ClaudeEssentials.dll Namespace: CloudNimble.ClaudeEssentials.Hooks.Tools.Responses Inheritance: System.ObjectSyntax
Summary
Represents the response payload returned by the Claude Code WebSearch tool after performing a web search.Remarks
The WebSearch tool allows Claude to search the web for up-to-date information beyond its training data cutoff. This response is received in the WebSearchPostToolUsePayload when thetool_name is “WebSearch”.
Note: Web search is currently only available in the US region.
Example JSON payload:
Constructors
.ctor
Syntax
.ctor Inherited
Inherited from
objectSyntax
Properties
DurationSeconds
Gets or sets the total duration of the search operation in seconds.Syntax
Property Value
Type:double
Remarks
This includes the time taken to perform the web search and process the results. Web searches typically complete within a few seconds, but may take longer depending on network conditions and search complexity.Query
Gets or sets the search query that was executed.Syntax
Property Value
Type:string
Remarks
This is the exact query string that was sent to the search engine. It matches the WebSearchToolInput.Query from the input.Results
Gets or sets the search results returned from the web search.Syntax
Property Value
Type:System.Collections.Generic.List<CloudNimble.ClaudeEssentials.Hooks.Tools.Responses.WebSearchResultContainer>
Remarks
Results are grouped into containers, each containing multiple search result items. The structure allows for multiple result sets from a single search operation. Use these results to inform responses about current events, recent documentation, or other information that may have changed since Claude’s training data cutoff.Methods
Equals Inherited Virtual
Inherited from
objectSyntax
Parameters
| Name | Type | Description |
|---|---|---|
obj | object? | - |
Returns
Type:bool
Equals Inherited
Inherited from
objectSyntax
Parameters
| Name | Type | Description |
|---|---|---|
objA | object? | - |
objB | object? | - |
Returns
Type:bool
GetHashCode Inherited Virtual
Inherited from
objectSyntax
Returns
Type:int
GetType Inherited
Inherited from
objectSyntax
Returns
Type:System.Type
MemberwiseClone Inherited
Inherited from
objectSyntax
Returns
Type:object
ReferenceEquals Inherited
Inherited from
objectSyntax
Parameters
| Name | Type | Description |
|---|---|---|
objA | object? | - |
objB | object? | - |
Returns
Type:bool
ToString Inherited Virtual
Inherited from
objectSyntax
Returns
Type:string?