pinecone.core.api_action 

 1from typing import NamedTuple
 2from pinecone.core.api_base import BaseAPI
 3
 4__all__ = ["ActionAPI", "VersionResponse", "WhoAmIResponse"]
 5
 6from pinecone.core.utils import get_version
 7
 8
 9class WhoAmIResponse(NamedTuple):
10    username: str = "UNKNOWN"
11    user_label: str = "UNKNOWN"
12    projectname: str = "UNKNOWN"
13
14
15class VersionResponse(NamedTuple):
16    server: str
17    client: str
18
19
20class ActionAPI(BaseAPI):
21    """User related API calls."""
22
23    client_version = get_version()
24
25    def whoami(self) -> WhoAmIResponse:
26        """Returns user information."""
27        response = self.get("/actions/whoami")
28        return WhoAmIResponse(
29            username=response.get("user_name", "UNDEFINED"),
30            projectname=response.get("project_name", "UNDEFINED"),
31            user_label=response.get("user_label", "UNDEFINED"),
32        )
33
34    def version(self) -> VersionResponse:
35        """Returns version information."""
36        response = self.get("/actions/version")
37        return VersionResponse(server=response.get("version", "UNKNOWN"), client=self.client_version)
class ActionAPI(pinecone.core.api_base.BaseAPI): 
21class ActionAPI(BaseAPI):
22    """User related API calls."""
23
24    client_version = get_version()
25
26    def whoami(self) -> WhoAmIResponse:
27        """Returns user information."""
28        response = self.get("/actions/whoami")
29        return WhoAmIResponse(
30            username=response.get("user_name", "UNDEFINED"),
31            projectname=response.get("project_name", "UNDEFINED"),
32            user_label=response.get("user_label", "UNDEFINED"),
33        )
34
35    def version(self) -> VersionResponse:
36        """Returns version information."""
37        response = self.get("/actions/version")
38        return VersionResponse(server=response.get("version", "UNKNOWN"), client=self.client_version)

User related API calls.

client_version = '2.2.4'
def whoami(self) -> WhoAmIResponse: 
26    def whoami(self) -> WhoAmIResponse:
27        """Returns user information."""
28        response = self.get("/actions/whoami")
29        return WhoAmIResponse(
30            username=response.get("user_name", "UNDEFINED"),
31            projectname=response.get("project_name", "UNDEFINED"),
32            user_label=response.get("user_label", "UNDEFINED"),
33        )

Returns user information.

def version(self) -> VersionResponse: 
35    def version(self) -> VersionResponse:
36        """Returns version information."""
37        response = self.get("/actions/version")
38        return VersionResponse(server=response.get("version", "UNKNOWN"), client=self.client_version)

Returns version information.

Inherited Members
pinecone.core.api_base.BaseAPI
BaseAPI
host
api_key
headers
get
post
patch
delete
class VersionResponse(typing.NamedTuple): 
16class VersionResponse(NamedTuple):
17    server: str
18    client: str

VersionResponse(server, client)

VersionResponse(server: str, client: str)

Create new instance of VersionResponse(server, client)

server: str

Alias for field number 0

client: str

Alias for field number 1

Inherited Members
builtins.tuple
index
count
class WhoAmIResponse(typing.NamedTuple): 
10class WhoAmIResponse(NamedTuple):
11    username: str = "UNKNOWN"
12    user_label: str = "UNKNOWN"
13    projectname: str = "UNKNOWN"

WhoAmIResponse(username, user_label, projectname)

WhoAmIResponse( username: str = 'UNKNOWN', user_label: str = 'UNKNOWN', projectname: str = 'UNKNOWN')

Create new instance of WhoAmIResponse(username, user_label, projectname)

username: str

Alias for field number 0

user_label: str

Alias for field number 1

projectname: str

Alias for field number 2

Inherited Members
builtins.tuple
index
count