From 3bbd267bd024f7ca2d09aea84b9c8eb89535973a Mon Sep 17 00:00:00 2001 From: Ishaan Jaff Date: Mon, 15 Apr 2024 18:15:15 -0700 Subject: [PATCH] docs - viewing if model supports vision --- docs/my-website/docs/completion/vision.md | 45 +++++++++++++++++++++++ docs/my-website/sidebars.js | 1 + 2 files changed, 46 insertions(+) create mode 100644 docs/my-website/docs/completion/vision.md diff --git a/docs/my-website/docs/completion/vision.md b/docs/my-website/docs/completion/vision.md new file mode 100644 index 0000000000..ea04b1e1e1 --- /dev/null +++ b/docs/my-website/docs/completion/vision.md @@ -0,0 +1,45 @@ +# Using Vision Models + +## Quick Start +Example passing images to a model + +```python +import os +from litellm import completion + +os.environ["OPENAI_API_KEY"] = "your-api-key" + +# openai call +response = completion( + model = "gpt-4-vision-preview", + messages=[ + { + "role": "user", + "content": [ + { + "type": "text", + "text": "What’s in this image?" + }, + { + "type": "image_url", + "image_url": { + "url": "https://upload.wikimedia.org/wikipedia/commons/thumb/d/dd/Gfp-wisconsin-madison-the-nature-boardwalk.jpg/2560px-Gfp-wisconsin-madison-the-nature-boardwalk.jpg" + } + } + ] + } + ], +) + +``` + +## Checking if a model supports `vision` + +Use `litellm.supports_vision(model="")` -> returns `True` if model supports `vision` and `False` if not + +```python +assert litellm.supports_vision(model="gpt-4-vision-preview") == True +assert litellm.supports_vision(model="gemini-1.0-pro-visionn") == True +assert litellm.supports_vision(model="gpt-3.5-turbo") == False +``` + diff --git a/docs/my-website/sidebars.js b/docs/my-website/sidebars.js index bf1ef6f149..3dc20cdd43 100644 --- a/docs/my-website/sidebars.js +++ b/docs/my-website/sidebars.js @@ -86,6 +86,7 @@ const sidebars = { "completion/stream", "completion/message_trimming", "completion/function_call", + "completion/vision", "completion/model_alias", "completion/batching", "completion/mock_requests",