Experiment

Overview

Available Operations

createExperimentProjectsProjectIdExperimentsPost - Create Experiment
~~listExperimentsProjectsProjectIdExperimentsGet~~ - List Experiments ⚠️ Deprecated
listExperimentsPaginatedProjectsProjectIdExperimentsPaginatedGet - List Experiments Paginated
searchExperimentsProjectsProjectIdExperimentsSearchPost - Search Experiments
getExperimentProjectsProjectIdExperimentsExperimentIdGet - Get Experiment
updateExperimentProjectsProjectIdExperimentsExperimentIdPut - Update Experiment
deleteExperimentProjectsProjectIdExperimentsExperimentIdDelete - Delete Experiment
experimentsAvailableColumnsProjectsProjectIdExperimentsAvailableColumnsPost - Experiments Available Columns
getExperimentMetricsProjectsProjectIdExperimentsExperimentIdMetricsPost - Get Experiment Metrics
getExperimentsMetricsProjectsProjectIdExperimentsMetricsPost - Get Experiments Metrics
updateMetricSettingsProjectsProjectIdExperimentsExperimentIdMetricSettingsPatch - Update Metric Settings
getMetricSettingsProjectsProjectIdExperimentsExperimentIdMetricSettingsGet - Get Metric Settings

createExperimentProjectsProjectIdExperimentsPost

Create a new experiment for a project.

Example Usage

import { GalileoGenerated } from "galileo-generated";

const galileoGenerated = new GalileoGenerated();

async function run() {
  const result = await galileoGenerated.experiment.createExperimentProjectsProjectIdExperimentsPost({
    apiKeyHeader: process.env["GALILEOGENERATED_API_KEY_HEADER"] ?? "",
  }, {
    projectId: "<value>",
    body: {
      name: "<value>",
    },
  });

  console.log(result);
}

run();

Standalone function

The standalone function version of this method:

import { GalileoGeneratedCore } from "galileo-generated/core.js";
import { experimentCreateExperimentProjectsProjectIdExperimentsPost } from "galileo-generated/funcs/experimentCreateExperimentProjectsProjectIdExperimentsPost.js";

// Use `GalileoGeneratedCore` for best tree-shaking performance.
// You can create one instance of it to use across an application.
const galileoGenerated = new GalileoGeneratedCore();

async function run() {
  const res = await experimentCreateExperimentProjectsProjectIdExperimentsPost(galileoGenerated, {
    apiKeyHeader: process.env["GALILEOGENERATED_API_KEY_HEADER"] ?? "",
  }, {
    projectId: "<value>",
    body: {
      name: "<value>",
    },
  });
  if (res.ok) {
    const { value: result } = res;
    console.log(result);
  } else {
    console.log("experimentCreateExperimentProjectsProjectIdExperimentsPost failed:", res.error);
  }
}

run();

Parameters

Parameter	Type	Required	Description
`request`	operations.CreateExperimentProjectsProjectIdExperimentsPostRequest	✔️	The request object to use for the request.
`security`	operations.CreateExperimentProjectsProjectIdExperimentsPostSecurity	✔️	The security requirements to use for the request.
`options`	RequestOptions	➖	Used to set various options for making HTTP requests.
`options.fetchOptions`	RequestInit	➖	Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed.
`options.retries`	RetryConfig	➖	Enables retrying HTTP requests under certain failure conditions.

Response

Promise<models.ExperimentResponse>

Errors

Error Type	Status Code	Content Type
errors.HTTPValidationError	422	application/json
errors.GalileoGeneratedDefaultError	4XX, 5XX	/

listExperimentsProjectsProjectIdExperimentsGet

Retrieve all experiments for a project.

⚠️ DEPRECATED: This will be removed in a future release, please migrate away from it as soon as possible.

Example Usage

import { GalileoGenerated } from "galileo-generated";

const galileoGenerated = new GalileoGenerated();

async function run() {
  const result = await galileoGenerated.experiment.listExperimentsProjectsProjectIdExperimentsGet({
    apiKeyHeader: process.env["GALILEOGENERATED_API_KEY_HEADER"] ?? "",
  }, {
    projectId: "<value>",
  });

  console.log(result);
}

