Skip to content

Commit 18efbfe

Browse files
committed
Use inline literal in documents
`https://example.com` is rendered to a link which the text is `example.com` without https scheme, we should use literal here. See https://docs.asciidoctor.org/asciidoc/latest/syntax-quick-reference/#literals-and-source-code Signed-off-by: Yanming Zhou <[email protected]>
1 parent fbec267 commit 18efbfe

File tree

5 files changed

+13
-13
lines changed

5 files changed

+13
-13
lines changed

spring-ai-docs/src/main/antora/modules/ROOT/pages/api/chat/deepseek-chat.adoc

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ Check the https://github.com/spring-projects/spring-ai/blob/main/models/spring-a
1717
Visit https://api-docs.deepseek.com/[here] to create an API Key. Configure it using the `spring.ai.openai.api-key` property in your Spring AI project.
1818

1919
* **Set the DeepSeek Base URL**:
20-
Set the `spring.ai.openai.base-url` property to `https://api.deepseek.com`.
20+
Set the `spring.ai.openai.base-url` property to `+https://api.deepseek.com+`.
2121

2222
* **Select a DeepSeek Model**:
2323
Use the `spring.ai.openai.chat.options.model=<model name>` property to specify the model. Refer to https://api-docs.deepseek.com/quick_start/pricing[Supported Models] for available options.
@@ -101,7 +101,7 @@ The prefix `spring.ai.openai` is used as the property prefix that lets you conne
101101
|====
102102
| Property | Description | Default
103103

104-
| spring.ai.openai.base-url | The URL to connect to. Must be set to `https://api.deepseek.com` | -
104+
| spring.ai.openai.base-url | The URL to connect to. Must be set to `+https://api.deepseek.com+` | -
105105
| spring.ai.openai.api-key | Your DeepSeek API Key | -
106106
|====
107107

@@ -127,7 +127,7 @@ The prefix `spring.ai.openai.chat` is the property prefix that lets you configur
127127

128128
| spring.ai.openai.chat.enabled (Removed and no longer valid) | Enable OpenAI chat model. | true
129129
| spring.ai.model.chat | Enable OpenAI chat model. | openai
130-
| spring.ai.openai.chat.base-url | Optional overrides the spring.ai.openai.base-url to provide chat specific url. Must be set to `https://api.deepseek.com` | -
130+
| spring.ai.openai.chat.base-url | Optional overrides the spring.ai.openai.base-url to provide chat specific url. Must be set to `+https://api.deepseek.com+` | -
131131
| spring.ai.openai.chat.api-key | Optional overrides the spring.ai.openai.api-key to provide chat specific api-key | -
132132
| spring.ai.openai.chat.options.model | The link:https://api-docs.deepseek.com/quick_start/pricing[DeepSeek LLM model] to use | -
133133
| spring.ai.openai.chat.options.temperature | The sampling temperature to use that controls the apparent creativity of generated completions. Higher values will make output more random while lower values will make results more focused and deterministic. It is not recommended to modify temperature and top_p for the same completions request as the interaction of these two settings is difficult to predict. | 0.8

spring-ai-docs/src/main/antora/modules/ROOT/pages/api/chat/groq-chat.adoc

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ for examples of using Groq with Spring AI.
2222
Please visit https://console.groq.com/keys[here] to create an API Key.
2323
The Spring AI project defines a configuration property named `spring.ai.openai.api-key` that you should set to the value of the `API Key` obtained from groq.com.
2424
* Set the Groq URL.
25-
You have to set the `spring.ai.openai.base-url` property to `https://api.groq.com/openai`.
25+
You have to set the `spring.ai.openai.base-url` property to `+https://api.groq.com/openai+`.
2626
* Select a https://console.groq.com/docs/models[Groq Model].
2727
Use the `spring.ai.openai.chat.options.model=<model name>` property to set the Model.
2828

@@ -105,7 +105,7 @@ The prefix `spring.ai.openai` is used as the property prefix that lets you conne
105105
|====
106106
| Property | Description | Default
107107

