compass.services.base.Service

class Service

Bases: ABC

Abstract base class for a Service that can be queued to run

See also

LLMService

Base class for LLM services.

OpenAIService

LLM service for OpenAI models.

ProcessPoolService

Service that contains a ProcessPoolExecutor instance.

ThreadedService

Service that contains a ThreadPoolExecutor instance.

Methods

acquire_resources()	Use this method to allocate resources, if needed
call(*args, **kwargs)	Call the service
process(*args, **kwargs)	Process a call to the service.
process_using_futures(fut, *args, **kwargs)	Process a call to the service
release_resources()	Use this method to clean up resources, if needed

Attributes

MAX_CONCURRENT_JOBS	Max number of concurrent job submissions.
can_process	Flag indicating whether the service can accept work
name	Service name used to pull the correct queue object

MAX_CONCURRENT_JOBS = 10000

Max number of concurrent job submissions.

async classmethod call(*args, **kwargs)

Call the service

Parameters:

• *args – Positional and keyword arguments to be passed to the underlying service processing function.

• **kwargs – Positional and keyword arguments to be passed to the underlying service processing function.

Returns:

object – A response object from the underlying service.

property name

Service name used to pull the correct queue object

Type:

str

async process_using_futures(fut, *args, **kwargs)

Process a call to the service

The result is communicated by updating fut.

Parameters:

• fut (asyncio.Future) – A future object that should get the result of the processing operation. If the processing function returns answer, this method should call fut.set_result(answer).

• **kwargs – Keyword arguments to be passed to the underlying processing function.

acquire_resources()

Use this method to allocate resources, if needed

release_resources()

Use this method to clean up resources, if needed

abstract property can_process

Flag indicating whether the service can accept work

Type:

bool

abstractmethod async process(*args, **kwargs)

Process a call to the service.

Parameters:

• *args – Positional and keyword arguments to be passed to the underlying processing function.

• **kwargs – Positional and keyword arguments to be passed to the underlying processing function.