Skip to content

Commit 5217f66

Browse files
authored
Removes erroneous flavour text from PUT inference API pages. (#4357)
1 parent a43be9c commit 5217f66

File tree

14 files changed

+0
-83
lines changed

14 files changed

+0
-83
lines changed

specification/inference/put/PutRequest.ts

-5
Original file line numberDiff line numberDiff line change
@@ -24,11 +24,6 @@ import { Id } from '@_types/common'
2424

2525
/**
2626
* Create an inference endpoint.
27-
* When you create an inference endpoint, the associated machine learning model is automatically deployed if it is not already running.
28-
* After creating the endpoint, wait for the model deployment to complete before using it.
29-
* To verify the deployment status, use the get trained model statistics API.
30-
* Look for `"state": "fully_allocated"` in the response and ensure that the `"allocation_count"` matches the `"target_allocation_count"`.
31-
* Avoid creating multiple endpoints for the same model unless required, as each endpoint consumes significant resources.
3227
*
3328
* IMPORTANT: The inference APIs enable you to use certain services, such as built-in machine learning models (ELSER, E5), models uploaded through Eland, Cohere, OpenAI, Mistral, Azure OpenAI, Google AI Studio, Google Vertex AI, Anthropic, Watsonx.ai, or Hugging Face.
3429
* For built-in models and models uploaded through Eland, the inference APIs offer an alternative way to use and manage trained models.

specification/inference/put_alibabacloud/PutAlibabaCloudRequest.ts

-6
Original file line numberDiff line numberDiff line change
@@ -31,12 +31,6 @@ import { Id } from '@_types/common'
3131
* Create an AlibabaCloud AI Search inference endpoint.
3232
*
3333
* Create an inference endpoint to perform an inference task with the `alibabacloud-ai-search` service.
34-
*
35-
* When you create an inference endpoint, the associated machine learning model is automatically deployed if it is not already running.
36-
* After creating the endpoint, wait for the model deployment to complete before using it.
37-
* To verify the deployment status, use the get trained model statistics API.
38-
* Look for `"state": "fully_allocated"` in the response and ensure that the `"allocation_count"` matches the `"target_allocation_count"`.
39-
* Avoid creating multiple endpoints for the same model unless required, as each endpoint consumes significant resources.
4034
* @rest_spec_name inference.put_alibabacloud
4135
* @availability stack since=8.16.0 stability=stable visibility=public
4236
* @availability serverless stability=stable visibility=public

specification/inference/put_amazonbedrock/PutAmazonBedrockRequest.ts

-6
Original file line numberDiff line numberDiff line change
@@ -34,12 +34,6 @@ import { Id } from '@_types/common'
3434
*
3535
* >info
3636
* > You need to provide the access and secret keys only once, during the inference model creation. The get inference API does not retrieve your access or secret keys. After creating the inference model, you cannot change the associated key pairs. If you want to use a different access and secret key pair, delete the inference model and recreate it with the same name and the updated keys.
37-
*
38-
* When you create an inference endpoint, the associated machine learning model is automatically deployed if it is not already running.
39-
* After creating the endpoint, wait for the model deployment to complete before using it.
40-
* To verify the deployment status, use the get trained model statistics API.
41-
* Look for `"state": "fully_allocated"` in the response and ensure that the `"allocation_count"` matches the `"target_allocation_count"`.
42-
* Avoid creating multiple endpoints for the same model unless required, as each endpoint consumes significant resources.
4337
* @rest_spec_name inference.put_amazonbedrock
4438
* @availability stack since=8.12.0 stability=stable visibility=public
4539
* @availability serverless stability=stable visibility=public

specification/inference/put_anthropic/PutAnthropicRequest.ts

-6
Original file line numberDiff line numberDiff line change
@@ -31,12 +31,6 @@ import { Id } from '@_types/common'
3131
* Create an Anthropic inference endpoint.
3232
*
3333
* Create an inference endpoint to perform an inference task with the `anthropic` service.
34-
*
35-
* When you create an inference endpoint, the associated machine learning model is automatically deployed if it is not already running.
36-
* After creating the endpoint, wait for the model deployment to complete before using it.
37-
* To verify the deployment status, use the get trained model statistics API.
38-
* Look for `"state": "fully_allocated"` in the response and ensure that the `"allocation_count"` matches the `"target_allocation_count"`.
39-
* Avoid creating multiple endpoints for the same model unless required, as each endpoint consumes significant resources.
4034
* @rest_spec_name inference.put_anthropic
4135
* @availability stack since=8.16.0 stability=stable visibility=public
4236
* @availability serverless stability=stable visibility=public

specification/inference/put_azureaistudio/PutAzureAiStudioRequest.ts

-6
Original file line numberDiff line numberDiff line change
@@ -31,12 +31,6 @@ import { Id } from '@_types/common'
3131
* Create an Azure AI studio inference endpoint.
3232
*
3333
* Create an inference endpoint to perform an inference task with the `azureaistudio` service.
34-
*
35-
* When you create an inference endpoint, the associated machine learning model is automatically deployed if it is not already running.
36-
* After creating the endpoint, wait for the model deployment to complete before using it.
37-
* To verify the deployment status, use the get trained model statistics API.
38-
* Look for `"state": "fully_allocated"` in the response and ensure that the `"allocation_count"` matches the `"target_allocation_count"`.
39-
* Avoid creating multiple endpoints for the same model unless required, as each endpoint consumes significant resources.
4034
* @rest_spec_name inference.put_azureaistudio
4135
* @availability stack since=8.14.0 stability=stable visibility=public
4236
* @availability serverless stability=stable visibility=public

specification/inference/put_azureopenai/PutAzureOpenAiRequest.ts

-6
Original file line numberDiff line numberDiff line change
@@ -38,12 +38,6 @@ import { Id } from '@_types/common'
3838
* * [GPT-3.5](https://learn.microsoft.com/en-us/azure/ai-services/openai/concepts/models?tabs=global-standard%2Cstandard-chat-completions#gpt-35)
3939
*
4040
* The list of embeddings models that you can choose from in your deployment can be found in the [Azure models documentation](https://learn.microsoft.com/en-us/azure/ai-services/openai/concepts/models?tabs=global-standard%2Cstandard-chat-completions#embeddings).
41-
*
42-
* When you create an inference endpoint, the associated machine learning model is automatically deployed if it is not already running.
43-
* After creating the endpoint, wait for the model deployment to complete before using it.
44-
* To verify the deployment status, use the get trained model statistics API.
45-
* Look for `"state": "fully_allocated"` in the response and ensure that the `"allocation_count"` matches the `"target_allocation_count"`.
46-
* Avoid creating multiple endpoints for the same model unless required, as each endpoint consumes significant resources.
4741
* @rest_spec_name inference.put_azureopenai
4842
* @availability stack since=8.14.0 stability=stable visibility=public
4943
* @availability serverless stability=stable visibility=public

specification/inference/put_cohere/PutCohereRequest.ts

-6
Original file line numberDiff line numberDiff line change
@@ -31,12 +31,6 @@ import { Id } from '@_types/common'
3131
* Create a Cohere inference endpoint.
3232
*
3333
* Create an inference endpoint to perform an inference task with the `cohere` service.
34-
*
35-
* When you create an inference endpoint, the associated machine learning model is automatically deployed if it is not already running.
36-
* After creating the endpoint, wait for the model deployment to complete before using it.
37-
* To verify the deployment status, use the get trained model statistics API.
38-
* Look for `"state": "fully_allocated"` in the response and ensure that the `"allocation_count"` matches the `"target_allocation_count"`.
39-
* Avoid creating multiple endpoints for the same model unless required, as each endpoint consumes significant resources.
4034
* @rest_spec_name inference.put_cohere
4135
* @availability stack since=8.13.0 stability=stable visibility=public
4236
* @availability serverless stability=stable visibility=public

specification/inference/put_googleaistudio/PutGoogleAiStudioRequest.ts

-6
Original file line numberDiff line numberDiff line change
@@ -30,12 +30,6 @@ import { Id } from '@_types/common'
3030
* Create an Google AI Studio inference endpoint.
3131
*
3232
* Create an inference endpoint to perform an inference task with the `googleaistudio` service.
33-
*
34-
* When you create an inference endpoint, the associated machine learning model is automatically deployed if it is not already running.
35-
* After creating the endpoint, wait for the model deployment to complete before using it.
36-
* To verify the deployment status, use the get trained model statistics API.
37-
* Look for `"state": "fully_allocated"` in the response and ensure that the `"allocation_count"` matches the `"target_allocation_count"`.
38-
* Avoid creating multiple endpoints for the same model unless required, as each endpoint consumes significant resources.
3933
* @rest_spec_name inference.put_googleaistudio
4034
* @availability stack since=8.15.0 stability=stable visibility=public
4135
* @availability serverless stability=stable visibility=public

specification/inference/put_googlevertexai/PutGoogleVertexAiRequest.ts

-6
Original file line numberDiff line numberDiff line change
@@ -31,12 +31,6 @@ import { Id } from '@_types/common'
3131
* Create a Google Vertex AI inference endpoint.
3232
*
3333
* Create an inference endpoint to perform an inference task with the `googlevertexai` service.
34-
*
35-
* When you create an inference endpoint, the associated machine learning model is automatically deployed if it is not already running.
36-
* After creating the endpoint, wait for the model deployment to complete before using it.
37-
* To verify the deployment status, use the get trained model statistics API.
38-
* Look for `"state": "fully_allocated"` in the response and ensure that the `"allocation_count"` matches the `"target_allocation_count"`.
39-
* Avoid creating multiple endpoints for the same model unless required, as each endpoint consumes significant resources.
4034
* @rest_spec_name inference.put_googlevertexai
4135
* @availability stack since=8.15.0 stability=stable visibility=public
4236
* @availability serverless stability=stable visibility=public

specification/inference/put_hugging_face/PutHuggingFaceRequest.ts

-6
Original file line numberDiff line numberDiff line change
@@ -44,12 +44,6 @@ import { Id } from '@_types/common'
4444
* * `e5-small-v2`
4545
* * `multilingual-e5-base`
4646
* * `multilingual-e5-small`
47-
*
48-
* When you create an inference endpoint, the associated machine learning model is automatically deployed if it is not already running.
49-
* After creating the endpoint, wait for the model deployment to complete before using it.
50-
* To verify the deployment status, use the get trained model statistics API.
51-
* Look for `"state": "fully_allocated"` in the response and ensure that the `"allocation_count"` matches the `"target_allocation_count"`.
52-
* Avoid creating multiple endpoints for the same model unless required, as each endpoint consumes significant resources.
5347
* @rest_spec_name inference.put_hugging_face
5448
* @availability stack since=8.12.0 stability=stable visibility=public
5549
* @availability serverless stability=stable visibility=public

specification/inference/put_jinaai/PutJinaAiRequest.ts

-6
Original file line numberDiff line numberDiff line change
@@ -34,12 +34,6 @@ import { Id } from '@_types/common'
3434
*
3535
* To review the available `rerank` models, refer to <https://jina.ai/reranker>.
3636
* To review the available `text_embedding` models, refer to the <https://jina.ai/embeddings/>.
37-
*
38-
* When you create an inference endpoint, the associated machine learning model is automatically deployed if it is not already running.
39-
* After creating the endpoint, wait for the model deployment to complete before using it.
40-
* To verify the deployment status, use the get trained model statistics API.
41-
* Look for `"state": "fully_allocated"` in the response and ensure that the `"allocation_count"` matches the `"target_allocation_count"`.
42-
* Avoid creating multiple endpoints for the same model unless required, as each endpoint consumes significant resources.
4337
* @rest_spec_name inference.put_jinaai
4438
* @availability stack since=8.18.0 stability=stable visibility=public
4539
* @availability serverless stability=stable visibility=public

specification/inference/put_mistral/PutMistralRequest.ts

-6
Original file line numberDiff line numberDiff line change
@@ -30,12 +30,6 @@ import { Id } from '@_types/common'
3030
* Create a Mistral inference endpoint.
3131
*
3232
* Creates an inference endpoint to perform an inference task with the `mistral` service.
33-
*
34-
* When you create an inference endpoint, the associated machine learning model is automatically deployed if it is not already running.
35-
* After creating the endpoint, wait for the model deployment to complete before using it.
36-
* To verify the deployment status, use the get trained model statistics API.
37-
* Look for `"state": "fully_allocated"` in the response and ensure that the `"allocation_count"` matches the `"target_allocation_count"`.
38-
* Avoid creating multiple endpoints for the same model unless required, as each endpoint consumes significant resources.
3933
* @rest_spec_name inference.put_mistral
4034
* @availability stack since=8.15.0 stability=stable visibility=public
4135
* @availability serverless stability=stable visibility=public

specification/inference/put_openai/PutOpenAiRequest.ts

-6
Original file line numberDiff line numberDiff line change
@@ -31,12 +31,6 @@ import { Id } from '@_types/common'
3131
* Create an OpenAI inference endpoint.
3232
*
3333
* Create an inference endpoint to perform an inference task with the `openai` service or `openai` compatible APIs.
34-
*
35-
* When you create an inference endpoint, the associated machine learning model is automatically deployed if it is not already running.
36-
* After creating the endpoint, wait for the model deployment to complete before using it.
37-
* To verify the deployment status, use the get trained model statistics API.
38-
* Look for `"state": "fully_allocated"` in the response and ensure that the `"allocation_count"` matches the `"target_allocation_count"`.
39-
* Avoid creating multiple endpoints for the same model unless required, as each endpoint consumes significant resources.
4034
* @rest_spec_name inference.put_openai
4135
* @availability stack since=8.12.0 stability=stable visibility=public
4236
* @availability serverless stability=stable visibility=public

specification/inference/put_watsonx/PutWatsonxRequest.ts

-6
Original file line numberDiff line numberDiff line change
@@ -31,12 +31,6 @@ import { Id } from '@_types/common'
3131
* Create an inference endpoint to perform an inference task with the `watsonxai` service.
3232
* You need an IBM Cloud Databases for Elasticsearch deployment to use the `watsonxai` inference service.
3333
* You can provision one through the IBM catalog, the Cloud Databases CLI plug-in, the Cloud Databases API, or Terraform.
34-
*
35-
* When you create an inference endpoint, the associated machine learning model is automatically deployed if it is not already running.
36-
* After creating the endpoint, wait for the model deployment to complete before using it.
37-
* To verify the deployment status, use the get trained model statistics API.
38-
* Look for `"state": "fully_allocated"` in the response and ensure that the `"allocation_count"` matches the `"target_allocation_count"`.
39-
* Avoid creating multiple endpoints for the same model unless required, as each endpoint consumes significant resources.
4034
* @rest_spec_name inference.put_watsonx
4135
* @availability stack since=8.16.0 stability=stable visibility=public
4236
* @availability serverless stability=stable visibility=public

0 commit comments

Comments
 (0)