Documentation ¶
Overview ¶
Package v1alpha1 contains API Schema definitions for the arcadia v1alpha1 API group +kubebuilder:object:generate=true +groupName=retriever.arcadia.kubeagi.k8s.com.cn
Index ¶
- Constants
- Variables
- type CommonRetrieverConfig
- type KnowledgeBaseRetriever
- type KnowledgeBaseRetrieverList
- type KnowledgeBaseRetrieverSpec
- type KnowledgeBaseRetrieverStatus
- type MultiQueryRetriever
- type MultiQueryRetrieverList
- type MultiQueryRetrieverSpec
- type MultiQueryRetrieverStatus
- type RerankRetriever
- type RerankRetrieverList
- type RerankRetrieverSpec
- type RerankRetrieverStatus
Constants ¶
const ( Group = "retriever.arcadia.kubeagi.k8s.com.cn" Version = "v1alpha1" )
const ( DefaultScoreThreshold = 0.3 DefaultNumDocuments = 5 MaxNumDocuments = 50 MinNumDocuments = 1 )
Variables ¶
var ( // GroupVersion is group version used to register these objects GroupVersion = schema.GroupVersion{Group: Group, Version: Version} // SchemeBuilder is used to add go types to the GroupVersionKind scheme SchemeBuilder = &scheme.Builder{GroupVersion: GroupVersion} // AddToScheme adds the types in this group-version to the given scheme. AddToScheme = SchemeBuilder.AddToScheme )
Functions ¶
This section is empty.
Types ¶
type CommonRetrieverConfig ¶
type CommonRetrieverConfig struct { // ScoreThreshold is the cosine distance float score threshold. Lower score represents more similarity. // +kubebuilder:validation:Minimum=0 // +kubebuilder:validation:Maximum=1 // +kubebuilder:default=0.3 ScoreThreshold *float32 `json:"scoreThreshold,omitempty"` // NumDocuments is the max number of documents to return. // +kubebuilder:default=5 // +kubebuilder:validation:Minimum=1 // +kubebuilder:validation:Maximum=50 NumDocuments int `json:"numDocuments,omitempty"` }
func (*CommonRetrieverConfig) DeepCopy ¶
func (in *CommonRetrieverConfig) DeepCopy() *CommonRetrieverConfig
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new CommonRetrieverConfig.
func (*CommonRetrieverConfig) DeepCopyInto ¶
func (in *CommonRetrieverConfig) DeepCopyInto(out *CommonRetrieverConfig)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type KnowledgeBaseRetriever ¶
type KnowledgeBaseRetriever struct { metav1.TypeMeta `json:",inline"` metav1.ObjectMeta `json:"metadata,omitempty"` Spec KnowledgeBaseRetrieverSpec `json:"spec,omitempty"` Status KnowledgeBaseRetrieverStatus `json:"status,omitempty"` }
KnowledgeBaseRetriever is the Schema for the KnowledgeBaseRetriever API
func (*KnowledgeBaseRetriever) DeepCopy ¶
func (in *KnowledgeBaseRetriever) DeepCopy() *KnowledgeBaseRetriever
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new KnowledgeBaseRetriever.
func (*KnowledgeBaseRetriever) DeepCopyInto ¶
func (in *KnowledgeBaseRetriever) DeepCopyInto(out *KnowledgeBaseRetriever)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*KnowledgeBaseRetriever) DeepCopyObject ¶
func (in *KnowledgeBaseRetriever) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
func (*KnowledgeBaseRetriever) SetRef ¶
func (c *KnowledgeBaseRetriever) SetRef()
type KnowledgeBaseRetrieverList ¶
type KnowledgeBaseRetrieverList struct { metav1.TypeMeta `json:",inline"` metav1.ListMeta `json:"metadata,omitempty"` Items []KnowledgeBaseRetriever `json:"items"` }
KnowledgeBaseRetrieverList contains a list of KnowledgeBaseRetriever
func (*KnowledgeBaseRetrieverList) DeepCopy ¶
func (in *KnowledgeBaseRetrieverList) DeepCopy() *KnowledgeBaseRetrieverList
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new KnowledgeBaseRetrieverList.
func (*KnowledgeBaseRetrieverList) DeepCopyInto ¶
func (in *KnowledgeBaseRetrieverList) DeepCopyInto(out *KnowledgeBaseRetrieverList)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*KnowledgeBaseRetrieverList) DeepCopyObject ¶
func (in *KnowledgeBaseRetrieverList) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type KnowledgeBaseRetrieverSpec ¶
type KnowledgeBaseRetrieverSpec struct { v1alpha1.CommonSpec `json:",inline"` CommonRetrieverConfig `json:",inline"` }
KnowledgeBaseRetrieverSpec defines the desired state of KnowledgeBaseRetriever
func (*KnowledgeBaseRetrieverSpec) DeepCopy ¶
func (in *KnowledgeBaseRetrieverSpec) DeepCopy() *KnowledgeBaseRetrieverSpec
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new KnowledgeBaseRetrieverSpec.
func (*KnowledgeBaseRetrieverSpec) DeepCopyInto ¶
func (in *KnowledgeBaseRetrieverSpec) DeepCopyInto(out *KnowledgeBaseRetrieverSpec)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type KnowledgeBaseRetrieverStatus ¶
type KnowledgeBaseRetrieverStatus struct { // ObservedGeneration is the last observed generation. // +optional ObservedGeneration int64 `json:"observedGeneration,omitempty"` // ConditionedStatus is the current status v1alpha1.ConditionedStatus `json:",inline"` }
KnowledgeBaseRetrieverStatus defines the observed state of KnowledgeBaseRetriever
func (*KnowledgeBaseRetrieverStatus) DeepCopy ¶
func (in *KnowledgeBaseRetrieverStatus) DeepCopy() *KnowledgeBaseRetrieverStatus
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new KnowledgeBaseRetrieverStatus.
func (*KnowledgeBaseRetrieverStatus) DeepCopyInto ¶
func (in *KnowledgeBaseRetrieverStatus) DeepCopyInto(out *KnowledgeBaseRetrieverStatus)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type MultiQueryRetriever ¶ added in v0.2.1
type MultiQueryRetriever struct { metav1.TypeMeta `json:",inline"` metav1.ObjectMeta `json:"metadata,omitempty"` Spec MultiQueryRetrieverSpec `json:"spec,omitempty"` Status MultiQueryRetrieverStatus `json:"status,omitempty"` }
MultiQueryRetriever is the Schema for the MultiQueryRetriever API
func (*MultiQueryRetriever) DeepCopy ¶ added in v0.2.1
func (in *MultiQueryRetriever) DeepCopy() *MultiQueryRetriever
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new MultiQueryRetriever.
func (*MultiQueryRetriever) DeepCopyInto ¶ added in v0.2.1
func (in *MultiQueryRetriever) DeepCopyInto(out *MultiQueryRetriever)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*MultiQueryRetriever) DeepCopyObject ¶ added in v0.2.1
func (in *MultiQueryRetriever) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
func (*MultiQueryRetriever) SetRef ¶ added in v0.2.1
func (c *MultiQueryRetriever) SetRef()
type MultiQueryRetrieverList ¶ added in v0.2.1
type MultiQueryRetrieverList struct { metav1.TypeMeta `json:",inline"` metav1.ListMeta `json:"metadata,omitempty"` Items []MultiQueryRetriever `json:"items"` }
MultiQueryRetrieverList contains a list of MultiQueryRetriever
func (*MultiQueryRetrieverList) DeepCopy ¶ added in v0.2.1
func (in *MultiQueryRetrieverList) DeepCopy() *MultiQueryRetrieverList
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new MultiQueryRetrieverList.
func (*MultiQueryRetrieverList) DeepCopyInto ¶ added in v0.2.1
func (in *MultiQueryRetrieverList) DeepCopyInto(out *MultiQueryRetrieverList)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*MultiQueryRetrieverList) DeepCopyObject ¶ added in v0.2.1
func (in *MultiQueryRetrieverList) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type MultiQueryRetrieverSpec ¶ added in v0.2.1
type MultiQueryRetrieverSpec struct { v1alpha1.CommonSpec `json:",inline"` CommonRetrieverConfig `json:",inline"` }
MultiQueryRetrieverSpec defines the desired state of MultiQueryRetriever
func (*MultiQueryRetrieverSpec) DeepCopy ¶ added in v0.2.1
func (in *MultiQueryRetrieverSpec) DeepCopy() *MultiQueryRetrieverSpec
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new MultiQueryRetrieverSpec.
func (*MultiQueryRetrieverSpec) DeepCopyInto ¶ added in v0.2.1
func (in *MultiQueryRetrieverSpec) DeepCopyInto(out *MultiQueryRetrieverSpec)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type MultiQueryRetrieverStatus ¶ added in v0.2.1
type MultiQueryRetrieverStatus struct { // ObservedGeneration is the last observed generation. // +optional ObservedGeneration int64 `json:"observedGeneration,omitempty"` // ConditionedStatus is the current status v1alpha1.ConditionedStatus `json:",inline"` }
MultiQueryRetrieverStatus defines the observed state of MultiQueryRetriever
func (*MultiQueryRetrieverStatus) DeepCopy ¶ added in v0.2.1
func (in *MultiQueryRetrieverStatus) DeepCopy() *MultiQueryRetrieverStatus
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new MultiQueryRetrieverStatus.
func (*MultiQueryRetrieverStatus) DeepCopyInto ¶ added in v0.2.1
func (in *MultiQueryRetrieverStatus) DeepCopyInto(out *MultiQueryRetrieverStatus)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type RerankRetriever ¶ added in v0.2.1
type RerankRetriever struct { metav1.TypeMeta `json:",inline"` metav1.ObjectMeta `json:"metadata,omitempty"` Spec RerankRetrieverSpec `json:"spec,omitempty"` Status RerankRetrieverStatus `json:"status,omitempty"` }
RerankRetriever is the Schema for the RerankRetriever API
func (*RerankRetriever) DeepCopy ¶ added in v0.2.1
func (in *RerankRetriever) DeepCopy() *RerankRetriever
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new RerankRetriever.
func (*RerankRetriever) DeepCopyInto ¶ added in v0.2.1
func (in *RerankRetriever) DeepCopyInto(out *RerankRetriever)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*RerankRetriever) DeepCopyObject ¶ added in v0.2.1
func (in *RerankRetriever) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
func (*RerankRetriever) SetRef ¶ added in v0.2.1
func (c *RerankRetriever) SetRef()
type RerankRetrieverList ¶ added in v0.2.1
type RerankRetrieverList struct { metav1.TypeMeta `json:",inline"` metav1.ListMeta `json:"metadata,omitempty"` Items []RerankRetriever `json:"items"` }
RerankRetrieverList contains a list of RerankRetriever
func (*RerankRetrieverList) DeepCopy ¶ added in v0.2.1
func (in *RerankRetrieverList) DeepCopy() *RerankRetrieverList
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new RerankRetrieverList.
func (*RerankRetrieverList) DeepCopyInto ¶ added in v0.2.1
func (in *RerankRetrieverList) DeepCopyInto(out *RerankRetrieverList)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*RerankRetrieverList) DeepCopyObject ¶ added in v0.2.1
func (in *RerankRetrieverList) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type RerankRetrieverSpec ¶ added in v0.2.1
type RerankRetrieverSpec struct { v1alpha1.CommonSpec `json:",inline"` CommonRetrieverConfig `json:",inline"` // the model of the rerank Model *v1alpha1.TypedObjectReference `json:"model,omitempty"` }
RerankRetrieverSpec defines the desired state of RerankRetriever
func (*RerankRetrieverSpec) DeepCopy ¶ added in v0.2.1
func (in *RerankRetrieverSpec) DeepCopy() *RerankRetrieverSpec
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new RerankRetrieverSpec.
func (*RerankRetrieverSpec) DeepCopyInto ¶ added in v0.2.1
func (in *RerankRetrieverSpec) DeepCopyInto(out *RerankRetrieverSpec)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type RerankRetrieverStatus ¶ added in v0.2.1
type RerankRetrieverStatus struct { // ObservedGeneration is the last observed generation. // +optional ObservedGeneration int64 `json:"observedGeneration,omitempty"` // ConditionedStatus is the current status v1alpha1.ConditionedStatus `json:",inline"` }
RerankRetrieverStatus defines the observed state of RerankRetriever
func (*RerankRetrieverStatus) DeepCopy ¶ added in v0.2.1
func (in *RerankRetrieverStatus) DeepCopy() *RerankRetrieverStatus
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new RerankRetrieverStatus.
func (*RerankRetrieverStatus) DeepCopyInto ¶ added in v0.2.1
func (in *RerankRetrieverStatus) DeepCopyInto(out *RerankRetrieverStatus)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.