dashboard

Documentation

Index

• Constants
• func DeleteAndDecode[T any](path string) (*T, error)
• func GetAndDecode[T any](path string) (*T, error)
• func PostAndDecode[B any, R any](path string, body B) (*R, error)
• func RequestWithBodyAndDecode[B any, R any](path string, method string, body B) (*R, error)
• func RequestWithoutBodyAndDecode[T any](path string, method string) (*T, error)
• type CreateApiKeyRequest
• type CreateApiKeyResponse
  • func CreateApiKey(projId string, keyName string) (*CreateApiKeyResponse, error)
• type CreateProjectRequest
• type CreateProjectResponse
  • func CreateProject(orgId string, projName string, podQuota int32) (*CreateProjectResponse, error)
• type DeleteApiKeyRequest
• type DeleteApiKeyResponse
  • func DeleteApiKey(projId string, key Key) (*DeleteApiKeyResponse, error)
• type DeletePostResponse
  • func DeleteProject(orgId string, projId string) (*DeletePostResponse, error)
• type DescribeOrganizationResponse
  • func DescribeOrganization(orgId string) (*DescribeOrganizationResponse, error)
• type GlobalProject
  • func GetProjectById(orgId string, projId string) (*GlobalProject, error)
  • func GetProjectByName(orgName string, projName string) (*GlobalProject, error)
• type Key
• type KeyResponse
  • func GetApiKeys(project GlobalProject) (*KeyResponse, error)
  • func GetApiKeysById(projectId string) (*KeyResponse, error)
• type Organization
• type OrganizationsResponse
  • func ListOrganizations() (*OrganizationsResponse, error)
• type Project
• type UserRole

Constants

const DashboardBaseURL = "https://console-api.pinecone.io"

const (
	URL_DELETE_API_KEYS = "/v2/dashboard/projects/%s/api-key"
)

const (
	URL_DELETE_PROJECT = "/v2/dashboard/projects/%s"
)

const (
	URL_GET_API_KEYS = "/v2/dashboard/projects/%s/api-keys"
)

const (
	URL_GET_ORGANIZATION = "/v2/dashboard/organizations/%s"
)

const (
	URL_LIST_ORGANIZATIONS = "/v2/dashboard/organizations"
)

const (
	URL_POST_API_KEYS = "/v2/dashboard/projects/%s/api-key"
)

const (
	URL_POST_PROJECTS = "/v2/dashboard/organizations/%s/projects"
)

Functions

func DeleteAndDecode

func DeleteAndDecode[T any](path string) (*T, error)

func GetAndDecode

func GetAndDecode[T any](path string) (*T, error)

func PostAndDecode

func PostAndDecode[B any, R any](path string, body B) (*R, error)

func RequestWithBodyAndDecode

func RequestWithBodyAndDecode[B any, R any](path string, method string, body B) (*R, error)

func RequestWithoutBodyAndDecode

func RequestWithoutBodyAndDecode[T any](path string, method string) (*T, error)

Types

type CreateApiKeyRequest

type CreateApiKeyRequest struct {
	Label string `json:"label"`
}

type CreateApiKeyResponse

type CreateApiKeyResponse struct {
	Success bool `json:"success"`
	Key     Key  `json:"key"`
}

func CreateApiKey

func CreateApiKey(projId string, keyName string) (*CreateApiKeyResponse, error)

type CreateProjectRequest

type CreateProjectRequest struct {
	Name        string `json:"name"`
	PodQuota    int32  `json:"quota"`
	Environment string `json:"environment"`
}

type CreateProjectResponse

type CreateProjectResponse struct {
	Success       bool          `json:"success"`
	GlobalProject GlobalProject `json:"globalProject"`
}

func CreateProject

func CreateProject(orgId string, projName string, podQuota int32) (*CreateProjectResponse, error)

type DeleteApiKeyRequest

type DeleteApiKeyRequest struct {
	Label    string `json:"label"`
	UserName string `json:"userName"`
}

type DeleteApiKeyResponse

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

func DeleteApiKey

func DeleteApiKey(projId string, key Key) (*DeleteApiKeyResponse, error)

type DeletePostResponse

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

func DeleteProject

func DeleteProject(orgId string, projId string) (*DeletePostResponse, error)

type DescribeOrganizationResponse

type DescribeOrganizationResponse struct {
	Success   bool       `json:"success"`
	UserRoles []UserRole `json:"userRoles"`
}

func DescribeOrganization

func DescribeOrganization(orgId string) (*DescribeOrganizationResponse, error)

type GlobalProject

type GlobalProject struct {
	Id         string `json:"id"`
	Name       string `json:"name"`
	Quota      string `json:"quota"`
	IndexQuota string `json:"indexQuota"`
}

func GetProjectById

func GetProjectById(orgId string, projId string) (*GlobalProject, error)

func GetProjectByName

func GetProjectByName(orgName string, projName string) (*GlobalProject, error)

type Key

type Key struct {
	Id        string `json:"id"`
	UserLabel string `json:"user_label"`
	Value     string `json:"value"`
	UserName  string `json:"user_name"`
}

type KeyResponse

type KeyResponse struct {
	Keys []Key `json:"keys"`
}

func GetApiKeys

func GetApiKeys(project GlobalProject) (*KeyResponse, error)

func GetApiKeysById

func GetApiKeysById(projectId string) (*KeyResponse, error)

type Organization

type Organization struct {
	Id       string    `json:"id"`
	Name     string    `json:"name"`
	Projects []Project `json:"projects"`
}

type OrganizationsResponse

type OrganizationsResponse struct {
	Organizations []Organization `json:"organizations"`
}

func ListOrganizations

func ListOrganizations() (*OrganizationsResponse, error)

type Project

type Project struct {
	Id            string        `json:"id"`
	Name          string        `json:"name"`
	GlobalProject GlobalProject `json:"globalProject"`
}

type UserRole

type UserRole struct {
	Id    string `json:"id"`
	Name  string `json:"name"`
	Email string `json:"email"`
	Role  string `json:"role"`
}