run();

Standalone function

The standalone function version of this method:

import { GalileoGeneratedCore } from "galileo-generated/core.js";
import { experimentListExperimentsProjectsProjectIdExperimentsGet } from "galileo-generated/funcs/experimentListExperimentsProjectsProjectIdExperimentsGet.js";

// Use `GalileoGeneratedCore` for best tree-shaking performance.
// You can create one instance of it to use across an application.
const galileoGenerated = new GalileoGeneratedCore();

async function run() {
  const res = await experimentListExperimentsProjectsProjectIdExperimentsGet(galileoGenerated, {
    apiKeyHeader: process.env["GALILEOGENERATED_API_KEY_HEADER"] ?? "",
  }, {
    projectId: "<value>",
  });
  if (res.ok) {
    const { value: result } = res;
    console.log(result);
  } else {
    console.log("experimentListExperimentsProjectsProjectIdExperimentsGet failed:", res.error);
  }
}

run();

Parameters

Parameter	Type	Required	Description
`request`	operations.ListExperimentsProjectsProjectIdExperimentsGetRequest	✔️	The request object to use for the request.
`security`	operations.ListExperimentsProjectsProjectIdExperimentsGetSecurity	✔️	The security requirements to use for the request.
`options`	RequestOptions	➖	Used to set various options for making HTTP requests.
`options.fetchOptions`	RequestInit	➖	Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed.
`options.retries`	RetryConfig	➖	Enables retrying HTTP requests under certain failure conditions.

Response

Promise<models.ExperimentResponse[]>

Errors

Error Type	Status Code	Content Type
errors.HTTPValidationError	422	application/json
errors.GalileoGeneratedDefaultError	4XX, 5XX	/

listExperimentsPaginatedProjectsProjectIdExperimentsPaginatedGet

Retrieve all experiments for a project with pagination.

Example Usage

import { GalileoGenerated } from "galileo-generated";

const galileoGenerated = new GalileoGenerated();

async function run() {
  const result = await galileoGenerated.experiment.listExperimentsPaginatedProjectsProjectIdExperimentsPaginatedGet({
    apiKeyHeader: process.env["GALILEOGENERATED_API_KEY_HEADER"] ?? "",
  }, {
    projectId: "<value>",
  });

  console.log(result);
}

run();

Standalone function

The standalone function version of this method:

import { GalileoGeneratedCore } from "galileo-generated/core.js";
import { experimentListExperimentsPaginatedProjectsProjectIdExperimentsPaginatedGet } from "galileo-generated/funcs/experimentListExperimentsPaginatedProjectsProjectIdExperimentsPaginatedGet.js";

// Use `GalileoGeneratedCore` for best tree-shaking performance.
// You can create one instance of it to use across an application.
const galileoGenerated = new GalileoGeneratedCore();

async function run() {
  const res = await experimentListExperimentsPaginatedProjectsProjectIdExperimentsPaginatedGet(galileoGenerated, {
    apiKeyHeader: process.env["GALILEOGENERATED_API_KEY_HEADER"] ?? "",
  }, {
    projectId: "<value>",
  });
  if (res.ok) {
    const { value: result } = res;
    console.log(result);
  } else {
    console.log("experimentListExperimentsPaginatedProjectsProjectIdExperimentsPaginatedGet failed:", res.error);
  }
}

run();

Parameters

Parameter	Type	Required	Description
`request`	operations.ListExperimentsPaginatedProjectsProjectIdExperimentsPaginatedGetRequest	✔️	The request object to use for the request.
`security`	operations.ListExperimentsPaginatedProjectsProjectIdExperimentsPaginatedGetSecurity	✔️	The security requirements to use for the request.
`options`	RequestOptions	➖	Used to set various options for making HTTP requests.
`options.fetchOptions`	RequestInit	➖	Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed.
`options.retries`	RetryConfig	➖	Enables retrying HTTP requests under certain failure conditions.

Response

Promise<models.ListExperimentResponse>

Errors

Error Type	Status Code	Content Type
errors.HTTPValidationError	422	application/json
errors.GalileoGeneratedDefaultError	4XX, 5XX	/

