Yi Ding
7699f5432d
In theory this will stop the API docs thrashing on every build. Of course, there is a drawback in that if main changes but we haven't released a new version of the docs yet the links will go out of date. So longer term we might want to investigate some kind of variable where we can continue to have up to date revs but keep the rev in a single variable somewhere: https://github.com/facebook/docusaurus/issues/395 In the meantime much smaller commits will be a relief
5.3 KiB
id, title, sidebar_label, sidebar_position, custom_edit_url
| id | title | sidebar_label | sidebar_position | custom_edit_url |
|---|---|---|---|---|
| BaseNode | Class: BaseNode | BaseNode | 0 | null |
Generic abstract class for retrievable nodes
Hierarchy
-
BaseNode↳
TextNode
Constructors
constructor
• new BaseNode(init?)
Parameters
| Name | Type |
|---|---|
init? |
Partial<BaseNode> |
Defined in
Properties
embedding
• Optional embedding: number[]
Defined in
excludedEmbedMetadataKeys
• excludedEmbedMetadataKeys: string[] = []
Defined in
excludedLlmMetadataKeys
• excludedLlmMetadataKeys: string[] = []
Defined in
hash
• hash: string = ""
Defined in
id_
• id_: string
Defined in
metadata
• metadata: Record<string, any> = {}
Defined in
relationships
• relationships: Partial<Record<NodeRelationship, RelatedNodeType>> = {}
Defined in
Accessors
childNodes
• get childNodes(): undefined | RelatedNodeInfo[]
Returns
undefined | RelatedNodeInfo[]
Defined in
nextNode
• get nextNode(): undefined | RelatedNodeInfo
Returns
undefined | RelatedNodeInfo
Defined in
nodeId
• get nodeId(): string
Returns
string
Defined in
parentNode
• get parentNode(): undefined | RelatedNodeInfo
Returns
undefined | RelatedNodeInfo
Defined in
prevNode
• get prevNode(): undefined | RelatedNodeInfo
Returns
undefined | RelatedNodeInfo
Defined in
sourceNode
• get sourceNode(): undefined | RelatedNodeInfo
Returns
undefined | RelatedNodeInfo
Defined in
Methods
asRelatedNodeInfo
▸ asRelatedNodeInfo(): RelatedNodeInfo
Returns
Defined in
getContent
▸ Abstract getContent(metadataMode): string
Parameters
| Name | Type |
|---|---|
metadataMode |
MetadataMode |
Returns
string
Defined in
getEmbedding
▸ getEmbedding(): number[]
Returns
number[]
Defined in
getMetadataStr
▸ Abstract getMetadataStr(metadataMode): string
Parameters
| Name | Type |
|---|---|
metadataMode |
MetadataMode |
Returns
string
Defined in
getType
▸ Abstract getType(): ObjectType
Returns
Defined in
setContent
▸ Abstract setContent(value): void
Parameters
| Name | Type |
|---|---|
value |
any |
Returns
void