Phidata uses OpenAIEmbedder as the default embeder for the vector database. The OpenAIEmbedder class is used to embed text data into vectors using the OpenAI API. Get your key from here.
Usage
cookbook/embedders/openai_embedder.py
from phi.agent import AgentKnowledgefrom phi.vectordb.pgvector import PgVectorfrom phi.embedder.openai import OpenAIEmbedderembeddings = OpenAIEmbedder().get_embedding("Embed me")# Print the embeddings and their dimensionsprint(f"Embeddings: {embeddings[:5]}")print(f"Dimensions: {len(embeddings)}")# Example usage:knowledge_base = AgentKnowledge( vector_db=PgVector( db_url="postgresql+psycopg://ai:ai@localhost:5532/ai", table_name="openai_embeddings", embedder=OpenAIEmbedder(), ), num_documents=2,)
Params
Parameter
Type
Default
Description
model
str
"text-embedding-ada-002"
The name of the model used for generating embeddings.
dimensions
int
1536
The dimensionality of the embeddings generated by the model.
encoding_format
Literal['float', 'base64']
"float"
The format in which the embeddings are encoded. Options are “float” or “base64”.
user
str
-
The user associated with the API request.
api_key
str
-
The API key used for authenticating requests.
organization
str
-
The organization associated with the API request.
base_url
str
-
The base URL for the API endpoint.
request_params
Optional[Dict[str, Any]]
-
Additional parameters to include in the API request.
client_params
Optional[Dict[str, Any]]
-
Additional parameters for configuring the API client.
openai_client
Optional[OpenAIClient]
-
An instance of the OpenAIClient to use for making API requests.
Was this page helpful?
{"docsConfig":{"$schema":"https://mintlify.com/docs.json","theme":"mint","name":"Phidata","colors":{"primary":"#FF4017","light":"#FF4017","dark":"#FF4017"},"favicon":"/favicon.png","logo":{"light":"https://mintcdn.com/phidata/lFNPEd2VNpWeOyVb/logo/light.svg?fit=max\u0026auto=format\u0026n=lFNPEd2VNpWeOyVb\u0026q=85\u0026s=f370694cd3cb79086e8da78f8cc8430b","dark":"https://mintcdn.com/phidata/lFNPEd2VNpWeOyVb/logo/dark.svg?fit=max\u0026auto=format\u0026n=lFNPEd2VNpWeOyVb\u0026q=85\u0026s=a05fc8a1e8a2fffee5af26d7e373e7ac"},"background":{"decoration":null,"color":{"light":"#FFFFFF","dark":"#111113"}},"navbar":{"links":[{"label":"Discord","href":"https://phidata.link/discord"},{"label":"Community","href":"https://community.phidata.com/"},{"label":"Log In","href":"https://phidata.app"}],"primary":{"type":"github","href":"https://github.com/agno-agi/phidata"}},"footer":{"socials":{"x":"https://x.com/phidatahq","github":"https://github.com/agno-agi/phidata","discord":"https://phidata.link/discord","youtube":"https://phidata.link/youtube","website":"https://phidata.com"}},"fonts":{"heading":{"family":"Inter","weight":900},"body":{"family":"Inter","weight":400}},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"phidata","hasAudioNarration":false,"actualSubdomain":"phidata","customDomains":["docs.phidata.com"],"gitSource":{"type":"github","owner":"agno-agi","repo":"phidata-docs","deployBranch":"main","contentDirectory":"","isPrivate":false,"mountPath":"","label":""},"feedback":{"thumbs":true,"edits":false,"issues":false},"entitlements":{"AI_CHAT":{"status":"DISABLED"}},"buildId":"6ae91e1edad76a2288f7e42e:success","clientVersion":"0.0.4177","searchFilterCounts":[{"language":"default","tag":"Documentation","count":284},{"language":"default","tag":"Examples","count":121},{"language":"default","tag":"Reference","count":65},{"language":"default","tag":"Models","count":57},{"language":"default","tag":"Tools","count":57},{"language":"default","tag":"Building Blocks","count":48},{"language":"default","tag":"Agents","count":36},{"language":"default","tag":"Templates","count":35},{"language":"default","tag":"Knowledge","count":17},{"language":"default","tag":"Command Line","count":17}]},"assistantConfig":{},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-rbac-roles","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"starter-pricing","enabled":true,"variant":{"name":"control","enabled":true,"payload":{"type":"string","value":"control"},"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"embedder/openai","slug":"/embedder/openai","pageMetadata":{"title":"OpenAI Embedder","sidebarTitle":"OpenAI","description":null,"href":"/embedder/openai"},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={a:`a`,code:`code`,p:`p`,pre:`pre`,span:`span`,tbody:`tbody`,td:`td`,th:`th`,thead:`thead`,tr:`tr`,..._provideComponents(),...props.components},{CodeBlock,Heading,Table}=_components;if(!CodeBlock)_missingMdxReference(`CodeBlock`,true);if(!Heading)_missingMdxReference(`Heading`,true);if(!Table)_missingMdxReference(`Table`,true);return _jsxs(_Fragment,{children:[_jsxs(_components.p,{children:[`Phidata uses `,_jsx(_components.code,{children:`OpenAIEmbedder`}),` as the default embeder for the vector database. The `,_jsx(_components.code,{children:`OpenAIEmbedder`}),` class is used to embed text data into vectors using the OpenAI API. Get your key from `,_jsx(_components.a,{href:`https://platform.openai.com/api-keys`,children:`here`}),`.`]}),`\n`,_jsx(Heading,{level:`2`,id:`usage`,children:`Usage`}),`\n`,_jsx(CodeBlock,{filename:`cookbook/embedders/openai_embedder.py`,numberOfLines:`19`,language:`python`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`python`,children:_jsxs(_components.code,{language:`python`,numberOfLines:`19`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#C586C0`},children:`from`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` phi.agent `}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#C586C0`},children:`import`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` AgentKnowledge`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#C586C0`},children:`from`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` phi.vectordb.pgvector `}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#C586C0`},children:`import`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` PgVector`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#C586C0`},children:`from`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` phi.embedder.openai `}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#C586C0`},children:`import`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` OpenAIEmbedder`})]}),`\n`,_jsx(_components.span,{className:`line`}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`embeddings `}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:`=`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` OpenAIEmbedder().get_embedding(`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"Embed me\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`)`})]}),`\n`,_jsx(_components.span,{className:`line`}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#6E7781`,\"--shiki-dark\":`#6A9955`},children:`# Print the embeddings and their dimensions`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#DCDCAA`},children:`print`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`(`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#569CD6`},children:`f`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"Embeddings: `}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#569CD6`},children:`{`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`embeddings[:`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#B5CEA8`},children:`5`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`]`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#569CD6`},children:`}`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`)`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#DCDCAA`},children:`print`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`(`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#569CD6`},children:`f`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"Dimensions: `}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#569CD6`},children:`{`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#DCDCAA`},children:`len`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`(embeddings)`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#569CD6`},children:`}`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`)`})]}),`\n`,_jsx(_components.span,{className:`line`}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#6E7781`,\"--shiki-dark\":`#6A9955`},children:`# Example usage:`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`knowledge_base `}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:`=`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` AgentKnowledge(`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#9CDCFE`},children:` vector_db`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:`=`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`PgVector(`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#9CDCFE`},children:` db_url`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:`=`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"postgresql+psycopg://ai:ai@localhost:5532/ai\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#9CDCFE`},children:` table_name`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:`=`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"openai_embeddings\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#9CDCFE`},children:` embedder`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:`=`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`OpenAIEmbedder(),`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` ),`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#9CDCFE`},children:` num_documents`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:`=`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#B5CEA8`},children:`2`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`)`})}),`\n`]})})}),`\n`,_jsx(Heading,{level:`2`,id:`params`,children:`Params`}),`\n`,_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:`Parameter`}),_jsx(_components.th,{children:`Type`}),_jsx(_components.th,{children:`Default`}),_jsx(_components.th,{children:`Description`})]})}),_jsxs(_components.tbody,{children:[_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`model`})}),_jsx(_components.td,{children:_jsx(_components.code,{children:`str`})}),_jsx(_components.td,{children:_jsx(_components.code,{children:`\"text-embedding-ada-002\"`})}),_jsx(_components.td,{children:`The name of the model used for generating embeddings.`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`dimensions`})}),_jsx(_components.td,{children:_jsx(_components.code,{children:`int`})}),_jsx(_components.td,{\"data-numeric\":`true`,children:_jsx(_components.code,{children:`1536`})}),_jsx(_components.td,{children:`The dimensionality of the embeddings generated by the model.`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`encoding_format`})}),_jsx(_components.td,{children:_jsx(_components.code,{children:`Literal['float', 'base64']`})}),_jsx(_components.td,{children:_jsx(_components.code,{children:`\"float\"`})}),_jsx(_components.td,{children:`The format in which the embeddings are encoded. Options are “float” or “base64”.`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`user`})}),_jsx(_components.td,{children:_jsx(_components.code,{children:`str`})}),_jsx(_components.td,{\"data-numeric\":`true`,children:`-`}),_jsx(_components.td,{children:`The user associated with the API request.`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`api_key`})}),_jsx(_components.td,{children:_jsx(_components.code,{children:`str`})}),_jsx(_components.td,{\"data-numeric\":`true`,children:`-`}),_jsx(_components.td,{children:`The API key used for authenticating requests.`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`organization`})}),_jsx(_components.td,{children:_jsx(_components.code,{children:`str`})}),_jsx(_components.td,{\"data-numeric\":`true`,children:`-`}),_jsx(_components.td,{children:`The organization associated with the API request.`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`base_url`})}),_jsx(_components.td,{children:_jsx(_components.code,{children:`str`})}),_jsx(_components.td,{\"data-numeric\":`true`,children:`-`}),_jsx(_components.td,{children:`The base URL for the API endpoint.`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`request_params`})}),_jsx(_components.td,{children:_jsx(_components.code,{children:`Optional[Dict[str, Any]]`})}),_jsx(_components.td,{\"data-numeric\":`true`,children:`-`}),_jsx(_components.td,{children:`Additional parameters to include in the API request.`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`client_params`})}),_jsx(_components.td,{children:_jsx(_components.code,{children:`Optional[Dict[str, Any]]`})}),_jsx(_components.td,{\"data-numeric\":`true`,children:`-`}),_jsx(_components.td,{children:`Additional parameters for configuring the API client.`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`openai_client`})}),_jsx(_components.td,{children:_jsx(_components.code,{children:`Optional[OpenAIClient]`})}),_jsx(_components.td,{\"data-numeric\":`true`,children:`-`}),_jsx(_components.td,{children:`An instance of the OpenAIClient to use for making API requests.`})]})]})]})]})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent};function _missingMdxReference(id,component){throw new Error(`Expected `+(component?`component`:`object`)+\" `\"+id+\"` to be defined: you likely forgot to import, pass, or provide it.\")}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"OpenAI Embedder","sidebarTitle":"OpenAI","description":null,"href":"/embedder/openai"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[{"title":"Usage","slug":"usage","depth":2,"children":[]},{"title":"Params","slug":"params","depth":2,"children":[]}],"codeExamples":{}},"jsLinks":[],"subdomain":"phidata","siteName":"Phidata","title":"OpenAI Embedder - Phidata","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-01-07T00:43:02.930Z","originalFileLocation":"embedder/openai.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"application-name\" content=\"Phidata\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/phidata/hGIXTHAhsTYBzt64/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/phidata/hGIXTHAhsTYBzt64/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/phidata/hGIXTHAhsTYBzt64/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/phidata/hGIXTHAhsTYBzt64/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/phidata/hGIXTHAhsTYBzt64/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/phidata/hGIXTHAhsTYBzt64/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/phidata/hGIXTHAhsTYBzt64/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/phidata/hGIXTHAhsTYBzt64/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/phidata/hGIXTHAhsTYBzt64/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"OpenAI Embedder - Phidata\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Phidata\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.phidata.com/embedder/openai\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://phidata.mintlify.site/_mintlify/api/og/v2?division=Embeddings\u0026amp;title=OpenAI+Embedder\u0026amp;theme=00e04e33fe67c544e89882b4\u0026amp;signature=f7c9ae403707e54e60263bd1d34c49b2b0b73b0c250e859f661732af900a56de\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"OpenAI Embedder - Phidata\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://phidata.mintlify.site/_mintlify/api/og/v2?division=Embeddings\u0026amp;title=OpenAI+Embedder\u0026amp;theme=00e04e33fe67c544e89882b4\u0026amp;signature=f7c9ae403707e54e60263bd1d34c49b2b0b73b0c250e859f661732af900a56de\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/phidata/hGIXTHAhsTYBzt64/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Phidata\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#FF4017\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.phidata.com/embedder/openai\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/embedder/openai.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.phidata.com/#organization\",\"name\":\"Phidata\",\"url\":\"https://docs.phidata.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/phidata/lFNPEd2VNpWeOyVb/logo/light.svg?fit=max\u0026auto=format\u0026n=lFNPEd2VNpWeOyVb\u0026q=85\u0026s=f370694cd3cb79086e8da78f8cc8430b\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.phidata.com#website\",\"name\":\"Phidata\",\"url\":\"https://docs.phidata.com\",\"publisher\":{\"@id\":\"https://docs.phidata.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.phidata.com/embedder/openai#webpage\",\"url\":\"https://docs.phidata.com/embedder/openai\",\"name\":\"OpenAI Embedder\",\"dateModified\":\"2026-01-07T00:43:02.930Z\",\"isPartOf\":{\"@id\":\"https://docs.phidata.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.phidata.com/embedder/openai#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.phidata.com/embedder/openai#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Documentation\",\"item\":\"https://docs.phidata.com/agents/introduction\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Embeddings\",\"item\":\"https://docs.phidata.com/embedder/introduction\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"OpenAI Embedder\",\"item\":\"https://docs.phidata.com/embedder/openai\"}]},{\"@type\":[\"Article\",\"TechArticle\"],\"@id\":\"https://docs.phidata.com/embedder/openai#article\",\"headline\":\"OpenAI Embedder\",\"name\":\"OpenAI Embedder\",\"url\":\"https://docs.phidata.com/embedder/openai\",\"mainEntityOfPage\":{\"@id\":\"https://docs.phidata.com/embedder/openai#webpage\"},\"dateModified\":\"2026-01-07T00:43:02.930Z\",\"publisher\":{\"@id\":\"https://docs.phidata.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.phidata.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Phidata\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"Phidata\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/embedder/openai.md","siteName":"Phidata","nav":{"global":null,"tabs":[{"tab":"Documentation","groups":[{"group":"Getting Started","pages":[{"title":"Introduction","href":"/introduction"},{"title":"Agent UI","href":"/agent-ui"},{"title":"Examples","href":"/more-examples"},{"title":"Monitoring","href":"/monitoring"},{"title":"Workflows","href":"/workflows"},{"title":"Getting Help","href":"/getting-help"}]},{"group":"Documentation","pages":[{"group":"Agents","pages":[{"title":"Introduction","href":"/agents/introduction"},{"title":"Prompts","href":"/agents/prompts"},{"title":"Tools","href":"/agents/tools"},{"title":"Knowledge","href":"/agents/knowledge"},{"title":"Memory","href":"/agents/memory"},{"title":"Storage","href":"/agents/storage"},{"title":"Structured Output","href":"/agents/structured-output"},{"title":"Reasoning","href":"/agents/reasoning"},{"title":"Teams","href":"/agents/teams"}]},{"group":"Models","pages":[{"title":"Introduction","href":"/models/introduction"},{"title":"OpenAI","href":"/models/openai"},{"title":"OpenAI Like","href":"/models/openai-like"},{"title":"Anthropic Claude","href":"/models/anthropic"},{"title":"AWS Bedrock Claude","href":"/models/aws-bedrock"},{"title":"Azure","href":"/models/azure"},{"title":"Cohere","href":"/models/cohere"},{"title":"DeepSeek","href":"/models/deepseek"},{"title":"Fireworks","href":"/models/fireworks"},{"title":"Gemini - AI Studio","href":"/models/google"},{"title":"Gemini - VertexAI","href":"/models/vertexai"},{"title":"Groq","href":"/models/groq"},{"title":"HuggingFace","href":"/models/huggingface"},{"title":"Mistral","href":"/models/mistral"},{"title":"Nvidia","href":"/models/nvidia"},{"title":"Ollama","href":"/models/ollama"},{"title":"OpenRouter","href":"/models/openrouter"},{"title":"Sambanova","href":"/models/sambanova"},{"title":"Together","href":"/models/together"},{"title":"xAI","href":"/models/xai"}]},{"group":"Tools","pages":[{"title":"Introduction","href":"/tools/introduction"},{"title":"Functions","href":"/tools/functions"},{"title":"Toolkits","href":"/tools/toolkits"},{"title":"Writing your own Toolkit","href":"/tools/custom-toolkits"},{"title":"Airflow","href":"/tools/airflow"},{"title":"Apify","href":"/tools/apify"},{"title":"Arxiv","href":"/tools/arxiv"},{"title":"AWS Lambda","href":"/tools/aws_lambda"},{"title":"BaiduSearch","sidebarTitle":"BaiduSearch","href":"/tools/baidusearch"},{"title":"Calculator","href":"/tools/calculator"},{"title":"Cal.com","href":"/tools/calcom"},{"title":"Composio","href":"/tools/composio"},{"title":"Crawl4AI","href":"/tools/crawl4ai"},{"title":"CSV","href":"/tools/csv"},{"title":"Dalle","href":"/tools/dalle"},{"title":"DuckDb","href":"/tools/duckdb"},{"title":"DuckDuckGo","sidebarTitle":"DuckDuckGo","href":"/tools/duckduckgo"},{"title":"Email","href":"/tools/email"},{"title":"Exa","href":"/tools/exa"},{"title":"Fal","href":"/tools/fal"},{"title":"File","href":"/tools/file"},{"title":"Firecrawl","href":"/tools/firecrawl"},{"title":"Giphy","href":"/tools/giphy"},{"title":"Github","href":"/tools/github"},{"title":"Google Calendar","href":"/tools/googlecalendar"},{"title":"Google Search","href":"/tools/googlesearch"},{"title":"Hacker News","href":"/tools/hackernews"},{"title":"Jina Reader","href":"/tools/jina_reader"},{"title":"Jira","href":"/tools/jira"},{"title":"Linear","href":"/tools/linear"},{"title":"Lumalabs","href":"/tools/lumalabs"},{"title":"MLX Transcribe","href":"/tools/mlx_transcribe"},{"title":"ModelsLabs","href":"/tools/models_labs"},{"title":"Newspaper","href":"/tools/newspaper"},{"title":"Newspaper4k","href":"/tools/newspaper4k"},{"title":"OpenBB","href":"/tools/openbb"},{"title":"Pandas","href":"/tools/pandas"},{"title":"Phi","href":"/tools/phi"},{"title":"Postgres","href":"/tools/postgres"},{"title":"Pubmed","href":"/tools/pubmed"},{"title":"Python","sidebarTitle":"Python","href":"/tools/python"},{"title":"Replicate","href":"/tools/replicate"},{"title":"Resend","href":"/tools/resend"},{"title":"Searxng","href":"/tools/searxng"},{"title":"Serpapi","href":"/tools/serpapi"},{"title":"Shell","href":"/tools/shell"},{"title":"Slack","href":"/tools/slack"},{"title":"Sleep","href":"/tools/sleep"},{"title":"Spider","href":"/tools/spider"},{"title":"SQL","href":"/tools/sql"},{"title":"Tavily","href":"/tools/tavily"},{"title":"Twitter","href":"/tools/twitter"},{"title":"Website","href":"/tools/website"},{"title":"Wikipedia","href":"/tools/wikipedia"},{"title":"Youtube","href":"/tools/youtube"},{"title":"Zendesk","href":"/tools/zendesk"},{"title":"Zoom","href":"/tools/zoom"}]},{"group":"Knowledge","pages":[{"title":"Introduction","href":"/knowledge/introduction"},{"title":"ArXiv Knowledge Base","sidebarTitle":"ArXiv","href":"/knowledge/arxiv"},{"title":"Combined KnowledgeBase","sidebarTitle":"Combined","href":"/knowledge/combined"},{"title":"CSV Knowledge Base","sidebarTitle":"CSV","href":"/knowledge/csv"},{"title":"CSV URL Knowledge Base","sidebarTitle":"CSV URLs","href":"/knowledge/csv-url"},{"title":"Docx Knowledge Base","sidebarTitle":"Docx","href":"/knowledge/docx"},{"title":"Document Knowledge Base","sidebarTitle":"Document","href":"/knowledge/document"},{"title":"JSON Knowledge Base","sidebarTitle":"JSON","href":"/knowledge/json"},{"title":"LangChain Knowledge Base","sidebarTitle":"LangChain","href":"/knowledge/langchain"},{"title":"LlamaIndex Knowledge Base","sidebarTitle":"LlamaIndex","href":"/knowledge/llamaindex"},{"title":"PDF Knowledge Base","sidebarTitle":"PDF","href":"/knowledge/pdf"},{"title":"PDF URL Knowledge Base","sidebarTitle":"PDF URLs","href":"/knowledge/pdf-url"},{"title":"S3 PDF Knowledge Base","sidebarTitle":"S3 PDF","href":"/knowledge/s3_pdf"},{"title":"S3 Text Knowledge Base","sidebarTitle":"S3 Text","href":"/knowledge/s3_text"},{"title":"Text Knowledge Base","sidebarTitle":"Text","href":"/knowledge/text"},{"title":"Website Knowledge Base","sidebarTitle":"Website","href":"/knowledge/website"},{"title":"Wikipedia KnowledgeBase","sidebarTitle":"Wikipedia","href":"/knowledge/wikipedia"}]},{"group":"Chunking","pages":[{"title":"Fixed Size Chunking","href":"/chunking/fixed-size-chunking"},{"title":"Agentic Chunking","href":"/chunking/agentic-chunking"},{"title":"Semantic Chunking","href":"/chunking/semantic-chunking"},{"title":"Recursive Chunking","href":"/chunking/recursive-chunking"},{"title":"Document Chunking","href":"/chunking/document-chunking"}]},{"group":"VectorDbs","pages":[{"title":"Introduction","href":"/vectordb/introduction"},{"title":"PgVector Agent Knowledge","sidebarTitle":"PgVector","href":"/vectordb/pgvector"},{"title":"Qdrant Agent Knowledge","sidebarTitle":"Qdrant","href":"/vectordb/qdrant"},{"title":"Pinecone Agent Knowledge","sidebarTitle":"Pinecone","href":"/vectordb/pinecone"},{"title":"LanceDB Agent Knowledge","sidebarTitle":"LanceDB","href":"/vectordb/lancedb"},{"title":"ChromaDB Agent Knowledge","sidebarTitle":"ChromaDB","href":"/vectordb/chroma"},{"title":"SingleStore Agent Knowledge","sidebarTitle":"SingleStore","href":"/vectordb/singlestore"}]},{"group":"Storage","pages":[{"title":"Introduction","href":"/storage/introduction"},{"title":"Postgres Agent Storage","sidebarTitle":"Postgres","href":"/storage/postgres"},{"title":"Sqlite Agent Storage","sidebarTitle":"Sqlite","href":"/storage/sqlite"},{"title":"Singlestore Agent Storage","sidebarTitle":"Singlestore","href":"/storage/singlestore"},{"title":"DynamoDB Agent Storage","sidebarTitle":"DynamoDB","href":"/storage/dynamodb"},{"title":"JSON Agent Storage","sidebarTitle":"JSON","href":"/storage/json"},{"title":"YAML Agent Storage","sidebarTitle":"YAML","href":"/storage/yaml"}]},{"group":"Embeddings","pages":[{"title":"Introduction","description":null,"href":"/embedder/introduction"},{"title":"OpenAI Embedder","sidebarTitle":"OpenAI","href":"/embedder/openai"},{"title":"Gemini Embedder","sidebarTitle":"Gemini","description":null,"href":"/embedder/gemini"},{"title":"Ollama Embedder","sidebarTitle":"Ollama","href":"/embedder/ollama"},{"title":"Voyage AI Embedder","sidebarTitle":"Voyage AI","href":"/embedder/voyageai"},{"title":"Azure OpenAI Embedder","sidebarTitle":"Azure OpenAI","href":"/embedder/azure_openai"},{"title":"Mistral Embedder","sidebarTitle":"Mistral","href":"/embedder/mistral"},{"title":"Fireworks Embedder","sidebarTitle":"Fireworks","href":"/embedder/fireworks"},{"title":"Together Embedder","sidebarTitle":"Together","href":"/embedder/together"},{"title":"HuggingFace Embedder","sidebarTitle":"HuggingFace","href":"/embedder/huggingface"},{"title":"Qdrant FastEmbed Embedder","sidebarTitle":"Qdrant FastEmbed","href":"/embedder/qdrant_fastembed"},{"title":"SentenceTransformers Embedder","sidebarTitle":"SentenceTransformers","href":"/embedder/sentencetransformers"}]},{"group":"Workflows","pages":[{"title":"Introduction","href":"/workflows/introduction"},{"title":"Session State","href":"/workflows/session-state"},{"title":"Streaming","href":"/workflows/streaming"},{"title":"Advanced Example - News Report Generator","href":"/workflows/news-report-generator"}]}]},{"group":"How To","pages":[{"title":"Install \u0026 Upgrade","href":"/how-to/install"},{"title":"Upgrade to v2.5.0","href":"/migration/2-5-0"}]}]},{"tab":"Examples","pages":[{"title":"Examples","href":"/examples/introduction"}]},{"tab":"Templates","pages":[{"title":"Templates","href":"/templates/introduction"}]},{"tab":"Product Updates","pages":[{"title":"Product Updates","href":"/changelog/overview"}]},{"tab":"Reference","pages":[{"title":"Reference","href":"/reference/agent"}]},{"tab":"FAQs","pages":[{"title":"FAQs","href":"/faq/could-not-connect-to-docker"}]}]},"basePath":"","title":"OpenAI Embedder - Phidata","deploymentId":"dpl_HhUetB7eHHDAmK9T1Teip38TgFx9","buildId":"dpl_HhUetB7eHHDAmK9T1Teip38TgFx9","dynamics":[],"chunks":[]}