Skip to content

Commit 042b48e

Browse files
fix: replace openai dummy endpoint by dummy strings to avoid lychee fail (#1784)
1 parent 4d1e2fe commit 042b48e

5 files changed

Lines changed: 23 additions & 27 deletions

File tree

docs/sdk/tutorials/llm_project_setup.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -92,7 +92,7 @@ model_response = kili.llm.create_model(
9292
model={
9393
"credentials": {
9494
"api_key": "<YOUR_OPEN_AI_API_KEY>",
95-
"endpoint": "https://api.openai.com/v1/",
95+
"endpoint": "<your_desired_open_ai_endpoint>",
9696
},
9797
"name": "My Model",
9898
"type": "OPEN_AI_SDK",

recipes/llm_project_setup.ipynb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -145,7 +145,7 @@
145145
" model={\n",
146146
" \"credentials\": {\n",
147147
" \"api_key\": \"<YOUR_OPEN_AI_API_KEY>\",\n",
148-
" \"endpoint\": \"https://api.openai.com/v1/\",\n",
148+
" \"endpoint\": \"<your_desired_open_ai_endpoint>\",\n",
149149
" },\n",
150150
" \"name\": \"My Model\",\n",
151151
" \"type\": \"OPEN_AI_SDK\",\n",

src/kili/llm/presentation/client/llm.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -118,7 +118,7 @@ def create_model(self, organization_id: str, model: dict) -> ModelDict:
118118
... "type": "OPEN_AI_SDK",
119119
... "credentials": {
120120
... "api_key": "your_open_ai_api_key",
121-
... "endpoint": "https://api.openai.com/v1/"
121+
... "endpoint": "your_open_ai_endpoint"
122122
... }
123123
... }
124124
>>> kili.llm.create_model(organization_id="your_organization_id", model=model_data)

tests/e2e/test_e2e_models.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ def test_create_and_manage_project_and_model_resources(kili: Kili):
4444
project_id = project["id"]
4545

4646
model_data = {
47-
"credentials": {"api_key": "***", "endpoint": "https://api.openai.com"},
47+
"credentials": {"api_key": "***", "endpoint": "your_open_ai_endpoint"},
4848
"name": MODEL_NAME,
4949
"type": "OPEN_AI_SDK",
5050
}

tests/unit/llm/test_model.py

Lines changed: 19 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,7 @@
6161

6262

6363
def test_map_create_model_input_with_openai_sdk_credentials():
64-
credentials = OpenAISDKCredentials(api_key="api_key", endpoint="https://api.openai.com/v1/")
64+
credentials = OpenAISDKCredentials(api_key="api_key", endpoint="your_open_ai_endpoint")
6565
input_data = ModelToCreateInput(
6666
name="Test Model",
6767
type=ModelType.OPEN_AI_SDK,
@@ -71,7 +71,7 @@ def test_map_create_model_input_with_openai_sdk_credentials():
7171
expected_output = {
7272
"credentials": {
7373
"apiKey": "api_key",
74-
"endpoint": "https://api.openai.com/v1/",
74+
"endpoint": "your_open_ai_endpoint",
7575
},
7676
"name": "Test Model",
7777
"type": ModelType.OPEN_AI_SDK.value,
@@ -86,7 +86,7 @@ def test_map_create_model_input_with_azure_openai_credentials():
8686
credentials = AzureOpenAICredentials(
8787
api_key="api_key",
8888
deployment_id="deployment_id",
89-
endpoint="https://azure-openai-endpoint.com",
89+
endpoint="your_azure_open_ai_endpoint",
9090
)
9191
input_data = ModelToCreateInput(
9292
name="Test Azure Model",
@@ -98,7 +98,7 @@ def test_map_create_model_input_with_azure_openai_credentials():
9898
"credentials": {
9999
"apiKey": "api_key",
100100
"deploymentId": "deployment_id",
101-
"endpoint": "https://azure-openai-endpoint.com",
101+
"endpoint": "your_azure_open_ai_endpoint",
102102
},
103103
"name": "Test Azure Model",
104104
"type": ModelType.AZURE_OPEN_AI.value,
@@ -118,14 +118,12 @@ def test_map_update_model_input_update_name_only():
118118

119119

120120
def test_map_update_model_input_update_openai_sdk_credentials():
121-
credentials = OpenAISDKCredentials(
122-
api_key="new_api_key", endpoint="https://new-openai-endpoint.com"
123-
)
121+
credentials = OpenAISDKCredentials(api_key="new_api_key", endpoint="your_new_open_ai_endpoint")
124122
input_data = ModelToUpdateInput(credentials=credentials)
125123
expected_output = {
126124
"credentials": {
127125
"apiKey": "new_api_key",
128-
"endpoint": "https://new-openai-endpoint.com",
126+
"endpoint": "your_new_open_ai_endpoint",
129127
}
130128
}
131129

@@ -137,14 +135,14 @@ def test_map_update_model_input_update_azure_openai_credentials():
137135
credentials = AzureOpenAICredentials(
138136
api_key="new_api_key",
139137
deployment_id="new_deployment_id",
140-
endpoint="https://new-azure-openai-endpoint.com",
138+
endpoint="your_new_azure_open_ai_endpoint",
141139
)
142140
input_data = ModelToUpdateInput(credentials=credentials)
143141
expected_output = {
144142
"credentials": {
145143
"apiKey": "new_api_key",
146144
"deploymentId": "new_deployment_id",
147-
"endpoint": "https://new-azure-openai-endpoint.com",
145+
"endpoint": "your_new_azure_open_ai_endpoint",
148146
}
149147
}
150148

@@ -153,15 +151,13 @@ def test_map_update_model_input_update_azure_openai_credentials():
153151

154152

155153
def test_map_update_model_input_update_name_and_openai_sdk_credentials():
156-
credentials = OpenAISDKCredentials(
157-
api_key="new_api_key", endpoint="https://new-openai-endpoint.com"
158-
)
154+
credentials = OpenAISDKCredentials(api_key="new_api_key", endpoint="your_new_open_ai_endpoint")
159155
input_data = ModelToUpdateInput(name="Updated Model Name", credentials=credentials)
160156
expected_output = {
161157
"name": "Updated Model Name",
162158
"credentials": {
163159
"apiKey": "new_api_key",
164-
"endpoint": "https://new-openai-endpoint.com",
160+
"endpoint": "your_new_open_ai_endpoint",
165161
},
166162
}
167163

@@ -173,15 +169,15 @@ def test_map_update_model_input_update_name_and_azure_openai_credentials():
173169
credentials = AzureOpenAICredentials(
174170
api_key="new_api_key",
175171
deployment_id="new_deployment_id",
176-
endpoint="https://new-azure-openai-endpoint.com",
172+
endpoint="your_new_azure_open_ai_endpoint",
177173
)
178174
input_data = ModelToUpdateInput(name="Updated Model Name", credentials=credentials)
179175
expected_output = {
180176
"name": "Updated Model Name",
181177
"credentials": {
182178
"apiKey": "new_api_key",
183179
"deploymentId": "new_deployment_id",
184-
"endpoint": "https://new-azure-openai-endpoint.com",
180+
"endpoint": "your_new_azure_open_ai_endpoint",
185181
},
186182
}
187183

@@ -229,7 +225,7 @@ def test_create_model_open_ai_sdk(mocker):
229225
"type": "OPEN_AI_SDK",
230226
"credentials": {
231227
"api_key": "***",
232-
"endpoint": "https://api.openai.com",
228+
"endpoint": "your_open_ai_endpoint",
233229
},
234230
},
235231
)
@@ -249,7 +245,7 @@ def test_create_model_azure_openai(mocker):
249245
"type": "AZURE_OPEN_AI",
250246
"credentials": {
251247
"api_key": "***",
252-
"endpoint": "https://api.openai.com",
248+
"endpoint": "your_open_ai_endpoint",
253249
"deployment_id": "deployment_id",
254250
},
255251
},
@@ -268,7 +264,7 @@ def test_create_invalid_model(mocker):
268264
model={
269265
"name": "New Model",
270266
"type": "Wrong type",
271-
"credentials": {"api_key": "***", "endpoint": "https://api.openai.com"},
267+
"credentials": {"api_key": "***", "endpoint": "your_open_ai_endpoint"},
272268
},
273269
)
274270

@@ -285,7 +281,7 @@ def test_update_model_open_ai_sdk(mocker):
285281
"name": "Updated Model",
286282
"credentials": {
287283
"api_key": "***",
288-
"endpoint": "https://api.openai.com",
284+
"endpoint": "your_open_ai_endpoint",
289285
},
290286
},
291287
)
@@ -305,7 +301,7 @@ def test_update_model_azure_open_ai(mocker):
305301
"name": "Updated Model",
306302
"credentials": {
307303
"api_key": "***",
308-
"endpoint": "https://api.openai.com",
304+
"endpoint": "your_open_ai_endpoint",
309305
"deployment_id": "deployment_id",
310306
},
311307
},
@@ -324,7 +320,7 @@ def test_update_invalid_model(mocker):
324320
model={
325321
"name": "New Model",
326322
"type": "Wrong type",
327-
"credentials": {"api_key": "***", "endpoint": "https://api.openai.com"},
323+
"credentials": {"api_key": "***", "endpoint": "your_open_ai_endpoint"},
328324
},
329325
)
330326

@@ -340,7 +336,7 @@ def test_update_non_existing_model(mocker):
340336
model={
341337
"name": "New Model",
342338
"type": "Wrong type",
343-
"credentials": {"api_key": "***", "endpoint": "https://api.openai.com"},
339+
"credentials": {"api_key": "***", "endpoint": "your_open_ai_endpoint"},
344340
},
345341
)
346342

0 commit comments

Comments
 (0)