Welcome to oa’s documentation!

Contents:

• oa
• oa._params
• oa._resources
  • Resources
  • compare_pricing_info_to_model_info()
  • extract_pricing_data()
  • get_pricing_page_html()
  • parse_pricing_page()
  • parse_section()
• oa.ask
• oa.audio
  • text_to_speech()
  • transcribe()
  • transcription_to_srt()
  • tts()
• oa.base
  • compute_price()
  • embeddings()
  • list_engine_ids()
  • model_information()
  • normalize_text_input()
  • text_is_valid()
• oa.batch_embeddings
  • BatchError
  • BatchRequestCounts
  • BatchStatus
  • EmbeddingsBatchProcess
  • ProcessingMall
  • compute_embeddings()
  • compute_embeddings_df()
• oa.batches
  • BatchCancelledError
  • BatchError
  • BatchExpiredError
  • BatchFailedError
  • BatchFinalizingError
  • BatchInProgressError
  • get_output_file_data()
  • mk_batch_file_embeddings_task()
  • on_complete()
  • random_custom_id()
• oa.chats
  • ChatDacc
  • find_all_matching_paths_in_list_values()
  • find_url_keys()
  • get_rendered_html()
  • get_rendered_html_async()
  • parse_chat_html()
  • reduce_chat_html()
  • remove_utm_source()
  • truncate_dict_values()
• oa.examples.aesop_fables
  • get_original_stories()
  • rm_extension()
• oa.examples.batch_embeddings_examples
  • context_manager_example()
  • error_handling_example()
  • non_blocking_example()
  • pandas_example()
  • simple_example()
• oa.examples.illustrate_stories
  • aggregate_story_and_image()
• oa.oa_types
  • BatchRequest
  • BatchRequestBody
  • EmbeddingResponse
  • InputDataJsonL
  • InputText
  • JsonL
  • JsonL
  • RequestResponse
  • Response
  • Response
  • ResponseBody
  • Usage
• oa.openai_specs
  • Message
  • get_openapi_spec_dict()
  • merge_keys_to_values()
  • normalized_file_name()
  • properties_to_annotation()
  • properties_to_param_dict()
  • schema_to_docs()
  • schema_to_rst_argument_descriptions()
  • schema_to_signature()
• oa.stores
  • DataObject
  • EmbeddingsDataObject
  • MappingHooks
  • MutuableMappingHooks
  • OaBatches
  • OaBatchesBase
  • OaFiles
  • OaFilesBase
  • OaFilesJsonData
  • OaFilesMetadata
  • OaJsonFiles
  • OaJsonLFiles
  • OaMapping
  • OaVectorStoreFiles
  • OaVectorStores
  • OaVectorStoresBase
  • ResponseDict
  • date_filter()
  • extract_id()
  • get_json_data_from_response()
  • get_json_or_jsonl_data()
  • is_task_dict()
  • is_task_dict_list()
  • object_of_data()
• oa.tools
  • JsonTypes
  • PromptFuncs
  • constrained_answer()
  • ensure_json_type()
  • infer_schema_from_verbal_description()
  • make_generic_json_schema()
  • pattern_based_map()
  • prompt_function()
  • prompt_json_function()
  • remove_pattern()
• oa.util
  • ProcessingManager
  • chunk_iterable()
  • concat_lists()
  • ensure_oa_client()
  • get_package_name()
  • iso_date_to_utc_int()
  • jsonl_dumps()
  • jsonl_loads_iter()
  • mk_local_files_saves_callback()
  • num_tokens()
  • oa_extractors_obj()
  • pricing_info()
  • save_in_temp_dir()
  • source_parameter_props_from()
  • utc_int_to_iso_date()
• oa.vector_stores
  • bind_and_modify()
  • docs_to_search_func_factory_via_vector_store()
  • docs_to_vector_store()
  • mk_search_func_for_oa_vector_store()

Indices and tables

• Index

• Module Index

• Search Page

Release: 0.1.50

Last change: Jun 21, 2026