gen_ai_hub.orchestration_v2.exceptions
index
/home/jenkins/agent/workspace/ation_generative-ai-hub-sdk_main/gen_ai_hub/orchestration_v2/exceptions.py

Exceptions for the orchestration service module.

 
Modules
       
httpx

 
Classes
       
builtins.Exception(builtins.BaseException)
OrchestrationError
OrchestrationErrorList

 
class OrchestrationError(builtins.Exception)
    OrchestrationError(request_id: str, headers: httpx.Headers, message: str, code: int, location: str, intermediate_results: gen_ai_hub.orchestration_v2.models.response.ModuleResults | dict, retries: int = 0)
 
This exception is raised when an error occurs during the execution of the
orchestration service, typically due to incorrect usage, invalid configurations,
or issues with run parameters defined by the user.
 
 
Method resolution order:
OrchestrationError
builtins.Exception
builtins.BaseException
builtins.object

Methods defined here:
__init__(self, request_id: str, headers: httpx.Headers, message: str, code: int, location: str, intermediate_results: gen_ai_hub.orchestration_v2.models.response.ModuleResults | dict, retries: int = 0)
Initializes the OrchestrationError with detailed context.
 
:param request_id: unique identifier for the request that encountered the error.
:type request_id: str
:param headers: HTTP headers associated with the request, useful in case of e.g. rate limiting..
:type headers: httpx.Headers
:param message: Detailed error message describing the issue.
:type message: str
:param code: Error code associated with the specific type of failure.
:type code: int
:param location: Specific component or step in the orchestration process where the error occurred.
:type location: str
:param intermediate_results: State information and partial results from various modules
    at the time of the error, useful for debugging.
:type intermediate_results: ModuleResults
:param retries: Number of retries attempted before the error was raised.
:type retries: int, optional
:param errors: Raw error payload(s) from the API. Can contain multiple errors.
:type errors: Optional[list[dict[str, Any]]]

Data descriptors defined here:
__weakref__
list of weak references to the object (if defined)

Static methods inherited from builtins.Exception:
__new__(*args, **kwargs) from builtins.type
Create and return a new object.  See help(type) for accurate signature.

Methods inherited from builtins.BaseException:
__delattr__(self, name, /)
Implement delattr(self, name).
__getattribute__(self, name, /)
Return getattr(self, name).
__reduce__(...)
Helper for pickle.
__repr__(self, /)
Return repr(self).
__setattr__(self, name, value, /)
Implement setattr(self, name, value).
__setstate__(...)
__str__(self, /)
Return str(self).
with_traceback(...)
Exception.with_traceback(tb) --
set self.__traceback__ to tb and return self.

Data descriptors inherited from builtins.BaseException:
__cause__
exception cause
__context__
exception context
__dict__
__suppress_context__
__traceback__
args

 
class OrchestrationErrorList(builtins.Exception)
    OrchestrationErrorList(errors: list[gen_ai_hub.orchestration_v2.exceptions.OrchestrationError])
 

 
 
Method resolution order:
OrchestrationErrorList
builtins.Exception
builtins.BaseException
builtins.object

Methods defined here:
__init__(self, errors: list[gen_ai_hub.orchestration_v2.exceptions.OrchestrationError])
Initialize self.  See help(type(self)) for accurate signature.

Data descriptors defined here:
__weakref__
list of weak references to the object (if defined)

Static methods inherited from builtins.Exception:
__new__(*args, **kwargs) from builtins.type
Create and return a new object.  See help(type) for accurate signature.

Methods inherited from builtins.BaseException:
__delattr__(self, name, /)
Implement delattr(self, name).
__getattribute__(self, name, /)
Return getattr(self, name).
__reduce__(...)
Helper for pickle.
__repr__(self, /)
Return repr(self).
__setattr__(self, name, value, /)
Implement setattr(self, name, value).
__setstate__(...)
__str__(self, /)
Return str(self).
with_traceback(...)
Exception.with_traceback(tb) --
set self.__traceback__ to tb and return self.

Data descriptors inherited from builtins.BaseException:
__cause__
exception cause
__context__
exception context
__dict__
__suppress_context__
__traceback__
args

 
Data
        Optional = typing.Optional