AzureOpenAiProvider
class AzureOpenAiProvider extends Provider implements EmbeddingProvider, FileProvider, ImageProvider, StoreProvider, SupportsCodeExecution, SupportsFileSearch, SupportsToolSearch, SupportsWebSearch, TextProvider
Traits
Properties
| protected EmbeddingGateway | $embeddingGateway | from HasEmbeddingGateway | |
| protected FileGateway | $fileGateway | from HasFileGateway | |
| protected ImageGateway | $imageGateway | from HasImageGateway | |
| protected StoreGateway | $storeGateway | from HasStoreGateway | |
| protected StepTextGateway | $textGateway | from HasTextGateway | |
| protected TextGenerationLoop|null | $textGenerationLoop | from HasTextGateway | |
| protected AzureOpenAiGateway|null | $azureGateway |
Methods
Get the provider connection configuration other than the driver, key, and name.
Get a provider instance that sends the given HTTP headers with each request.
Run the given gateway call, dispatching the event built from its exception before rethrowing.
Format the given provider / model list.
Get provider and model pairs without discarding on-demand instances.
Restore the provider from its serialized representation.
Get embedding vectors representing the given inputs.
Determine if the provider may omit dimensions and use a model's native embedding dimensions.
Validate embeddings inputs against the provider's supported media types.
Generate an image.
Get the tool approval to resume with, unless a faked agent has no paused approval to resume.
Replace another provider's raw paused-turn replay state with its generic mapping, since raw blocks are only valid verbatim on the provider that produced them.
Determine whether the prompt is a resume that runs the approved tools.
Get a callback that captures a resume's resolved approval results for its completion event.
Resolve the tools for the given prompt, wrapping any agent instances as tools.
Get the tools the agent declares, including the tool that loads its skills.
Resolve a tool returned by the agent into a native tool instance when needed.
Build the run's context, letting a remembered conversation claim and record the approval decisions the run resumes.
Build the context that identifies this run and reports its step and tool events.
Dispatch the terminal failure event for a run, unless the caller may still retry it against another provider.
Throw when a pause has surfaced on a prompt that cannot be resumed from persisted or replayed history.
Get the provider's embedding gateway.
Get the provider's file gateway.
Get the provider's image gateway.
Get the provider's store gateway.
Get the provider's text gateway.
Get the multi-step text generation loop wrapping the provider's text gateway.
Create a new vector store.
Add a file to a vector store.
Remove a file from a vector store.
Get the shared Azure OpenAI gateway instance.
Get the name of the default (deployment name) text model.
Get the name of the cheapest text model.
Get the name of the smartest text model.
Get the name of the default image deployment.
Get the default / normalized image options for the provider.
Get the name of the default embeddings model.
Get the default dimensions of the default embeddings model.
Get the code execution tool options for the provider.
Details
at line 62
__construct(array $config, Dispatcher $events)
Create an Azure OpenAI provider instance.
in
Provider at line 34
string
name()
Get the name of the underlying AI provider.
in
Provider at line 42
string
driver()
Get the name of the underlying AI driver.
in
Provider at line 50
array
providerCredentials()
Get the credentials for the underlying AI provider.
at line 216
array
additionalConfiguration()
Get the provider connection configuration other than the driver, key, and name.
in
Provider at line 72
Provider
withHeaders(array $headers)
| internal |
Get a provider instance that sends the given HTTP headers with each request.
in
Provider at line 92
protected mixed
dispatchingFailure(Closure $call, Closure $failed)
Run the given gateway call, dispatching the event built from its exception before rethrowing.
in
Provider at line 114
static array
formatProviderAndModelList(Provider|Lab|array|string $providers, string|null $model = null)
Format the given provider / model list.
in
Provider at line 132
static array
providerAndModelPairs(Provider|Lab|array|string $providers, string|null $model = null)
| internal |
Get provider and model pairs without discarding on-demand instances.
in
Provider at line 164
array
__serialize()
Get the serializable representation of the provider.
in
Provider at line 174
void
__unserialize(array $data)
Restore the provider from its serialized representation.
in
Provider at line 190
string
__toString()
Convert the provider to its string representation.
in
GeneratesEmbeddings at line 29
EmbeddingsResponse
embeddings(array $inputs, int|null $dimensions = null, string|null $model = null, int $timeout = 30, array $providerOptions = [])
Get embedding vectors representing the given inputs.
in
GeneratesEmbeddings at line 87
protected bool
supportsNativeEmbeddingDimensions()
Determine if the provider may omit dimensions and use a model's native embedding dimensions.
in
GeneratesEmbeddings at line 97
protected void
validateEmbeddingInputs(array $inputs, string $model)
Validate embeddings inputs against the provider's supported media types.
in
GeneratesImages at line 26
ImageResponse
image(string $prompt, array $attachments = [], string|null $size = null, string|null $quality = null, string|null $model = null, int|null $timeout = null, array $providerOptions = [])
Generate an image.
in
ResumesToolApprovals at line 26
protected array|null
resumableApprovalFor(AgentPrompt $prompt, array $messages, array $tools)
Get the tool approval to resume with, unless a faked agent has no paused approval to resume.
in
ResumesToolApprovals at line 37
protected array
withoutForeignReplayBlocks(array $messages)
Replace another provider's raw paused-turn replay state with its generic mapping, since raw blocks are only valid verbatim on the provider that produced them.
in
ResumesToolApprovals at line 57
protected bool
resumesApproval(AgentPrompt $prompt, array $messages, array $tools)
Determine whether the prompt is a resume that runs the approved tools.
in
ResumesToolApprovals at line 76
protected Closure|null
approvalResultRecorderFor(AgentPrompt $prompt, array|null $approval, Collection|null $resolvedApprovalResults)
Get a callback that captures a resume's resolved approval results for its completion event.
in
GeneratesText at line 53
AgentResponse
prompt(AgentPrompt $prompt)
Invoke the given agent.
in
GeneratesText at line 175
protected array
gatherMiddlewareFor(Agent $agent)
Gather the internal run middleware for the given agent.
in
GeneratesText at line 193
protected array
resolveTools(AgentPrompt $prompt)
Resolve the tools for the given prompt, wrapping any agent instances as tools.
in
GeneratesText at line 204
protected array
declaredTools(Agent $agent)
Get the tools the agent declares, including the tool that loads its skills.
in
GeneratesText at line 214
protected mixed
resolveTool(mixed $tool)
Resolve a tool returned by the agent into a native tool instance when needed.
in
GeneratesText at line 233
protected RunContext
prepareRunContext(string $invocationId, AgentPrompt $prompt, array|null $approval)
Build the run's context, letting a remembered conversation claim and record the approval decisions the run resumes.
in
GeneratesText at line 257
protected RunContext
runContextFor(string $invocationId, AgentPrompt $prompt)
Build the context that identifies this run and reports its step and tool events.
in
GeneratesText at line 268
protected void
recordAgentFailure(string $invocationId, AgentPrompt $prompt, Throwable $exception, bool $retryable = true)
Dispatch the terminal failure event for a run, unless the caller may still retry it against another provider.
in
GeneratesText at line 285
protected void
throwIfNotResumable(AgentPrompt $prompt)
Throw when a pause has surfaced on a prompt that cannot be resumed from persisted or replayed history.
at line 85
EmbeddingGateway
embeddingGateway()
Get the provider's embedding gateway.
in
HasEmbeddingGateway at line 27
HasEmbeddingGateway
useEmbeddingGateway(EmbeddingGateway $gateway)
Set the provider's embedding gateway.
Changing a shared provider's gateway affects subsequent operations.
at line 229
FileGateway
fileGateway()
Get the provider's file gateway.
in
HasFileGateway at line 27
HasFileGateway
useFileGateway(FileGateway $gateway)
Set the provider's file gateway.
Changing a shared provider's gateway affects subsequent operations.
at line 117
ImageGateway
imageGateway()
Get the provider's image gateway.
in
HasImageGateway at line 27
HasImageGateway
useImageGateway(ImageGateway $gateway)
Set the provider's image gateway.
Changing a shared provider's gateway affects subsequent operations.
at line 237
StoreGateway
storeGateway()
Get the provider's store gateway.
in
HasStoreGateway at line 27
HasStoreGateway
useStoreGateway(StoreGateway $gateway)
Set the provider's store gateway.
Changing a shared provider's gateway affects subsequent operations.
at line 77
StepTextGateway
textGateway()
Get the provider's text gateway.
in
HasTextGateway at line 30
HasTextGateway
useTextGateway(StepTextGateway $gateway)
Set the provider's text gateway.
Changing a shared provider's gateway affects subsequent operations.
in
HasTextGateway at line 42
TextGenerationLoop
textGenerationLoop()
Get the multi-step text generation loop wrapping the provider's text gateway.
in
ManagesFiles at line 23
FileResponse
getFile(string $fileId)
Get a file by its ID.
in
ManagesFiles at line 31
StoredFileResponse
putFile(StorableFile $file)
Store the given file.
in
ManagesFiles at line 68
void
deleteFile(string $fileId)
Delete a file by its ID.
in
ManagesStores at line 30
Store
getStore(string $storeId)
Get a vector store by its ID.
in
ManagesStores at line 38
Store
createStore(string $name, string|null $description = null, Collection|null $fileIds = null, DateInterval|null $expiresWhenIdleFor = null)
Create a new vector store.
in
ManagesStores at line 87
string
addFileToStore(string $storeId, HasProviderId $file, array $metadata = [])
Add a file to a vector store.
in
ManagesStores at line 122
bool
removeFileFromStore(string $storeId, HasProviderId|string $documentId)
Remove a file from a vector store.
in
ManagesStores at line 162
bool
deleteStore(string $storeId)
Delete a vector store by its ID.
in
StreamsText at line 37
StreamableAgentResponse
stream(AgentPrompt $prompt)
Stream the response from the given agent.
at line 69
protected AzureOpenAiGateway
azureGateway()
Get the shared Azure OpenAI gateway instance.
at line 93
string
defaultTextModel()
Get the name of the default (deployment name) text model.
at line 101
string
cheapestTextModel()
Get the name of the cheapest text model.
at line 109
string
smartestTextModel()
Get the name of the smartest text model.
at line 125
string
defaultImageModel()
Get the name of the default image deployment.
at line 133
array
defaultImageOptions(string|null $size = null, string|null $quality = null)
Get the default / normalized image options for the provider.
at line 149
string
defaultEmbeddingsModel()
Get the name of the default embeddings model.
at line 157
int
defaultEmbeddingsDimensions()
Get the default dimensions of the default embeddings model.
at line 165
array
fileSearchToolOptions(FileSearch $search)
Get the file search tool options for the provider.
at line 179
array
codeExecutionToolOptions(CodeExecution $codeExecution)
Get the code execution tool options for the provider.
at line 189
array
webSearchToolOptions(WebSearch $search)
Get the web search tool options for the provider.