Skip to content

InferenceEndpointsService.md

Latest commit

 

History

History
242 lines (169 loc) · 13.8 KB

InferenceEndpointsService.md

File metadata and controls

242 lines (169 loc) · 13.8 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
listInferenceEndpoints Lists inference endpoints.
getInferenceEndpoint Gets an inference endpoint.
listInferenceEndpointJobs Lists inference endpoint jobs.
createInferenceEndpointJob Creates a new inference endpoint job.
getInferenceEndpointJob Gets an inference endpoint job.
deleteInferenceEndpointJob Cancels an inference endpoint job.

listInferenceEndpoints

Lists 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 maximum number of items per page.

Return Type

InferenceEndpointCollection

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('acme-corp', {
    page: 1,
    pageSize: 1,
  });

  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 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('acme-corp', 'transcribe');

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

listInferenceEndpointJobs

Lists 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 inference endpoint name.
page number ❌ The page number.
pageSize number ❌ The maximum number of items per page.

Return Type

InferenceEndpointJobCollection

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.listInferenceEndpointJobs('acme-corp', 'transcribe', {
    page: 1,
    pageSize: 1,
  });

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

createInferenceEndpointJob

Creates a new inference endpoint job.

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

Parameters

Name Type Required Description
body InferenceEndpointJobPrototype ✅ 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 inference endpoint name.

Return Type

InferenceEndpointJob

Example Usage Code Snippet

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

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

  const inferenceEndpointJobPrototype: InferenceEndpointJobPrototype = {
    input: [],
    metadata: {},
    webhookUrl: 'https://webhook.example.com/events',
  };

  const { data } = await saladCloudSdk.inferenceEndpoints.createInferenceEndpointJob(
    'acme-corp',
    'transcribe',
    inferenceEndpointJobPrototype,
  );

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

getInferenceEndpointJob

Gets an inference endpoint job.

  • 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 inference endpoint name.
inferenceEndpointJobId string ✅ The inference endpoint job identifier.

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(
    'acme-corp',
    'transcribe',
    '2fc459a1-1c09-4a34-ade7-54d03fc51d6a',
  );

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

deleteInferenceEndpointJob

Cancels 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 inference endpoint name.
inferenceEndpointJobId string ✅ The inference endpoint job identifier.

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(
    'acme-corp',
    'transcribe',
    '2fc459a1-1c09-4a34-ade7-54d03fc51d6a',
  );

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