Skip to content

Latest commit

 

History

History
255 lines (182 loc) · 14.3 KB

InferenceEndpointsService.md

File metadata and controls

255 lines (182 loc) · 14.3 KB
Raw

InferenceEndpointsService

A list of all methods in the InferenceEndpointsService service. Click on the method name to view detailed information about that method.

Methods Description
list_inference_endpoints Gets the list of inference endpoints
get_inference_endpoint Gets an inference endpoint
get_inference_endpoint_jobs Retrieves a list of an inference endpoint jobs
create_inference_endpoint_job Creates a new job
get_inference_endpoint_job Retrieves a job in an inference endpoint
delete_inference_endpoint_job Deletes an inference endpoint job

list_inference_endpoints

Gets the list of inference endpoints

  • HTTP Method: GET
  • Endpoint: /organizations/{organization_name}/inference-endpoints

Parameters

Name Type Required Description
organization_name str ✅ Your organization name. This identifies the billing context for the API operation and represents a security boundary for SaladCloud resources. The organization must be created before using the API, and you must be a member of the organization.
page int ❌ The page number
page_size int ❌ The number of items per page

Return Type

InferenceEndpointsList

Example Usage Code Snippet

from salad_cloud_sdk import SaladCloudSdk, Environment

sdk = SaladCloudSdk(
    api_key="YOUR_API_KEY",
    api_key_header="YOUR_API_KEY_HEADER",
    base_url=Environment.DEFAULT.value,
    timeout=10000
)

result = sdk.inference_endpoints.list_inference_endpoints(
    organization_name="wtxd1j0ixuhfk-hdff3n3-hbtsigyh53bt0g4gjh8mcz4",
    page=121822981,
    page_size=37
)

print(result)

get_inference_endpoint

Gets an inference endpoint

  • HTTP Method: GET
  • Endpoint: /organizations/{organization_name}/inference-endpoints/{inference_endpoint_name}

Parameters

Name Type Required Description
organization_name str ✅ Your organization name. This identifies the billing context for the API operation and represents a security boundary for SaladCloud resources. The organization must be created before using the API, and you must be a member of the organization.
inference_endpoint_name str ✅ The unique inference endpoint name

Return Type

InferenceEndpoint

Example Usage Code Snippet

from salad_cloud_sdk import SaladCloudSdk, Environment

sdk = SaladCloudSdk(
    api_key="YOUR_API_KEY",
    api_key_header="YOUR_API_KEY_HEADER",
    base_url=Environment.DEFAULT.value,
    timeout=10000
)

result = sdk.inference_endpoints.get_inference_endpoint(
    organization_name="u5ke3wy-5gl1809s8so",
    inference_endpoint_name="et tempor sint"
)

print(result)

get_inference_endpoint_jobs

Retrieves a list of an inference endpoint jobs

  • HTTP Method: GET
  • Endpoint: /organizations/{organization_name}/inference-endpoints/{inference_endpoint_name}/jobs

Parameters

Name Type Required Description
organization_name str ✅ Your organization name. This identifies the billing context for the API operation and represents a security boundary for SaladCloud resources. The organization must be created before using the API, and you must be a member of the organization.
inference_endpoint_name str ✅ The unique inference endpoint name
page int ❌ The page number
page_size int ❌ The number of items per page

Return Type

InferenceEndpointJobList

Example Usage Code Snippet

from salad_cloud_sdk import SaladCloudSdk, Environment

sdk = SaladCloudSdk(
    api_key="YOUR_API_KEY",
    api_key_header="YOUR_API_KEY_HEADER",
    base_url=Environment.DEFAULT.value,
    timeout=10000
)

result = sdk.inference_endpoints.get_inference_endpoint_jobs(
    organization_name="yg0u13rmnwb7eyumc25lm4prwopvwr-1961f",
    inference_endpoint_name="consectetur occaecat",
    page=355955712,
    page_size=39
)

print(result)

create_inference_endpoint_job

Creates a new job

  • HTTP Method: POST
  • Endpoint: /organizations/{organization_name}/inference-endpoints/{inference_endpoint_name}/jobs

Parameters

Name Type Required Description
request_body CreateInferenceEndpointJob ✅ The request body.
organization_name str ✅ Your organization name. This identifies the billing context for the API operation and represents a security boundary for SaladCloud resources. The organization must be created before using the API, and you must be a member of the organization.
inference_endpoint_name str ✅ The unique inference endpoint name

Return Type

InferenceEndpointJob

Example Usage Code Snippet

from salad_cloud_sdk import SaladCloudSdk, Environment
from salad_cloud_sdk.models import CreateInferenceEndpointJob

sdk = SaladCloudSdk(
    api_key="YOUR_API_KEY",
    api_key_header="YOUR_API_KEY_HEADER",
    base_url=Environment.DEFAULT.value,
    timeout=10000
)

request_body = CreateInferenceEndpointJob(
    input="",
    metadata={},
    webhook="webhook"
)

result = sdk.inference_endpoints.create_inference_endpoint_job(
    request_body=request_body,
    organization_name="yg0u13rmnwb7eyumc25lm4prwopvwr-1961f",
    inference_endpoint_name="consectetur occaecat"
)

print(result)

get_inference_endpoint_job

Retrieves a job in an inference endpoint

  • HTTP Method: GET
  • Endpoint: /organizations/{organization_name}/inference-endpoints/{inference_endpoint_name}/jobs/{inference_endpoint_job_id}

Parameters

Name Type Required Description
organization_name str ✅ Your organization name. This identifies the billing context for the API operation and represents a security boundary for SaladCloud resources. The organization must be created before using the API, and you must be a member of the organization.
inference_endpoint_name str ✅ The unique inference endpoint name
inference_endpoint_job_id str ✅ The unique job id

Return Type

InferenceEndpointJob

Example Usage Code Snippet

from salad_cloud_sdk import SaladCloudSdk, Environment

sdk = SaladCloudSdk(
    api_key="YOUR_API_KEY",
    api_key_header="YOUR_API_KEY_HEADER",
    base_url=Environment.DEFAULT.value,
    timeout=10000
)

result = sdk.inference_endpoints.get_inference_endpoint_job(
    organization_name="kdhvnhwadaqzuh18",
    inference_endpoint_name="eiusmod dolore do",
    inference_endpoint_job_id="inference_endpoint_job_id"
)

print(result)

delete_inference_endpoint_job

Deletes an inference endpoint job

  • HTTP Method: DELETE
  • Endpoint: /organizations/{organization_name}/inference-endpoints/{inference_endpoint_name}/jobs/{inference_endpoint_job_id}

Parameters

Name Type Required Description
organization_name str ✅ Your organization name. This identifies the billing context for the API operation and represents a security boundary for SaladCloud resources. The organization must be created before using the API, and you must be a member of the organization.
inference_endpoint_name str ✅ The unique inference endpoint name
inference_endpoint_job_id str ✅ The unique job id

Example Usage Code Snippet

from salad_cloud_sdk import SaladCloudSdk, Environment

sdk = SaladCloudSdk(
    api_key="YOUR_API_KEY",
    api_key_header="YOUR_API_KEY_HEADER",
    base_url=Environment.DEFAULT.value,
    timeout=10000
)

result = sdk.inference_endpoints.delete_inference_endpoint_job(
    organization_name="kdhvnhwadaqzuh18",
    inference_endpoint_name="eiusmod dolore do",
    inference_endpoint_job_id="inference_endpoint_job_id"
)

print(result)