collections_items_get_parser_hints

Get hints for the proposed parser of an item

Functions

async pydelfini.delfini_core.api.items.collections_items_get_parser_hints.asyncio(collection_id, version_id, item_id, *, client, body)[source]

Get hints for the proposed parser of an item

Get hints for setting the parser settings for the provided item. This includes choices or default values that are recommended for the item.

Parameters:

  • collection_id (str)

  • version_id (str)

  • item_id (str)

  • body (Union['ItemParser', None]) – Example: {‘name’: ‘auto’}.

  • client (AuthenticatedClient)

Raises:

  • errors.UnexpectedStatus – If the server returns a status code greater than or equal to 300.

  • httpx.TimeoutException – If the request takes longer than Client.timeout.

Returns:

Union[Parser]

Return type:

Parser

async pydelfini.delfini_core.api.items.collections_items_get_parser_hints.asyncio_detailed(collection_id, version_id, item_id, *, client, body)[source]

Get hints for the proposed parser of an item

Get hints for setting the parser settings for the provided item. This includes choices or default values that are recommended for the item.

Parameters:

  • collection_id (str)

  • version_id (str)

  • item_id (str)

  • body (Union['ItemParser', None]) – Example: {‘name’: ‘auto’}.

  • client (AuthenticatedClient)

Raises:

  • errors.UnexpectedStatus – If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.

  • httpx.TimeoutException – If the request takes longer than Client.timeout.

Returns:

Response[Union[Parser, ServerError]]

Return type:

Response[Parser | ServerError]

pydelfini.delfini_core.api.items.collections_items_get_parser_hints.sync(collection_id, version_id, item_id, *, client, body)[source]

Get hints for the proposed parser of an item

Get hints for setting the parser settings for the provided item. This includes choices or default values that are recommended for the item.

Parameters:

  • collection_id (str)

  • version_id (str)

  • item_id (str)

  • body (Union['ItemParser', None]) – Example: {‘name’: ‘auto’}.

  • client (AuthenticatedClient)

Raises:

  • errors.UnexpectedStatus – If the server returns a status code greater than or equal to 300.

  • httpx.TimeoutException – If the request takes longer than Client.timeout.

Returns:

Union[Parser]

Return type:

Parser

pydelfini.delfini_core.api.items.collections_items_get_parser_hints.sync_detailed(collection_id, version_id, item_id, *, client, body)[source]

Get hints for the proposed parser of an item

Get hints for setting the parser settings for the provided item. This includes choices or default values that are recommended for the item.

Parameters:

  • collection_id (str)

  • version_id (str)

  • item_id (str)

  • body (Union['ItemParser', None]) – Example: {‘name’: ‘auto’}.

  • client (AuthenticatedClient)

Raises:

  • errors.UnexpectedStatus – If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.

  • httpx.TimeoutException – If the request takes longer than Client.timeout.

Returns:

Response[Union[Parser, ServerError]]

Return type:

Response[Parser | ServerError]