:py:mod:`vendor_fabric.meshy.connector` ======================================= .. py:module:: vendor_fabric.meshy.connector .. autodoc2-docstring:: vendor_fabric.meshy.connector :parser: myst :allowtitles: Module Contents --------------- Classes ~~~~~~~ .. list-table:: :class: autosummary longtable :align: left * - :py:obj:`MeshyConnector ` - .. autodoc2-docstring:: vendor_fabric.meshy.connector.MeshyConnector :parser: myst :summary: API ~~~ .. py:class:: MeshyConnector(api_key: str | None = None, base_url: str | None = None, timeout: float = 300.0, **kwargs: typing.Any) :canonical: vendor_fabric.meshy.connector.MeshyConnector Bases: :py:obj:`vendor_fabric.base.ConnectorBase` .. autodoc2-docstring:: vendor_fabric.meshy.connector.MeshyConnector :parser: myst .. rubric:: Initialization .. autodoc2-docstring:: vendor_fabric.meshy.connector.MeshyConnector.__init__ :parser: myst .. py:attribute:: API_KEY_ENV :canonical: vendor_fabric.meshy.connector.MeshyConnector.API_KEY_ENV :value: 'MESHY_API_KEY' .. autodoc2-docstring:: vendor_fabric.meshy.connector.MeshyConnector.API_KEY_ENV :parser: myst .. py:attribute:: BASE_URL :canonical: vendor_fabric.meshy.connector.MeshyConnector.BASE_URL :value: 'https://api.meshy.ai' .. autodoc2-docstring:: vendor_fabric.meshy.connector.MeshyConnector.BASE_URL :parser: myst .. py:method:: text3d_generate(prompt: str, art_style: str = 'realistic', negative_prompt: str = '', target_polycount: int = 30000, enable_pbr: bool = True, wait: bool = True) -> extended_data.containers.ExtendedDict | extended_data.containers.ExtendedString :canonical: vendor_fabric.meshy.connector.MeshyConnector.text3d_generate .. autodoc2-docstring:: vendor_fabric.meshy.connector.MeshyConnector.text3d_generate :parser: myst .. py:method:: image3d_generate(image_url: str, topology: str = 'triangle', target_polycount: int = 15000, enable_pbr: bool = True, wait: bool = True) -> extended_data.containers.ExtendedDict | extended_data.containers.ExtendedString :canonical: vendor_fabric.meshy.connector.MeshyConnector.image3d_generate .. autodoc2-docstring:: vendor_fabric.meshy.connector.MeshyConnector.image3d_generate :parser: myst .. py:method:: rig_model(model_id: str, wait: bool = True) -> extended_data.containers.ExtendedDict | extended_data.containers.ExtendedString :canonical: vendor_fabric.meshy.connector.MeshyConnector.rig_model .. autodoc2-docstring:: vendor_fabric.meshy.connector.MeshyConnector.rig_model :parser: myst .. py:method:: apply_animation(model_id: str, animation_id: int, wait: bool = True) -> extended_data.containers.ExtendedDict | extended_data.containers.ExtendedString :canonical: vendor_fabric.meshy.connector.MeshyConnector.apply_animation .. autodoc2-docstring:: vendor_fabric.meshy.connector.MeshyConnector.apply_animation :parser: myst .. py:method:: retexture_model(model_id: str, texture_prompt: str, enable_pbr: bool = True, wait: bool = True) -> extended_data.containers.ExtendedDict | extended_data.containers.ExtendedString :canonical: vendor_fabric.meshy.connector.MeshyConnector.retexture_model .. autodoc2-docstring:: vendor_fabric.meshy.connector.MeshyConnector.retexture_model :parser: myst .. py:attribute:: CONNECTOR_CATEGORY :canonical: vendor_fabric.meshy.connector.MeshyConnector.CONNECTOR_CATEGORY :type: typing.ClassVar[str] :value: 'external' .. py:attribute:: CONNECTOR_CAPABILITIES :canonical: vendor_fabric.meshy.connector.MeshyConnector.CONNECTOR_CAPABILITIES :type: typing.ClassVar[tuple[str, ...]] :value: () .. py:attribute:: TIMEOUT :canonical: vendor_fabric.meshy.connector.MeshyConnector.TIMEOUT :type: typing.ClassVar[float] :value: 300.0 .. py:attribute:: MIN_REQUEST_INTERVAL :canonical: vendor_fabric.meshy.connector.MeshyConnector.MIN_REQUEST_INTERVAL :type: typing.ClassVar[float] :value: 0.0 .. py:attribute:: MAX_RETRIES :canonical: vendor_fabric.meshy.connector.MeshyConnector.MAX_RETRIES :type: typing.ClassVar[int] :value: 5 .. py:property:: api_key :canonical: vendor_fabric.meshy.connector.MeshyConnector.api_key :type: str .. py:property:: client :canonical: vendor_fabric.meshy.connector.MeshyConnector.client :type: httpx.Client .. py:method:: close() -> None :canonical: vendor_fabric.meshy.connector.MeshyConnector.close .. py:method:: request(method: str, endpoint: str, *, headers: dict[str, str] | None = None, **kwargs: typing.Any) -> httpx.Response :canonical: vendor_fabric.meshy.connector.MeshyConnector.request .. py:method:: decode_response(response: httpx.Response, *, suffix: str | None = None, as_extended: bool = True) -> typing.Any :canonical: vendor_fabric.meshy.connector.MeshyConnector.decode_response .. py:method:: decode_response_file(response: httpx.Response, *, source: str | None = None, suffix: str | None = None, as_extended: bool = True, metadata: collections.abc.Mapping[str, typing.Any] | None = None) -> extended_data.io.DataFile :canonical: vendor_fabric.meshy.connector.MeshyConnector.decode_response_file .. py:method:: extend_result(value: typing.Any) -> typing.Any :canonical: vendor_fabric.meshy.connector.MeshyConnector.extend_result .. py:method:: request_data(method: str, endpoint: str, *, headers: dict[str, str] | None = None, suffix: str | None = None, as_extended: bool = True, **kwargs: typing.Any) -> typing.Any :canonical: vendor_fabric.meshy.connector.MeshyConnector.request_data .. py:method:: request_data_file(method: str, endpoint: str, *, headers: dict[str, str] | None = None, suffix: str | None = None, as_extended: bool = True, **kwargs: typing.Any) -> extended_data.io.DataFile :canonical: vendor_fabric.meshy.connector.MeshyConnector.request_data_file .. py:method:: request_workflow(method: str, endpoint: str, *, headers: dict[str, str] | None = None, suffix: str | None = None, as_extended: bool = True, **kwargs: typing.Any) -> extended_data.workflows.DataWorkflow :canonical: vendor_fabric.meshy.connector.MeshyConnector.request_workflow .. py:method:: get(endpoint: str, **kwargs: typing.Any) -> httpx.Response :canonical: vendor_fabric.meshy.connector.MeshyConnector.get .. py:method:: get_data(endpoint: str, *, suffix: str | None = None, as_extended: bool = True, **kwargs: typing.Any) -> typing.Any :canonical: vendor_fabric.meshy.connector.MeshyConnector.get_data .. py:method:: get_workflow(endpoint: str, *, suffix: str | None = None, as_extended: bool = True, **kwargs: typing.Any) -> extended_data.workflows.DataWorkflow :canonical: vendor_fabric.meshy.connector.MeshyConnector.get_workflow .. py:method:: post(endpoint: str, **kwargs: typing.Any) -> httpx.Response :canonical: vendor_fabric.meshy.connector.MeshyConnector.post .. py:method:: post_data(endpoint: str, *, suffix: str | None = None, as_extended: bool = True, **kwargs: typing.Any) -> typing.Any :canonical: vendor_fabric.meshy.connector.MeshyConnector.post_data .. py:method:: post_workflow(endpoint: str, *, suffix: str | None = None, as_extended: bool = True, **kwargs: typing.Any) -> extended_data.workflows.DataWorkflow :canonical: vendor_fabric.meshy.connector.MeshyConnector.post_workflow .. py:method:: put(endpoint: str, **kwargs: typing.Any) -> httpx.Response :canonical: vendor_fabric.meshy.connector.MeshyConnector.put .. py:method:: put_data(endpoint: str, *, suffix: str | None = None, as_extended: bool = True, **kwargs: typing.Any) -> typing.Any :canonical: vendor_fabric.meshy.connector.MeshyConnector.put_data .. py:method:: put_workflow(endpoint: str, *, suffix: str | None = None, as_extended: bool = True, **kwargs: typing.Any) -> extended_data.workflows.DataWorkflow :canonical: vendor_fabric.meshy.connector.MeshyConnector.put_workflow .. py:method:: delete(endpoint: str, **kwargs: typing.Any) -> httpx.Response :canonical: vendor_fabric.meshy.connector.MeshyConnector.delete .. py:method:: delete_data(endpoint: str, *, suffix: str | None = None, as_extended: bool = True, **kwargs: typing.Any) -> typing.Any :canonical: vendor_fabric.meshy.connector.MeshyConnector.delete_data .. py:method:: delete_workflow(endpoint: str, *, suffix: str | None = None, as_extended: bool = True, **kwargs: typing.Any) -> extended_data.workflows.DataWorkflow :canonical: vendor_fabric.meshy.connector.MeshyConnector.delete_workflow .. py:method:: patch(endpoint: str, **kwargs: typing.Any) -> httpx.Response :canonical: vendor_fabric.meshy.connector.MeshyConnector.patch .. py:method:: patch_data(endpoint: str, *, suffix: str | None = None, as_extended: bool = True, **kwargs: typing.Any) -> typing.Any :canonical: vendor_fabric.meshy.connector.MeshyConnector.patch_data .. py:method:: patch_workflow(endpoint: str, *, suffix: str | None = None, as_extended: bool = True, **kwargs: typing.Any) -> extended_data.workflows.DataWorkflow :canonical: vendor_fabric.meshy.connector.MeshyConnector.patch_workflow .. py:method:: download(url: str, output_path: str) -> int :canonical: vendor_fabric.meshy.connector.MeshyConnector.download .. py:attribute:: vendor_capabilities :canonical: vendor_fabric.meshy.connector.MeshyConnector.vendor_capabilities :type: typing.ClassVar[dict[str, vendor_fabric.capabilities.CapabilitySpec]] :value: None .. py:attribute:: vendor_capability_methods :canonical: vendor_fabric.meshy.connector.MeshyConnector.vendor_capability_methods :type: typing.ClassVar[dict[str, str]] :value: None .. py:method:: get_input(k: str, default: typing.Any | None = None, required: bool = False, is_bool: bool = False, is_integer: bool = False, is_float: bool = False, is_path: bool = False, is_datetime: bool = False, as_extended: bool = False) -> typing.Any :canonical: vendor_fabric.meshy.connector.MeshyConnector.get_input .. py:method:: decode_input(k: str, default: typing.Any | None = None, required: bool = False, decode_from_json: bool = False, decode_from_yaml: bool = False, decode_from_base64: bool = False, allow_none: bool = True, as_extended: bool = False) -> typing.Any :canonical: vendor_fabric.meshy.connector.MeshyConnector.decode_input .. py:method:: freeze_inputs() -> extended_data.containers.mappings.ExtendedDict :canonical: vendor_fabric.meshy.connector.MeshyConnector.freeze_inputs .. py:method:: thaw_inputs() -> extended_data.containers.mappings.ExtendedDict :canonical: vendor_fabric.meshy.connector.MeshyConnector.thaw_inputs .. py:method:: snapshot_inputs(*, frozen: bool = False) -> extended_data.containers.mappings.ExtendedDict :canonical: vendor_fabric.meshy.connector.MeshyConnector.snapshot_inputs .. py:method:: replace_inputs(new_inputs: collections.abc.Mapping[str, typing.Any] | None, *, clear_frozen: bool = True) -> extended_data.containers.mappings.ExtendedDict :canonical: vendor_fabric.meshy.connector.MeshyConnector.replace_inputs .. py:method:: merge_inputs(new_inputs: collections.abc.Mapping[str, typing.Any] | None) -> extended_data.containers.mappings.ExtendedDict :canonical: vendor_fabric.meshy.connector.MeshyConnector.merge_inputs .. py:method:: shift_inputs() -> extended_data.containers.mappings.ExtendedDict :canonical: vendor_fabric.meshy.connector.MeshyConnector.shift_inputs