Make form of openai endpoint parameter clearer in docstrings+test

Author: dirkkul

test/collection/test_config.py

@@ -323,13 +323,13 @@ def test_basic_config():
         Configure.Vectorizer.text2vec_openai(
             vectorize_collection_name=False,
             model="ada",
-            endpoint="https://api.custom.com/v1/embeddings",
+            endpoint="/api/v3/embeddings",
         ),
         {
             "text2vec-openai": {
                 "vectorizeClassName": False,
                 "model": "ada",
-                "endpoint": "https://api.custom.com/v1/embeddings",
+                "endpoint": "/api/v3/embeddings",
                 "isAzure": False,
             }
         },
@@ -1779,7 +1779,7 @@ def test_vector_config_flat_pq() -> None:
             Configure.NamedVectors.text2vec_openai(
                 name="test",
                 source_properties=["prop"],
-                endpoint="https://api.custom.com/v1/embeddings",
+                endpoint="/api/v3/embeddings",
             )
         ],
         {
@@ -1788,7 +1788,7 @@ def test_vector_config_flat_pq() -> None:
                     "text2vec-openai": {
                         "properties": ["prop"],
                         "vectorizeClassName": True,
-                        "endpoint": "https://api.custom.com/v1/embeddings",
+                        "endpoint": "/api/v3/embeddings",
                         "isAzure": False,
                     }
                 },
@@ -2403,7 +2403,7 @@ def test_config_with_named_vectors(
             Configure.Vectors.text2vec_openai(
                 name="test",
                 source_properties=["prop"],
-                endpoint="https://api.custom.com/v1/embeddings",
+                endpoint="/api/v3/embeddings",
             )
         ],
         {
@@ -2412,7 +2412,7 @@ def test_config_with_named_vectors(
                     "text2vec-openai": {
                         "properties": ["prop"],
                         "vectorizeClassName": True,
-                        "endpoint": "https://api.custom.com/v1/embeddings",
+                        "endpoint": "/api/v3/embeddings",
                         "isAzure": False,
                     }
                 },
@@ -2472,7 +2472,7 @@ def test_config_with_named_vectors(
             Configure.Vectors.text2vec_morph(
                 name="test",
                 source_properties=["prop"],
-                endpoint="https://api.custom.com/v1/embeddings",
+                endpoint="/api/v3/embeddings",
             )
         ],
         {
@@ -2481,7 +2481,7 @@ def test_config_with_named_vectors(
                     "text2vec-morph": {
                         "vectorizeClassName": True,
                         "properties": ["prop"],
-                        "endpoint": "https://api.custom.com/v1/embeddings",
+                        "endpoint": "/api/v3/embeddings",
                     }
                 },
                 "vectorIndexType": "hnsw",

weaviate/collections/classes/config_named_vectors.py

@@ -425,7 +425,7 @@ def text2vec_openai(
             vectorize_collection_name: Whether to vectorize the collection name. Defaults to `True`.
             base_url: The base URL to use where API requests should go. Defaults to `None`, which uses the server-defined default.
             dimensions: Number of dimensions. Applicable to v3 OpenAI models only. Defaults to `None`, which uses the server-defined default.
-            endpoint: The endpoint to use. Defaults to `None`, which uses the server-defined default of `/v1/embeddings`.
+            endpoint: The API path to append to `base_url`, e.g. `/api/v3/embeddings`. Defaults to `None`, which uses the server-defined default.
 
         Raises:
             pydantic.ValidationError: If `type_` is not a valid value from the `OpenAIType` type.

weaviate/collections/classes/config_vectorizers.py

@@ -1153,7 +1153,7 @@ def text2vec_openai(
             vectorize_collection_name: Whether to vectorize the collection name. Defaults to `True`.
             base_url: The base URL to use where API requests should go. Defaults to `None`, which uses the server-defined default.
             dimensions: Number of dimensions. Applicable to v3 OpenAI models only. Defaults to `None`, which uses the server-defined default.
-            endpoint: The endpoint to use. Defaults to `None`, which uses the server-defined default of `/v1/embeddings`.
+            endpoint: The API path to append to `base_url`, e.g. `/api/v3/embeddings`. Defaults to `None`, which uses the server-defined default.
 
         Raises:
             pydantic.ValidationError: If `type_` is not a valid value from the `OpenAIType` type.

weaviate/collections/classes/config_vectors.py

@@ -679,7 +679,7 @@ def text2vec_morph(
             quantizer: The quantizer to use for the vector index. If not provided, no quantization will be applied.
             base_url: The base URL to use where API requests should go. Defaults to `None`, which uses the server-defined default.
             model: The model to use. Defaults to `None`, which uses the server-defined default.
-            endpoint: The endpoint to use. Defaults to `None`, which uses the server-defined default of `/v1/embeddings`.
+            endpoint: The API path to append to `base_url`, e.g. `/api/v3/embeddings`. Defaults to `None`, which uses the server-defined default.
             source_properties: Which properties should be included when vectorizing. By default all text properties are included.
             vector_index_config: The configuration for Weaviate's vector index. Use `wvc.config.Configure.VectorIndex` to create a vector index configuration. None by default
             vectorize_collection_name: Whether to vectorize the collection name. Defaults to `True`.
@@ -760,7 +760,7 @@ def text2vec_openai(
             quantizer: The quantizer to use for the vector index. If not provided, no quantization will be applied.
             base_url: The base URL to use where API requests should go. Defaults to `None`, which uses the server-defined default.
             dimensions: Number of dimensions. Applicable to v3 OpenAI models only. Defaults to `None`, which uses the server-defined default.
-            endpoint: The endpoint to use. Defaults to `None`, which uses the server-defined default of `/v1/embeddings`.
+            endpoint: The API path to append to `base_url`, e.g. `/api/v3/embeddings`. Defaults to `None`, which uses the server-defined default.
             model: The model to use. Defaults to `None`, which uses the server-defined default.
             model_version: The model version to use. Defaults to `None`, which uses the server-defined default.
             type_: The type of model to use. Defaults to `None`, which uses the server-defined default.