Module lunar.rec.channels.channel

Classes

class ChannelClient (config: Config)

Client for BAP Recommendation API (/v1/channels/).

Example

import bap

client = bap.client("channel")

Ancestors

Methods

def create_channel(self, id: str, experiment_id: str = None) ‑> Channel

Create a new channel.

Args

  • id: (str) Unique identifier of a channel
  • experiment_id: (optional) (str) Unique identifier of an experiment assigned

Returns

Channel

Example

channel = client.create_channel(id="my_channel", experiment_id="my_experiment")
async def create_channel_async(self, id: str, experiment_id: str = None) ‑> Channel

Create a new channel (async).

Args

  • id: (str) Unique identifier of a channel
  • experiment_id: (optional) (str) Unique identifier of an experiment assigned

Returns

Channel

Example

channel = await client.create_channel_async(id="my_channel", experiment_id="my_experiment")
def delete_channel(self, id: str) ‑> None

Delete a channel.

Args

  • id: (str) Unique identifier of a channel

Example

client.delete_channel(id="my_channel")
async def delete_channel_async(self, id: str) ‑> None

Delete a channel (async).

Args

  • id: (str) Unique identifier of a channel

Example

await client.delete_channel_async(id="my_channel")
def get_channel(self, id: str) ‑> Channel

Get a channel.

Args

  • id: (str) Unique identifier of the channel

Returns

Channel

Example

channel = client.get_channel(id="my_channel")
async def get_channel_async(self, id: str) ‑> Channel

Get a channel (async).

Args

  • id: (str) Unique identifier of a channel

Returns

Channel

Example

channel = await client.get_channel_async(id="my_channel")
def list_channels(self) ‑> List[Channel]

List channels.

Returns

list(Channel)

Example

channels = client.list_channels()
async def list_channels_async(self) ‑> List[Channel]

List channels (async).

Returns

list(Channel)

Example

channels = await client.list_channels_async()
def update_channel(self, id: str, experiment_id: str = None) ‑> Channel

Update a channel.

Args

  • id: (str) Unique identifier of a channel
  • experiment_id: (optional) (str) Unique identifier of an experiment assigned

Returns

Channel

Example

updated_channel = client.update_channel(id="my_channel", experiment_id="new_experiment")
async def update_channel_async(self, id: str, experiment_id: str = None) ‑> Channel

Update a channel (async).

Args

  • id: (str) Unique identifier of a channel
  • experiment_id: (optional) (str) Unique identifier of an experiment assigned

Returns

Channel

Example

updated_channel = await client.update_channel_async(id="my_channel", experiment_id="new_experiment")
def update_channel_partial(self, id: str, experiment_id: str = None) ‑> Channel

Partially update a channel.

Args

  • id: (str) Unique identifier of a channel
  • experiment_id: (optional) (str) Unique identifier of an experiment assigned

Returns

Channel

Example

updated_channel = client.update_channel_partial(id="my_channel", experiment_id="new_experiment")
async def update_channel_partial_async(self, id: str, experiment_id: str = None) ‑> Channel

Partially update a channel (async).

Args

  • id: (str) Unique identifier of a channel
  • experiment_id: (optional) (str) Unique identifier of an experiment assigned

Returns

Channel

Example

updated_channel = await client.update_channel_partial_async(id="my_channel", experiment_id="new_experiment")