Skip to content

Conversation

@maxhniebergall
Copy link
Contributor

Alias task_settings as parameters in the perform inference API.

examples:

Put the endpoint

  {
  "service": "cohere",
  "service_settings": {
    "model_id": "rerank-english-v3.0",
    "api_key": "<REDACTED>"
  },
  "task_settings": {
    "return_documents": true
  }
  }

perform inference with task settings:

request:

{
    "input": ["test1", "test2", "test3"],
    "query": "test",
    "task_settings":{
        "return_documents":true,
        "top_n": 1
    }
}

response:

{
    "rerank": [
        {
            "index": 0,
            "relevance_score": 9.927262E-4,
            "text": "test1"
        }
    ]
}

perform inference with parameters:

request:

{
    "input": ["test1", "test2", "test3"],
    "query": "test",
    "parameters":{
        "return_documents":true,
        "top_n": 1
    }
}

response:

{
    "rerank": [
        {
            "index": 0,
            "relevance_score": 9.927262E-4,
            "text": "test1"
        }
    ]
}

without parameters or task_settings:

request:

{
    "input": ["test1", "test2", "test3"],
    "query": "test"
}

response:

{
    "rerank": [
        {
            "index": 0,
            "relevance_score": 9.927262E-4,
            "text": "test1"
        },
        {
            "index": 1,
            "relevance_score": 7.1802974E-4,
            "text": "test2"
        },
        {
            "index": 2,
            "relevance_score": 2.1152887E-4,
            "text": "test3"
        }
    ]
}

with both parameters and task settings (the latter one is used)

request:

{
    "input": ["test1", "test2", "test3"],
    "query": "test",
    "parameters":{
        "top_n": 1
    },
    "task_settings":{
        "top_n": 2
    }
}

response:

{
    "rerank": [
        {
            "index": 0,
            "relevance_score": 9.927262E-4,
            "text": "test1"
        },
        {
            "index": 1,
            "relevance_score": 7.1802974E-4,
            "text": "test2"
        }
    ]
}

@elasticsearchmachine
Copy link
Collaborator

Hi @maxhniebergall, I've created a changelog YAML for you.

@elasticsearchmachine elasticsearchmachine added the Team:ML Meta label for the ML team label Oct 8, 2024
@elasticsearchmachine
Copy link
Collaborator

Pinging @elastic/ml-core (Team:ML)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

>enhancement :ml Machine learning Team:ML Meta label for the ML team v8.16.0 v9.0.0

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants