FrontendAdapter
Defined in: packages/ai.matey.types/src/adapters.ts:71
Frontend adapter interface.
Frontend adapters represent how developers want to interact with AI APIs. They normalize provider-specific request formats into universal IR and denormalize IR responses back to provider-specific formats.
Type Parameters
Section titled “Type Parameters”TRequest
Section titled “TRequest”TRequest = unknown
Provider-specific request type
TResponse
Section titled “TResponse”TResponse = unknown
Provider-specific response type
TStreamChunk
Section titled “TStreamChunk”TStreamChunk = unknown
Provider-specific stream chunk type
Properties
Section titled “Properties”metadata
Section titled “metadata”
readonlymetadata:AdapterMetadata
Defined in: packages/ai.matey.types/src/adapters.ts:75
Adapter metadata for identification and capabilities.
Methods
Section titled “Methods”fromIR()
Section titled “fromIR()”fromIR(
response):Promise<TResponse>
Defined in: packages/ai.matey.types/src/adapters.ts:94
Convert universal IR response to provider-specific format.
Parameters
Section titled “Parameters”response
Section titled “response”Universal IR response
Returns
Section titled “Returns”Promise<TResponse>
Provider-specific response object
Throws
Section titled “Throws”If conversion fails
fromIRStream()
Section titled “fromIRStream()”fromIRStream(
stream,options?):AsyncGenerator<TStreamChunk,void,undefined>
Defined in: packages/ai.matey.types/src/adapters.ts:104
Convert universal IR stream to provider-specific stream format.
Parameters
Section titled “Parameters”stream
Section titled “stream”Universal IR stream
options?
Section titled “options?”Optional stream conversion options (mode, transform, etc.)
Returns
Section titled “Returns”AsyncGenerator<TStreamChunk, void, undefined>
Provider-specific stream of chunks
Throws
Section titled “Throws”If stream processing fails
toIR()
Section titled “toIR()”toIR(
request):Promise<IRChatRequest>
Defined in: packages/ai.matey.types/src/adapters.ts:85
Convert provider-specific request to universal IR.
Parameters
Section titled “Parameters”request
Section titled “request”TRequest
Provider-specific request object
Returns
Section titled “Returns”Promise<IRChatRequest>
Universal IR request
Throws
Section titled “Throws”If request is invalid for this provider
Throws
Section titled “Throws”If conversion fails
validate()?
Section titled “validate()?”
optionalvalidate(request):Promise<void>
Defined in: packages/ai.matey.types/src/adapters.ts:115
Optional: Validate provider-specific request before conversion.
Parameters
Section titled “Parameters”request
Section titled “request”TRequest
Provider-specific request
Returns
Section titled “Returns”Promise<void>
Throws
Section titled “Throws”If request is invalid