searchExperimentsProjectsProjectIdExperimentsSearchPost

Search experiments for a project.

Example Usage

import { GalileoGenerated } from "galileo-generated";

const galileoGenerated = new GalileoGenerated();

async function run() {
  const result = await galileoGenerated.experiment.searchExperimentsProjectsProjectIdExperimentsSearchPost({
    apiKeyHeader: process.env["GALILEOGENERATED_API_KEY_HEADER"] ?? "",
  }, {
    projectId: "<value>",
    body: {},
  });

  console.log(result);
}

run();

Standalone function

The standalone function version of this method:

import { GalileoGeneratedCore } from "galileo-generated/core.js";
import { experimentSearchExperimentsProjectsProjectIdExperimentsSearchPost } from "galileo-generated/funcs/experimentSearchExperimentsProjectsProjectIdExperimentsSearchPost.js";

// Use `GalileoGeneratedCore` for best tree-shaking performance.
// You can create one instance of it to use across an application.
const galileoGenerated = new GalileoGeneratedCore();

async function run() {
  const res = await experimentSearchExperimentsProjectsProjectIdExperimentsSearchPost(galileoGenerated, {
    apiKeyHeader: process.env["GALILEOGENERATED_API_KEY_HEADER"] ?? "",
  }, {
    projectId: "<value>",
    body: {},
  });
  if (res.ok) {
    const { value: result } = res;
    console.log(result);
  } else {
    console.log("experimentSearchExperimentsProjectsProjectIdExperimentsSearchPost failed:", res.error);
  }
}

run();

Parameters

Parameter	Type	Required	Description
`request`	operations.SearchExperimentsProjectsProjectIdExperimentsSearchPostRequest	✔️	The request object to use for the request.
`security`	operations.SearchExperimentsProjectsProjectIdExperimentsSearchPostSecurity	✔️	The security requirements to use for the request.
`options`	RequestOptions	➖	Used to set various options for making HTTP requests.
`options.fetchOptions`	RequestInit	➖	Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed.
`options.retries`	RetryConfig	➖	Enables retrying HTTP requests under certain failure conditions.

Response

Promise<models.ListExperimentResponse>

Errors

Error Type	Status Code	Content Type
errors.HTTPValidationError	422	application/json
errors.GalileoGeneratedDefaultError	4XX, 5XX	/

getExperimentProjectsProjectIdExperimentsExperimentIdGet

Retrieve a specific experiment.

Example Usage

import { GalileoGenerated } from "galileo-generated";

const galileoGenerated = new GalileoGenerated();

async function run() {
  const result = await galileoGenerated.experiment.getExperimentProjectsProjectIdExperimentsExperimentIdGet({
    apiKeyHeader: process.env["GALILEOGENERATED_API_KEY_HEADER"] ?? "",
  }, {
    experimentId: "<value>",
    projectId: "<value>",
  });

  console.log(result);
}

run();

Standalone function

The standalone function version of this method:

import { GalileoGeneratedCore } from "galileo-generated/core.js";
import { experimentGetExperimentProjectsProjectIdExperimentsExperimentIdGet } from "galileo-generated/funcs/experimentGetExperimentProjectsProjectIdExperimentsExperimentIdGet.js";

// Use `GalileoGeneratedCore` for best tree-shaking performance.
// You can create one instance of it to use across an application.
const galileoGenerated = new GalileoGeneratedCore();

async function run() {
  const res = await experimentGetExperimentProjectsProjectIdExperimentsExperimentIdGet(galileoGenerated, {
    apiKeyHeader: process.env["GALILEOGENERATED_API_KEY_HEADER"] ?? "",
  }, {
    experimentId: "<value>",
    projectId: "<value>",
  });
  if (res.ok) {
    const { value: result } = res;
    console.log(result);
  } else {
    console.log("experimentGetExperimentProjectsProjectIdExperimentsExperimentIdGet failed:", res.error);
  }
}

run();

Parameters

