AiDocHit

public sealed class AiDocHit

A single search result from the SDK docs. Carries enough for the model to decide whether to use this symbol; the full content (with examples, pitfalls, etc.) lives in the doc body that IAiSdkDocs returns separately if asked.

Constructors

AiDocHit

public AiDocHit(string fullName, string signature, string summary, string[] topics)

Parameters:

fullName (string)
signature (string)
summary (string)
topics (string[])

Properties

FullName

public string FullName { get; }

Fully qualified symbol or topic name, e.g. "Grasshopper2.Parameters.Standard.NumberParameter".

Signature

public string Signature { get; }

One-line C# declaration, e.g. "public NumberParameter(string name, string user, string info, Access access)".

Summary

public string Summary { get; }

One-or-two-line plain-English summary of what the symbol does.

Topics

public string[] Topics { get; }

Topic tags used by the search ranker, e.g. "parameters", "data-access", "trees".