Files

8.2 KiB

CodeSpan

Properties

Name Type Description Notes
EndLine Pointer to int64 EndLine is the last line of the span, inclusive. It equals Line for a one-line span rather than being zero or absent. [optional]
File Pointer to string File is the path inside the repo, relative to its root and never absolute. [optional]
Kind Pointer to string Kind is what the indexer decided this chunk IS — "func", "method", "type", "struct", "interface", "var", "const", or "block" for a run of code that declares nothing. Absent when the chunker could not classify it. [optional]
Line Pointer to int64 Line is where the span starts, 1-based, as an editor counts. [optional]
Repo Pointer to string Repo is the indexed repository the span was found in, as it was indexed ("owner/name"). A search may be scoped to one repo or run across all of them, so this is how a caller tells the results apart. [optional]
Role Pointer to string context: match definition
Score Pointer to float64 Score ranks this span against the OTHERS IN THE SAME RESPONSE and means nothing across responses or between tiers: the hybrid tier's number is a reciprocal-rank fusion sum (Σ 1/(60+rank), so tenths at best), the symbol tier's is a descending position count, and the text and semantic tiers pass through bm25 and cosine. Compare within a list; never threshold on it. [optional]
Snippet Pointer to string Snippet is the code itself: a bounded excerpt on /search, the whole chunk on /context — which is why the same type serves both and why a /context span is the one an agent pastes into its window. [optional]
Symbol Pointer to string Symbol is the declared name, when the span declares one. Absent on a block. [optional]
Tier Pointer to string Tier is which retrieval produced the span: "hybrid" (the default — all three fused), "text" (trigram/FTS), "regex", "semantic" (vector), or "symbol". It is what explains a Score, so the two travel together. [optional]

Methods

NewCodeSpan

func NewCodeSpan() *CodeSpan

NewCodeSpan instantiates a new CodeSpan object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

NewCodeSpanWithDefaults

func NewCodeSpanWithDefaults() *CodeSpan

NewCodeSpanWithDefaults instantiates a new CodeSpan object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set

GetEndLine

func (o *CodeSpan) GetEndLine() int64

GetEndLine returns the EndLine field if non-nil, zero value otherwise.

GetEndLineOk

func (o *CodeSpan) GetEndLineOk() (*int64, bool)

GetEndLineOk returns a tuple with the EndLine field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetEndLine

func (o *CodeSpan) SetEndLine(v int64)

SetEndLine sets EndLine field to given value.

HasEndLine

func (o *CodeSpan) HasEndLine() bool

HasEndLine returns a boolean if a field has been set.

GetFile

func (o *CodeSpan) GetFile() string

GetFile returns the File field if non-nil, zero value otherwise.

GetFileOk

func (o *CodeSpan) GetFileOk() (*string, bool)

GetFileOk returns a tuple with the File field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetFile

func (o *CodeSpan) SetFile(v string)

SetFile sets File field to given value.

HasFile

func (o *CodeSpan) HasFile() bool

HasFile returns a boolean if a field has been set.

GetKind

func (o *CodeSpan) GetKind() string

GetKind returns the Kind field if non-nil, zero value otherwise.

GetKindOk

func (o *CodeSpan) GetKindOk() (*string, bool)

GetKindOk returns a tuple with the Kind field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetKind

func (o *CodeSpan) SetKind(v string)

SetKind sets Kind field to given value.

HasKind

func (o *CodeSpan) HasKind() bool

HasKind returns a boolean if a field has been set.

GetLine

func (o *CodeSpan) GetLine() int64

GetLine returns the Line field if non-nil, zero value otherwise.

GetLineOk

func (o *CodeSpan) GetLineOk() (*int64, bool)

GetLineOk returns a tuple with the Line field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetLine

func (o *CodeSpan) SetLine(v int64)

SetLine sets Line field to given value.

HasLine

func (o *CodeSpan) HasLine() bool

HasLine returns a boolean if a field has been set.

GetRepo

func (o *CodeSpan) GetRepo() string

GetRepo returns the Repo field if non-nil, zero value otherwise.

GetRepoOk

func (o *CodeSpan) GetRepoOk() (*string, bool)

GetRepoOk returns a tuple with the Repo field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetRepo

func (o *CodeSpan) SetRepo(v string)

SetRepo sets Repo field to given value.

HasRepo

func (o *CodeSpan) HasRepo() bool

HasRepo returns a boolean if a field has been set.

GetRole

func (o *CodeSpan) GetRole() string

GetRole returns the Role field if non-nil, zero value otherwise.

GetRoleOk

func (o *CodeSpan) GetRoleOk() (*string, bool)

GetRoleOk returns a tuple with the Role field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetRole

func (o *CodeSpan) SetRole(v string)

SetRole sets Role field to given value.

HasRole

func (o *CodeSpan) HasRole() bool

HasRole returns a boolean if a field has been set.

GetScore

func (o *CodeSpan) GetScore() float64

GetScore returns the Score field if non-nil, zero value otherwise.

GetScoreOk

func (o *CodeSpan) GetScoreOk() (*float64, bool)

GetScoreOk returns a tuple with the Score field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetScore

func (o *CodeSpan) SetScore(v float64)

SetScore sets Score field to given value.

HasScore

func (o *CodeSpan) HasScore() bool

HasScore returns a boolean if a field has been set.

GetSnippet

func (o *CodeSpan) GetSnippet() string

GetSnippet returns the Snippet field if non-nil, zero value otherwise.

GetSnippetOk

func (o *CodeSpan) GetSnippetOk() (*string, bool)

GetSnippetOk returns a tuple with the Snippet field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetSnippet

func (o *CodeSpan) SetSnippet(v string)

SetSnippet sets Snippet field to given value.

HasSnippet

func (o *CodeSpan) HasSnippet() bool

HasSnippet returns a boolean if a field has been set.

GetSymbol

func (o *CodeSpan) GetSymbol() string

GetSymbol returns the Symbol field if non-nil, zero value otherwise.

GetSymbolOk

func (o *CodeSpan) GetSymbolOk() (*string, bool)

GetSymbolOk returns a tuple with the Symbol field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetSymbol

func (o *CodeSpan) SetSymbol(v string)

SetSymbol sets Symbol field to given value.

HasSymbol

func (o *CodeSpan) HasSymbol() bool

HasSymbol returns a boolean if a field has been set.

GetTier

func (o *CodeSpan) GetTier() string

GetTier returns the Tier field if non-nil, zero value otherwise.

GetTierOk

func (o *CodeSpan) GetTierOk() (*string, bool)

GetTierOk returns a tuple with the Tier field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetTier

func (o *CodeSpan) SetTier(v string)

SetTier sets Tier field to given value.

HasTier

func (o *CodeSpan) HasTier() bool

HasTier returns a boolean if a field has been set.

[Back to Model list] [Back to API list] [Back to README]