Parameter	Type	Required	Description
`request`	operations.GetExperimentProjectsProjectIdExperimentsExperimentIdGetRequest	✔️	The request object to use for the request.
`security`	operations.GetExperimentProjectsProjectIdExperimentsExperimentIdGetSecurity	✔️	The security requirements to use for the request.
`options`	RequestOptions	➖	Used to set various options for making HTTP requests.
`options.fetchOptions`	RequestInit	➖	Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed.
`options.retries`	RetryConfig	➖	Enables retrying HTTP requests under certain failure conditions.

Response

Promise<models.ExperimentResponse>

Errors

Error Type	Status Code	Content Type
errors.HTTPValidationError	422	application/json
errors.GalileoGeneratedDefaultError	4XX, 5XX	/

updateExperimentProjectsProjectIdExperimentsExperimentIdPut

Update a specific experiment.

Example Usage

import { GalileoGenerated } from "galileo-generated";

const galileoGenerated = new GalileoGenerated();

async function run() {
  const result = await galileoGenerated.experiment.updateExperimentProjectsProjectIdExperimentsExperimentIdPut({
    apiKeyHeader: process.env["GALILEOGENERATED_API_KEY_HEADER"] ?? "",
  }, {
    experimentId: "<value>",
    projectId: "<value>",
    body: {
      name: "<value>",
    },
  });

  console.log(result);
}

run();

Standalone function

The standalone function version of this method:

import { GalileoGeneratedCore } from "galileo-generated/core.js";
import { experimentUpdateExperimentProjectsProjectIdExperimentsExperimentIdPut } from "galileo-generated/funcs/experimentUpdateExperimentProjectsProjectIdExperimentsExperimentIdPut.js";

// Use `GalileoGeneratedCore` for best tree-shaking performance.
// You can create one instance of it to use across an application.
const galileoGenerated = new GalileoGeneratedCore();

async function run() {
  const res = await experimentUpdateExperimentProjectsProjectIdExperimentsExperimentIdPut(galileoGenerated, {
    apiKeyHeader: process.env["GALILEOGENERATED_API_KEY_HEADER"] ?? "",
  }, {
    experimentId: "<value>",
    projectId: "<value>",
    body: {
      name: "<value>",
    },
  });
  if (res.ok) {
    const { value: result } = res;
    console.log(result);
  } else {
    console.log("experimentUpdateExperimentProjectsProjectIdExperimentsExperimentIdPut failed:", res.error);
  }
}

run();

Parameters

Parameter	Type	Required	Description
`request`	operations.UpdateExperimentProjectsProjectIdExperimentsExperimentIdPutRequest	✔️	The request object to use for the request.
`security`	operations.UpdateExperimentProjectsProjectIdExperimentsExperimentIdPutSecurity	✔️	The security requirements to use for the request.
`options`	RequestOptions	➖	Used to set various options for making HTTP requests.
`options.fetchOptions`	RequestInit	➖	Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed.
`options.retries`	RetryConfig	➖	Enables retrying HTTP requests under certain failure conditions.

Response

Promise<models.ExperimentResponse>

Errors

Error Type	Status Code	Content Type
errors.HTTPValidationError	422	application/json
errors.GalileoGeneratedDefaultError	4XX, 5XX	/

deleteExperimentProjectsProjectIdExperimentsExperimentIdDelete

Delete a specific experiment.

Example Usage

import { GalileoGenerated } from "galileo-generated";

const galileoGenerated = new GalileoGenerated();

async function run() {
  await galileoGenerated.experiment.deleteExperimentProjectsProjectIdExperimentsExperimentIdDelete({
    apiKeyHeader: process.env["GALILEOGENERATED_API_KEY_HEADER"] ?? "",
  }, {
    experimentId: "<value>",
    projectId: "<value>",
  });


}

run();

Standalone function

The standalone function version of this method:

import { GalileoGeneratedCore } from "galileo-generated/core.js";
import { experimentDeleteExperimentProjectsProjectIdExperimentsExperimentIdDelete } from "galileo-generated/funcs/experimentDeleteExperimentProjectsProjectIdExperimentsExperimentIdDelete.js";

// Use `GalileoGeneratedCore` for best tree-shaking performance.
// You can create one instance of it to use across an application.
const galileoGenerated = new GalileoGeneratedCore();