108-
| spring.ai.openai.base-url | The URL to connect to. Must be set to `https://api.groq.com/openai` | -
108+
| spring.ai.openai.base-url | The URL to connect to. Must be set to `+https://api.groq.com/openai+` | -
109109
| spring.ai.openai.api-key | The Groq API Key | -
110110
|====
111111

@@ -131,7 +131,7 @@ The prefix `spring.ai.openai.chat` is the property prefix that lets you configur
131131

132132
| spring.ai.openai.chat.enabled (Removed and no longer valid) | Enable OpenAI chat model. | true
133133
| spring.ai.openai.chat | Enable OpenAI chat model. | openai
134-
| spring.ai.openai.chat.base-url | Optional overrides the spring.ai.openai.base-url to provide chat specific url. Must be set to `https://api.groq.com/openai` | -
134+
| spring.ai.openai.chat.base-url | Optional overrides the spring.ai.openai.base-url to provide chat specific url. Must be set to `+https://api.groq.com/openai+` | -
135135
| spring.ai.openai.chat.api-key | Optional overrides the spring.ai.openai.api-key to provide chat specific api-key | -
136136
| spring.ai.openai.chat.options.model | The https://console.groq.com/docs/models[available model] names are `llama3-8b-8192`, `llama3-70b-8192`, `mixtral-8x7b-32768`, `gemma2-9b-it`. | -
137137
| spring.ai.openai.chat.options.temperature | The sampling temperature to use that controls the apparent creativity of generated completions. Higher values will make output more random while lower values will make results more focused and deterministic. It is not recommended to modify temperature and top_p for the same completions request as the interaction of these two settings is difficult to predict. | 0.8

spring-ai-docs/src/main/antora/modules/ROOT/pages/api/chat/nvidia-chat.adoc

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
https://docs.api.nvidia.com/nim/reference/llm-apis[NVIDIA LLM API] is a proxy AI Inference Engine offering a wide range of models from link:https://docs.api.nvidia.com/nim/reference/llm-apis#models[various providers].
44

55
Spring AI integrates with the NVIDIA LLM API by reusing the existing xref::api/chat/openai-chat.adoc[OpenAI] client.
6-
For this you need to set the base-url to `https://integrate.api.nvidia.com`, select one of the provided https://docs.api.nvidia.com/nim/reference/llm-apis#model[LLM models] and get an `api-key` for it.
6+
For this you need to set the base-url to `+https://integrate.api.nvidia.com+`, select one of the provided https://docs.api.nvidia.com/nim/reference/llm-apis#model[LLM models] and get an `api-key` for it.
77

88
image::spring-ai-nvidia-llm-api-1.jpg[w=800,align="center"]
99

@@ -77,7 +77,7 @@ The prefix `spring.ai.openai` is used as the property prefix that lets you conne
7777
|====
7878
| Property | Description | Default
7979

80-
| spring.ai.openai.base-url | The URL to connect to. Must be set to `https://integrate.api.nvidia.com` | -
80+
| spring.ai.openai.base-url | The URL to connect to. Must be set to `+https://integrate.api.nvidia.com+` | -
8181
| spring.ai.openai.api-key | The NVIDIA API Key | -
8282
|====
8383

@@ -102,7 +102,7 @@ The prefix `spring.ai.openai.chat` is the property prefix that lets you configur
102102

103103
| spring.ai.openai.chat.enabled (Removed and no longer valid) | Enable OpenAI chat model. | true
104104
| spring.ai.model.chat | Enable OpenAI chat model. | openai
105-
| spring.ai.openai.chat.base-url | Optional overrides the spring.ai.openai.base-url to provide chat specific url. Must be set to `https://integrate.api.nvidia.com` | -
105+
| spring.ai.openai.chat.base-url | Optional overrides the spring.ai.openai.base-url to provide chat specific url. Must be set to `+https://integrate.api.nvidia.com+` | -
106106
| spring.ai.openai.chat.api-key | Optional overrides the spring.ai.openai.api-key to provide chat specific api-key | -
107107
| spring.ai.openai.chat.options.model | The link:https://docs.api.nvidia.com/nim/reference/llm-apis#models[NVIDIA LLM model] to use | -
108108
| spring.ai.openai.chat.options.temperature | The sampling temperature to use that controls the apparent creativity of generated completions. Higher values will make output more random while lower values will make results more focused and deterministic. It is not recommended to modify temperature and top_p for the same completions request as the interaction of these two settings is difficult to predict. | 0.8

