Getting Started

Installation

To install this package:

pip install optimeering

Contents

• Getting Started
• Authentication
  • OAuth Authentication
    • Pre requisites
    • Signing in with the Azure CLI
    • Configuring the Client
  • API Key Authentication
    • Pre requisites
    • Configuring the Client
• Configuration
  • Configuration
    • Configuration.logger
    • Configuration.logger_stream_handler
    • Configuration.logger_file_handler
    • Configuration.verify_ssl
    • Configuration.ssl_ca_cert
    • Configuration.cert_file
    • Configuration.key_file
    • Configuration.assert_hostname
    • Configuration.tls_server_name
    • Configuration.connection_pool_maxsize
    • Configuration.proxy
    • Configuration.proxy_headers
    • Configuration.retries
    • Configuration.socket_options
    • Configuration.datetime_format
    • Configuration.date_format
    • Configuration.set_default()
    • Configuration.get_default_copy()
    • Configuration.get_default()
    • Configuration.logger_file
    • Configuration.debug
    • Configuration.logger_format
• Code Examples
  • Working with Prediction Series
  • Working with Prediction Versions
• AccessApi
  • AccessApi
    • AccessApi.create_api_key()
    • AccessApi.delete_key()
    • AccessApi.list_my_keys()
• PredictionsApi
  • PredictionsApi
    • PredictionsApi.list_parameters()
    • PredictionsApi.list_series()
    • PredictionsApi.list_version()
    • PredictionsApi.retrieve()
    • PredictionsApi.retrieve_latest()
    • PredictionsApi.retrieve_versioned()
• Client
  • OptimeeringClient
    • OptimeeringClient.user_agent
    • OptimeeringClient.get_default()
    • OptimeeringClient.set_default()
    • OptimeeringClient.param_serialize()
    • OptimeeringClient.call_api()
    • OptimeeringClient.response_deserialize()
    • OptimeeringClient.sanitize_for_serialization()
    • OptimeeringClient.deserialize()
    • OptimeeringClient.parameters_to_tuples()
    • OptimeeringClient.parameters_to_url_query()
    • OptimeeringClient.files_parameters()
    • OptimeeringClient.select_header_accept()
    • OptimeeringClient.select_header_content_type()
    • OptimeeringClient.update_params_for_auth()
    • OptimeeringClient.access_api
    • OptimeeringClient.predictions_api