async function run() {
  const res = await experimentDeleteExperimentProjectsProjectIdExperimentsExperimentIdDelete(galileoGenerated, {
    apiKeyHeader: process.env["GALILEOGENERATED_API_KEY_HEADER"] ?? "",
  }, {
    experimentId: "<value>",
    projectId: "<value>",
  });
  if (res.ok) {
    const { value: result } = res;
    
  } else {
    console.log("experimentDeleteExperimentProjectsProjectIdExperimentsExperimentIdDelete failed:", res.error);
  }
}

run();

Parameters

Parameter	Type	Required	Description
`request`	operations.DeleteExperimentProjectsProjectIdExperimentsExperimentIdDeleteRequest	✔️	The request object to use for the request.
`security`	operations.DeleteExperimentProjectsProjectIdExperimentsExperimentIdDeleteSecurity	✔️	The security requirements to use for the request.
`options`	RequestOptions	➖	Used to set various options for making HTTP requests.
`options.fetchOptions`	RequestInit	➖	Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed.
`options.retries`	RetryConfig	➖	Enables retrying HTTP requests under certain failure conditions.

Response

Promise<void>

Errors

Error Type	Status Code	Content Type
errors.HTTPValidationError	422	application/json
errors.GalileoGeneratedDefaultError	4XX, 5XX	/

experimentsAvailableColumnsProjectsProjectIdExperimentsAvailableColumnsPost

Procures the column information for experiments.

Example Usage

import { GalileoGenerated } from "galileo-generated";

const galileoGenerated = new GalileoGenerated();

async function run() {
  const result = await galileoGenerated.experiment.experimentsAvailableColumnsProjectsProjectIdExperimentsAvailableColumnsPost({
    apiKeyHeader: process.env["GALILEOGENERATED_API_KEY_HEADER"] ?? "",
  }, {
    projectId: "<value>",
  });

  console.log(result);
}

run();

Standalone function

The standalone function version of this method:

import { GalileoGeneratedCore } from "galileo-generated/core.js";
import {
  experimentExperimentsAvailableColumnsProjectsProjectIdExperimentsAvailableColumnsPost,
} from "galileo-generated/funcs/experimentExperimentsAvailableColumnsProjectsProjectIdExperimentsAvailableColumnsPost.js";

// Use `GalileoGeneratedCore` for best tree-shaking performance.
// You can create one instance of it to use across an application.
const galileoGenerated = new GalileoGeneratedCore();

async function run() {
  const res = await experimentExperimentsAvailableColumnsProjectsProjectIdExperimentsAvailableColumnsPost(galileoGenerated, {
    apiKeyHeader: process.env["GALILEOGENERATED_API_KEY_HEADER"] ?? "",
  }, {
    projectId: "<value>",
  });
  if (res.ok) {
    const { value: result } = res;
    console.log(result);
  } else {
    console.log("experimentExperimentsAvailableColumnsProjectsProjectIdExperimentsAvailableColumnsPost failed:", res.error);
  }
}

run();

Parameters

Parameter	Type	Required	Description
`request`	operations.ExperimentsAvailableColumnsProjectsProjectIdExperimentsAvailableColumnsPostRequest	✔️	The request object to use for the request.
`security`	operations.ExperimentsAvailableColumnsProjectsProjectIdExperimentsAvailableColumnsPostSecurity	✔️	The security requirements to use for the request.
`options`	RequestOptions	➖	Used to set various options for making HTTP requests.
`options.fetchOptions`	RequestInit	➖	Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed.
`options.retries`	RetryConfig	➖	Enables retrying HTTP requests under certain failure conditions.

Response

Promise<models.ExperimentsAvailableColumnsResponse>

Errors

Error Type	Status Code	Content Type
errors.HTTPValidationError	422	application/json
errors.GalileoGeneratedDefaultError	4XX, 5XX	/

getExperimentMetricsProjectsProjectIdExperimentsExperimentIdMetricsPost

Retrieve metrics for a specific experiment.

Example Usage

import { GalileoGenerated } from "galileo-generated";

const galileoGenerated = new GalileoGenerated();

