Toggle Menu
Prev Up Next

# `langchain_community.utilities.steam`.SteamWebAPIWrapper

class langchain_community.utilities.steam.SteamWebAPIWrapper

  Bases: `BaseModel`

  Wrapper for Steam API.

  Create a new model by parsing and validating input data from keyword arguments.

  Raises ValidationError if the input data cannot be parsed to form a valid model.

  param operations: List[dict] = [{'mode': 'get_game_details', 'name': 'Get Game Details', 'description': '\n This tool is a wrapper around python-steam-api\'s steam.apps.search_games API and \n steam.apps.get_app_details API, useful when you need to search for a game.\n The input to this tool is a string specifying the name of the game you want to \n search for. For example, to search for a game called "Counter-Strike: Global \n Offensive", you would input "Counter-Strike: Global Offensive" as the game name.\n This input will be passed into steam.apps.search_games to find the game id, link \n and price, and then the game id will be passed into steam.apps.get_app_details to \n get the detailed description and supported languages of the game. Finally the \n results are combined and returned as a string.\n'}, {'mode': 'get_recommended_games', 'name': 'Get Recommended Games', 'description': '\n This tool is a wrapper around python-steam-api\'s steam.users.get_owned_games API \n and steamspypi\'s steamspypi.download API, useful when you need to get a list of \n recommended games. The input to this tool is a string specifying the steam id of \n the user you want to get recommended games for. For example, to get recommended \n games for a user with steam id 76561197960435530, you would input \n "76561197960435530" as the steam id. This steamid is then utilized to form a \n data_request sent to steamspypi\'s steamspypi.download to retrieve genres of user\'s \n owned games. Then, calculates the frequency of each genre, identifying the most \n popular one, and stored it in a dictionary. Subsequently, use steamspypi.download\n to returns all games in this genre and return 5 most-played games that is not owned\n by the user.\n\n'}]
  param steam: Any = None
  classmethod construct(_fields_set: Optional[SetStr] = None, **values: Any) → Model

    Creates a new model setting __dict__ and __fields_set__ from trusted or pre-validated data. Default values are respected, but no other validation is performed. Behaves as if Config.extra = ‘allow’ was set since it adds all passed values

    Parameters

      - _fields_set (Optional[SetStr]) –

      - values (Any) –

    Return type

      Model

  copy(*, include: Optional[Union[AbstractSetIntStr, MappingIntStrAny]] = None, exclude: Optional[Union[AbstractSetIntStr, MappingIntStrAny]] = None, update: Optional[DictStrAny] = None, deep: bool = False) → Model

    Duplicate a model, optionally choose which fields to include, exclude and change.

    Parameters

      - include (Optional[Union[AbstractSetIntStr, MappingIntStrAny]]) – fields to include in new model

      - exclude (Optional[Union[AbstractSetIntStr, MappingIntStrAny]]) – fields to exclude from new model, as with values this takes precedence over include

      - update (Optional[DictStrAny]) – values to change/add in the new model. Note: the data is not validated before creating the new model: you should trust this data

      - deep (bool) – set to True to make a deep copy of the model

      - self (Model) –

    Returns

      new model instance

    Return type

      Model

  details_of_games(name: str) → str
    Parameters

      name (str) –

    Return type

      str

  dict(*, include: Optional[Union[AbstractSetIntStr, MappingIntStrAny]] = None, exclude: Optional[Union[AbstractSetIntStr, MappingIntStrAny]] = None, by_alias: bool = False, skip_defaults: Optional[bool] = None, exclude_unset: bool = False, exclude_defaults: bool = False, exclude_none: bool = False) → DictStrAny

    Generate a dictionary representation of the model, optionally specifying which fields to include or exclude.

    Parameters

      - include (Optional[Union[AbstractSetIntStr, MappingIntStrAny]]) –

      - exclude (Optional[Union[AbstractSetIntStr, MappingIntStrAny]]) –

      - by_alias (bool) –

      - skip_defaults (Optional[bool]) –

      - exclude_unset (bool) –

      - exclude_defaults (bool) –

      - exclude_none (bool) –

    Return type

      DictStrAny

  classmethod from_orm(obj: Any) → Model
    Parameters

      obj (Any) –

    Return type

      Model

  get_id_link_price(games: dict) → dict

    The response may contain more than one game, so we need to choose the right one and return the id.

    Parameters

      games (dict) –

    Return type

      dict

  get_operations() → List[dict]

    Return a list of operations.

    Return type

      List[dict]

  get_steam_id(name: str) → str
    Parameters

      name (str) –

    Return type

      str

  get_users_games(steam_id: str) → List[str]
    Parameters

      steam_id (str) –

    Return type

      List[str]

  json(*, include: Optional[Union[AbstractSetIntStr, MappingIntStrAny]] = None, exclude: Optional[Union[AbstractSetIntStr, MappingIntStrAny]] = None, by_alias: bool = False, skip_defaults: Optional[bool] = None, exclude_unset: bool = False, exclude_defaults: bool = False, exclude_none: bool = False, encoder: Optional[Callable[[Any], Any]] = None, models_as_dict: bool = True, **dumps_kwargs: Any) → unicode

    Generate a JSON representation of the model, include and exclude arguments as per dict().

    encoder is an optional function to supply as default to json.dumps(), other arguments as per json.dumps().

    Parameters

      - include (Optional[Union[AbstractSetIntStr, MappingIntStrAny]]) –

      - exclude (Optional[Union[AbstractSetIntStr, MappingIntStrAny]]) –

      - by_alias (bool) –

      - skip_defaults (Optional[bool]) –

      - exclude_unset (bool) –

      - exclude_defaults (bool) –

      - exclude_none (bool) –

      - encoder (Optional[Callable[[Any], Any]]) –

      - models_as_dict (bool) –

      - dumps_kwargs (Any) –

    Return type

      unicode

  classmethod parse_file(path: Union[str, Path], *, content_type: unicode = None, encoding: unicode = 'utf8', proto: Protocol = None, allow_pickle: bool = False) → Model
    Parameters

      - path (Union[str, Path]) –

      - content_type (unicode) –

      - encoding (unicode) –

      - proto (Protocol) –

      - allow_pickle (bool) –

    Return type

      Model

  classmethod parse_obj(obj: Any) → Model
    Parameters

      obj (Any) –

    Return type

      Model

  classmethod parse_raw(b: Union[str, bytes], *, content_type: unicode = None, encoding: unicode = 'utf8', proto: Protocol = None, allow_pickle: bool = False) → Model
    Parameters

      - b (Union[str, bytes]) –

      - content_type (unicode) –

      - encoding (unicode) –

      - proto (Protocol) –

      - allow_pickle (bool) –

    Return type

      Model

  parse_to_str(details: dict) → str

    Parse the details result.

    Parameters

      details (dict) –

    Return type

      str

  recommended_games(steam_id: str) → str
    Parameters

      steam_id (str) –

    Return type

      str

  remove_html_tags(html_string: str) → str
    Parameters

      html_string (str) –

    Return type

      str

  run(mode: str, game: str) → str
    Parameters

      - mode (str) –

      - game (str) –

    Return type

      str

  classmethod schema(by_alias: bool = True, ref_template: unicode = '#/definitions/{model}') → DictStrAny
    Parameters

      - by_alias (bool) –

      - ref_template (unicode) –

    Return type

      DictStrAny

  classmethod schema_json(*, by_alias: bool = True, ref_template: unicode = '#/definitions/{model}', **dumps_kwargs: Any) → unicode
    Parameters

      - by_alias (bool) –

      - ref_template (unicode) –

      - dumps_kwargs (Any) –

    Return type

      unicode

  classmethod update_forward_refs(**localns: Any) → None

    Try to update ForwardRefs on fields based on this Model, globalns and localns.

    Parameters

      localns (Any) –

    Return type

      None

  classmethod validate(value: Any) → Model
    Parameters

      value (Any) –

    Return type

      Model

# Examples using SteamWebAPIWrapper

- steam.md