spring-ai-docs/src/main/antora/modules/ROOT/pages/api/chat/perplexity-chat.adoc

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ Check the https://github.com/spring-projects/spring-ai/blob/main/models/spring-a
2020
Visit https://docs.perplexity.ai/guides/getting-started[here] to create an API Key. Configure it using the `spring.ai.openai.api-key` property in your Spring AI project.
2121

2222
* **Set the Perplexity Base URL**:
23-
Set the `spring.ai.openai.base-url` property to `https://api.perplexity.ai`.
23+
Set the `spring.ai.openai.base-url` property to `+https://api.perplexity.ai+`.
2424

2525
* **Select a Perplexity Model**:
2626
Use the `spring.ai.openai.chat.model=<model name>` property to specify the model. Refer to https://docs.perplexity.ai/guides/model-cards[Supported Models] for available options.
@@ -107,7 +107,7 @@ The prefix `spring.ai.openai` is used as the property prefix that lets you conne
107107
|====
108108
| Property | Description | Default
109109

110-
| spring.ai.openai.base-url | The URL to connect to. Must be set to `https://api.perplexity.ai` | -
110+
| spring.ai.openai.base-url | The URL to connect to. Must be set to `+https://api.perplexity.ai+` | -
111111
| spring.ai.openai.chat.api-key | Your Perplexity API Key | -
112112
|====
113113

@@ -132,7 +132,7 @@ The prefix `spring.ai.openai.chat` is the property prefix that lets you configur
132132

133133
| spring.ai.model.chat | Enable OpenAI chat model. | openai
134134
| spring.ai.openai.chat.model | One of the supported https://docs.perplexity.ai/guides/model-cards[Perplexity models]. Example: `llama-3.1-sonar-small-128k-online`. | -
135-
| spring.ai.openai.chat.base-url | Optional overrides the spring.ai.openai.base-url to provide chat specific url. Must be set to `https://api.perplexity.ai` | -
135+
| spring.ai.openai.chat.base-url | Optional overrides the spring.ai.openai.base-url to provide chat specific url. Must be set to `+https://api.perplexity.ai+` | -
136136
| spring.ai.openai.chat.completions-path | Must be set to `/chat/completions` | `/v1/chat/completions`
137137
| spring.ai.openai.chat.options.temperature | The amount of randomness in the response, valued between 0 inclusive and 2 exclusive. Higher values are more random, and lower values are more deterministic. Required range: `0 < x < 2`. | 0.2
138138
| spring.ai.openai.chat.options.frequencyPenalty | A multiplicative penalty greater than 0. Values greater than 1.0 penalize new tokens based on their existing frequency in the text so far, decreasing the model's likelihood to repeat the same line verbatim. A value of 1.0 means no penalty. Incompatible with presence_penalty. Required range: `x > 0`. | 1

spring-ai-docs/src/main/antora/modules/ROOT/pages/api/image/stabilityai-image.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -76,7 +76,7 @@ The prefix `spring.ai.stabilityai.image` is the property prefix that lets you co
7676

7777
| spring.ai.stabilityai.image.enabled (Removed and no longer valid) | Enable Stability AI image model. | true
7878
| spring.ai.model.image | Enable Stability AI image model. | stabilityai
79-
| spring.ai.stabilityai.image.base-url | Optional overrides the spring.ai.openai.base-url to provide a specific url | `https://api.stability.ai/v1`
79+
| spring.ai.stabilityai.image.base-url | Optional overrides the spring.ai.openai.base-url to provide a specific url | `+https://api.stability.ai/v1+`
8080
| spring.ai.stabilityai.image.api-key | Optional overrides the spring.ai.openai.api-key to provide a specific api-key | -
8181
| spring.ai.stabilityai.image.option.n | The number of images to be generated. Must be between 1 and 10. | 1
8282
| spring.ai.stabilityai.image.option.model | The engine/model to use in Stability AI. The model is passed in the URL as a path parameter. | `stable-diffusion-v1-6`

0 commit comments

Comments
 (0)