knowledge

Documentation

Index

• Constants
• func GetKnowledgeControlBaseUrl() string
• func GetKnowledgeDataBaseUrl() string
• func GetKnowledgeModelSearchCompletions(kmName string, content string) (*models.ChatCompletionModel, error)
• func IsSupportedFile(filePath string) bool
• type CreateKnowledgeModelRequest
• type DeleteKnowledgeFileResponse
  • func DeleteKnowledgeFile(kmName string, fileId string) (*DeleteKnowledgeFileResponse, error)
• type DeleteKnowledgeModelResponse
  • func DeleteKnowledgeModel(kmName string) (*DeleteKnowledgeModelResponse, error)
• type KnowledgeFileModel
  • func DescribeKnowledgeModelFile(kmName string, fileId string) (*KnowledgeFileModel, error)
  • func UploadKnowledgeFile(kmName string, filePath string) (*KnowledgeFileModel, error)
• type KnowledgeFileStatusState
• type KnowledgeMetadata
  • func (kmm *KnowledgeMetadata) ToString() string
• type KnowledgeModel
  • func CreateKnowledgeModel(name string) (*KnowledgeModel, error)
  • func DescribeKnowledgeModel(kmName string) (*KnowledgeModel, error)
• type KnowledgeModelStatusState
• type ListKnowledgeModelFilesResponse
  • func ListKnowledgeModelFiles(kmName string) (*ListKnowledgeModelFilesResponse, error)
• type ListKnowledgeModelsResponse
  • func ListKnowledgeModels() (*ListKnowledgeModelsResponse, error)

Constants

const KnowledgeControlPlaneBaseStagingUrl = "https://api-staging.pinecone.io"

const KnowledgeControlPlaneBaseUrl = "https://api.pinecone.io"

const KnowledgeDataPlaneBaseStagingUrl = "https://staging-data.ke.pinecone.io"

const KnowledgeDataPlaneBaseUrl = "https://prod-1-data.ke.pinecone.io"

const (
	URL_DELETE_KNOWLEDGE_FILE = "/knowledge/files/%s/%s"
)

const (
	URL_DELETE_KNOWLEDGE_MODEL = "/knowledge/models/%s"
)

const (
	URL_DESCRIBE_KNOWLEDGE_MODEL = "/knowledge/models/%s"
)

const (
	URL_GET_KNOWLEDGE_MODEL_FILE = "/knowledge/files/%s/%s"
)

const (
	URL_KNOWLEDGE_FILE_UPLOAD = "/knowledge/files/%s"
)

const (
	URL_KNOWLEDGE_MODEL_CHAT_COMPLETIONS = "/knowledge/chat/%s/chat/completions"
)

const (
	URL_LIST_KNOWLEDGE_MODELS = "/knowledge/models"
)

const (
	URL_LIST_KNOWLEDGE_MODEL_FILES = "/knowledge/files/%s"
)

const (
	URL_POST_KNOWLEDGE_MODEL = "/knowledge/models"
)

Functions

func GetKnowledgeControlBaseUrl

func GetKnowledgeControlBaseUrl() string

func GetKnowledgeDataBaseUrl

func GetKnowledgeDataBaseUrl() string

func GetKnowledgeModelSearchCompletions

func GetKnowledgeModelSearchCompletions(kmName string, content string) (*models.ChatCompletionModel, error)

func IsSupportedFile

func IsSupportedFile(filePath string) bool

Types

type CreateKnowledgeModelRequest

type CreateKnowledgeModelRequest struct {
	Name     string                 `json:"name"`
	Metadata map[string]interface{} `json:"metadata"`
}

type DeleteKnowledgeFileResponse

type DeleteKnowledgeFileResponse string

func DeleteKnowledgeFile

func DeleteKnowledgeFile(kmName string, fileId string) (*DeleteKnowledgeFileResponse, error)

type DeleteKnowledgeModelResponse

type DeleteKnowledgeModelResponse struct {
	Success bool `json:"success"`
}

func DeleteKnowledgeModel

func DeleteKnowledgeModel(kmName string) (*DeleteKnowledgeModelResponse, error)

type KnowledgeFileModel

type KnowledgeFileModel struct {
	Name      string                   `json:"name"`
	Id        string                   `json:"id"`
	Metadata  KnowledgeMetadata        `json:"metadata"`
	CreatedOn string                   `json:"created_on"`
	UpdatedOn string                   `json:"updated_on"`
	Status    KnowledgeFileStatusState `json:"status"`
}

func DescribeKnowledgeModelFile

func DescribeKnowledgeModelFile(kmName string, fileId string) (*KnowledgeFileModel, error)

func UploadKnowledgeFile

func UploadKnowledgeFile(kmName string, filePath string) (*KnowledgeFileModel, error)

type KnowledgeFileStatusState

type KnowledgeFileStatusState string

const (
	Processing KnowledgeFileStatusState = "Processing"
	Available  KnowledgeFileStatusState = "Available"
	Deleting   KnowledgeFileStatusState = "Deleting"
)

type KnowledgeMetadata

type KnowledgeMetadata map[string]interface{}

func (*KnowledgeMetadata) ToString

func (kmm *KnowledgeMetadata) ToString() string

type KnowledgeModel

type KnowledgeModel struct {
	Name      string                    `json:"name"`
	Metadata  KnowledgeMetadata         `json:"metadata"`
	Status    KnowledgeModelStatusState `json:"status"`
	CreatedAt string                    `json:"created_at"`
	UpdatedAt string                    `json:"updated_at"`
}

func CreateKnowledgeModel

func CreateKnowledgeModel(name string) (*KnowledgeModel, error)

func DescribeKnowledgeModel

func DescribeKnowledgeModel(kmName string) (*KnowledgeModel, error)

type KnowledgeModelStatusState

type KnowledgeModelStatusState string

const (
	Initializing         KnowledgeModelStatusState = "Initializing"
	InitializationFailed KnowledgeModelStatusState = "Failed"
	Ready                KnowledgeModelStatusState = "Ready"
	ScalingDown          KnowledgeModelStatusState = "Terminating"
)

type ListKnowledgeModelFilesResponse

type ListKnowledgeModelFilesResponse struct {
	Files []KnowledgeFileModel `json:"files"`
}

func ListKnowledgeModelFiles

func ListKnowledgeModelFiles(kmName string) (*ListKnowledgeModelFilesResponse, error)

type ListKnowledgeModelsResponse

type ListKnowledgeModelsResponse struct {
	KnowledgeModels []KnowledgeModel `json:"knowledge_models"`
}

func ListKnowledgeModels

func ListKnowledgeModels() (*ListKnowledgeModelsResponse, error)