docwire::openai::embed Class Reference

Inheritance diagram for docwire::openai::embed:

Public Types
enum class	model { text_embedding_3_small , text_embedding_3_large , text_embedding_ada_002 }

Public Member Functions
	embed (const std::string &api_key, modelmodel modelmodel=model::text_embedding_3_small)
continuation	operator() (message_ptr msg, const message_callbacks &emit_message)
	Executes transform operation for given node data.

Additional Inherited Members
Protected Types inherited from docwire::with_pimpl< embed >
using	impl_type
Protected Member Functions inherited from docwire::with_pimpl< embed >
impl_type *	create_impl (Args &&... args)
	with_pimpl (Args &&... args)
with_pimpl &	operator= (with_pimpl &&other) noexcept
impl_type &	impl ()

Detailed Description

Examples

openai_embedding.cpp.

Definition at line 26 of file embed.h.

Member Enumeration Documentation

model

enum class docwire::openai::embed::model

strong

Enumerator
text_embedding_3_small	text-embedding-3-small: A new third generation embedding model, is OpenAI recommended default for most use cases.
text_embedding_3_large	text-embedding-3-large: A larger and more powerful third generation embedding model, is OpenAI best performing embedding model.
text_embedding_ada_002	text-embedding-ada-002: Older generation of OpenAI's embedding model.

Definition at line 29 of file embed.h.

Member Function Documentation

operator()()

continuation docwire::openai::embed::operator()	(	message_ptr	msg,
		const message_callbacks &	emit_message )

Executes transform operation for given node data.

See also

docwire::message_ptr

Parameters

tag
callback

---

The documentation for this class was generated from the following file:

• embed.h