async function run() {
  const result = await galileoGenerated.experiment.getExperimentMetricsProjectsProjectIdExperimentsExperimentIdMetricsPost({
    apiKeyHeader: process.env["GALILEOGENERATED_API_KEY_HEADER"] ?? "",
  }, {
    projectId: "<value>",
    experimentId: "<value>",
    body: {
      filters: [
        {
          columnId: "<id>",
          operator: "eq",
          value: "example input",
          caseSensitive: true,
          type: "text",
        },
      ],
    },
  });

  console.log(result);
}

run();

Standalone function

The standalone function version of this method:

import { GalileoGeneratedCore } from "galileo-generated/core.js";
import {
  experimentGetExperimentMetricsProjectsProjectIdExperimentsExperimentIdMetricsPost,
} from "galileo-generated/funcs/experimentGetExperimentMetricsProjectsProjectIdExperimentsExperimentIdMetricsPost.js";

// Use `GalileoGeneratedCore` for best tree-shaking performance.
// You can create one instance of it to use across an application.
const galileoGenerated = new GalileoGeneratedCore();

async function run() {
  const res = await experimentGetExperimentMetricsProjectsProjectIdExperimentsExperimentIdMetricsPost(galileoGenerated, {
    apiKeyHeader: process.env["GALILEOGENERATED_API_KEY_HEADER"] ?? "",
  }, {
    projectId: "<value>",
    experimentId: "<value>",
    body: {
      filters: [
        {
          columnId: "<id>",
          operator: "eq",
          value: "example input",
          caseSensitive: true,
          type: "text",
        },
      ],
    },
  });
  if (res.ok) {
    const { value: result } = res;
    console.log(result);
  } else {
    console.log("experimentGetExperimentMetricsProjectsProjectIdExperimentsExperimentIdMetricsPost failed:", res.error);
  }
}

run();

Parameters

Parameter	Type	Required	Description
`request`	operations.GetExperimentMetricsProjectsProjectIdExperimentsExperimentIdMetricsPostRequest	✔️	The request object to use for the request.
`security`	operations.GetExperimentMetricsProjectsProjectIdExperimentsExperimentIdMetricsPostSecurity	✔️	The security requirements to use for the request.
`options`	RequestOptions	➖	Used to set various options for making HTTP requests.
`options.fetchOptions`	RequestInit	➖	Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed.
`options.retries`	RetryConfig	➖	Enables retrying HTTP requests under certain failure conditions.

Response

Promise<models.ExperimentMetricsResponse>

Errors

Error Type	Status Code	Content Type
errors.HTTPValidationError	422	application/json
errors.GalileoGeneratedDefaultError	4XX, 5XX	/

getExperimentsMetricsProjectsProjectIdExperimentsMetricsPost

Retrieve metrics for all experiments in a project.

Example Usage

import { GalileoGenerated } from "galileo-generated";

const galileoGenerated = new GalileoGenerated();

async function run() {
  const result = await galileoGenerated.experiment.getExperimentsMetricsProjectsProjectIdExperimentsMetricsPost({
    apiKeyHeader: process.env["GALILEOGENERATED_API_KEY_HEADER"] ?? "",
  }, {
    projectId: "<value>",
    body: {
      filters: [
        {
          columnId: "<id>",
          operator: "eq",
          value: "example input",
          caseSensitive: true,
          type: "text",
        },
      ],
    },
  });

  console.log(result);
}

run();

Standalone function

The standalone function version of this method:

import { GalileoGeneratedCore } from "galileo-generated/core.js";
import { experimentGetExperimentsMetricsProjectsProjectIdExperimentsMetricsPost } from "galileo-generated/funcs/experimentGetExperimentsMetricsProjectsProjectIdExperimentsMetricsPost.js";

// Use `GalileoGeneratedCore` for best tree-shaking performance.
// You can create one instance of it to use across an application.
const galileoGenerated = new GalileoGeneratedCore();

