Skip to content

Latest commit

 

History

History
195 lines (123 loc) · 12.9 KB

InferenceEndpointsService.md

File metadata and controls

195 lines (123 loc) · 12.9 KB

InferenceEndpointsService

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

Methods Description
ListInferenceEndpointsAsync Gets the list of inference endpoints
GetInferenceEndpointAsync Gets an inference endpoint
GetInferenceEndpointJobsAsync Retrieves a list of an inference endpoint jobs
CreateInferenceEndpointJobAsync Creates a new job
GetInferenceEndpointJobAsync Retrieves a job in an inference endpoint
DeleteInferenceEndpointJobAsync Deletes an inference endpoint job

ListInferenceEndpointsAsync

Gets the list of inference endpoints

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

Parameters

Name Type Required Description
organizationName string 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 long The page number
pageSize long The number of items per page

Return Type

InferenceEndpointsList

Example Usage Code Snippet

using Salad.Cloud.SDK;

var client = new SaladCloudSdkClient();

var response = await client.InferenceEndpoints.ListInferenceEndpointsAsync("wtxd1j0ixuhfk-hdff3n3-hbtsigyh53bt0g4gjh8mcz4", 121822981, 37);

Console.WriteLine(response);

GetInferenceEndpointAsync

Gets an inference endpoint

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

Parameters

Name Type Required Description
organizationName string 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.
inferenceEndpointName string The unique inference endpoint name

Return Type

InferenceEndpoint

Example Usage Code Snippet

using Salad.Cloud.SDK;

var client = new SaladCloudSdkClient();

var response = await client.InferenceEndpoints.GetInferenceEndpointAsync("u5ke3wy-5gl1809s8so", "et tempor sint");

Console.WriteLine(response);

GetInferenceEndpointJobsAsync

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
organizationName string 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.
inferenceEndpointName string The unique inference endpoint name
page long The page number
pageSize long The number of items per page

Return Type

InferenceEndpointJobList

Example Usage Code Snippet

using Salad.Cloud.SDK;

var client = new SaladCloudSdkClient();

var response = await client.InferenceEndpoints.GetInferenceEndpointJobsAsync("yg0u13rmnwb7eyumc25lm4prwopvwr-1961f", "consectetur occaecat", 355955712, 39);

Console.WriteLine(response);

CreateInferenceEndpointJobAsync

Creates a new job

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

Parameters

Name Type Required Description
input CreateInferenceEndpointJob The request body.
organizationName string 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.
inferenceEndpointName string The unique inference endpoint name

Return Type

InferenceEndpointJob

Example Usage Code Snippet

using Salad.Cloud.SDK;
using Salad.Cloud.SDK.Models;

var client = new SaladCloudSdkClient();

var input = new CreateInferenceEndpointJob(new object {});

var response = await client.InferenceEndpoints.CreateInferenceEndpointJobAsync(input, "yg0u13rmnwb7eyumc25lm4prwopvwr-1961f", "consectetur occaecat");

Console.WriteLine(response);

GetInferenceEndpointJobAsync

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
organizationName string 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.
inferenceEndpointName string The unique inference endpoint name
inferenceEndpointJobId string The unique job id

Return Type

InferenceEndpointJob

Example Usage Code Snippet

using Salad.Cloud.SDK;

var client = new SaladCloudSdkClient();

var response = await client.InferenceEndpoints.GetInferenceEndpointJobAsync("kdhvnhwadaqzuh18", "eiusmod dolore do", "inference_endpoint_job_id");

Console.WriteLine(response);

DeleteInferenceEndpointJobAsync

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
organizationName string 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.
inferenceEndpointName string The unique inference endpoint name
inferenceEndpointJobId string The unique job id

Example Usage Code Snippet

using Salad.Cloud.SDK;

var client = new SaladCloudSdkClient();

await client.InferenceEndpoints.DeleteInferenceEndpointJobAsync("kdhvnhwadaqzuh18", "eiusmod dolore do", "inference_endpoint_job_id");