Share via

OpenAIEmbeddingPromptExecutionSettings Class

Specific settings for the text embedding endpoint.

Initialize the prompt execution settings.

Constructor

OpenAIEmbeddingPromptExecutionSettings(service_id: str | None = None, *, extension_data: dict[str, Any] = None, function_choice_behavior: FunctionChoiceBehavior | None = None, input: str | list[str] | list[int] | list[list[int]] | None = None, ai_model_id: str | None = None, encoding_format: Literal['float', 'base64'] | None = None, user: str | None = None, extra_headers: dict | None = None, extra_query: dict | None = None, extra_body: dict | None = None, timeout: float | None = None, dimensions: Annotated[int | None, Gt(gt=0), Le(le=3072)] = None)

Parameters

Name Description
service_id
str

The service ID to use for the request.

Default value: None
kwargs
Required
Any

Additional keyword arguments, these are attempted to parse into the keys of the specific prompt execution settings.

Keyword-Only Parameters

Name Description
extension_data
Required
function_choice_behavior
Required
input
Required
ai_model_id
Required
encoding_format
Required
user
Required
extra_headers
Required
extra_query
Required
extra_body
Required
timeout
Required
dimensions
Required

Attributes

ai_model_id 

ai_model_id: Annotated[str | None, FieldInfo(annotation=NoneType, required=True, alias_priority=2, serialization_alias='model')]

dimensions 

dimensions: Annotated[int | None, FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0), Le(le=3072)])]

encoding_format 

encoding_format: Literal['float', 'base64'] | None

extra_body 

extra_body: dict | None

extra_headers 

extra_headers: dict | None

extra_query 

extra_query: dict | None

input 

input: str | list[str] | list[int] | list[list[int]] | None

timeout 

timeout: float | None

user 

user: str | None