async function run() {
  const res = await experimentGetExperimentsMetricsProjectsProjectIdExperimentsMetricsPost(galileoGenerated, {
    apiKeyHeader: process.env["GALILEOGENERATED_API_KEY_HEADER"] ?? "",
  }, {
    projectId: "<value>",
    body: {
      filters: [
        {
          columnId: "<id>",
          operator: "eq",
          value: "example input",
          caseSensitive: true,
          type: "text",
        },
      ],
    },
  });
  if (res.ok) {
    const { value: result } = res;
    console.log(result);
  } else {
    console.log("experimentGetExperimentsMetricsProjectsProjectIdExperimentsMetricsPost failed:", res.error);
  }
}

run();

Parameters

Parameter	Type	Required	Description
`request`	operations.GetExperimentsMetricsProjectsProjectIdExperimentsMetricsPostRequest	✔️	The request object to use for the request.
`security`	operations.GetExperimentsMetricsProjectsProjectIdExperimentsMetricsPostSecurity	✔️	The security requirements to use for the request.
`options`	RequestOptions	➖	Used to set various options for making HTTP requests.
`options.fetchOptions`	RequestInit	➖	Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed.
`options.retries`	RetryConfig	➖	Enables retrying HTTP requests under certain failure conditions.

Response

Promise<models.ExperimentMetricsResponse>

Errors

Error Type	Status Code	Content Type
errors.HTTPValidationError	422	application/json
errors.GalileoGeneratedDefaultError	4XX, 5XX	/

updateMetricSettingsProjectsProjectIdExperimentsExperimentIdMetricSettingsPatch

Update Metric Settings

Example Usage

import { GalileoGenerated } from "galileo-generated";

const galileoGenerated = new GalileoGenerated();

async function run() {
  const result = await galileoGenerated.experiment.updateMetricSettingsProjectsProjectIdExperimentsExperimentIdMetricSettingsPatch({
    apiKeyHeader: process.env["GALILEOGENERATED_API_KEY_HEADER"] ?? "",
  }, {
    projectId: "<value>",
    experimentId: "<value>",
    body: {},
  });

  console.log(result);
}

run();

Standalone function

The standalone function version of this method:

import { GalileoGeneratedCore } from "galileo-generated/core.js";
import {
  experimentUpdateMetricSettingsProjectsProjectIdExperimentsExperimentIdMetricSettingsPatch,
} from "galileo-generated/funcs/experimentUpdateMetricSettingsProjectsProjectIdExperimentsExperimentIdMetricSettingsPatch.js";

// Use `GalileoGeneratedCore` for best tree-shaking performance.
// You can create one instance of it to use across an application.
const galileoGenerated = new GalileoGeneratedCore();

async function run() {
  const res = await experimentUpdateMetricSettingsProjectsProjectIdExperimentsExperimentIdMetricSettingsPatch(galileoGenerated, {
    apiKeyHeader: process.env["GALILEOGENERATED_API_KEY_HEADER"] ?? "",
  }, {
    projectId: "<value>",
    experimentId: "<value>",
    body: {},
  });
  if (res.ok) {
    const { value: result } = res;
    console.log(result);
  } else {
    console.log("experimentUpdateMetricSettingsProjectsProjectIdExperimentsExperimentIdMetricSettingsPatch failed:", res.error);
  }
}

run();

Parameters

Parameter	Type	Required	Description
`request`	operations.UpdateMetricSettingsProjectsProjectIdExperimentsExperimentIdMetricSettingsPatchRequest	✔️	The request object to use for the request.
`security`	operations.UpdateMetricSettingsProjectsProjectIdExperimentsExperimentIdMetricSettingsPatchSecurity	✔️	The security requirements to use for the request.
`options`	RequestOptions	➖	Used to set various options for making HTTP requests.
`options.fetchOptions`	RequestInit	➖	Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed.
`options.retries`	RetryConfig	➖	Enables retrying HTTP requests under certain failure conditions.

Response

Promise<models.MetricSettingsResponse>

Errors

Error Type	Status Code	Content Type
errors.HTTPValidationError	422	application/json
errors.GalileoGeneratedDefaultError	4XX, 5XX	/

getMetricSettingsProjectsProjectIdExperimentsExperimentIdMetricSettingsGet

Get Metric Settings

Example Usage

import { GalileoGenerated } from "galileo-generated";

const galileoGenerated = new GalileoGenerated();

