feat(api): Add Vision endpoint. (#221)

Author: stainless-app[bot]

api.md

@@ -192,4 +192,4 @@ from writerai.types import VisionRequest, VisionResponse
 
 Methods:
 
-- <code title="post /v1/vision">client.vision.<a href="./src/writerai/resources/vision.py">analyze_images</a>(\*\*<a href="src/writerai/types/vision_analyze_images_params.py">params</a>) -> <a href="./src/writerai/types/vision_response.py">VisionResponse</a></code>
+- <code title="post /v1/vision">client.vision.<a href="./src/writerai/resources/vision.py">analyze</a>(\*\*<a href="src/writerai/types/vision_analyze_params.py">params</a>) -> <a href="./src/writerai/types/vision_response.py">VisionResponse</a></code>

src/writerai/resources/vision.py

@@ -6,7 +6,7 @@
 
 import httpx
 
-from ..types import vision_analyze_images_params
+from ..types import vision_analyze_params
 from .._types import NOT_GIVEN, Body, Query, Headers, NotGiven
 from .._utils import (
     maybe_transform,
@@ -46,12 +46,12 @@ def with_streaming_response(self) -> VisionResourceWithStreamingResponse:
         """
         return VisionResourceWithStreamingResponse(self)
 
-    def analyze_images(
+    def analyze(
         self,
         *,
         model: str,
         prompt: str,
-        variables: Iterable[vision_analyze_images_params.Variable],
+        variables: Iterable[vision_analyze_params.Variable],
         # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
         # The extra values given here take precedence over values defined on the client or passed to this method.
         extra_headers: Headers | None = None,
@@ -86,7 +86,7 @@ def analyze_images(
                     "prompt": prompt,
                     "variables": variables,
                 },
-                vision_analyze_images_params.VisionAnalyzeImagesParams,
+                vision_analyze_params.VisionAnalyzeParams,
             ),
             options=make_request_options(
                 extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
@@ -115,12 +115,12 @@ def with_streaming_response(self) -> AsyncVisionResourceWithStreamingResponse:
         """
         return AsyncVisionResourceWithStreamingResponse(self)
 
-    async def analyze_images(
+    async def analyze(
         self,
         *,
         model: str,
         prompt: str,
-        variables: Iterable[vision_analyze_images_params.Variable],
+        variables: Iterable[vision_analyze_params.Variable],
         # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
         # The extra values given here take precedence over values defined on the client or passed to this method.
         extra_headers: Headers | None = None,
@@ -155,7 +155,7 @@ async def analyze_images(
                     "prompt": prompt,
                     "variables": variables,
                 },
-                vision_analyze_images_params.VisionAnalyzeImagesParams,
+                vision_analyze_params.VisionAnalyzeParams,
             ),
             options=make_request_options(
                 extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
@@ -168,33 +168,33 @@ class VisionResourceWithRawResponse:
     def __init__(self, vision: VisionResource) -> None:
         self._vision = vision
 
-        self.analyze_images = to_raw_response_wrapper(
-            vision.analyze_images,
+        self.analyze = to_raw_response_wrapper(
+            vision.analyze,
         )
 
 
 class AsyncVisionResourceWithRawResponse:
     def __init__(self, vision: AsyncVisionResource) -> None:
         self._vision = vision
 
-        self.analyze_images = async_to_raw_response_wrapper(
-            vision.analyze_images,
+        self.analyze = async_to_raw_response_wrapper(
+            vision.analyze,
         )
 
 
 class VisionResourceWithStreamingResponse:
     def __init__(self, vision: VisionResource) -> None:
         self._vision = vision
 
-        self.analyze_images = to_streamed_response_wrapper(
-            vision.analyze_images,
+        self.analyze = to_streamed_response_wrapper(
+            vision.analyze,
         )
 
 
 class AsyncVisionResourceWithStreamingResponse:
     def __init__(self, vision: AsyncVisionResource) -> None:
         self._vision = vision
 
-        self.analyze_images = async_to_streamed_response_wrapper(
-            vision.analyze_images,
+        self.analyze = async_to_streamed_response_wrapper(
+            vision.analyze,
         )

src/writerai/types/__init__.py

@@ -41,14 +41,14 @@
 from .graph_question_params import GraphQuestionParams as GraphQuestionParams
 from .graph_update_response import GraphUpdateResponse as GraphUpdateResponse
 from .tool_parse_pdf_params import ToolParsePdfParams as ToolParsePdfParams
+from .vision_analyze_params import VisionAnalyzeParams as VisionAnalyzeParams
 from .chat_completion_choice import ChatCompletionChoice as ChatCompletionChoice
 from .application_list_params import ApplicationListParams as ApplicationListParams
 from .chat_completion_message import ChatCompletionMessage as ChatCompletionMessage
 from .question_response_chunk import QuestionResponseChunk as QuestionResponseChunk
 from .tool_parse_pdf_response import ToolParsePdfResponse as ToolParsePdfResponse
 from .completion_create_params import CompletionCreateParams as CompletionCreateParams
 from .application_list_response import ApplicationListResponse as ApplicationListResponse
-from .vision_analyze_images_params import VisionAnalyzeImagesParams as VisionAnalyzeImagesParams
 from .application_retrieve_response import ApplicationRetrieveResponse as ApplicationRetrieveResponse
 from .graph_add_file_to_graph_params import GraphAddFileToGraphParams as GraphAddFileToGraphParams
 from .application_generate_content_chunk import ApplicationGenerateContentChunk as ApplicationGenerateContentChunk

…ai/types/vision_analyze_images_params.py …/writerai/types/vision_analyze_params.pysrc/writerai/types/vision_analyze_images_params.py renamed to src/writerai/types/vision_analyze_params.py src/writerai/types/vision_analyze_images_params.py renamed to src/writerai/types/vision_analyze_params.py

@@ -5,10 +5,10 @@
 from typing import Iterable
 from typing_extensions import Required, TypedDict
 
-__all__ = ["VisionAnalyzeImagesParams", "Variable"]
+__all__ = ["VisionAnalyzeParams", "Variable"]
 
 
-class VisionAnalyzeImagesParams(TypedDict, total=False):
+class VisionAnalyzeParams(TypedDict, total=False):
     model: Required[str]
     """The model to be used for image analysis.
 

tests/api_resources/test_vision.py

@@ -18,8 +18,8 @@ class TestVision:
     parametrize = pytest.mark.parametrize("client", [False, True], indirect=True, ids=["loose", "strict"])
 
     @parametrize
-    def test_method_analyze_images(self, client: Writer) -> None:
-        vision = client.vision.analyze_images(
+    def test_method_analyze(self, client: Writer) -> None:
+        vision = client.vision.analyze(
             model="palmyra-vision",
             prompt="Describe the difference between the image {{image_1}} and the image {{image_2}}.",
             variables=[
@@ -36,8 +36,8 @@ def test_method_analyze_images(self, client: Writer) -> None:
         assert_matches_type(VisionResponse, vision, path=["response"])
 
     @parametrize
-    def test_raw_response_analyze_images(self, client: Writer) -> None:
-        response = client.vision.with_raw_response.analyze_images(
+    def test_raw_response_analyze(self, client: Writer) -> None:
+        response = client.vision.with_raw_response.analyze(
             model="palmyra-vision",
             prompt="Describe the difference between the image {{image_1}} and the image {{image_2}}.",
             variables=[
@@ -58,8 +58,8 @@ def test_raw_response_analyze_images(self, client: Writer) -> None:
         assert_matches_type(VisionResponse, vision, path=["response"])
 
     @parametrize
-    def test_streaming_response_analyze_images(self, client: Writer) -> None:
-        with client.vision.with_streaming_response.analyze_images(
+    def test_streaming_response_analyze(self, client: Writer) -> None:
+        with client.vision.with_streaming_response.analyze(
             model="palmyra-vision",
             prompt="Describe the difference between the image {{image_1}} and the image {{image_2}}.",
             variables=[
@@ -86,8 +86,8 @@ class TestAsyncVision:
     parametrize = pytest.mark.parametrize("async_client", [False, True], indirect=True, ids=["loose", "strict"])
 
     @parametrize
-    async def test_method_analyze_images(self, async_client: AsyncWriter) -> None:
-        vision = await async_client.vision.analyze_images(
+    async def test_method_analyze(self, async_client: AsyncWriter) -> None:
+        vision = await async_client.vision.analyze(
             model="palmyra-vision",
             prompt="Describe the difference between the image {{image_1}} and the image {{image_2}}.",
             variables=[
@@ -104,8 +104,8 @@ async def test_method_analyze_images(self, async_client: AsyncWriter) -> None:
         assert_matches_type(VisionResponse, vision, path=["response"])
 
     @parametrize
-    async def test_raw_response_analyze_images(self, async_client: AsyncWriter) -> None:
-        response = await async_client.vision.with_raw_response.analyze_images(
+    async def test_raw_response_analyze(self, async_client: AsyncWriter) -> None:
+        response = await async_client.vision.with_raw_response.analyze(
             model="palmyra-vision",
             prompt="Describe the difference between the image {{image_1}} and the image {{image_2}}.",
             variables=[
@@ -126,8 +126,8 @@ async def test_raw_response_analyze_images(self, async_client: AsyncWriter) -> N
         assert_matches_type(VisionResponse, vision, path=["response"])
 
     @parametrize
-    async def test_streaming_response_analyze_images(self, async_client: AsyncWriter) -> None:
-        async with async_client.vision.with_streaming_response.analyze_images(
+    async def test_streaming_response_analyze(self, async_client: AsyncWriter) -> None:
+        async with async_client.vision.with_streaming_response.analyze(
             model="palmyra-vision",
             prompt="Describe the difference between the image {{image_1}} and the image {{image_2}}.",
             variables=[