Preparing search index...
The search index is not available
LangChain.js - v0.0.213
LangChain.js
langchain-openai
formatToOpenAITool
Function formatToOpenAITool
format
To
OpenAITool
(
tool
)
:
OpenAIClient.Chat.ChatCompletionTool
Parameters
tool
:
StructuredToolInterface
<
ZodObject
<
any
,
any
,
any
,
any
,
{}
>
>
Returns
OpenAIClient.Chat.ChatCompletionTool
Settings
Member Visibility
Protected
Inherited
Theme
OS
Light
Dark
Lang
Chain.js -
v0.0.213
langchain-
anthropic
langchain-
community/agents/toolkits/aws_
sfn
langchain-
community/agents/toolkits/base
langchain-
community/agents/toolkits/connery
langchain-
community/caches/cloudflare_
kv
langchain-
community/caches/ioredis
langchain-
community/caches/momento
langchain-
community/caches/upstash_
redis
langchain-
community/callbacks/handlers/llmonitor
langchain-
community/chat_
models/baiduwenxin
langchain-
community/chat_
models/bedrock
langchain-
community/chat_
models/bedrock/web
langchain-
community/chat_
models/cloudflare_
workersai
langchain-
community/chat_
models/fireworks
langchain-
community/chat_
models/googlepalm
langchain-
community/chat_
models/googlevertexai
langchain-
community/chat_
models/googlevertexai/web
langchain-
community/chat_
models/iflytek_
xinghuo
langchain-
community/chat_
models/iflytek_
xinghuo/web
langchain-
community/chat_
models/llama_
cpp
langchain-
community/chat_
models/minimax
langchain-
community/chat_
models/ollama
langchain-
community/chat_
models/portkey
langchain-
community/chat_
models/yandex
langchain-
community/document_
transformers/html_
to_
text
langchain-
community/document_
transformers/mozilla_
readability
langchain-
community/embeddings/bedrock
langchain-
community/embeddings/cloudflare_
workersai
langchain-
community/embeddings/cohere
langchain-
community/embeddings/googlepalm
langchain-
community/embeddings/googlevertexai
langchain-
community/embeddings/gradient_
ai
langchain-
community/embeddings/hf
langchain-
community/embeddings/hf_
transformers
langchain-
community/embeddings/llama_
cpp
langchain-
community/embeddings/minimax
langchain-
community/embeddings/ollama
langchain-
community/embeddings/tensorflow
langchain-
community/embeddings/togetherai
langchain-
community/embeddings/voyage
langchain-
community/graphs/neo4j_
graph
langchain-
community/llms/ai21
langchain-
community/llms/aleph_
alpha
langchain-
community/llms/bedrock
langchain-
community/llms/bedrock/web
langchain-
community/llms/cloudflare_
workersai
langchain-
community/llms/cohere
langchain-
community/llms/fireworks
langchain-
community/llms/googlepalm
langchain-
community/llms/googlevertexai
langchain-
community/llms/googlevertexai/web
langchain-
community/llms/gradient_
ai
langchain-
community/llms/hf
langchain-
community/llms/llama_
cpp
langchain-
community/llms/ollama
langchain-
community/llms/portkey
langchain-
community/llms/raycast
langchain-
community/llms/replicate
langchain-
community/llms/sagemaker_
endpoint
langchain-
community/llms/togetherai
langchain-
community/llms/watsonx_
ai
langchain-
community/llms/writer
langchain-
community/llms/yandex
langchain-
community/load
langchain-
community/load/serializable
langchain-
community/memory/chat_
memory
langchain-
community/memory/motorhead_
memory
langchain-
community/memory/zep
langchain-
community/retrievers/amazon_
kendra
langchain-
community/retrievers/chaindesk
langchain-
community/retrievers/databerry
langchain-
community/retrievers/metal
langchain-
community/retrievers/supabase
langchain-
community/retrievers/tavily_
search_
api
langchain-
community/retrievers/vectara_
summary
langchain-
community/retrievers/zep
langchain-
community/storage/convex
langchain-
community/storage/ioredis
langchain-
community/storage/upstash_
redis
langchain-
community/storage/vercel_
kv
langchain-
community/stores/doc/base
langchain-
community/stores/doc/in_
memory
langchain-
community/stores/message/cassandra
langchain-
community/stores/message/cloudflare_
d1
langchain-
community/stores/message/convex
langchain-
community/stores/message/dynamodb
langchain-
community/stores/message/firestore
langchain-
community/stores/message/in_
memory
langchain-
community/stores/message/ioredis
langchain-
community/stores/message/momento
langchain-
community/stores/message/mongodb
langchain-
community/stores/message/planetscale
langchain-
community/stores/message/redis
langchain-
community/stores/message/upstash_
redis
langchain-
community/stores/message/xata
langchain-
community/tools/aiplugin
langchain-
community/tools/aws_
lambda
langchain-
community/tools/aws_
sfn
langchain-
community/tools/bingserpapi
langchain-
community/tools/brave_
search
langchain-
community/tools/connery
langchain-
community/tools/dadjokeapi
langchain-
community/tools/dataforseo_
api_
search
langchain-
community/tools/discord
langchain-
community/tools/dynamic
langchain-
community/tools/gmail
langchain-
community/tools/google_
custom_
search
langchain-
community/tools/google_
places
langchain-
community/tools/ifttt
langchain-
community/tools/searchapi
langchain-
community/tools/searxng_
search
langchain-
community/tools/serpapi
langchain-
community/tools/serper
langchain-
community/tools/tavily_
search
langchain-
community/tools/wikipedia_
query_
run
langchain-
community/tools/wolframalpha
langchain-
community/utils/convex
langchain-
community/utils/event_
source_
parse
langchain-
community/vectorstores/analyticdb
langchain-
community/vectorstores/astradb
langchain-
community/vectorstores/azure_
cosmosdb
langchain-
community/vectorstores/cassandra
langchain-
community/vectorstores/chroma
langchain-
community/vectorstores/clickhouse
langchain-
community/vectorstores/closevector/node
langchain-
community/vectorstores/closevector/web
langchain-
community/vectorstores/cloudflare_
vectorize
langchain-
community/vectorstores/convex
langchain-
community/vectorstores/elasticsearch
langchain-
community/vectorstores/faiss
langchain-
community/vectorstores/googlevertexai
langchain-
community/vectorstores/hnswlib
langchain-
community/vectorstores/lancedb
langchain-
community/vectorstores/milvus
langchain-
community/vectorstores/momento_
vector_
index
langchain-
community/vectorstores/mongodb_
atlas
langchain-
community/vectorstores/myscale
langchain-
community/vectorstores/neo4j_
vector
langchain-
community/vectorstores/opensearch
langchain-
community/vectorstores/pgvector
langchain-
community/vectorstores/pinecone
langchain-
community/vectorstores/prisma
langchain-
community/vectorstores/qdrant
langchain-
community/vectorstores/redis
langchain-
community/vectorstores/rockset
langchain-
community/vectorstores/singlestore
langchain-
community/vectorstores/supabase
langchain-
community/vectorstores/tigris
langchain-
community/vectorstores/typeorm
langchain-
community/vectorstores/typesense
langchain-
community/vectorstores/usearch
langchain-
community/vectorstores/vectara
langchain-
community/vectorstores/vercel_
postgres
langchain-
community/vectorstores/voy
langchain-
community/vectorstores/weaviate
langchain-
community/vectorstores/xata
langchain-
community/vectorstores/zep
langchain-
google-
genai
langchain-
mistralai
langchain-
openai
Azure
Chat
OpenAI
Azure
OpenAI
Chat
OpenAI
OpenAI
OpenAIChat
OpenAIEmbeddings
Azure
OpenAIInput
Chat
OpenAICall
Options
Legacy
OpenAIInput
OpenAIBase
Input
OpenAICall
Options
OpenAIChat
Call
Options
OpenAIChat
Input
OpenAIEmbeddings
Params
OpenAIEndpoint
Config
OpenAIInput
OpenAICore
Request
Options
format
To
OpenAIAssistant
Tool
format
To
OpenAIFunction
format
To
OpenAITool
get
Endpoint
message
To
OpenAIRole
wrap
OpenAIClient
Error
langchain/agents
langchain/agents/format_
scratchpad/log
langchain/agents/format_
scratchpad/log_
to_
message
langchain/agents/format_
scratchpad/openai_
functions
langchain/agents/format_
scratchpad/openai_
tools
langchain/agents/format_
scratchpad/xml
langchain/agents/load
langchain/agents/openai/output_
parser
langchain/agents/react/output_
parser
langchain/agents/toolkits
langchain/agents/toolkits/aws_
sfn
langchain/agents/toolkits/connery
langchain/agents/toolkits/sql
langchain/agents/xml/output_
parser
langchain/base_
language
langchain/cache
langchain/cache/cloudflare_
kv
langchain/cache/file_
system
langchain/cache/ioredis
langchain/cache/momento
langchain/cache/redis
langchain/cache/upstash_
redis
langchain/callbacks
langchain/callbacks/handlers/llmonitor
langchain/chains
langchain/chains/combine_
documents
langchain/chains/combine_
documents/reduce
langchain/chains/graph_
qa/cypher
langchain/chains/history_
aware_
retriever
langchain/chains/load
langchain/chains/openai_
functions
langchain/chains/query_
constructor
langchain/chains/query_
constructor/ir
langchain/chains/retrieval
langchain/chains/sql_
db
langchain/chat_
models/anthropic
langchain/chat_
models/baiduwenxin
langchain/chat_
models/base
langchain/chat_
models/bedrock
langchain/chat_
models/bedrock/web
langchain/chat_
models/cloudflare_
workersai
langchain/chat_
models/fake
langchain/chat_
models/fireworks
langchain/chat_
models/googlepalm
langchain/chat_
models/googlevertexai
langchain/chat_
models/googlevertexai/web
langchain/chat_
models/iflytek_
xinghuo
langchain/chat_
models/iflytek_
xinghuo/web
langchain/chat_
models/llama_
cpp
langchain/chat_
models/minimax
langchain/chat_
models/ollama
langchain/chat_
models/openai
langchain/chat_
models/portkey
langchain/chat_
models/yandex
langchain/document
langchain/document_
loaders/base
langchain/document_
loaders/fs/buffer
langchain/document_
loaders/fs/chatgpt
langchain/document_
loaders/fs/csv
langchain/document_
loaders/fs/directory
langchain/document_
loaders/fs/docx
langchain/document_
loaders/fs/epub
langchain/document_
loaders/fs/json
langchain/document_
loaders/fs/notion
langchain/document_
loaders/fs/obsidian
langchain/document_
loaders/fs/openai_
whisper_
audio
langchain/document_
loaders/fs/pdf
langchain/document_
loaders/fs/pptx
langchain/document_
loaders/fs/srt
langchain/document_
loaders/fs/text
langchain/document_
loaders/fs/unstructured
langchain/document_
loaders/web/apify_
dataset
langchain/document_
loaders/web/assemblyai
langchain/document_
loaders/web/azure_
blob_
storage_
container
langchain/document_
loaders/web/azure_
blob_
storage_
file
langchain/document_
loaders/web/cheerio
langchain/document_
loaders/web/college_
confidential
langchain/document_
loaders/web/confluence
langchain/document_
loaders/web/figma
langchain/document_
loaders/web/gitbook
langchain/document_
loaders/web/github
langchain/document_
loaders/web/hn
langchain/document_
loaders/web/imsdb
langchain/document_
loaders/web/notionapi
langchain/document_
loaders/web/notiondb
langchain/document_
loaders/web/pdf
langchain/document_
loaders/web/playwright
langchain/document_
loaders/web/puppeteer
langchain/document_
loaders/web/recursive_
url
langchain/document_
loaders/web/s3
langchain/document_
loaders/web/searchapi
langchain/document_
loaders/web/serpapi
langchain/document_
loaders/web/sonix_
audio
langchain/document_
loaders/web/sort_
xyz_
blockchain
langchain/document_
loaders/web/youtube
langchain/document_
transformers/html_
to_
text
langchain/document_
transformers/mozilla_
readability
langchain/document_
transformers/openai_
functions
langchain/embeddings/base
langchain/embeddings/bedrock
langchain/embeddings/cache_
backed
langchain/embeddings/cloudflare_
workersai
langchain/embeddings/cohere
langchain/embeddings/fake
langchain/embeddings/googlepalm
langchain/embeddings/googlevertexai
langchain/embeddings/gradient_
ai
langchain/embeddings/hf
langchain/embeddings/hf_
transformers
langchain/embeddings/llama_
cpp
langchain/embeddings/minimax
langchain/embeddings/ollama
langchain/embeddings/openai
langchain/embeddings/tensorflow
langchain/embeddings/voyage
langchain/evaluation
langchain/experimental/autogpt
langchain/experimental/babyagi
langchain/experimental/chains/violation_
of_
expectations
langchain/experimental/chat_
models/anthropic_
functions
langchain/experimental/chat_
models/bittensor
langchain/experimental/chat_
models/ollama_
functions
langchain/experimental/generative_
agents
langchain/experimental/hubs/makersuite/googlemakersuitehub
langchain/experimental/llms/bittensor
langchain/experimental/masking
langchain/experimental/multimodal_
embeddings/googlevertexai
langchain/experimental/openai_
assistant
langchain/experimental/openai_
files
langchain/experimental/plan_
and_
execute
langchain/experimental/tools/pyinterpreter
langchain/graphs/neo4j_
graph
langchain/hub
langchain/llms/ai21
langchain/llms/aleph_
alpha
langchain/llms/base
langchain/llms/bedrock
langchain/llms/bedrock/web
langchain/llms/cloudflare_
workersai
langchain/llms/cohere
langchain/llms/fake
langchain/llms/fireworks
langchain/llms/googlepalm
langchain/llms/googlevertexai
langchain/llms/googlevertexai/web
langchain/llms/gradient_
ai
langchain/llms/hf
langchain/llms/llama_
cpp
langchain/llms/load
langchain/llms/ollama
langchain/llms/openai
langchain/llms/portkey
langchain/llms/raycast
langchain/llms/replicate
langchain/llms/sagemaker_
endpoint
langchain/llms/watsonx_
ai
langchain/llms/writer
langchain/llms/yandex
langchain/load
langchain/load/serializable
langchain/memory
langchain/memory/zep
langchain/output_
parsers
langchain/output_
parsers/expression
langchain/prompts
langchain/prompts/load
langchain/retrievers/amazon_
kendra
langchain/retrievers/chaindesk
langchain/retrievers/contextual_
compression
langchain/retrievers/databerry
langchain/retrievers/document_
compressors
langchain/retrievers/document_
compressors/chain_
extract
langchain/retrievers/document_
compressors/embeddings_
filter
langchain/retrievers/hyde
langchain/retrievers/metal
langchain/retrievers/multi_
query
langchain/retrievers/multi_
vector
langchain/retrievers/parent_
document
langchain/retrievers/remote
langchain/retrievers/score_
threshold
langchain/retrievers/self_
query
langchain/retrievers/self_
query/chroma
langchain/retrievers/self_
query/functional
langchain/retrievers/self_
query/pinecone
langchain/retrievers/self_
query/supabase
langchain/retrievers/self_
query/vectara
langchain/retrievers/self_
query/weaviate
langchain/retrievers/supabase
langchain/retrievers/tavily_
search_
api
langchain/retrievers/time_
weighted
langchain/retrievers/vectara_
summary
langchain/retrievers/vespa
langchain/retrievers/zep
langchain/runnables
langchain/runnables/remote
langchain/schema
langchain/schema/document
langchain/schema/output_
parser
langchain/schema/prompt_
template
langchain/schema/query_
constructor
langchain/schema/retriever
langchain/schema/runnable
langchain/schema/storage
langchain/sql_
db
langchain/storage/convex
langchain/storage/encoder_
backed
langchain/storage/file_
system
langchain/storage/in_
memory
langchain/storage/ioredis
langchain/storage/upstash_
redis
langchain/storage/vercel_
kv
langchain/stores/doc/gcs
langchain/stores/doc/in_
memory
langchain/stores/file/in_
memory
langchain/stores/file/node
langchain/stores/message/cassandra
langchain/stores/message/cloudflare_
d1
langchain/stores/message/convex
langchain/stores/message/dynamodb
langchain/stores/message/firestore
langchain/stores/message/in_
memory
langchain/stores/message/ioredis
langchain/stores/message/momento
langchain/stores/message/mongodb
langchain/stores/message/planetscale
langchain/stores/message/redis
langchain/stores/message/upstash_
redis
langchain/stores/message/xata
langchain/text_
splitter
langchain/tools
langchain/tools/aws_
lambda
langchain/tools/aws_
sfn
langchain/tools/calculator
langchain/tools/connery
langchain/tools/gmail
langchain/tools/google_
calendar
langchain/tools/google_
places
langchain/tools/render
langchain/tools/retriever
langchain/tools/sql
langchain/tools/webbrowser
langchain/util/convex
langchain/util/document
langchain/util/math
langchain/util/time
langchain/vectorstores/analyticdb
langchain/vectorstores/base
langchain/vectorstores/cassandra
langchain/vectorstores/chroma
langchain/vectorstores/clickhouse
langchain/vectorstores/closevector/node
langchain/vectorstores/closevector/web
langchain/vectorstores/cloudflare_
vectorize
langchain/vectorstores/convex
langchain/vectorstores/elasticsearch
langchain/vectorstores/faiss
langchain/vectorstores/googlevertexai
langchain/vectorstores/hnswlib
langchain/vectorstores/lancedb
langchain/vectorstores/memory
langchain/vectorstores/milvus
langchain/vectorstores/momento_
vector_
index
langchain/vectorstores/mongo
langchain/vectorstores/mongodb_
atlas
langchain/vectorstores/myscale
langchain/vectorstores/neo4j_
vector
langchain/vectorstores/opensearch
langchain/vectorstores/pgvector
langchain/vectorstores/pinecone
langchain/vectorstores/prisma
langchain/vectorstores/qdrant
langchain/vectorstores/redis
langchain/vectorstores/rockset
langchain/vectorstores/singlestore
langchain/vectorstores/supabase
langchain/vectorstores/tigris
langchain/vectorstores/typeorm
langchain/vectorstores/typesense
langchain/vectorstores/usearch
langchain/vectorstores/vectara
langchain/vectorstores/vercel_
postgres
langchain/vectorstores/voy
langchain/vectorstores/weaviate
langchain/vectorstores/xata
langchain/vectorstores/zep
Generated using
TypeDoc