Skip to content

Latest commit

 

History

History
249 lines (176 loc) · 13.9 KB

InferenceEndpointsService.md

File metadata and controls

249 lines (176 loc) · 13.9 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
listInferenceEndpoints Gets the list of inference endpoints
getInferenceEndpoint Gets an inference endpoint
getInferenceEndpointJobs Retrieves a list of an inference endpoint jobs
createInferenceEndpointJob Creates a new job
getInferenceEndpointJob Retrieves a job in an inference endpoint
deleteInferenceEndpointJob Deletes an inference endpoint job

listInferenceEndpoints

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 number ❌ The page number
pageSize number ❌ The number of items per page

Return Type

InferenceEndpointsList

Example Usage Code Snippet

import { SaladCloudSdk } from '@saladtechnologies-oss/salad-cloud-sdk';

(async () => {
  const saladCloudSdk = new SaladCloudSdk({
    apiKey: 'YOUR_API_KEY',
  });

  const { data } = await saladCloudSdk.inferenceEndpoints.listInferenceEndpoints(
    'wtxd1j0ixuhfk-hdff3n3-hbtsigyh53bt0g4gjh8mcz4',
    {
      page: 121822981,
      pageSize: 37,
    },
  );

  console.log(data);
})();

getInferenceEndpoint

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

import { SaladCloudSdk } from '@saladtechnologies-oss/salad-cloud-sdk';

(async () => {
  const saladCloudSdk = new SaladCloudSdk({
    apiKey: 'YOUR_API_KEY',
  });

  const { data } = await saladCloudSdk.inferenceEndpoints.getInferenceEndpoint('u5ke3wy-5gl1809s8so', 'et tempor sint');

  console.log(data);
})();

getInferenceEndpointJobs

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 number ❌ The page number
pageSize number ❌ The number of items per page

Return Type

InferenceEndpointJobList

Example Usage Code Snippet

import { SaladCloudSdk } from '@saladtechnologies-oss/salad-cloud-sdk';

(async () => {
  const saladCloudSdk = new SaladCloudSdk({
    apiKey: 'YOUR_API_KEY',
  });

  const { data } = await saladCloudSdk.inferenceEndpoints.getInferenceEndpointJobs(
    'yg0u13rmnwb7eyumc25lm4prwopvwr-1961f',
    'consectetur occaecat',
    {
      page: 355955712,
      pageSize: 39,
    },
  );

  console.log(data);
})();

createInferenceEndpointJob

Creates a new job

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

Parameters

Name Type Required Description
body 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

import { CreateInferenceEndpointJob, SaladCloudSdk } from '@saladtechnologies-oss/salad-cloud-sdk';

(async () => {
  const saladCloudSdk = new SaladCloudSdk({
    apiKey: 'YOUR_API_KEY',
  });

  const createInferenceEndpointJob: CreateInferenceEndpointJob = {
    input: [],
    metadata: {},
    webhook: 'webhook',
  };

  const { data } = await saladCloudSdk.inferenceEndpoints.createInferenceEndpointJob(
    'yg0u13rmnwb7eyumc25lm4prwopvwr-1961f',
    'consectetur occaecat',
    input,
  );

  console.log(data);
})();

getInferenceEndpointJob

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

import { SaladCloudSdk } from '@saladtechnologies-oss/salad-cloud-sdk';

(async () => {
  const saladCloudSdk = new SaladCloudSdk({
    apiKey: 'YOUR_API_KEY',
  });

  const { data } = await saladCloudSdk.inferenceEndpoints.getInferenceEndpointJob(
    'kdhvnhwadaqzuh18',
    'eiusmod dolore do',
    'inference_endpoint_job_id',
  );

  console.log(data);
})();

deleteInferenceEndpointJob

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

import { SaladCloudSdk } from '@saladtechnologies-oss/salad-cloud-sdk';

(async () => {
  const saladCloudSdk = new SaladCloudSdk({
    apiKey: 'YOUR_API_KEY',
  });

  const { data } = await saladCloudSdk.inferenceEndpoints.deleteInferenceEndpointJob(
    'kdhvnhwadaqzuh18',
    'eiusmod dolore do',
    'inference_endpoint_job_id',
  );

  console.log(data);
})();