async function run() {
  const result = await galileoGenerated.experiment.getMetricSettingsProjectsProjectIdExperimentsExperimentIdMetricSettingsGet({
    apiKeyHeader: process.env["GALILEOGENERATED_API_KEY_HEADER"] ?? "",
  }, {
    experimentId: "<value>",
    projectId: "<value>",
  });

  console.log(result);
}

run();

Standalone function

The standalone function version of this method:

import { GalileoGeneratedCore } from "galileo-generated/core.js";
import {
  experimentGetMetricSettingsProjectsProjectIdExperimentsExperimentIdMetricSettingsGet,
} from "galileo-generated/funcs/experimentGetMetricSettingsProjectsProjectIdExperimentsExperimentIdMetricSettingsGet.js";

// Use `GalileoGeneratedCore` for best tree-shaking performance.
// You can create one instance of it to use across an application.
const galileoGenerated = new GalileoGeneratedCore();

async function run() {
  const res = await experimentGetMetricSettingsProjectsProjectIdExperimentsExperimentIdMetricSettingsGet(galileoGenerated, {
    apiKeyHeader: process.env["GALILEOGENERATED_API_KEY_HEADER"] ?? "",
  }, {
    experimentId: "<value>",
    projectId: "<value>",
  });
  if (res.ok) {
    const { value: result } = res;
    console.log(result);
  } else {
    console.log("experimentGetMetricSettingsProjectsProjectIdExperimentsExperimentIdMetricSettingsGet failed:", res.error);
  }
}

run();

Parameters

Parameter	Type	Required	Description
`request`	operations.GetMetricSettingsProjectsProjectIdExperimentsExperimentIdMetricSettingsGetRequest	✔️	The request object to use for the request.
`security`	operations.GetMetricSettingsProjectsProjectIdExperimentsExperimentIdMetricSettingsGetSecurity	✔️	The security requirements to use for the request.
`options`	RequestOptions	➖	Used to set various options for making HTTP requests.
`options.fetchOptions`	RequestInit	➖	Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed.
`options.retries`	RetryConfig	➖	Enables retrying HTTP requests under certain failure conditions.

Response

Promise<models.MetricSettingsResponse>

Errors

Error Type	Status Code	Content Type
errors.HTTPValidationError	422	application/json
errors.GalileoGeneratedDefaultError	4XX, 5XX	/

FilesExpand file tree

README.md

Latest commit

History

README.md

File metadata and controls

Experiment

Overview

Available Operations

createExperimentProjectsProjectIdExperimentsPost

Example Usage

Standalone function

Parameters

Response

Errors

listExperimentsProjectsProjectIdExperimentsGet

Example Usage

Standalone function

Parameters

Response

Errors

listExperimentsPaginatedProjectsProjectIdExperimentsPaginatedGet

Example Usage

Standalone function

Parameters

Response

Errors

searchExperimentsProjectsProjectIdExperimentsSearchPost

Example Usage

Standalone function

Parameters

Response

Errors

getExperimentProjectsProjectIdExperimentsExperimentIdGet

Example Usage

Standalone function

Parameters

Response

Errors

updateExperimentProjectsProjectIdExperimentsExperimentIdPut

Example Usage

Standalone function

Parameters

Response

Errors

deleteExperimentProjectsProjectIdExperimentsExperimentIdDelete

Example Usage

Standalone function

Parameters

Response

Errors

experimentsAvailableColumnsProjectsProjectIdExperimentsAvailableColumnsPost

Example Usage

Standalone function

Parameters

Response

Errors

getExperimentMetricsProjectsProjectIdExperimentsExperimentIdMetricsPost

Example Usage

Standalone function

Parameters

Response

Errors

getExperimentsMetricsProjectsProjectIdExperimentsMetricsPost

Example Usage

Standalone function

Parameters

Response

Errors

updateMetricSettingsProjectsProjectIdExperimentsExperimentIdMetricSettingsPatch

Example Usage

Standalone function

Parameters

Response

Errors

getMetricSettingsProjectsProjectIdExperimentsExperimentIdMetricSettingsGet

Example Usage

Standalone function

Parameters

Response