• Client Models
  • AccessKeyCreated
    • AccessKeyCreated.from_dict()
    • AccessKeyCreated.from_json()
    • AccessKeyCreated.to_dict()
    • AccessKeyCreated.to_json()
    • AccessKeyCreated.to_pandas()
    • AccessKeyCreated.to_polars()
    • AccessKeyCreated.to_str()
  • AccessKeyListKeyResponse
    • AccessKeyListKeyResponse.filter()
    • AccessKeyListKeyResponse.from_dict()
    • AccessKeyListKeyResponse.from_json()
    • AccessKeyListKeyResponse.to_dict()
    • AccessKeyListKeyResponse.to_json()
    • AccessKeyListKeyResponse.to_pandas()
    • AccessKeyListKeyResponse.to_polars()
    • AccessKeyListKeyResponse.to_str()
  • AccessKeyPostResponse
    • AccessKeyPostResponse.from_dict()
    • AccessKeyPostResponse.from_json()
    • AccessKeyPostResponse.to_dict()
    • AccessKeyPostResponse.to_json()
    • AccessKeyPostResponse.to_pandas()
    • AccessKeyPostResponse.to_polars()
    • AccessKeyPostResponse.to_str()
  • AccessPostKey
    • AccessPostKey.from_dict()
    • AccessPostKey.from_json()
    • AccessPostKey.to_dict()
    • AccessPostKey.to_json()
    • AccessPostKey.to_pandas()
    • AccessPostKey.to_polars()
    • AccessPostKey.to_str()
  • EventTimeEnd
    • EventTimeEnd.from_json()
    • EventTimeEnd.to_dict()
    • EventTimeEnd.to_json()
    • EventTimeEnd.to_str()
  • EventTimeStart
    • EventTimeStart.from_json()
    • EventTimeStart.to_dict()
    • EventTimeStart.to_json()
    • EventTimeStart.to_str()
  • ExpiresAt
    • ExpiresAt.from_json()
    • ExpiresAt.to_dict()
    • ExpiresAt.to_json()
    • ExpiresAt.to_str()
  • HTTPValidationError
    • HTTPValidationError.filter()
    • HTTPValidationError.from_dict()
    • HTTPValidationError.from_json()
    • HTTPValidationError.to_dict()
    • HTTPValidationError.to_json()
    • HTTPValidationError.to_pandas()
    • HTTPValidationError.to_polars()
    • HTTPValidationError.to_str()
  • MaxEventTime
    • MaxEventTime.from_json()
    • MaxEventTime.to_dict()
    • MaxEventTime.to_json()
    • MaxEventTime.to_str()
  • PredictionsData
    • PredictionsData.filter()
    • PredictionsData.from_dict()
    • PredictionsData.from_json()
    • PredictionsData.to_dict()
    • PredictionsData.to_json()
    • PredictionsData.to_pandas()
    • PredictionsData.to_polars()
    • PredictionsData.to_str()
    • PredictionsData.version_validate_regular_expression()
  • PredictionsDataList
    • PredictionsDataList.filter()
    • PredictionsDataList.from_dict()
    • PredictionsDataList.from_json()
    • PredictionsDataList.to_dict()
    • PredictionsDataList.to_json()
    • PredictionsDataList.to_pandas()
    • PredictionsDataList.to_polars()
    • PredictionsDataList.to_str()
  • PredictionsEvent
    • PredictionsEvent.from_dict()
    • PredictionsEvent.from_json()
    • PredictionsEvent.to_dict()
    • PredictionsEvent.to_json()
    • PredictionsEvent.to_pandas()
    • PredictionsEvent.to_polars()
    • PredictionsEvent.to_str()
  • PredictionsSeries
    • PredictionsSeries.datapoints()
    • PredictionsSeries.from_dict()
    • PredictionsSeries.from_json()
    • PredictionsSeries.list_version()
    • PredictionsSeries.retrieve()
    • PredictionsSeries.retrieve_latest()
    • PredictionsSeries.to_dict()
    • PredictionsSeries.to_json()
    • PredictionsSeries.to_pandas()
    • PredictionsSeries.to_polars()
    • PredictionsSeries.to_str()
  • PredictionsSeriesList
    • PredictionsSeriesList.datapoints()
    • PredictionsSeriesList.filter()
    • PredictionsSeriesList.from_dict()
    • PredictionsSeriesList.from_json()
    • PredictionsSeriesList.list_version()
    • PredictionsSeriesList.retrieve()
    • PredictionsSeriesList.retrieve_latest()
    • PredictionsSeriesList.series_ids
    • PredictionsSeriesList.to_dict()
    • PredictionsSeriesList.to_json()
    • PredictionsSeriesList.to_pandas()
    • PredictionsSeriesList.to_polars()
    • PredictionsSeriesList.to_str()
  • PredictionsValue
    • PredictionsValue.from_dict()
    • PredictionsValue.from_json()
    • PredictionsValue.to_dict()
    • PredictionsValue.to_json()
    • PredictionsValue.to_pandas()
    • PredictionsValue.to_polars()
    • PredictionsValue.to_str()
  • PredictionsVersion
    • PredictionsVersion.convert_to_versioned_series()
    • PredictionsVersion.from_dict()
    • PredictionsVersion.from_json()
    • PredictionsVersion.retrieve_versioned()
    • PredictionsVersion.to_dict()
    • PredictionsVersion.to_json()
    • PredictionsVersion.to_pandas()
    • PredictionsVersion.to_polars()
    • PredictionsVersion.to_str()
    • PredictionsVersion.version_validate_regular_expression()
  • PredictionsVersionList
    • PredictionsVersionList.convert_to_versioned_series()
    • PredictionsVersionList.filter()
    • PredictionsVersionList.from_dict()
    • PredictionsVersionList.from_json()
    • PredictionsVersionList.retrieve_versioned()
    • PredictionsVersionList.to_dict()
    • PredictionsVersionList.to_json()
    • PredictionsVersionList.to_pandas()
    • PredictionsVersionList.to_polars()
    • PredictionsVersionList.to_str()
  • ValidationError
    • ValidationError.from_dict()
    • ValidationError.from_json()
    • ValidationError.to_dict()
    • ValidationError.to_json()
    • ValidationError.to_pandas()
    • ValidationError.to_polars()
    • ValidationError.to_str()
  • ValidationErrorLocInner
    • ValidationErrorLocInner.from_json()
    • ValidationErrorLocInner.to_dict()
    • ValidationErrorLocInner.to_json()
    • ValidationErrorLocInner.to_str()
  • VersionedSeries
    • VersionedSeries.from_dict()
    • VersionedSeries.from_json()
    • VersionedSeries.to_dict()
    • VersionedSeries.to_json()
    • VersionedSeries.to_pandas()
    • VersionedSeries.to_polars()
    • VersionedSeries.to_str()
    • VersionedSeries.version_validate_regular_expression()